Interface: ComboBox

ComboBox

Extends

Methods

addRecord(item)

Adds a record to the list of options
Parameters:
Name Type Description
item Record The record to add.

get(name) → {Object}

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

getDisplayValue() → {String}

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

getId() → {ID}

Returns the ID of the widget.
Inherited From:
Returns:
- The ID of the widget
Type
ID

getSelectedRecord() → {Record}

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

getValue() → {Object}

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

hasRecord() → {Boolean}

Returns true if the widget has a record selected.
Returns:
- True if there is a record selected, false otherwise.
Type
Boolean

hide()

Hides the widget.
Inherited From:

isEnabled() → {Boolean}

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

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.
Inherited From:

setDisplayValue(display)

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

setEnabled(Enabled)

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

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:

setQuery(queryName)

Sets the query used to populate the ComboBox's options
Parameters:
Name Type Description
queryName String The name of the query.

setRecord(record)

Sets the currently selected record.
Parameters:
Name Type Description
record Record The record to select.

setRecords(items)

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.

setStyle(Object)

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

setValue()

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

show()

Shows the widget.
Overrides: