Class FormFieldOption

checked : boolean (Read Only)

Identifies if this option is checked.

htmlValue : String (Read Only)

The value for the HTML value attribute of a HTML option element.

label : String

The value for the HTML label attribute of the HTML option element. If not specified in the form option definition the label is identical with the string representation of option value (see getValue()).

object : Object (Read Only)

The object that was bound to this option value.

optionId : String (Read Only)

The ID of the option. This is an internal ID used to uniquely reference this option. If not specified in the form option definition the ID is identical with the string representation of the option value (see getValue()).

parent : FormField (Read Only)

The parent, which is a field element.

selected : boolean (Read Only)

Identifies if this option is selected.

value : Object (Read Only)

The actual value associated with this option. This value is formatted and than returned as HTML value with the method getHtmlValue().

This class does not have a constructor, so you cannot create it directly.

getHtmlValue() : String

Returns the value for the HTML value attribute of a HTML option element.

getLabel() : String

Returns the value for the HTML label attribute of the HTML option element.

getObject() : Object

Returns the object that was bound to this option value.

getOptionId() : String

Returns the ID of the option.

getParent() : FormField

The parent, which is a field element.

getValue() : Object

The actual value associated with this option.

isChecked() : boolean

Identifies if this option is checked.

isSelected() : boolean

Identifies if this option is selected.

setLabel(label : String) : void

Sets the label attribute for this option.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

getHtmlValue

getHtmlValue() : String

Returns the value for the HTML value attribute of a HTML option element.

Returns:

the value for the HTML value attribute of a HTML option element.

getLabel

getLabel() : String

Returns the value for the HTML label attribute of the HTML option element. If not specified in the form option definition the label is identical with the string representation of option value (see getValue()).

Returns:

the value for the HTML label attribute of the HTML option element.

getObject

getObject() : Object

Returns the object that was bound to this option value.

Returns:

the object that was bound to this option value.

getOptionId

getOptionId() : String

Returns the ID of the option. This is an internal ID used to uniquely reference this option. If not specified in the form option definition the ID is identical with the string representation of the option value (see getValue()).

Returns:

the ID of the option.

getParent

getParent() : FormField

The parent, which is a field element.

Returns:

the parent form field.

getValue

getValue() : Object

The actual value associated with this option. This value is formatted and than returned as HTML value with the method getHtmlValue().

Returns:

the value associated with this option

isChecked

isChecked() : boolean

Identifies if this option is checked.

Returns:

true if this option is checked, false otherwise.

isSelected

isSelected() : boolean

Identifies if this option is selected.

Returns:

true if this option is selected, false otherwise.

setLabel

setLabel(label : String) : void

Sets the label attribute for this option.

Parameters:

label - the label value.