Interface: Select

Select

Extends

Methods

get(name) → {Object}

Gets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
Overrides:
Returns:
- The property's value.
Type
Object

getDisplayValue() → {String}

Returns the currently displayed value.
Returns:
- The currently displayed value.
Type
String

getDisplayValue() → {String}

Returns the currently displayed value.
Returns:
- The currently displayed value.
Type
String

getEnumValue() → {Record}

Returns the integer value of the currently selected enum. Note: Only works when the widget is coupled to an enum attribute.
Returns:
- The currently selected record.
Type
Record

getId() → {ID}

Returns the ID of the widget.
Overrides:
Returns:
- The ID of the widget
Type
ID

getOptions() → {Array}

Returns the currently selectable options
Returns:
- An array of all of the currently selectable options.
Type
Array

getOptions() → {Array}

Returns the currently selectable options
Returns:
- An array of all of the currently selectable options.
Type
Array

getSelectedRecord() → {Record}

Returns the currently selected record.
Returns:
- The currently selected record.
Type
Record

getSelectedRecord() → {Record}

Returns the currently selected record.
Returns:
- The currently selected record.
Type
Record

getValue() → {Object}

Returns the widget's value.
Overrides:
Returns:
- The widget's value.
Type
Object

hide()

Hides the widget.
Overrides:

isEmpty() → {Boolean}

Checks if the select has any selectable options.
Returns:
- True if there are no selectable options.
Type
Boolean

isEnabled() → {Boolean}

Returns true if the widget is enabled.
Overrides:
Returns:
- True if enabled, otherwise false.
Type
Boolean

reload()

Refreshes the widget.

reload()

Refreshes the widget.

set(name, value)

Sets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
value Object The new value.
Overrides:

setDisplayValue(value)

Sets the currently displayed value.
Parameters:
Name Type Description
value String The new value.

setEnabled(Enabled)

Enables/disables the widget.
Parameters:
Name Type Description
Enabled Boolean True to enable the widget, false to disable.
Overrides:

setLabel(Label)

Sets the label on the button.
Parameters:
Name Type Description
Label String Text or HTML to set as the label on this button.
Overrides:

setOptions(options)

Sets widget's selectable options to the options in the provided array.
Parameters:
Name Type Description
options Array An array containing option values.

setOptions(options)

Sets widget's selectable options to the options in the provided array.
Parameters:
Name Type Description
options Object | Array An object or array containing option values.

setStyle(Object)

Set the widget-style
Parameters:
Name Type Description
Object Object with style-properties
Overrides:

setValue()

Sets the widget's value.
Parameters:
Type Description
Object The new value.
Overrides:

setValueAndReload(value)

Sets the value and then refreshes the widget.
Parameters:
Name Type Description
value Object Optional new value to select.

show()

Shows the widget.
Overrides:

Select

Extends

Methods

get(name) → {Object}

Gets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
Overrides:
Returns:
- The property's value.
Type
Object

getDisplayValue() → {String}

Returns the currently displayed value.
Returns:
- The currently displayed value.
Type
String

getDisplayValue() → {String}

Returns the currently displayed value.
Returns:
- The currently displayed value.
Type
String

getEnumValue() → {Record}

Returns the integer value of the currently selected enum. Note: Only works when the widget is coupled to an enum attribute.
Returns:
- The currently selected record.
Type
Record

getId() → {ID}

Returns the ID of the widget.
Overrides:
Returns:
- The ID of the widget
Type
ID

getOptions() → {Array}

Returns the currently selectable options
Returns:
- An array of all of the currently selectable options.
Type
Array

getOptions() → {Array}

Returns the currently selectable options
Returns:
- An array of all of the currently selectable options.
Type
Array

getSelectedRecord() → {Record}

Returns the currently selected record.
Returns:
- The currently selected record.
Type
Record

getSelectedRecord() → {Record}

Returns the currently selected record.
Returns:
- The currently selected record.
Type
Record

getValue() → {Object}

Returns the widget's value.
Overrides:
Returns:
- The widget's value.
Type
Object

hide()

Hides the widget.
Overrides:

isEmpty() → {Boolean}

Checks if the select has any selectable options.
Returns:
- True if there are no selectable options.
Type
Boolean

isEnabled() → {Boolean}

Returns true if the widget is enabled.
Overrides:
Returns:
- True if enabled, otherwise false.
Type
Boolean

reload()

Refreshes the widget.

reload()

Refreshes the widget.

set(name, value)

Sets the value of the specified property.
Parameters:
Name Type Description
name String The name of the property.
value Object The new value.
Overrides:

setDisplayValue(value)

Sets the currently displayed value.
Parameters:
Name Type Description
value String The new value.

setEnabled(Enabled)

Enables/disables the widget.
Parameters:
Name Type Description
Enabled Boolean True to enable the widget, false to disable.
Overrides:

setLabel(Label)

Sets the label on the button.
Parameters:
Name Type Description
Label String Text or HTML to set as the label on this button.
Overrides:

setOptions(options)

Sets widget's selectable options to the options in the provided array.
Parameters:
Name Type Description
options Array An array containing option values.

setOptions(options)

Sets widget's selectable options to the options in the provided array.
Parameters:
Name Type Description
options Object | Array An object or array containing option values.

setStyle(Object)

Set the widget-style
Parameters:
Name Type Description
Object Object with style-properties
Overrides:

setValue()

Sets the widget's value.
Parameters:
Type Description
Object The new value.
Overrides:

setValueAndReload(value)

Sets the value and then refreshes the widget.
Parameters:
Name Type Description
value Object Optional new value to select.

show()

Shows the widget.
Overrides: