Class SelectField

Object
   |
   +--Field
         |
         +--SelectField

class SelectField

extends Field

Defined in form.js

Field Detail

multiple

Boolean multiple

Indicates if the field accepts multiple choice

SelectField

SelectField(<Object> fld)

Class used to encapsulate operations over select inputs, accepting single or multiple choice

Parameters:
fld - Field object

addOption

void addOption(<String> value, <String> text, <Number> pos)

Add a new option in the select field

Parameters:
value - Option value
text - Option text
pos - Option position (defaults to last position)

clear

void clear()

Unselect all selected options in the list

clearOptions

void clearOptions()

Remove all options off the select field

getValue

Object getValue()

Gets the current selected option(s). In multiple choice select inputs, this method returns an array of values

importOptions

void importOptions(<String> str, <String> lsep, <String> csep, <Number> pos, <String> val)

Import options to the select field from a string splitted by line and column separators. The default separators are "|" for a line and "~" for value and text. Ex: "1~One|2~Two|3~Three". The index on where the options must be added can be specified on the 4th parameter

Parameters:
str - Options string
lsep - Line separator
csep - Column separator
pos - Insertion position
val - Value to set

removeOption

void removeOption(<Number> idx)

Remove an option from the list

Parameters:
idx - Option index

removeSelectedOptions

void removeSelectedOptions(<Function> func, <Number> idx)

Remove the selected options from the list. This method is used by EditSelection and LookupSelection form components

Parameters:
func - Callback for each removed option
idx - Start index. Defaults to 0

selectByText

void selectByText(<String> text)

Select an option by its text

Parameters:
text - Option text

setFirstOption

void setFirstOption(<String> value, <String> text)

Change the first option of the select field

Parameters:
value - Option value
text - Option text

setValue

void setValue(<Object> val)

Changes the selected option(s) in the field. For multiple choice inputs, expects an array parameter

Parameters:
val - New value