net.liftweb.mapper

MappedEnum

abstract class MappedEnum[T <: Mapper[T], ENUM <: Enumeration] extends MappedField[mapper.MappedEnum.ENUM.Value, T]

Warning: Do not use unnamed Enumerations with 2.8.1 as this will cause too many items to be displayed in the dropdown.

See https://issues.scala-lang.org/browse/SI-3687 for details

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MappedEnum
  2. MappedField
  3. Equals
  4. PSettableValueHolder
  5. PValueHolder
  6. BaseOwnedMappedField
  7. BaseMappedField
  8. Serializable
  9. Serializable
  10. MixableMappedField
  11. BaseField
  12. FieldContainer
  13. SettableField
  14. SettableValueHolder
  15. Settable
  16. ReadableField
  17. ValueHolder
  18. FieldIdentifier
  19. Bindable
  20. SelectableField
  21. TypedField
  22. AnyRef
  23. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MappedEnum(fieldOwner: T, enum: ENUM)

Type Members

  1. type TheOwnerType = T

    Will be set to the type of the owner of the field

    Will be set to the type of the owner of the field

    Definition Classes
    MappedFieldMixableMappedField
  2. type ValueType = ENUM.Value

    Will be set to the type of the field

    Will be set to the type of the field

    Definition Classes
    MappedFieldPValueHolderValueHolder

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. def :=(v: ENUM.Value): ENUM.Value

    Definition Classes
    MappedField
  5. def :=[Q](v: Q)(implicit arg0: (Q) ⇒ ENUM.Value): ENUM.Value

    Definition Classes
    MappedField
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def _dbColumnNameLC: String

    The forced lower case column names

    The forced lower case column names

    Definition Classes
    BaseMappedField
  9. def _toForm: Box[NodeSeq]

    Create an input field for the item

    Create an input field for the item

    Definition Classes
    MappedEnumMappedFieldBaseMappedField
  10. def actualField(actual: T): MappedField[ENUM.Value, T]

    Get the field that this prototypical field represents

    Get the field that this prototypical field represents

    actual

    the object to find the field on

    Definition Classes
    MappedField
  11. def allFields: Seq[BaseField]

    Definition Classes
    BaseFieldFieldContainer
  12. def appendFieldId(in: Elem): Elem

    If the field has a defined fieldId, append it

    If the field has a defined fieldId, append it

    Attributes
    protected
    Definition Classes
    MappedField
  13. def apply(v: ENUM.Value): T

    Definition Classes
    MappedField
  14. def apply[Q](v: Q)(implicit arg0: (Q) ⇒ ENUM.Value): T

    Definition Classes
    MappedField
  15. def asHtml: Node

    Default read-only rendering of field

    Default read-only rendering of field

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedFieldReadableFieldBindable
  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. def asJs: List[(String, JsExp)]

    Definition Classes
    BaseMappedField
  18. def asJsExp: JsExp

    Definition Classes
    MappedEnumBaseMappedField
  19. def asJsonField: Box[JField]

    Definition Classes
    BaseMappedField
  20. def asJsonValue: Box[JValue]

    Definition Classes
    MappedEnumBaseMappedField
  21. def asString: String

    Return the field name and field value, delimited by an '='

    Return the field name and field value, delimited by an '='

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  22. 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
  23. def buildDisplayList: List[(Int, String)]

    Build a list for the select.

    Build a list for the select. Return a tuple of (String, String) where the first string is the id.string of the Value and the second string is the Text name of the Value.

  24. def buildSetActualValue(accessor: Method, data: AnyRef, columnName: String): (T, AnyRef) ⇒ Unit

    Definition Classes
    MappedEnumMappedField
  25. def buildSetBooleanValue(accessor: Method, columnName: String): (T, Boolean, Boolean) ⇒ Unit

    Definition Classes
    MappedEnumMappedField
  26. def buildSetDateValue(accessor: Method, columnName: String): (T, Date) ⇒ Unit

    Definition Classes
    MappedEnumMappedField
  27. def buildSetLongValue(accessor: Method, columnName: String): (T, Long, Boolean) ⇒ Unit

    Definition Classes
    MappedEnumMappedField
  28. def buildSetStringValue(accessor: Method, columnName: String): (T, String) ⇒ Unit

    Definition Classes
    MappedEnumMappedField
  29. def calcFieldName: String

    Definition Classes
    MappedField
  30. def canEqual(that: Any): Boolean

    Definition Classes
    MappedField → Equals
  31. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def convertToJDBCFriendly(value: ENUM.Value): AnyRef

    Definition Classes
    MappedField
  33. def dbAddedColumn: Box[() ⇒ Unit]

    Called when a column has been added to the database via Schemifier

    Called when a column has been added to the database via Schemifier

    Definition Classes
    MappedFieldBaseMappedField
  34. def dbAddedIndex: Box[() ⇒ Unit]

    Called when a column has indexed via Schemifier

    Called when a column has indexed via Schemifier

    Definition Classes
    MappedFieldBaseMappedField
  35. def dbAutogenerated_?: Boolean

    Is the primary key autogenerated

    Is the primary key autogenerated

    Definition Classes
    BaseMappedField
  36. def dbColumnCount: Int

    The number of database columns that this field represents

    The number of database columns that this field represents

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  37. def dbColumnName: String

    Definition Classes
    MappedFieldBaseMappedField
  38. def dbColumnNames(in: String): List[String]

    Definition Classes
    MappedFieldBaseMappedField
  39. def dbDisplay_?: Boolean

    Definition Classes
    BaseMappedField
  40. def dbFieldClass: Class[ENUM.Value]

    What is the real class that corresponds to FieldType

    What is the real class that corresponds to FieldType

    Definition Classes
    MappedEnumTypedField
  41. def dbForeignKey_?: Boolean

    Is the field a foreign key reference

    Is the field a foreign key reference

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  42. def dbIgnoreSQLType_?: Boolean

    Do we ignore the targetSQLType for setObject

    Do we ignore the targetSQLType for setObject

    Definition Classes
    BaseMappedField
  43. def dbIncludeInForm_?: Boolean

    Definition Classes
    BaseMappedField
  44. def dbIndexFieldIndicatesSaved_?: Boolean

    override this method in indexed fields to indicate that the field has been saved

    override this method in indexed fields to indicate that the field has been saved

    Definition Classes
    MappedField
  45. def dbIndexed_?: Boolean

    Should the field be indexed?

    Should the field be indexed?

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  46. def dbNotNull_?: Boolean

    Set to true if the field should be created as NOT NULL

    Set to true if the field should be created as NOT NULL

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  47. def dbPrimaryKey_?: Boolean

    Is the field the table's primary key

    Is the field the table's primary key

    Definition Classes
    MappedFieldBaseMappedFieldMixableMappedField
  48. def dbSelectString: String

    Definition Classes
    MappedFieldSelectableField
  49. def defaultValue: ENUM.Value

    The default value for the field

    The default value for the field

    Definition Classes
    MappedEnumTypedField
  50. def dirty_?(b: Boolean): Unit

    Make the field dirty

    Make the field dirty

    Attributes
    protected
    Definition Classes
    MappedField
  51. def dirty_?: Boolean

    Is the field dirty (has it been changed since the record was loaded from the database

    Is the field dirty (has it been changed since the record was loaded from the database

    Definition Classes
    MappedField
  52. def displayHtml: NodeSeq

    Definition Classes
    ReadableField
  53. def displayName: String

    The display name of this field (e.

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

    Definition Classes
    MappedFieldReadableField
  54. def displayNameHtml: Box[NodeSeq]

    Definition Classes
    ReadableField
  55. def doField(inst: T, meth: Method, func: PartialFunction[MappedField[ENUM.Value, T], Unit]): Unit

    Attributes
    protected
    Definition Classes
    MappedField
  56. def doneWithSave(): Unit

    Called after the field is saved to the database

    Called after the field is saved to the database

    Attributes
    protected[net.liftweb.mapper]
    Definition Classes
    MappedEnumBaseMappedField
  57. val enum: ENUM

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

    Definition Classes
    AnyRef
  59. def equals(other: Any): Boolean

    Does the "right thing" comparing mapped fields

    Does the "right thing" comparing mapped fields

    Definition Classes
    MappedField → Equals → AnyRef → Any
  60. def fieldCreatorString(dbType: DriverType, colName: String): String

    Given the driver type, return the string required to create the column in the database

    Given the driver type, return the string required to create the column in the database

    Definition Classes
    MappedEnumMappedFieldBaseMappedField
  61. def fieldCreatorString(dbType: DriverType): List[String]

    Given the driver type, return a list of SQL creation strings for the columns represented by this field

    Given the driver type, return a list of SQL creation strings for the columns represented by this field

    Definition Classes
    MappedFieldBaseMappedField
  62. 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
  63. val fieldOwner: T

    Return the owner of this field

    Return the owner of this field

    Definition Classes
    MappedEnumMappedField
  64. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  65. def formElemAttrs: Seq[http.SHtml.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
    BaseMappedField
  66. def formInputType: String

    When building the form field, what's the input element's type attribute.

    When building the form field, what's the input element's type attribute. Defaults to 'text', but change to 'email' or other HTML5 values.

    Attributes
    protected
    Definition Classes
    MappedField
  67. def fromInt(in: Int): ENUM.Value

  68. def get: ENUM.Value

    Convert the field to its "context free" type (e.

    Convert the field to its "context free" type (e.g., String, Int, Long, etc.) If there are no read permissions, the value will be obscured

    Definition Classes
    MappedFieldValueHolder
  69. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  70. def getField(inst: T, meth: Method): MappedField[ENUM.Value, T]

    Attributes
    protected
    Definition Classes
    MappedField
  71. def hashCode(): Int

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

    Definition Classes
    SettableField
  73. def i_is_!: ENUM.Value

    The actual value of the field

    The actual value of the field

    Attributes
    protected
    Definition Classes
    MappedEnumMappedField
  74. def i_obscure_!(in: ENUM.Value): ENUM.Value

    Obscure the incoming value to a "safe" value (e.

    Obscure the incoming value to a "safe" value (e.g., if there are not enough rights to view the entire social security number 123-45-5678, this method might return ***-**-*678

    Attributes
    protected
    Definition Classes
    MappedEnumMappedField
  75. final def i_set_!(value: ENUM.Value): ENUM.Value

    Attributes
    protected
    Definition Classes
    MappedField
  76. def i_was_!: ENUM.Value

    The value of the field when it was pulled from the DB

    The value of the field when it was pulled from the DB

    Attributes
    protected
    Definition Classes
    MappedEnumMappedField
  77. def ignoreField_?: Boolean

    Should the field be ignored by the OR Mapper?

    Should the field be ignored by the OR Mapper?

    Definition Classes
    MappedField
  78. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  79. def jdbcFriendly: Integer

    Get a JDBC friendly object for the part of this field that maps to the first column in the database

    Get a JDBC friendly object for the part of this field that maps to the first column in the database

    Definition Classes
    MappedEnumMappedFieldBaseMappedField
  80. def jdbcFriendly(field: String): Integer

    Get a JDBC friendly representation of the named field (this is used for MappedFields that correspond to more than 1 column in the database.

    Get a JDBC friendly representation of the named field (this is used for MappedFields that correspond to more than 1 column in the database.)

    field

    -- the name of the field being mapped to

    Definition Classes
    MappedEnumMappedFieldBaseMappedField
  81. final def name: String

    The name of this field

    The name of this field

    Definition Classes
    MappedFieldReadableField
  82. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  83. def notNullAppender(): String

    Definition Classes
    MappedField
  84. final def notify(): Unit

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

    Definition Classes
    AnyRef
  86. 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
  87. def readPermission_?: Boolean

    Given the current execution state, can the field be read?

    Given the current execution state, can the field be read?

    Definition Classes
    MappedEnumMappedField
  88. def real_convertToJDBCFriendly(value: ENUM.Value): AnyRef

    Definition Classes
    MappedEnumMappedField
  89. def real_i_set_!(value: ENUM.Value): ENUM.Value

    Must be implemented to store the value of the field

    Must be implemented to store the value of the field

    Attributes
    protected
    Definition Classes
    MappedEnumMappedField
  90. def renderJs_?: Boolean

    Definition Classes
    BaseMappedField
  91. 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
  92. def resetDirty: Unit

    Definition Classes
    MappedField
  93. def runFilters(in: ENUM.Value, filter: List[(ENUM.Value) ⇒ ENUM.Value]): ENUM.Value

    Definition Classes
    MappedField
  94. 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
    MappedField
  95. def set(value: ENUM.Value): ENUM.Value

    Set the field to the value

    Set the field to the value

    Definition Classes
    MappedFieldSettable
  96. def setFilter: List[(ENUM.Value) ⇒ ENUM.Value]

    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
    MappedFieldSettableField
  97. def setFromAny(in: Any): ENUM.Value

    Attempt to figure out what the incoming value is and set the field to that value.

    Attempt to figure out what the incoming value is and set the field to that value. Return true if the value could be assigned

    Definition Classes
    MappedEnumMappedField
  98. def set_?(value: Box[ENUM.Value]): Box[ENUM.Value]

    Set the field to the Box value if the Box is Full

    Set the field to the Box value if the Box is Full

    Definition Classes
    MappedField
  99. def shouldDisplay_?: Boolean

    Given the current context, should this field be displayed

    Given the current context, should this field be displayed

    Definition Classes
    ReadableField
  100. 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
  101. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  102. def targetSQLType: Int

    Get the JDBC SQL Type for this field

    Get the JDBC SQL Type for this field

    Definition Classes
    MappedEnumMappedFieldBaseMappedField
  103. def targetSQLType(field: String): Int

    Get the JDBC SQL Type for this field

    Get the JDBC SQL Type for this field

    Definition Classes
    MappedFieldBaseMappedField
  104. def toForm: Box[NodeSeq]

    Create an input field for the item

    Create an input field for the item

    Definition Classes
    MappedFieldSettableField
  105. def toFormAppendedAttributes: MetaData

    Definition Classes
    MappedField
  106. def toInt: Int

  107. def toString(): String

    Definition Classes
    MappedField → AnyRef → Any
  108. def uniqueFieldId: Box[String]

    The unique field id is the field name and the mapper name

    The unique field id is the field name and the mapper name

    Definition Classes
    MappedFieldFieldIdentifier
  109. def update[Q](v: Q)(implicit arg0: (Q) ⇒ ENUM.Value): Unit

    Assignment from the underlying type.

    Assignment from the underlying type. It's ugly, but:
    field() = new_value
    field set new_value
    field.set(new_value)
    are all the same

    Definition Classes
    MappedField
  110. 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
  111. def validate: List[FieldError]

    Validate this field and return a list of Validation Issues

    Validate this field and return a list of Validation Issues

    Definition Classes
    MappedFieldSettableField
  112. def validations: List[(ENUM.Value) ⇒ List[FieldError]]

    Definition Classes
    MappedFieldSettableField
  113. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  116. def was: ENUM.Value

    What value was the field's value when it was pulled from the DB?

    What value was the field's value when it was pulled from the DB?

    Definition Classes
    MappedField
  117. def writePermission_?: Boolean

    Given the current execution state, can the field be written?

    Given the current execution state, can the field be written?

    Definition Classes
    MappedEnumMappedField

Deprecated Value Members

  1. def is: ENUM.Value

    Get the value.

    Get the value. Use get.

    Definition Classes
    MappedFieldValueHolder
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6) Use get instead

Inherited from MappedField[ENUM.Value, T]

Inherited from Equals

Inherited from PSettableValueHolder[ENUM.Value]

Inherited from PValueHolder[ENUM.Value]

Inherited from BaseOwnedMappedField[T]

Inherited from BaseMappedField

Inherited from Serializable

Inherited from Serializable

Inherited from MixableMappedField

Inherited from BaseField

Inherited from FieldContainer

Inherited from SettableField

Inherited from SettableValueHolder

Inherited from Settable

Inherited from ReadableField

Inherited from ValueHolder

Inherited from FieldIdentifier

Inherited from Bindable

Inherited from SelectableField

Inherited from TypedField[ENUM.Value]

Inherited from AnyRef

Inherited from Any

Ungrouped