\Hazaar\View\Widgets
ListBox

DropDownList button widget.

Tags

Since

1.1

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

Initialise a DropDownList widget

Parameters

$namestring

The name (ID) of the widget to create.

$params

No description

addItem()
addItem($item) : string

Adds a new item to the jqxDropDownList. 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
allowDrag()
allowDrag($value) : \\Hazaar\\Widgets\\DropDownList

Enables/disables the dragging of ListBox Items.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
allowDrop()
allowDrop($value) : \\Hazaar\\Widgets\\DropDownList

Enables/disables the dropping of ListBox Items.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
autoHeight()
autoHeight($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets whether the listbox’s height is equal to the sum of each item’s height

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
beginUpdate()
beginUpdate($select) : string

Stops the ListBox’s rendering. That method is usually used when multiple items need to be inserted or removed dynamically.

Tags

Since

1.1

Parameters

$selectobject

No description

Returns

string
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\\DropDownList

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\\DropDownList
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
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\\DropDownList

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\\DropDownList
dragEnd()
dragEnd($value) : \\Hazaar\\Widgets\\DropDownList

Callback function which is called when a drag operation ends.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
dragStart()
dragStart($value) : \\Hazaar\\Widgets\\DropDownList

Callback function which is called when a drag operation starts.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
dropAction()
dropAction($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets the drop action when an item is dropped.

Possible Values:

  • ‘default’
  • ‘copy’-adds a clone of the dropped item
  • ‘none’-means that the dropped item will not be added to a new collection and will not be removed from its parent collection

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

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

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

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
enableHover()
enableHover($value) : \\Hazaar\\Widgets\\DropDownList

Enables/disables the hover state.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

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

Enables/disables the selection.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
endUpdate()
endUpdate($select) : string

Starts the ListBox’s rendering and refreshes the ListBox. That method is usually used in combination with the ‘beginUpdate’ method when multiple items need to be inserted or removed dynamically.

Tags

Since

1.1

Parameters

$selectobject

No description

Returns

string
ensureVisible()
ensureVisible($index) : string

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

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
equalItemsWidth()
equalItemsWidth($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets whether the items width should be equal to the listbox’s width.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
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
getSelectedItems()
getSelectedItems() : 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
hasThreeStates()
hasThreeStates($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets whether the checkboxes have three states – checked, unchecked and indeterminate.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
incrementalSearch()
incrementalSearch($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets the incrementalSearch property. An incremental search begins searching as soon as you type the first character of the search string. As you type in the search string, jqxDropDownList automatically selects the found item.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
incrementalSearchDelay()
incrementalSearchDelay($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets the incrementalSearchDelay property. The incrementalSearchDelay specifies the time-interval in milliseconds after which the previous search string is deleted. The timer starts when you stop typing.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
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 jqxDropDownList.

Tags

Since

1.1

Parameters

$itemstring

No description

$indexint

No description

Returns

string
invalidate()
invalidate() : string

The invalidate method will repaint the jqxListBox’s items.

Tags

Since

1.1

Returns

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

Sets or gets the height of the jqxDropDownList 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\\DropDownList
multiple()
multiple($value) : \\Hazaar\\Widgets\\DropDownList

Enables/disables the multiple selection. When this property is set to true, the user can select multiple items.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
multipleextended()
multipleextended($value) : \\Hazaar\\Widgets\\DropDownList

Enables/disables the multiple selection using Shift and Ctrl keys. When this property is set to true, the user can select multiple items by clicking on item and holding Shift or Ctrl.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

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

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\\DropDownList
onChange()
onChange($code) : \\Hazaar\\Widgets\\DropDownList

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\\DropDownList
onCheckChange()
onCheckChange($code) : \\Hazaar\\Widgets\\DropDownList

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\\DropDownList
onDragEnd()
onDragEnd($code) : \\Hazaar\\Widgets\\DropDownList

This event is triggered when the user drops an item.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\DropDownList
onDragStart()
onDragStart($code) : \\Hazaar\\Widgets\\DropDownList

This event is triggered when the user starts a drag operation.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

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

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\\DropDownList
onUnselect()
onUnselect($code) : \\Hazaar\\Widgets\\DropDownList

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\\DropDownList
removeAt()
removeAt($index) : string

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

Tags

Since

1.1

Parameters

$indexint

No description

Returns

string
renderer()
renderer($value) : \\Hazaar\\Widgets\\DropDownList

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\\DropDownList
scrollBarSize()
scrollBarSize($value) : \\Hazaar\\Widgets\\DropDownList

Sets or gets the scrollbars size.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

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

Sets or gets the item incremental search mode. When the user types some text in a focused DropDownList, the jqxListBox 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

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
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\\DropDownList

Sets or gets the selected index.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\DropDownList
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
valueMember()
valueMember($value) : \\Hazaar\\Widgets\\DropDownList

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\\DropDownList