Trait

net.liftweb.record.field

EnumTypedField

Related Doc: package field

Permalink

trait EnumTypedField[EnumType <: Enumeration] extends TypedField[field.EnumTypedField.EnumType.Value]

Linear Supertypes
TypedField[EnumType.Value], BaseField, util.BaseField, FieldContainer, SettableField, SettableValueHolder, Settable, ReadableField, Bindable, ValueHolder, FieldIdentifier, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EnumTypedField
  2. TypedField
  3. BaseField
  4. BaseField
  5. FieldContainer
  6. SettableField
  7. SettableValueHolder
  8. Settable
  9. ReadableField
  10. Bindable
  11. ValueHolder
  12. FieldIdentifier
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. type MyType = EnumType.Value

    Permalink
    Definition Classes
    TypedField
  2. type ValidationFunction = (ValueType) ⇒ List[FieldError]

    Permalink
    Definition Classes
    TypedField
  3. abstract type ValueType

    Permalink
    Definition Classes
    ValueHolder

Abstract Value Members

  1. abstract def defaultValueBox: Box[MyType]

    Permalink

    The default value of the field when no value is set.

    The default value of the field when no value is set. Must return a Full Box unless optional_? is true

    Definition Classes
    TypedField
  2. abstract val enum: EnumType

    Permalink
    Attributes
    protected
  3. abstract def get: ValueType

    Permalink
    Definition Classes
    ValueHolder
  4. abstract def liftSetFilterToBox(in: Box[MyType]): Box[MyType]

    Permalink

    OptionalTypedField and MandatoryTypedField implement this to do the appropriate lifting of Box[MyType] to ValueType

    OptionalTypedField and MandatoryTypedField implement this to do the appropriate lifting of Box[MyType] to ValueType

    Attributes
    protected
    Definition Classes
    TypedField
  5. abstract def name: String

    Permalink
    Definition Classes
    ReadableField
  6. abstract def set(in: ValueType): ValueType

    Permalink
    Definition Classes
    Settable
  7. abstract def toBoxMyType(in: ValueType): Box[MyType]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  8. abstract def toValueType(in: Box[MyType]): ValueType

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  9. abstract val valueManifest: Manifest[EnumType.Value]

    Permalink
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def allFields: Seq[util.BaseField]

    Permalink
    Definition Classes
    BaseField → FieldContainer
  5. def asHtml: NodeSeq

    Permalink
    Definition Classes
    ReadableField → Bindable
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def asJIntOrdinal: JValue

    Permalink
  8. def asJString(encode: (MyType) ⇒ String): JValue

    Permalink

    Helper for implementing asJValue for a conversion to an encoded JString

    Helper for implementing asJValue for a conversion to an encoded JString

    encode

    function to transform the field value into a String

    Attributes
    protected
    Definition Classes
    TypedField
  9. def asJStringName: JValue

    Permalink
  10. def asJValue: JValue

    Permalink

    Encode the field value into a JValue

    Encode the field value into a JValue

    Definition Classes
    EnumTypedFieldBaseField
  11. def asJs: JsExp with Product with Serializable

    Permalink

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    Definition Classes
    EnumTypedFieldBaseField
  12. def asString: String

    Permalink

    Convert the field to a String...

    Convert the field to a String... usually of the form "displayName=value"

    Definition Classes
    TypedFieldBaseField
  13. def atomicUpdate(f: (ValueType) ⇒ ValueType): ValueType

    Permalink
    Definition Classes
    Settable
  14. implicit def boxNodeFuncToFieldError(in: (Box[MyType]) ⇒ Box[Node]): (Box[MyType]) ⇒ List[FieldError]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  15. implicit def boxNodeToFieldError(in: Box[Node]): List[FieldError]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  16. def buildDisplayList: List[(Box[EnumType.Value], String)]

    Permalink

    Build a list of (value, label) options for a select list.

    Build a list of (value, label) options for a select list. Return a tuple of (Box[String], String) where the first string is the value of the field and the second string is the Text name of the Value.

  17. def canRead_?: Boolean

    Permalink

    Can the value of this field be read without obscuring the result?

    Can the value of this field be read without obscuring the result?

    Definition Classes
    BaseField
  18. def canWrite_?: Boolean

    Permalink

    Can the value of this field be written?

    Can the value of this field be written?

    Definition Classes
    BaseField
  19. def checkCanRead_?: Boolean

    Permalink

    If the owner is not in "safe" mode, check the current environment to see if the field can be read

    If the owner is not in "safe" mode, check the current environment to see if the field can be read

    Definition Classes
    BaseField
  20. def checkCanWrite_?: Boolean

    Permalink

    If the owner is not in "safe" mode, check the current environment to see if the field can be written

    If the owner is not in "safe" mode, check the current environment to see if the field can be written

    Definition Classes
    BaseField
  21. def clear: Unit

    Permalink

    Clear the value of this field

    Clear the value of this field

    Definition Classes
    TypedField
  22. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def defaultValue: EnumType.Value

    Permalink
  24. def dirty_?: Boolean

    Permalink
    Definition Classes
    BaseField
  25. def dirty_?(b: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BaseField
  26. def displayHtml: NodeSeq

    Permalink
    Definition Classes
    ReadableField
  27. def displayName: String

    Permalink
    Definition Classes
    ReadableField
  28. def displayNameHtml: Box[NodeSeq]

    Permalink
    Definition Classes
    ReadableField
  29. def emptyOptionLabel: String

    Permalink

    Label for the selection item representing Empty, show when this field is optional.

    Label for the selection item representing Empty, show when this field is optional. Defaults to the empty string.

  30. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  32. def fieldId: Option[NodeSeq]

    Permalink
    Definition Classes
    SettableField
  33. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  34. def forceDirty_?: Boolean

    Permalink

    Should the dirty flag always be set when setBox is called

    Should the dirty flag always be set when setBox is called

    Definition Classes
    BaseField
  35. def formElemAttrs: Seq[http.SHtml.ElemAttr]

    Permalink

    What form elements are we going to add to this field?

    What form elements are we going to add to this field?

    Definition Classes
    BaseField
  36. def formInputType: String

    Permalink

    Form field's type.

    Form field's type. Defaults to 'text', but you may want to change it to other HTML5 values.

    Definition Classes
    BaseField
  37. def fromInt(in: Int): Box[EnumType.Value]

    Permalink
  38. final def genericSetFromAny(in: Any)(implicit m: Manifest[MyType]): Box[MyType]

    Permalink

    Generic implementation of setFromAny that implements exactly what the doc for setFromAny specifies, using a Manifest to check types

    Generic implementation of setFromAny that implements exactly what the doc for setFromAny specifies, using a Manifest to check types

    Attributes
    protected
    Definition Classes
    TypedField
  39. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  40. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  41. def helpAsHtml: Box[NodeSeq]

    Permalink
    Definition Classes
    SettableField
  42. def ignoreField_?: Boolean

    Permalink

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    Definition Classes
    BaseField
  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  44. def label: NodeSeq

    Permalink
    Definition Classes
    BaseField
  45. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  46. def noValueErrorMessage: String

    Permalink

    The error message used when the field value could not be set

    The error message used when the field value could not be set

    Definition Classes
    BaseField
  47. implicit def nodeToFieldError(node: Node): List[FieldError]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  48. def notOptionalErrorMessage: String

    Permalink

    The error message used when the field value must be set

    The error message used when the field value must be set

    Definition Classes
    BaseField
  49. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  51. def obscure(in: MyType): Box[MyType]

    Permalink
    Definition Classes
    TypedField
  52. def optional_?: Boolean

    Permalink

    Is the value of this field optional (e.g.

    Is the value of this field optional (e.g. NULLable)?

    Definition Classes
    BaseField
  53. def performAtomicOperation[T](f: ⇒ T): T

    Permalink
    Definition Classes
    Settable
  54. def required_?: Boolean

    Permalink
    Definition Classes
    SettableField
  55. def resetDirty: Unit

    Permalink
    Definition Classes
    BaseField
  56. def runFilters(in: Box[MyType], filter: List[(Box[MyType]) ⇒ Box[MyType]]): Box[MyType]

    Permalink
    Definition Classes
    TypedField
  57. def runValidation(in: Box[MyType]): List[FieldError]

    Permalink

    Helper function that does validation of a value by using the validators specified for the field

    Helper function that does validation of a value by using the validators specified for the field

    Attributes
    protected
    Definition Classes
    TypedField
  58. def safe_?: Boolean

    Permalink
    Definition Classes
    BaseField
  59. def setBox(in: Box[MyType]): Box[MyType]

    Permalink
    Definition Classes
    TypedField
  60. def setFilter: List[(ValueType) ⇒ ValueType]

    Permalink
    Definition Classes
    TypedField → SettableField
  61. def setFilterBox: List[(Box[MyType]) ⇒ Box[MyType]]

    Permalink

    A list of functions that transform the value before it is set.

    A list of functions that transform the value before it is set. The transformations are also applied before the value is used in a query. Typical applications of this are trimming and/or toLowerCase-ing strings

    Attributes
    protected
    Definition Classes
    TypedField
  62. def setFromAny(in: Any): Box[EnumType.Value]

    Permalink

    Set the value of the field from anything.

    Set the value of the field from anything. Implementations of this method should accept at least the following (pattern => valueBox)

    • value: MyType => setBox(Full(value))
    • Some(value: MyType) => setBox(Full(value))
    • Full(value: MyType) => setBox(Full(value))
    • (value: MyType)::_ => setBox(Full(value))
    • s: String => setFromString(s)
    • Some(s: String) => setFromString(s)
    • Full(s: String) => setFromString(s)
    • null|None|Empty => setBox(defaultValueBox)
    • f: Failure => setBox(f) And usually convert the input to a string and uses setFromString as a last resort.

    Note that setFromAny should _always_ call setBox, even if the conversion fails. This is so that validation properly notes the error.

    The method genericSetFromAny implements this guideline.

    Definition Classes
    EnumTypedFieldTypedField
  63. def setFromJIntOrdinal(jvalue: JValue): Box[EnumType.Value]

    Permalink
  64. def setFromJString(jvalue: JValue)(decode: (String) ⇒ Box[MyType]): Box[MyType]

    Permalink

    Helper for implementing setFromJValue for a conversion from an encoded JString

    Helper for implementing setFromJValue for a conversion from an encoded JString

    decode

    function to try and transform a String into a field value

    Attributes
    protected
    Definition Classes
    TypedField
  65. def setFromJStringName(jvalue: JValue): Box[EnumType.Value]

    Permalink
  66. def setFromJValue(jvalue: JValue): Box[EnumType.Value]

    Permalink

    Decode the JValue and set the field to the decoded value.

    Decode the JValue and set the field to the decoded value. Returns Empty or Failure if the value could not be set

    Definition Classes
    EnumTypedFieldTypedField
  67. def setFromString(s: String): Box[EnumType.Value]

    Permalink

    Set the value of the field using some kind of type-specific conversion from a String.

    Set the value of the field using some kind of type-specific conversion from a String. By convention, if the field is optional_?, then the empty string should be treated as no-value (Empty). Note that setFromString should _always_ call setBox, even if the conversion fails. This is so that validation properly notes the error.

    returns

    Full(convertedValue) if the conversion succeeds (the field value will be set by side-effect) Empty or Failure if the conversion does not succeed

    Definition Classes
    EnumTypedFieldTypedField
  68. def set_!(in: Box[MyType]): Box[MyType]

    Permalink
    Attributes
    protected
    Definition Classes
    TypedField
  69. def shouldDisplay_?: Boolean

    Permalink
    Definition Classes
    ReadableField
  70. def show_?: Boolean

    Permalink
    Definition Classes
    SettableField
  71. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  72. def tabIndex: Int

    Permalink
    Definition Classes
    BaseField
  73. def toForm: Box[NodeSeq]

    Permalink

    Generate a form control for the field

    Generate a form control for the field

    Definition Classes
    EnumTypedFieldBaseField → SettableField
  74. def toInt: Box[Int]

    Permalink
  75. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  76. def toXHtml: NodeSeq

    Permalink

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    Definition Classes
    BaseField
  77. def uniqueFieldId: Box[String]

    Permalink
    Definition Classes
    BaseField → FieldIdentifier
  78. def uploadField_?: Boolean

    Permalink
    Definition Classes
    SettableField
  79. def validate: List[FieldError]

    Permalink

    Validate this field's setting, returning any errors found

    Validate this field's setting, returning any errors found

    Definition Classes
    TypedField → SettableField
  80. def validations: List[ValidationFunction]

    Permalink
    Definition Classes
    TypedField → SettableField
  81. def valueBox: Box[MyType]

    Permalink
    Definition Classes
    TypedField
  82. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TypedField[EnumType.Value]

Inherited from BaseField

Inherited from util.BaseField

Inherited from FieldContainer

Inherited from SettableField

Inherited from SettableValueHolder

Inherited from Settable

Inherited from ReadableField

Inherited from Bindable

Inherited from ValueHolder

Inherited from FieldIdentifier

Inherited from AnyRef

Inherited from Any

Ungrouped