net.liftweb.record

Field

trait Field [ThisType, OwnerType <: Record[OwnerType]] extends OwnedField[OwnerType] with TypedField[ThisType]

A simple field that can store and retreive a value of a given type

Linear Supertypes
TypedField[ThisType], OwnedField[OwnerType], BaseField, BaseField, FieldContainer, SettableField, SettableValueHolder, Settable, ReadableField, Bindable, ValueHolder, FieldIdentifier, AnyRef, Any
Known Subclasses
BinaryField, BooleanField, BsonRecordField, BsonRecordListField, CountryField, DBRefField, DateField, DateTimeField, DecimalField, DoubleField, EmailField, EnumField, EnumNameField, IntField, IntRefField, IntRefListField, JObjectField, JSONBasicArrayField, JSONSubRecordArrayField, JSONSubRecordField, JsonObjectField, KeyField, LocaleField, LongField, LongRefField, LongRefListField, MongoCaseClassField, MongoCaseClassListField, MongoDateListField, MongoJsonObjectListField, MongoListField, MongoMapField, MongoPasswordField, MongoRefListField, MyEmail, MyFirstName, MyLastName, MyLocale, MyMappedLongClass, MyPassword, MySuperUser, MyTimeZone, MyUniqueId, MyValidated, ObjectIdField, ObjectIdRefField, ObjectIdRefListField, OptionalBinaryField, OptionalBooleanField, OptionalCountryField, OptionalDateTimeField, OptionalDecimalField, OptionalDoubleField, OptionalEmailField, OptionalEnumField, OptionalEnumNameField, OptionalIntField, OptionalLocaleField, OptionalLongField, OptionalPasswordField, OptionalPostalCodeField, OptionalStringField, OptionalTextareaField, OptionalTimeZoneField, PasswordField, PatternField, PostalCodeField, StringField, StringRefField, StringRefListField, TextareaField, TimeZoneField, UUIDField, UUIDRefField, UUIDRefListField, UniqueIdField, _id, id, id, id, id, id, id, rev
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Field
  2. TypedField
  3. OwnedField
  4. BaseField
  5. BaseField
  6. FieldContainer
  7. SettableField
  8. SettableValueHolder
  9. Settable
  10. ReadableField
  11. Bindable
  12. ValueHolder
  13. FieldIdentifier
  14. AnyRef
  15. Any
Visibility
  1. Public
  2. All

Type Members

  1. type MyType = ThisType

    Definition Classes
    TypedField

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

    Definition Classes
    TypedField

  3. type ValueType

    Attributes
    abstract
    Definition Classes
    ValueHolder

Abstract Value Members

  1. def asJValue : JValue

    Encode the field value into a JValue

    Encode the field value into a JValue

    Attributes
    abstract
    Definition Classes
    BaseField

  2. def asJs : JsExp

    Returns the field's value as a valid JavaScript expression

    Returns the field's value as a valid JavaScript expression

    Attributes
    abstract
    Definition Classes
    BaseField

  3. 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

    Attributes
    abstract
    Definition Classes
    TypedField

  4. def get : ValueType

    get the value

    get the value

    Attributes
    abstract
    Definition Classes
    ValueHolder

  5. 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 abstract
    Definition Classes
    TypedField

  6. def owner : OwnerType

    Return the owner of this field

    Return the owner of this field

    Attributes
    abstract
    Definition Classes
    OwnedField

  7. def set (in: ValueType): ValueType

    Attributes
    abstract
    Definition Classes
    Settable

  8. def setFromAny (in: Any): Box[MyType]

    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.

    Attributes
    abstract
    Definition Classes
    TypedField

  9. 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

    Attributes
    abstract
    Definition Classes
    TypedField

  10. def setFromString (s: String): Box[MyType]

    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

    Attributes
    abstract
    Definition Classes
    TypedField

  11. def toBoxMyType (in: ValueType): Box[MyType]

    Attributes
    protected abstract
    Definition Classes
    TypedField

  12. def toForm : Box[NodeSeq]

    Generate a form control for the field

    Generate a form control for the field

    Attributes
    abstract
    Definition Classes
    BaseField → SettableField

  13. def toValueType (in: Box[MyType]): ValueType

    Attributes
    protected abstract
    Definition Classes
    TypedField

  14. def is : ValueType

    Get the value.

    Get the value. Use get.

    @deprecated

    Attributes
    abstract
    Definition Classes
    ValueHolder
    Annotations
    @deprecated
    Deprecated

    Use get

Concrete Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def allFields : Seq[BaseField]

    Definition Classes
    BaseField → FieldContainer

  7. def apply (in: Box[MyType]): OwnerType

  8. def apply (in: MyType): OwnerType

  9. def asHtml : NodeSeq

    Default read-only rendering of field

    Default read-only rendering of field

    Definition Classes
    ReadableField → Bindable

  10. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  11. 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

  12. def asString : String

    Convert the field to a String.

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

    Definition Classes
    TypedField → BaseField

  13. 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

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

    Attributes
    protected implicit
    Definition Classes
    TypedField

  15. implicit def boxNodeToFieldError (in: Box[Node]): List[FieldError]

    Attributes
    protected implicit
    Definition Classes
    TypedField

  16. 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

  17. def canWrite_? : Boolean

    Can the value of this field be written?

    Can the value of this field be written?

    Definition Classes
    BaseField

  18. 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

  19. 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

  20. def clear : Unit

    Clear the value of this field

    Clear the value of this field

    Definition Classes
    TypedField

  21. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  22. def dirty_? : Boolean

    Definition Classes
    BaseField

  23. def dirty_? (b: Boolean): Unit

    Attributes
    protected
    Definition Classes
    BaseField

  24. def displayHtml : NodeSeq

    Definition Classes
    ReadableField

  25. def displayName : String

    The display name of this field (e.

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

    Definition Classes
    ReadableField

  26. def displayNameHtml : Box[NodeSeq]

    Definition Classes
    ReadableField

  27. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  28. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  29. 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

  30. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  31. 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

  32. 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

  33. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  34. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  35. def helpAsHtml : Box[NodeSeq]

    Definition Classes
    SettableField

  36. def ignoreField_? : Boolean

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    Definition Classes
    BaseField

  37. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  38. def label : NodeSeq

    Definition Classes
    BaseField

  39. def name : String

    The text name of this field

    The text name of this field

    Definition Classes
    BaseField → ReadableField

  40. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  41. 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

  42. implicit def nodeToFieldError (node: Node): List[FieldError]

    Attributes
    protected implicit
    Definition Classes
    TypedField

  43. 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

  44. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  45. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  46. def obscure (in: MyType): Box[MyType]

    Definition Classes
    TypedField

  47. def optional_? : Boolean

    Is the value of this field optional (e.

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

    Definition Classes
    BaseField

  48. 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

  49. 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

  50. def resetDirty : Unit

    Definition Classes
    BaseField

  51. def runFilters (in: Box[MyType], filter: List[(Box[MyType]) ⇒ Box[MyType]]): Box[MyType]

    Definition Classes
    TypedField

  52. 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

  53. 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
    OwnedField → BaseField

  54. def setBox (in: Box[MyType]): Box[MyType]

    Definition Classes
    TypedField

  55. 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
    TypedField → SettableField

  56. 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

  57. 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

  58. def set_! (in: Box[MyType]): Box[MyType]

    Attributes
    protected
    Definition Classes
    TypedField

  59. def shouldDisplay_? : Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField

  60. 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

  61. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  62. def tabIndex : Int

    Definition Classes
    BaseField

  63. def toString (): String

    Definition Classes
    AnyRef → Any

  64. def toXHtml : NodeSeq

    Convert the field value to an XHTML representation

    Convert the field value to an XHTML representation

    Definition Classes
    BaseField

  65. def uniqueFieldId : Box[String]

    Definition Classes
    BaseField → FieldIdentifier

  66. 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

  67. def validate : List[FieldError]

    Validate this field's setting, returning any errors found

    Validate this field's setting, returning any errors found

    Definition Classes
    TypedField → SettableField

  68. def validations : List[ValidationFunction]

    Definition Classes
    TypedField → SettableField

  69. def valueBox : Box[MyType]

    Definition Classes
    TypedField

  70. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  71. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  72. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from TypedField[ThisType]

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