net.liftweb.record.field

OptionalEmailField

class OptionalEmailField[OwnerType <: Record[OwnerType]] extends OptionalStringField[OwnerType] with EmailTypedField

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. OptionalEmailField
  2. EmailTypedField
  3. OptionalStringField
  4. StringTypedField
  5. StringValidators
  6. OptionalTypedField
  7. Product1
  8. Product
  9. Equals
  10. Field
  11. TypedField
  12. OwnedField
  13. BaseField
  14. BaseField
  15. FieldContainer
  16. SettableField
  17. SettableValueHolder
  18. Settable
  19. ReadableField
  20. Bindable
  21. ValueHolder
  22. FieldIdentifier
  23. AnyRef
  24. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionalEmailField(rec: OwnerType, maxLength: Int)

Type Members

  1. type MyType = String

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

    Definition Classes
    TypedField
  3. type ValueType = Option[String]

    ValueType represents the type that users will work with.

    ValueType represents the type that users will work with. For OptionalTypedField, this is equal to Option[ThisType].

    Definition Classes
    OptionalTypedFieldValueHolder

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def _1: Box[MyType]

    Definition Classes
    OptionalTypedField → Product1
  7. def allFields: Seq[BaseField]

    Definition Classes
    BaseFieldFieldContainer
  8. def apply(in: Box[MyType]): OwnerType

    Definition Classes
    Field
  9. def apply(in: MyType): OwnerType

    Definition Classes
    Field
  10. def asHtml: NodeSeq

    Default read-only rendering of field

    Default read-only rendering of field

    Definition Classes
    ReadableFieldBindable
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. 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
  13. def asJValue: JValue

    Encode the field value into a JValue

    Encode the field value into a JValue

    Definition Classes
    StringTypedFieldBaseField
  14. def asJs: JsExp with Product with Serializable

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    Definition Classes
    StringTypedFieldBaseField
  15. def asString: String

    Convert the field to a String.

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

    Definition Classes
    TypedFieldBaseField
  16. 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
  17. implicit def boxNodeFuncToFieldError(in: (Box[MyType]) ⇒ Box[Node]): (Box[MyType]) ⇒ List[FieldError]

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

    Attributes
    protected
    Definition Classes
    TypedField
  19. def boxStrToValType(in: Box[String]): ValueType

    Attributes
    protected
    Definition Classes
    OptionalStringFieldStringValidators
  20. def canEqual(a: Any): Boolean

    Definition Classes
    OptionalTypedField → Equals
  21. 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
  22. def canWrite_?: Boolean

    Can the value of this field be written?

    Can the value of this field be written?

    Definition Classes
    BaseField
  23. 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
  24. 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
  25. def clear: Unit

    Clear the value of this field

    Clear the value of this field

    Definition Classes
    TypedField
  26. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. def crop(in: ValueType): ValueType

    Definition Classes
    StringValidators
  28. def defaultValue: String

    Definition Classes
    StringTypedField
  29. 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
  30. def dirty_?: Boolean

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

    Attributes
    protected
    Definition Classes
    BaseField
  32. def displayHtml: NodeSeq

    Definition Classes
    ReadableField
  33. def displayName: String

    The display name of this field (e.

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

    Definition Classes
    ReadableField
  34. def displayNameHtml: Box[NodeSeq]

    Definition Classes
    ReadableField
  35. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  37. 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
  38. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  39. def forceDirty_?: Boolean

    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
  40. def formElemAttrs: Seq[ElemAttr]

    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
  41. def formInputType: String

    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
  42. final 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
    Definition Classes
    TypedField
  43. def get: Option[MyType]

    get the value

    get the value

    Definition Classes
    OptionalTypedFieldValueHolder
  44. final def getClass(): java.lang.Class[_]

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

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

    Definition Classes
    SettableField
  47. def ignoreField_?: Boolean

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    Definition Classes
    BaseField
  48. def is: Option[MyType]

    Get the value.

    Get the value. Use get.

    @deprecated

    Definition Classes
    OptionalTypedFieldValueHolder
  49. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  50. def label: NodeSeq

    Definition Classes
    BaseField
  51. 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
  52. def maxLen: Int

    Definition Classes
    StringTypedFieldStringValidators
  53. def name: String

    The text name of this field

    The text name of this field

    Definition Classes
    BaseFieldReadableField
  54. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  55. 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
  56. implicit def nodeToFieldError(node: Node): List[FieldError]

    Attributes
    protected
    Definition Classes
    TypedField
  57. def notNull(in: ValueType): ValueType

    Definition Classes
    StringValidators
  58. 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
  59. final def notify(): Unit

    Definition Classes
    AnyRef
  60. final def notifyAll(): Unit

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

    Definition Classes
    TypedField
  62. final def optional_?: Boolean

    Is the value of this field optional (e.

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

    Definition Classes
    OptionalTypedFieldBaseField
  63. def owner: OwnerType

    Return the owner of this field

    Return the owner of this field

    Definition Classes
    OptionalStringFieldOwnedField
  64. 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
  65. def productArity: Int

    Definition Classes
    Product1 → Product
  66. def productElement(n: Int): Any

    Definition Classes
    Product1 → Product
    Annotations
    @throws()
  67. def productIterator: Iterator[Any]

    Definition Classes
    Product
  68. def productPrefix: String

    Definition Classes
    Product
  69. def removeRegExChars(regEx: String)(in: ValueType): ValueType

    Definition Classes
    StringValidators
  70. 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
  71. def resetDirty: Unit

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

    Definition Classes
    TypedField
  73. 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
  74. final 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.)

    Definition Classes
    OwnedFieldBaseField
  75. 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
  76. def setBox(in: Box[MyType]): Box[MyType]

    Definition Classes
    TypedField
  77. 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
  78. 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
  79. def setFromAny(in: Any): Box[String]

    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
    StringTypedFieldTypedField
  80. 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
  81. def setFromJValue(jvalue: JValue): Box[MyType]

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

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

    Attributes
    protected
    Definition Classes
    TypedField
  84. def shouldDisplay_?: Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField
  85. def show_?: Boolean

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

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

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

    Definition Classes
    AnyRef
  87. def tabIndex: Int

    Definition Classes
    BaseField
  88. def toBoxMyType(in: ValueType): Box[String]

    Definition Classes
    OptionalTypedFieldTypedField
  89. def toForm: Box[NodeSeq]

    Generate a form control for the field

    Generate a form control for the field

    Definition Classes
    StringTypedFieldBaseFieldSettableField
  90. def toLower(in: ValueType): ValueType

    Definition Classes
    StringValidators
  91. def toString(): String

    Definition Classes
    OptionalTypedField → AnyRef → Any
  92. def toUpper(in: ValueType): ValueType

    Definition Classes
    StringValidators
  93. def toValueType(in: Box[MyType]): Option[MyType]

    Definition Classes
    OptionalTypedFieldTypedField
  94. def toXHtml: NodeSeq

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    Definition Classes
    BaseField
  95. def trim(in: ValueType): ValueType

    Definition Classes
    StringValidators
  96. def uniqueFieldId: Box[String]

    Definition Classes
    BaseFieldFieldIdentifier
  97. 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
  98. def valMaxLen(len: Int, msg: ⇒ String)(value: ValueType): List[FieldError]

    A validation helper.

    A validation helper. Make sure the string is no more than a particular length and generate a validation issue if not.

    Definition Classes
    StringValidators
  99. def valMinLen(len: Int, msg: ⇒ String)(value: ValueType): List[FieldError]

    A validation helper.

    A validation helper. Make sure the string is at least a particular length and generate a validation issue if not.

    Definition Classes
    StringValidators
  100. def valRegex(pat: Pattern, msg: ⇒ String)(value: ValueType): List[FieldError]

    Make sure the field matches a regular expression

    Make sure the field matches a regular expression

    Definition Classes
    StringValidators
  101. 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
  102. def validations: List[(ValueType) ⇒ List[FieldError]]

    Definition Classes
    EmailTypedFieldTypedFieldSettableField
  103. def value: Option[MyType]

    Definition Classes
    OptionalTypedField
  104. def valueBox: Box[MyType]

    Definition Classes
    TypedField
  105. def valueTypeToBoxString(in: ValueType): Box[String]

    Attributes
    protected
    Definition Classes
    OptionalStringFieldStringValidators
  106. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def productElements: Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use productIterator instead

Inherited from EmailTypedField

Inherited from OptionalStringField[OwnerType]

Inherited from StringTypedField

Inherited from StringValidators

Inherited from OptionalTypedField[String]

Inherited from Product1[Box[String]]

Inherited from Product

Inherited from Equals

Inherited from Field[String, OwnerType]

Inherited from TypedField[String]

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