| OVERVIEW | PACKAGE | CONSTR | FIELDS | METHODS | FRAMES NO FRAMES | INHERITED |
class StringField[OwnerType <: Record[OwnerType]](rec : OwnerType, maxLength : Int)
extends
Field[String, OwnerType] with StringValidators
def this(rec : OwnerType, value : String)
|
def this(rec : OwnerType, maxLength : Int, value : String)
|
def this(rec : OwnerType, maxLength : Int, value : Box[String])
|
def this(rec : OwnerType, value : Box[String])
|
def this(rec : OwnerType, maxLength : Int)
|
| asJValue.. |
def asJValue
Encode the field value into a JValue
|
JValue | |
| asJs.. |
def asJs
Returns the field's value as a valid JavaScript expression
|
JsExp with Product |
|
| asString.. |
def asString
Convert the field to a String
[details]
.. usually of the form "displayName=value"
|
String | OwnedField |
| asXHtml.. |
def asXHtml
|
NodeSeq | |
| canRead_?.. |
def canRead_?
Can the value of this field be read without obscuring the result?
|
Boolean | OwnedField |
| canWrite_?.. |
def canWrite_?
|
Boolean | OwnedField |
| checkCanRead_?.. |
def checkCanRead_?
If the owner is not in "safe" mode, check the current environment to see if
the field can be read
|
Boolean | OwnedField |
| checkCanWrite_?.. |
def checkCanWrite_?
|
Boolean | OwnedField |
| defaultValue.. |
def defaultValue
The default value of the field when a field has no value set and is optional, or a method that must return a value (e
[details]
g. value) is used
|
String | |
| defaultValueBox.. |
def defaultValueBox
The default value of the field when no value is set
[details]
Must return a Full Box unless optional_? is true
|
Box[MyType] | OwnedField |
| dirty_?.. |
def dirty_?
|
Boolean | OwnedField |
| displayName.. |
def displayName
The display name of the field (by default, the 'internal' name of the field)
|
String | OwnedField |
| ignoreField_?.. |
def ignoreField_?
Should the field be ignored by the OR Mapper?
|
Boolean | OwnedField |
| label.. |
def label
|
NodeSeq | OwnedField |
| maxLen.. |
def maxLen
|
Int | |
| name.. |
def name
The text name of this field
|
String | OwnedField |
| noValueErrorMessage.. |
def noValueErrorMessage
The error message used when the field value could not be set
|
String | OwnedField |
| notOptionalErrorMessage.. |
def notOptionalErrorMessage
The error message used when the field value must be set
|
String | OwnedField |
| optional_?.. |
def optional_?
Is the value of this field optional (e
[details]
g. NULLable)?
|
Boolean | OwnedField |
| owner.. |
def owner
Return the owner of this field
|
OwnerType | |
| safe_?.. |
final def safe_?
Are we in "safe" mode (i
[details]
e., the value of the field can be read or written without any security checks.)
|
Boolean | OwnedField |
| tabIndex.. |
def tabIndex
|
Int | OwnedField |
| toForm.. |
def toForm
|
NodeSeq | |
| toXHtml.. |
def toXHtml
Convert the field value to an XHTML representation
|
NodeSeq | OwnedField |
| uniqueFieldId.. |
override def uniqueFieldId
|
Box[String] | OwnedField |
| validateField.. |
def validateField
Validate this field's setting, returning any errors found
|
List[FieldError] | OwnedField |
| value.. |
def value
|
MyType | OwnedField |
| valueBox.. |
def valueBox
|
Box[MyType] | OwnedField |
| !=.. |
final def !=(arg0 : Object)
|
Boolean | AnyRef |
| !=.. |
final def !=(arg0 : Any)
|
Boolean | Any |
| ==.. |
final def ==(arg0 : Any)
|
Boolean | Any |
| ==.. |
final def ==(arg0 : Object)
|
Boolean | AnyRef |
| apply.. |
def apply(in : Box[ThisType])
|
OwnerType | Field |
| apply.. |
def apply(in : ThisType)
|
OwnerType | Field |
| asInstanceOf.. |
final def asInstanceOf[T0]
|
T0 | Any |
| asJString.. |
protected def asJString(encode : (MyType) => String)
Helper for implementing asJValue for a conversion to an encoded JString
[details]
|
JValue | OwnedField |
| boxNodeFuncToFieldError.. |
protected implicit def boxNodeFuncToFieldError(in : (Box[MyType]) => Box[Node])
|
(Box[MyType]) => List[FieldError] | OwnedField |
| boxNodeToFieldError.. |
protected implicit def boxNodeToFieldError(in : Box[Node])
|
List[FieldError] | OwnedField |
| boxStrToValType.. |
protected def boxStrToValType(in : Box[String])
|
Box | |
| clear.. |
def clear
Clear the value of this field
|
Unit | OwnedField |
| clone.. |
protected def clone
|
Object | AnyRef |
| crop.. |
def crop(arg0 : ValueType)
|
ValueType | StringValidators |
| dirty_?.. |
protected def dirty_?(b : Boolean)
|
Unit | OwnedField |
| eq.. |
final def eq(arg0 : Object)
|
Boolean | AnyRef |
| equals.. |
def equals(arg0 : Any)
|
Boolean | AnyRef |
| finalize.. |
protected def finalize
|
Unit | AnyRef |
| genericSetFromAny.. |
protected final def genericSetFromAny(in : Any)(implicit m : Manifest[MyType])
Generic implementation of setFromAny that implements exactly what the doc for setFromAny specifies, using a Manifest to check types
|
Box[MyType] | OwnedField |
| getClass.. |
final def getClass
|
Class[Any] | AnyRef |
| hashCode.. |
def hashCode
|
Int | AnyRef |
| isInstanceOf.. |
final def isInstanceOf[T0]
|
Boolean | Any |
| ne.. |
final def ne(arg0 : Object)
|
Boolean | AnyRef |
| nodeToFieldError.. |
protected implicit def nodeToFieldError(node : Node)
|
List[FieldError] | OwnedField |
| notNull.. |
def notNull(arg0 : ValueType)
|
ValueType | StringValidators |
| notify.. |
final def notify
|
Unit | AnyRef |
| notifyAll.. |
final def notifyAll
|
Unit | AnyRef |
| obscure.. |
def obscure(in : MyType)
|
Box[MyType] | OwnedField |
| removeRegExChars.. |
def removeRegExChars(arg0 : String)
|
ValueType | StringValidators |
| resetDirty.. |
def resetDirty
|
Unit | OwnedField |
| runFilters.. |
def runFilters(in : Box[MyType], filter : List[(Box[MyType]) => Box[MyType]])
|
Box[MyType] | OwnedField |
| runValidation.. |
protected def runValidation(in : Box[MyType])
Helper function that does validation of a value by using the validators specified for the field
|
List[FieldError] | OwnedField |
| set.. |
def set(in : MyType)
Set the value of the field to the given value
[details]
Note: Because setting a field can fail (return non-Full), this method will
return defaultValue if the field could not be set.
|
MyType | OwnedField |
| setBox.. |
def setBox(in : Box[MyType])
|
Box[MyType] | OwnedField |
| setFilter.. |
protected def setFilter
A list of functions that transform the value before it is set
[details]
The transformations
are also applied before the value is used in a query. Typical applications
of this are trimming and/or toLowerCase-ing strings
|
List[(Box[MyType]) => Box[MyType]] | OwnedField |
| setFromAny.. |
def setFromAny(in : Any)
Set the value of the field from anything
[details]
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.
|
Box[String] | |
| setFromJString.. |
protected def setFromJString(jvalue : JValue)(decode : (String) => Box[MyType])
Helper for implementing setFromJValue for a conversion from an encoded JString
[details]
|
Box[MyType] | OwnedField |
| setFromJValue.. |
def setFromJValue(jvalue : JValue)
Decode the JValue and set the field to the decoded value
[details]
Returns Empty or Failure if the value could not be set
|
Box[String] | |
| setFromString.. |
def setFromString(s : String)
Set the value of the field using some kind of type-specific conversion from a String
[details]
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.
|
Box[String] | |
| set_!.. |
protected def set_!(in : Box[MyType])
|
Box[MyType] | OwnedField |
| synchronized.. |
final def synchronized[T0](arg0 : T0)
|
T0 | AnyRef |
| toLower.. |
def toLower(arg0 : ValueType)
|
ValueType | StringValidators |
| toString.. |
override def toString
|
String | OwnedField |
| toUpper.. |
def toUpper(arg0 : ValueType)
|
ValueType | StringValidators |
| trim.. |
def trim(arg0 : ValueType)
|
ValueType | StringValidators |
| valMaxLen.. |
def valMaxLen(arg0 : Int, arg1 : => String)
|
List[FieldError] | StringValidators |
| valMinLen.. |
def valMinLen(arg0 : Int, arg1 : => String)
|
List[FieldError] | StringValidators |
| valRegex.. |
def valRegex(arg0 : Pattern, arg1 : => String)
|
List[FieldError] | StringValidators |
| validators.. |
def validators
Return a list of functions that will be subsequently called for validating this field
[details]
Each function takes a field-type parameter and returns a Box[Node].
The field values is valid if all validation functions return an Empty Box
|
List[Function1] | OwnedField |
| valueTypeToBoxString.. |
protected def valueTypeToBoxString(in : Box)
|
Box[String] | |
| wait.. |
final def wait(arg0 : Long, arg1 : Int)
|
Unit | AnyRef |
| wait.. |
final def wait
|
Unit | AnyRef |
| wait.. |
final def wait(arg0 : Long)
|
Unit | AnyRef |
| OVERVIEW | PACKAGE | CONSTR | FIELDS | METHODS | FRAMES NO FRAMES | INHERITED |