net.liftweb.record.field.OptionalStringField

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

OptionalStringField
StringTypedField
StringValidators
OptionalTypedField
Product1
Product
Equals
Field
TypedField
OwnedField
BaseField
BaseField
FieldContainer
SettableField
SettableValueHolder
Settable
ReadableField
Bindable
ValueHolder
FieldIdentifier
AnyRef
Any

Visibility

Public
All

Instance Constructors

new OptionalStringField (rec: OwnerType, value: Box[String])
new OptionalStringField (rec: OwnerType, maxLength: Int, value: Box[String])
new OptionalStringField (rec: OwnerType, maxLength: Int)

Type Members

type MyType = String

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

Definition Classes
TypedField
type ValueType = Option[String]

Definition Classes
OptionalTypedField → ValueHolder

Value Members

def != (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def ## (): Int

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

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

Attributes
final
Definition Classes
Any
def _1 : Box[MyType]

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

Definition Classes
BaseField → FieldContainer
def apply (in: Box[MyType]): OwnerType

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

Definition Classes
Field
def asHtml : NodeSeq

Default read-only rendering of field
Default read-only rendering of field

Definition Classes
ReadableField → Bindable
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
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
def asJValue : JValue

Encode the field value into a JValue
Encode the field value into a JValue

Definition Classes
StringTypedField → BaseField
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
StringTypedField → BaseField
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
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
implicit def boxNodeFuncToFieldError (in: (Box[MyType]) ⇒ Box[Node]): (Box[MyType]) ⇒ List[FieldError]

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

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

Attributes
protected
Definition Classes
OptionalStringField → StringValidators
def canEqual (a: Any): Boolean

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

Can the value of this field be written?
Can the value of this field be written?

Definition Classes
BaseField
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
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
def clear : Unit

Clear the value of this field
Clear the value of this field

Definition Classes
TypedField
def clone (): AnyRef

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

Definition Classes
StringValidators
def defaultValue : String

Definition Classes
StringTypedField
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
OptionalTypedField → TypedField
def dirty_? : Boolean

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

Attributes
protected
Definition Classes
BaseField
def displayHtml : NodeSeq

Definition Classes
ReadableField
def displayName : String

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

Definition Classes
ReadableField
def displayNameHtml : Box[NodeSeq]

Definition Classes
ReadableField
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

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

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
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
def get : Option[MyType]

get the value
get the value

Definition Classes
OptionalTypedField → ValueHolder
def getClass (): java.lang.Class[_]

Attributes
final
Definition Classes
AnyRef
def hashCode (): Int

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

Definition Classes
SettableField
def ignoreField_? : Boolean

Should the field be ignored by the OR Mapper?
Should the field be ignored by the OR Mapper?

Definition Classes
BaseField
def is : Option[MyType]

Get the value.
Get the value. Use get.
@deprecated

Definition Classes
OptionalTypedField → ValueHolder
def isInstanceOf [T0] : Boolean

Attributes
final
Definition Classes
Any
def label : NodeSeq

Definition Classes
BaseField
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
OptionalTypedField → TypedField
def maxLen : Int

Definition Classes
StringTypedField → StringValidators
val maxLength : Int

Definition Classes
OptionalStringField → StringTypedField
def name : String

The text name of this field
The text name of this field

Definition Classes
BaseField → ReadableField
def ne (arg0: AnyRef): Boolean

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

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

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

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
def obscure (in: MyType): Box[MyType]

Definition Classes
TypedField
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
OptionalTypedField → BaseField
def owner : OwnerType

Return the owner of this field
Return the owner of this field

Definition Classes
OptionalStringField → OwnedField
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
def productArity : Int

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

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

Definition Classes
Product
def productPrefix : String

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

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

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

Definition Classes
TypedField
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
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
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
OptionalTypedField → Settable
def setBox (in: Box[MyType]): Box[MyType]

Definition Classes
TypedField
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
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
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
StringTypedField → TypedField
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
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
StringTypedField → TypedField
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
StringTypedField → TypedField
def set_! (in: Box[MyType]): Box[MyType]

Attributes
protected
Definition Classes
TypedField
def shouldDisplay_? : Boolean

Given the current context, should this field be displayed
Given the current context, should this field be displayed

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

Attributes
final
Definition Classes
AnyRef
def tabIndex : Int

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

Definition Classes
OptionalTypedField → TypedField
def toForm : Box[NodeSeq]

Generate a form control for the field
Generate a form control for the field

Definition Classes
StringTypedField → BaseField → SettableField
def toLower (in: ValueType): ValueType

Definition Classes
StringValidators
def toString (): String

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

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

Definition Classes
OptionalTypedField → TypedField
def toXHtml : NodeSeq

Convert the field value to an XHTML representation
Convert the field value to an XHTML representation

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

Definition Classes
StringValidators
def uniqueFieldId : Box[String]

Definition Classes
BaseField → FieldIdentifier
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
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
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
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
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
def validations : List[ValidationFunction]

Definition Classes
TypedField → SettableField
def value : Option[MyType]

Definition Classes
OptionalTypedField
def valueBox : Box[MyType]

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

Attributes
protected
Definition Classes
OptionalStringField → StringValidators
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def productElements : Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
use productIterator instead

OptionalStringField

class OptionalStringField [OwnerType <: Record[OwnerType]] extends Field[String, OwnerType] with OptionalTypedField[String] with StringTypedField

Instance Constructors

new OptionalStringField (rec: OwnerType, value: Box[String])

new OptionalStringField (rec: OwnerType, maxLength: Int, value: Box[String])

new OptionalStringField (rec: OwnerType, maxLength: Int)

Type Members

type MyType = String

type ValidationFunction = (ValueType) ⇒ List[FieldError]

type ValueType = Option[String]

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def _1 : Box[MyType]

def allFields : Seq[BaseField]

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

def apply (in: MyType): OwnerType

def asHtml : NodeSeq

def asInstanceOf [T0] : T0

def asJString (encode: (MyType) ⇒ String): JValue

def asJValue : JValue

def asJs : JsExp with Product with Serializable

def asString : String

def atomicUpdate (f: (ValueType) ⇒ ValueType): ValueType

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

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

def boxStrToValType (in: Box[String]): ValueType

def canEqual (a: Any): Boolean

def canRead_? : Boolean

def canWrite_? : Boolean

def checkCanRead_? : Boolean

def checkCanWrite_? : Boolean

def clear : Unit

def clone (): AnyRef

def crop (in: ValueType): ValueType

def defaultValue : String

def defaultValueBox : Box[MyType]

def dirty_? : Boolean

def dirty_? (b: Boolean): Unit

def displayHtml : NodeSeq

def displayName : String

def displayNameHtml : Box[NodeSeq]

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def fieldId : Option[NodeSeq]

def finalize (): Unit

def genericSetFromAny (in: Any)(implicit m: Manifest[MyType]): Box[MyType]

def get : Option[MyType]

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

def hashCode (): Int

def helpAsHtml : Box[NodeSeq]

def ignoreField_? : Boolean

def is : Option[MyType]

def isInstanceOf [T0] : Boolean

def label : NodeSeq

def liftSetFilterToBox (in: Box[MyType]): Box[MyType]

def maxLen : Int

val maxLength : Int

def name : String

def ne (arg0: AnyRef): Boolean

def noValueErrorMessage : String

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

def notNull (in: ValueType): ValueType

def notOptionalErrorMessage : String

def notify (): Unit

def notifyAll (): Unit

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

def optional_? : Boolean

def owner : OwnerType

def performAtomicOperation [T] (f: ⇒ T): T

def productArity : Int

def productElement (n: Int): Any

def productIterator : Iterator[Any]

def productPrefix : String

def removeRegExChars (regEx: String)(in: ValueType): ValueType

def required_? : Boolean

def resetDirty : Unit