The Select widget enables selecting values from a dropdown menu and taking interactive actions on the selected values.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
DisabledThe widget cannot be used.
Empty TextText to display when no value is selected.
FilterAllow the user to filter the select's options.
HiddenHides the widget from the user.
Options FunctionUse a function for generating the Select's options.
PlaceholderValue to display until the user has entered something. This can provide the user with a clue as to what type of information is requested in the field.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.

Style

Name Desciption
Background-colorChange background color of the widget.
Border colorAdd the color for the border.
Border radiusAdd curves to the borders of the widget.
Border styleThe style of the border whether it is solid, dotted or dashed.
Border widthDefine the border width in pixels for the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Dropdown box backgroundThe background color of the box that opens the dropdown.
Dropdown icon colorThe color of the arrow for the dropdown.
Font SizeSet the font size in pixels for text.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Change Event triggered after the element has finished changing.
event ID/value of the currently selected item.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.

Function

_resetOptions ( )

addRecord ( item: Record )

Adds a record to the select.

Parameters
Name Type Description
item Record The record to add.

getDisplayValue ( ) { String }

Returns the currently displayed value.

Returns

The currently displayed value.

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.

getOptions ( ) { Array }

Returns the currently selectable options

Returns

An array of all of the currently selectable options.

getSelectedRecord ( ) { Record }

Returns the currently selected record.

Returns

The currently selected record.

isEmpty ( ) { Boolean }

Checks if the select has any selectable options.

Returns

True if there are no selectable options.

reload ( )

Refreshes the widget.

setDisplayValue ( value: String )

Sets the currently displayed value.

Parameters
Name Type Description
value String The new value.

setOptions ( options: Object )

Sets widget's selectable options to the options in the provided array.

Parameters
Name Type Description
options Object An object or array containing option values.

setValueAndReload ( value: Object )

Sets the value and then refreshes the widget.

Parameters
Name Type Description
value Object Optional new value to select.

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.