ComboBox

WIP description for ComboBox

addRecord ( item: Record )

Adds a record to the list of options

Parameters
Name Type Description
item Record The record to add.

getDisplayValue ( ) →{ String }

Returns the displayed value.

Returns

The displayed value.

getSelectedRecord ( ) →{ Record }

Returns the currently selected record.

Returns

The currently selected record.

hasRecord ( ) →{ Boolean }

Returns true if the widget has a record selected.

Returns

True if there is a record selected, false otherwise.

setDisplayValue ( display: String )

Sets the displayed value.

Parameters
Name Type Description
display String The new value.

setQuery ( queryName: String )

Sets the query used to populate the ComboBox's options

Parameters
Name Type Description
queryName String The name of the query.

setRecord ( record: Record )

Sets the currently selected record.

Parameters
Name Type Description
record Record The record to select.

setRecords ( items: Array<Record>)

Sets the ComboBox's options to the specified array of records

Parameters
Name Type Description
items Array<Record> Array of records to use as the new options.

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.

Widgets