Methods

This section describes members used to manipulate the widget.

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when changing multiple component settings at once.

clientHeight()

Returns the height of the widget in pixels.

Return Value: Number
The value of the widget height in pixels.

deleteItem(itemElement)

Removes the specified item from the list.

Parameters:
itemElement: DOM Node|Number|Object
The item element node or index number representing the list item to delete. If the list is grouped, pass an object with the required group and item indexes, e.g., { group: 0, item: 0 }.
Return Value: Object
A Promise of the jQuery Deferred object resolved if the item is deleted and rejected if it is not.

This method deletes the specified item if the editEnabled option is set to true.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when changing multiple component setting at once.

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

isItemSelected(itemElement)

Returns a Boolean value that indicates whether or not the specified item is selected.

Parameters:
itemElement: DOM Node
The item element node or index number representing the requested list item. If the list is grouped, pass an object with the required group and item indexes, e.g., { group: 0, item: 0 }.
Return Value: Boolean
A Boolean value specifying whether or not the requested item is selected.

To determine which items are currently selected, use the widget's option method, passing the selectedItems as a parameter.

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

repaint()

Redraws the widget.

After performing some external modifications that lead to a change of the widget container's size or visibility, the widget's state may become invalid. In this instance, use the repaint() method to redraw the widget.

scrollBy(distance)

Scrolls the list content by the specified number of pixels.

Parameters:
distance: Number
A distance to be scrolled in pixels.

scrollHeight()

Returns the height of the list content in pixels.

Return Value: Number
The value of the content height in pixels.

scrollTo(location)

Scrolls list content to the specified position.

Parameters:
location: Number
The position to scroll to (in pixels).

scrollTop()

Returns how far the list content is scrolled from the top.

Return Value: Number
The value of the current scroll position from the top in pixels.

selectItem(itemElement)

Selects the specified item from the list.

Parameters:
itemElement: DOM Node
The item element node or index number representing the list item to select. If the list is grouped, pass an object with the required group and item indexes, e.g. { group: 0, item: 0 }.

This method selects the specified item if the editEnabled option is set to true.

unselectItem(itemElement)

Deselects the specified item from the list.

Parameters:
itemElement: DOM Node
The item element node or index number representing the list item to deselect. If the list is grouped, pass an object with the required group and item indexes, e.g., { group: 0, index: 0 }.

This method deselects the specified item if the editEnabled option is set to true.

update()

Updates the widget scrollbar according to widget content size.

Return Value: Object
A Promise of the jQuery Deferred object resolved when the update process is complete.

Use this option to update the position of list items after the widget element was resized.