net.liftweb.record.field

OptionalEnumField

class OptionalEnumField [OwnerType <: Record[OwnerType], EnumType <: Enumeration] extends Field[Value, OwnerType] with OptionalTypedField[Value] with EnumTypedField[EnumType]

linear super types: EnumTypedField[EnumType], OptionalTypedField[Value], Product1[Box[Value]], Product, Equals, Field[Value, OwnerType], TypedField[Value], OwnedField[OwnerType], BaseField, BaseField, FieldContainer, SettableField, SettableValueHolder, Settable, ReadableField, Bindable, ValueHolder, FieldIdentifier, AnyRef, Any
known subclasses: OptionalCountryField
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. OptionalEnumField
  2. EnumTypedField
  3. OptionalTypedField
  4. Product1
  5. Product
  6. Equals
  7. Field
  8. TypedField
  9. OwnedField
  10. BaseField
  11. BaseField
  12. FieldContainer
  13. SettableField
  14. SettableValueHolder
  15. Settable
  16. ReadableField
  17. Bindable
  18. ValueHolder
  19. FieldIdentifier
  20. AnyRef
  21. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new OptionalEnumField (rec: OwnerType, enum: EnumType, value: Box[Value])(implicit m: Manifest[Value])

  2. new OptionalEnumField (rec: OwnerType, enum: EnumType)(implicit m: Manifest[Value])

Type Members

  1. type MyType = Value

    definition classes: TypedField
  2. type ValidationFunction = (ValueType) ⇒ List[FieldError]

    definition classes: TypedField
  3. type ValueType = Option[Value]

    definition classes: OptionalTypedFieldValueHolder

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def _1 : Box[MyType]

    definition classes: OptionalTypedField → Product1
  9. def allFields : Seq[BaseField]

    definition classes: BaseFieldFieldContainer
  10. def apply (in: Box[MyType]) : OwnerType

    definition classes: Field
  11. def apply (in: MyType) : OwnerType

    definition classes: Field
  12. def asHtml : NodeSeq

    Default read-only rendering of field

    Default read-only rendering of field

    definition classes: ReadableFieldBindable
  13. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  14. def asJIntOrdinal : JValue

    definition classes: EnumTypedField
  15. def asJString (encode: (MyType) ⇒ String) : JValue

    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
  16. def asJStringName : JValue

    definition classes: EnumTypedField
  17. def asJValue : JValue

    Encode the field value into a JValue

    Encode the field value into a JValue

    definition classes: EnumTypedFieldBaseField
  18. def asJs : JsExp with Product

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    definition classes: EnumTypedFieldBaseField
  19. def asString : String

    Convert the field to a String.

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

    definition classes: TypedFieldBaseField
  20. def atomicUpdate (f: (ValueType) ⇒ ValueType) : ValueType

    Perform an atomic update of this Settable.

    Perform an atomic update of this Settable. The current value is passed to the function and the ValueHolder is set to the result of the function. This is enclosed in the performAtomicOperation method which will, by default, synchronize this instance

    definition classes: Settable
  21. implicit def boxNodeFuncToFieldError (in: (Box[MyType]) ⇒ Box[Node]) : (Box[MyType]) ⇒ List[FieldError]

    attributes: protected implicit
    definition classes: TypedField
  22. implicit def boxNodeToFieldError (in: Box[Node]) : List[FieldError]

    attributes: protected implicit
    definition classes: TypedField
  23. def buildDisplayList : List[(Box[Value], String)]

    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.

    definition classes: EnumTypedField
  24. def canEqual (a: Any) : Boolean

    definition classes: OptionalTypedField → Equals
  25. def canRead_? : Boolean

    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
  26. def canWrite_? : Boolean

    Can the value of this field be written?

    Can the value of this field be written?

    definition classes: BaseField
  27. def checkCanRead_? : Boolean

    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
  28. def checkCanWrite_? : Boolean

    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
  29. def clear : Unit

    Clear the value of this field

    Clear the value of this field

    definition classes: TypedField
  30. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  31. def defaultValue : Value

    definition classes: EnumTypedField
  32. def defaultValueBox : Box[MyType]

    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: OptionalTypedFieldTypedField
  33. def dirty_? : Boolean

    definition classes: BaseField
  34. def dirty_? (b: Boolean) : Unit

    attributes: protected
    definition classes: BaseField
  35. def displayHtml : NodeSeq

    definition classes: ReadableField
  36. def displayName : String

    The display name of this field (e.

    The display name of this field (e.g., "First Name")

    definition classes: ReadableField
  37. def displayNameHtml : Box[NodeSeq]

    definition classes: ReadableField
  38. def emptyOptionLabel : String

    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.

    definition classes: EnumTypedField
  39. val enum : EnumType

    attributes: protected
    definition classes: OptionalEnumFieldEnumTypedField
  40. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  41. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  42. def fieldId : Option[NodeSeq]

    A unique 'id' for the field for form generation

    A unique 'id' for the field for form generation

    definition classes: SettableField
  43. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  44. def fromInt (in: Int) : Box[Value]

    definition classes: EnumTypedField
  45. def genericSetFromAny (in: Any)(implicit m: Manifest[MyType]) : Box[MyType]

    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 final
    definition classes: TypedField
  46. def get : Option[MyType]

    get the value

    get the value

    definition classes: OptionalTypedFieldValueHolder
  47. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  48. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  49. def helpAsHtml : Box[NodeSeq]

    definition classes: SettableField
  50. def ignoreField_? : Boolean

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    definition classes: BaseField
  51. def is : Option[MyType]

    Get the value.

    Get the value. Use get.

    @deprecated

    definition classes: OptionalTypedFieldValueHolder
  52. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  53. def label : NodeSeq

    definition classes: BaseField
  54. def liftSetFilterToBox (in: Box[MyType]) : Box[MyType]

    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: OptionalTypedFieldTypedField
  55. def name : String

    The text name of this field

    The text name of this field

    definition classes: BaseFieldReadableField
  56. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  57. def noValueErrorMessage : String

    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
  58. implicit def nodeToFieldError (node: Node) : List[FieldError]

    attributes: protected implicit
    definition classes: TypedField
  59. def notOptionalErrorMessage : String

    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
  60. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  61. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  62. def obscure (in: MyType) : Box[MyType]

    definition classes: TypedField
  63. def optional_? : Boolean

    Is the value of this field optional (e.

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

    attributes: final
    definition classes: OptionalTypedFieldBaseField
  64. def owner : OwnerType

    Return the owner of this field

    Return the owner of this field

    definition classes: OptionalEnumFieldOwnedField
  65. def performAtomicOperation [T] (f: ⇒ T) : T

    Perform an atomic operation on the Settable.

    Perform an atomic operation on the Settable. By default synchronizes the instance, but it could use other mechanisms

    definition classes: Settable
  66. def productArity : Int

    definition classes: Product1 → Product
  67. def productElement (n: Int) : Any

    definition classes: Product1 → Product
  68. def productElements : Iterator[Any]

    definition classes: Product
      deprecated:
    1. use productIterator instead

  69. def productIterator : Iterator[Any]

    definition classes: Product
  70. def productPrefix : String

    definition classes: Product
  71. def required_? : Boolean

    Is the Field required (and will have a style designating it as such)

    Is the Field required (and will have a style designating it as such)

    definition classes: SettableField
  72. def resetDirty : Unit

    definition classes: BaseField
  73. def runFilters (in: Box[MyType], filter: List[(Box[MyType]) ⇒ Box[MyType]]) : Box[MyType]

    definition classes: TypedField
  74. def runValidation (in: Box[MyType]) : List[FieldError]

    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
  75. def safe_? : Boolean

    Are we in "safe" mode (i.

    Are we in "safe" mode (i.e., the value of the field can be read or written without any security checks.)

    attributes: final
    definition classes: OwnedFieldBaseField
  76. def set (in: Option[MyType]) : Option[MyType]

    Set the value of the field to the given value.

    Set the value of the field to the given value. Note: Because setting a field can fail (return non-Full), this method will return defaultValueBox if the field could not be set.

    definition classes: OptionalTypedFieldSettable
  77. def setBox (in: Box[MyType]) : Box[MyType]

    definition classes: TypedField
  78. def setFilter : List[(ValueType) ⇒ ValueType]

    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

    definition classes: TypedFieldSettableField
  79. def setFilterBox : List[(Box[MyType]) ⇒ Box[MyType]]

    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
  80. def setFromAny (in: Any) : Box[Value]

    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
  81. def setFromJIntOrdinal (jvalue: JValue) : Box[Value]

    definition classes: EnumTypedField
  82. def setFromJString (jvalue: JValue)(decode: (String) ⇒ Box[MyType]) : Box[MyType]

    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
  83. def setFromJStringName (jvalue: JValue) : Box[Value]

    definition classes: EnumTypedField
  84. def setFromJValue (jvalue: JValue) : Box[Value]

    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
  85. def setFromString (s: String) : Box[Value]

    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
  86. def set_! (in: Box[MyType]) : Box[MyType]

    attributes: protected
    definition classes: TypedField
  87. def shouldDisplay_? : Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    definition classes: ReadableField
  88. def show_? : Boolean

    Give the current state of things, should the this field be shown

    Give the current state of things, should the this field be shown

    definition classes: SettableField
  89. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  90. def tabIndex : Int

    definition classes: BaseField
  91. def toBoxMyType (in: ValueType) : Box[Value]

    definition classes: OptionalTypedFieldTypedField
  92. def toForm : Box[NodeSeq]

    Generate a form control for the field

    Generate a form control for the field

    definition classes: EnumTypedFieldBaseFieldSettableField
  93. def toInt : Box[Int]

    definition classes: EnumTypedField
  94. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: OptionalTypedField → AnyRef → Any
  95. def toValueType (in: Box[MyType]) : Option[MyType]

    definition classes: OptionalTypedFieldTypedField
  96. def toXHtml : NodeSeq

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    definition classes: BaseField
  97. def uniqueFieldId : Box[String]

    definition classes: BaseFieldFieldIdentifier
  98. def uploadField_? : Boolean

    Is this an upload field so that a form that includes this field must be multi-part mime

    Is this an upload field so that a form that includes this field must be multi-part mime

    definition classes: SettableField
  99. def validate : List[FieldError]

    Validate this field's setting, returning any errors found

    Validate this field's setting, returning any errors found

    definition classes: TypedFieldSettableField
  100. def validations : List[ValidationFunction]

    definition classes: TypedFieldSettableField
  101. def value : Option[MyType]

    definition classes: OptionalTypedField
  102. def valueBox : Box[MyType]

    definition classes: TypedField
  103. val valueManifest : Manifest[Value]

    attributes: protected
    definition classes: OptionalEnumFieldEnumTypedField
  104. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  105. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  106. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from EnumTypedField[EnumType]

Inherited from OptionalTypedField[Value]

Inherited from Product1[Box[Value]]

Inherited from Product

Inherited from Equals

Inherited from Field[Value, OwnerType]

Inherited from TypedField[Value]

Inherited from OwnedField[OwnerType]

Inherited from BaseField

Inherited from 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