Represents an option for a form field.
Property Summary
Property Description checked : Boolean (read-only)Identifies if this option is checked. htmlValue : String (read-only)Returns the value for the HTML value attribute of a HTML option element. label : String Returns the value for the HTML label attribute of the HTML option element. object : Object (read-only)Returns the object that was bound to this option value. optionId : String (read-only)Returns the ID of the option. 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.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Method Description getHtmlValue ()Returns the value for the HTML value attribute of a HTML option element. getLabel ()Returns the value for the HTML label attribute of the HTML option element. getObject ()Returns the object that was bound to this option value. getOptionId ()Returns the ID of the option. getParent ()The parent, which is a field element. getValue ()The actual value associated with this option. isChecked ()Identifies if this option is checked. isSelected ()Identifies if this option is selected. setLabel (String )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
Property Details
checked
checked: Boolean (read-only)
Identifies if this option is checked.
htmlValue
htmlValue: String (read-only)
Returns the value for the HTML value attribute of a HTML option element.
label
label: 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()).
object
object: Object (read-only)
Returns the object that was bound to this option value.
optionId
optionId: String (read-only)
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()).
parent
parent: FormField (read-only)
The parent, which is a field element.
selected
selected: Boolean (read-only)
Identifies if this option is selected.
value
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().
Method Details
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:
getParent()
getParent(): FormField
The parent, which is a field element.
Returns:
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(String)
setLabel(label: String ): void
Sets the label attribute for this option.
Parameters: