\Hazaar\View\Widgets
ComboBox

ComboBox button widget.

Tags

Since

1.1

Summary
Methods Properties Constants
val
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $params = Array ( ) )

Initialise a ComboBox widget

Parameters

$namestring

The name (ID) of the widget to create.

$params

No description

addItem()
addItem($item) : string

Adds a new item to the jqxComboBox. Returns ‘true’, if the new item is added or false if the item is not added.

Tags

Since

1.1

Parameters

$itemstring

No description

Returns

string
animationType()
animationType($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the type of the animation.

Possible Values:

  • ‘fade’
  • ‘slide’
  • ‘none’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
autoComplete()
autoComplete($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the whether the ‘autoComplete’ feature is enabled or disabled. When this feature is enabled, the jqxComboBox displays in the popup listbox, only the items that match the searched text.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
autoDropDownHeight()
autoDropDownHeight($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets whether the height of the jqxComboBox’s ListBox displayed in the widget’s DropDown is calculated as a sum of the items heights.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
autoOpen()
autoOpen($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets whether the DropDown is automatically opened when the mouse cursor is moved over the widget.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
checkAll()
checkAll($item) : string

Checks all list items when the ‘checkboxes’ property value is true.

Tags

Since

1.1

Parameters

$itemobject

No description

Returns

string
checkIndex()
checkIndex($index) : string

Checks a list item when the ‘checkboxes’ property value is true. The index is zero-based, i.e to check the first item, the ‘checkIndex’ method should be called with parameter 0.

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
checkItem()
checkItem($item) : string

Checks an item.

Tags

Since

1.1

Parameters

$itemobject

No description

Returns

string
checkboxes()
checkboxes($value) : \\Hazaar\\Widgets\\ComboBox

Determines whether checkboxes will be displayed next to the list items. (The feature requires jqxcheckbox.js)

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
clear()
clear() : string

Clears all items.

Tags

Since

1.1

Returns

string
clearSelection()
clearSelection() : string

Clears all selected items.

Tags

Since

1.1

Returns

string
close()
close() : string

Hides the popup listbox.

Tags

Since

1.1

Returns

string
closeDelay()
closeDelay($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the delay of the ‘close’ animation.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
disableAt()
disableAt($index) : string

Disables an item by index. Index is a number.

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
displayMember()
displayMember($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the displayMember of the Items. The displayMember specifies the name of an object property to display. The name is contained in the collection specified by the ‘source’ property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
dropDownHeight()
dropDownHeight($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the height of the jqxComboBox’s ListBox displayed in the widget’s DropDown.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
dropDownHorizontalAlignment()
dropDownHorizontalAlignment($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the DropDown’s alignment.

Possible Values:

  • ‘left’
  • ‘right’

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
dropDownWidth()
dropDownWidth($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the width of the jqxComboBox’s ListBox displayed in the widget’s DropDown.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
enableAt()
enableAt($index) : string

Enables a disabled item by index. Index is a number.

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
enableBrowserBoundsDetection()
enableBrowserBoundsDetection($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets whether the dropdown detects the browser window’s bounds and automatically adjusts the dropdown’s position.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
enableHover()
enableHover($value) : \\Hazaar\\Widgets\\ComboBox

Enables/disables the hover state.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
enableSelection()
enableSelection($value) : \\Hazaar\\Widgets\\ComboBox

Enables/disables the selection.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
ensureVisible()
ensureVisible($index) : string

Ensures that an item is visible. index is number. When necessary, the jqxComboBox scrolls to the item to make it visible.

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
getCheckedItems()
getCheckedItems() : string

Gets the checked items. The returned value is an array of Items.

Each item represents an Object with the following fields:

  • label – gets item’s label.
  • value – gets the item’s value.
  • disabled – gets whether the item is enabled/disabled.
  • checked – gets whether the item is checked/unchecked.
  • hasThreeStates – determines whether the item’s checkbox supports three states.
  • html – gets the item’s display html. This can be used instead of label.
  • index – gets the item’s index.
  • group – gets the item’s group.

Tags

Since

1.1

Returns

string
getItem()
getItem($index) : string

Gets item by index.

The returned value is an Object with the following fields:

  • label – gets item’s label.
  • value – gets the item’s value.
  • disabled – gets whether the item is enabled/disabled.
  • checked – gets whether the item is checked/unchecked.
  • hasThreeStates – determines whether the item’s checkbox supports three states.
  • html – gets the item’s display html. This can be used instead of label.
  • index – gets the item’s index.
  • group – gets the item’s group.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
getItemByValue()
getItemByValue($value) : string

Gets an item by its value.

The returned value is an Object with the following fields:

  • label – gets item’s label.
  • value – gets the item’s value.
  • disabled – gets whether the item is enabled/disabled.
  • checked – gets whether the item is checked/unchecked.
  • hasThreeStates – determines whether the item’s checkbox supports three states.
  • html – gets the item’s display html. This can be used instead of label.
  • index – gets the item’s index.
  • group – gets the item’s group.

Tags

Since

1.1

Parameters

$value

No description

Returns

string
getItems()
getItems() : string

Gets all items. The returned value is an array of Items.

Each item represents an Object with the following fields:

  • label – gets item’s label.
  • value – gets the item’s value.
  • disabled – gets whether the item is enabled/disabled.
  • checked – gets whether the item is checked/unchecked.
  • hasThreeStates – determines whether the item’s checkbox supports three states.
  • html – gets the item’s display html. This can be used instead of label.
  • index – gets the item’s index.
  • group – gets the item’s group.

Tags

Since

1.1

Returns

string
getSelectedIndex()
getSelectedIndex() : string

Gets the index of the selected item. The returned value is the index of the selected item. If there’s no selected item, -1 is returned.

Tags

Since

1.1

Returns

string
getSelectedItem()
getSelectedItem() : string

Gets the selected item. The returned value is an Object or null(if there is no selected item).

Item Fields:

  • label – gets item’s label.
  • value – gets the item’s value.
  • disabled – gets whether the item is enabled/disabled.
  • checked – gets whether the item is checked/unchecked.
  • hasThreeStates – determines whether the item’s checkbox supports three states.
  • html – gets the item’s display html. This can be used instead of label.
  • index – gets the item’s index.
  • group – gets the item’s group.

Tags

Since

1.1

Returns

string
indeterminateIndex()
indeterminateIndex($index) : string

indeterminates a list item when the ‘checkboxes’ property value is true. The index is zero-based, i.e to indeterminate the first item, the ‘indeterminateIndex’ method should be called with parameter 0.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
indeterminateItem()
indeterminateItem($item) : string

Indeterminates an item.

Tags

Since

1.1

Parameters

$itemobject

No description

Returns

string
insertAt()
insertAt($item, $index) : string

Inserts a new item to the jqxComboBox.

Tags

Since

1.1

Parameters

$itemstring

No description

$indexint

No description

Returns

string
isOpened()
isOpened() : string

Returns true, if the popup is opened. Otherwise returns false.

Tags

Since

1.1

Returns

string
itemHeight()
itemHeight($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the height of the jqxComboBox Items. When the itemHeight == – 1, each item’s height is equal to its desired height.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
loadFromSelect()
loadFromSelect($select) : string

Loads list items from a ‘select’ tag.

Tags

Since

1.1

Parameters

$selectobject

No description

Returns

string
minLength()
minLength($value) : \\Hazaar\\Widgets\\ComboBox

Determines the minimum number of characters that need to be entered by the user for search in remote data source when remoteAutoComplete property is set to true.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
onBindingComplete()
onBindingComplete($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when the data binding operation is completed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
onChange()
onChange($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when the user selects an item.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
onCheckChange()
onCheckChange($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when an item is checked/unchecked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
onClose()
onClose($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when the popup ListBox is closed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
onOpen()
onOpen($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when the popup ListBox is opened.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
onSelect()
onSelect($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when the user selects an item.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
onUnselect()
onUnselect($code) : \\Hazaar\\Widgets\\ComboBox

This event is triggered when the user unselects an item.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\ComboBox
open()
open() : string

Shows the popup listbox.

Tags

Since

1.1

Returns

string
openDelay()
openDelay($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the delay of the ‘open’ animation.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
placeHolder()
placeHolder($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the input field’s place holder.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
popupZIndex()
popupZIndex($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the popup’s z-index.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
remoteAutoComplete()
remoteAutoComplete($value) : \\Hazaar\\Widgets\\ComboBox

Determines whether the items displayed in the popup come from a remote data source. When this property is set to true, the jqxComboBox calls the ‘search’ callback function when the user types into the input field.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
remoteAutoCompleteDelay()
remoteAutoCompleteDelay($value) : \\Hazaar\\Widgets\\ComboBox

Determines the delay between two keystrokes. The search callback function is called on timeout. The value is specified in milliseconds.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
removeAt()
removeAt($index) : string

Removes an item from the jqxComboBox. Index is a number of the item to remove

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
renderSelectedItem()
renderSelectedItem($value) : \\Hazaar\\Widgets\\ComboBox

Callback function which is called when the selected item is rendered. By using the renderSelectedItem function, you can customize the displayed text in the ComboBox’s input field.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
renderer()
renderer($value) : \\Hazaar\\Widgets\\ComboBox

Callback function which is called when an item is rendered. By using the renderer function, you can customize the look of the list items.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
scrollBarSize()
scrollBarSize($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the scrollbars size.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
search()
search($value) : \\Hazaar\\Widgets\\ComboBox

Callback function which is called when the ‘remoteAutoComplate’ property is set to true and the user types into the ComboBox’s input field.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
searchMode()
searchMode($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the item search mode. When the user types into the edit field, the jqxComboBox widget tries to find the searched item using the entered text and the selected search mode.

Possible Values:

  • ‘none’
  • ‘contains’
  • ‘containsignorecase’
  • ‘equals’
  • ‘equalsignorecase’
  • ‘startswithignorecase’
  • ‘startswith’
  • ‘endswithignorecase’
  • ‘endswith’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
selectIndex()
selectIndex($index) : string

Selects an item by index. The index is zero-based, i.e to select the first item, the ‘selectIndex’ method should be called with parameter 0.

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
selectItem()
selectItem($item) : string

Selects an item.

Tags

Since

1.1

Parameters

$itemobject

No description

Returns

string
selectedIndex()
selectedIndex($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the selected index.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox
setContent()
setContent($content) : string

Sets the content of the ComboBox.

Tags

Since

1.1

Parameters

$contentstring

No description

Returns

string
source()
source($source, $root = null, $map = null, $formatData = null) : Hazaar\\jqWidgets\\Input

Sets or gets the items source. The source can be either a DataAdapter object or an array of data values.

Tags

Since

1.1

Parameters

$sourcemixed

The DataSource object that defines where data is coming from.

$root

No description

$map\Hazaar\View\Widgets\JavaScript

No description

$formatData\Hazaar\View\Widgets\JavaScript

No description

Returns

\Hazaar\View\Widgets\Hazaar\\jqWidgets\\Input
uncheckAll()
uncheckAll() : string

Unchecks all list items when the ‘checkboxes’ property value is true.

Tags

Since

1.1

Returns

string
uncheckIndex()
uncheckIndex($index) : string

Unchecks a list item when the ‘checkboxes’ property value is true. The index is zero-based, i.e to uncheck the first item, the ‘uncheckIndex’ method should be called with parameter 0.

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
uncheckItem()
uncheckItem($item) : string

Unchecks an item.

Tags

Since

1.1

Parameters

$itemobject

No description

Returns

string
unselectIndex()
unselectIndex($index) : string

Unselects item by index. The index is zero-based, i.e to unselect the first item, the ‘unselectIndex’ method should be called with parameter 0.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
unselectItem()
unselectItem($item) : string

Unselects an item.

Tags

Since

1.1

Parameters

$itemobject

No description

Returns

string
val()
val($value = null) : string

Sets or gets the selected value.

Tags

Since

1.1

Parameters

$valuestring

No description

Returns

string
valueMember()
valueMember($value) : \\Hazaar\\Widgets\\ComboBox

Sets or gets the valueMember of the Items. The valueMember specifies the name of an object property to set as a ‘value’ of the list items. The name is contained in the collection specified by the ‘source’ property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\ComboBox