LongListBox

Description

The LongListBox component is a grouped list.

Comments

The component is implemented by the LongListBox class.

Example

The component looks as follows:

The example of creating a grouped list is described on the Example of Creating the LongListBox Component page.

Constructor

  Constructor name Brief description
LongListBox The LongListBox constructor creates an instance of the LongListBox component.

Properties

  Property name Brief description
Groups The Groups property contains an array of settings of groups of elements.
GroupsHeight The GroupsHeight property contains title height of list groups.
GroupsTemplate The GroupsTemplate property contains a template for list groups titles.
ItemsHeight The ItemsHeight property contains height of list elements.
ItemsTemplate The ItemsTemplate property contains a template for list elements.

Methods

  Method name Brief description
addGroups The addGroups method adds an array of groups to the current groups.
calcItemsContainerHeight The calcItemsContainerHeight method returns component container height.
beginUpdate The beginUpdate method disables rerendering of the list until the endUpdate method is called.
endUpdate The endUpdate method enables list rerendering and refreshes it.
getItems The getItems method returns loaded elements of the grouped list.
getMultiSelect The getMultiSelect returns whether multiple selection of grouped list elements is available.
getScrollBar The getScrollBar method returns vertical scrollbar of the grouped list.
getVisibleItems The getVisibleItems method returns array of visible elements of grouped list.
isAllLoaded The isAllLoaded method determines whether all list elements are loaded.
setChildProps The setChildProps method determines settings for grouped list elements.

Properties inherited from the class Control

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property determines component animation parameters.
Bottom The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
Content The Content property determines component contents.
ContextMenu The ContextMenu property determines a component's context menu.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether a component can be used.
Height The Height property determines component height.
IsRTL The IsRTL property determines whether component elements are aligned to the right.
IsVisible The IsVisible property determines whether a component is displayed.
Left The Left property determines a left margin if a component is placed inside GridPanel.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property determines a parent DOM node.
ResourceKey The ResourceKey property determines a component resource key.
Right The Right property determines a right margin if a component is placed inside LayoutPanel.
Rotate The Rotate property determines a component rotation angle.
ShowToolTip The ShowToolTip property determines whether a tooltip of the component can be displayed.
Style The Style property determines a component style.
TabIndex The TabIndex property determines the order of the control element passing inside the container.
Tag The Tag property determines a JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property determines a top margin if a component is placed inside GridPanel.
Value The Value property determines a component value.
Width The Width property determines component width.

Methods inherited from the class Control

  Method name Brief description
addItem The addItem method adds a new element to list.
beginUpdate The beginUpdate method determines whether the list is updated.
clear The clear method removes all elements from the list.
clearSelection The clearSelection method is used to reset selection.
endUpdate The endUpdate method removes whether the list is updated.
filterByText The filterByText method filters list elements by string.
getActiveItem The getActiveItem method returns the selected list element.
getItemByPoint The getItemByPoint method returns list element by the specified coordinates.
getLastItemClick The getLastItemClick method returns the last selected list element.
getLayoutItems The getLayoutItems method returns an array of list elements.
getScrollBox The getScrollBox method returns scrolling region of elements list.
getSelectedItems The getSelectedItems method returns array of selected list elements.
insertItem The insertItem method adds an element to the position of the elements list set by the index parameter.
removeItem The removeItem method removes the element of the list by the specified index.
scrollToItem The scrollToItem method scrolls the list up to the item element.
scrollToSelected The scrollToSelected method scrolls the list up to the selected list element.
selectItemById The selectItemById method selects the element with the specified Id identifier.
setSelectedFocus The setSelectedFocus method sets focus on the element index.

Events inherited from the class Control

  Event name Brief description
Drag The Drag event occurs on clicking and holding the mouse button.
DragEnd The DragEnd event occurs when dragging the component finishes.
DragStart The DragStart event occurs when dragging the component starts.
OnContextMenu The OnContextMenu event occurs on calling context menu of the component.
SizeChanged The SizeChanged event occurs after the component is resized.
SizeChanging The SizeChanging event occurs during component resize.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

DHTML Components