TreeListBox

The TreeListBox class implements the TreeListBox component used to display a tree of object inheritance with pagewise navigation.

Syntax

PP.initClass(PP.Ui.TreeListBox, [PP.Ui.TreeListView, PP.Ui.TreeDynamicScrollingMixin], "TreeListBox");

Constructor

Properties

Methods

Properties inherited from the TreeListView class

	Property name	Brief description
	AutoScrollDelay	The AutoScrollDelay property determines delay between autoscroll position changes.
	Captions	The Captions property determines tree titles.
	ContentVerticalAlign	The ContentVerticalAlign property determines vertical alignment of titles.
	DblClickExpand	The DblClickExpand property determines mode of node expand/collapse on double-click.
	DragAndDropDelay	The DragAndDropDelay property determines delay before Drag&Drop mode start.
	DragAndDropIndent	The DragAndDropIndent property determines separating line indent on using the Drag&Drop mode.
	DragAndDropMode	The DragAndDropMode property determines Drag&Drop mode.
	EnableAutoColumnSize	The EnableAutoColumnSize property determines column width autofit mode.
	EnableAutoScroll	The EnableAutoScroll property determines autoscroll mode.
	EnableColumnsMenu	The EnableColumnsMenu property determines visibility of column selection menu.
	EnableDragAndDrop	The EnableDragAndDrop property determines whether Drag&Drop mode is enabled.
	EnableDragOutside	The EnableDragOutside property determines whether it is available to drag to other trees.
	EnableDropOutside	The EnableDropOutside property determines whether it is available to drag from other trees.
	EnableEdit	The EnableEdit property determines cell editing mode.
	EnableKeyNavigation	The EnableKeyNavigation property determines whether keyboard can be used for navigation in a tree.
	EnableRangeSelect	The EnableRangeSelect property determines whether nodes can be selected by range.
	EnableResizeColumns	The EnableResizeColumns property determines whether column width can be changed.
	EnableSearch	The EnableSearch property determines whether it is available to search in a tree.
	EnableSort	The EnableSort property determines whether sorting is available.
	IconVerticalAlign	The IconVerticalAlign property determines vertical alignment of icons.
	ImageList	The ImageList property determines an image with icons for nodes.
	NodeDefaultStyle	The NodeDefaultStyle property determines default node style.
	PageStyle	The PageStyle property determines style of container with nodes.
	RightButtonSelect	The RightButtonSelect property determines whether nodes can be selected with the right mouse button.
	RowSelect	The RowSelect property determines whole row selection mode.
	ScrollStep	The ScrollStep property determines scroll step for mouse wheel and autoscroll.
	ShowCaptions	The ShowCaptions property determines whether column headers are displayed.
	ShowCheckBoxes	The ShowCheckBoxes property determines whether checkboxes are displayed.
	ShowGridLines	The ShowGridLines property determines whether gridlines are displayed.
	ShowToolTips	The ShowToolTips property determines whether tooltips are displayed.
	ShowTree	The ShowTree property determines tree structure display mode in the first column.
	ShowTreeLines	The ShowTreeLines property determines displaying of tree structure lines.
	ScrollBarH	The ScrollBarH property determines a horizontal scrollbar.
	ScrollBarV	The ScrollBarV property determines a vertical scrollbar.

Methods inherited from the TreeListView class

	Method name	Brief description
	clearHighlightedText	The clearHighlightedText method clears text highlighting.
	areAllVisibleNodesLoaded	The areAllVisibleNodesLoaded method determines whether all visible nodes are loaded.
	cancelEditing	The cancelEditing method cancels the current editing.
	endDropFromOutside	The endDropFromOutside method initiates an event of moving node from external tree with the specified arguments.
	getVisibleNodes	The getVisibleNodes method returns keys of all visible nodes.
	highlightText	The highlightText method highlights the specified strings in tree elements.
	measureColumnContentWidth	The measureColumnContentWidth method returns column contents.
	moveDrag	The moveDrag method moves the dragged node to the current cursor position.
	removeHover	The removeHover method removes the current mouseover highlighting.
	scrollToNode	The scrollToNode method scrolls tree to the node by key.
	scrollToPosition	The scrollToPosition method scrolls tree to the mode by number.
	setHoveredNode	The setHoveredNode method sets highlighting caused by mouseover on the specified node.
	startEditing	The startEditing method enables node contents edit mode.
	stopEditing	The stopEditing method stops node editing.

Events Inherited from the TreeListView class

	Event name	Brief description
	CheckBoxClick	The CheckBoxClick event occurs before clicking the checkbox.
	NodeCellMouseOut	The NodeCellMouseOut event occurs on moving mouse from node cell.
	NodeCellMouseOver	The NodeCellMouseOver event occurs on pointing a mouse on node cell.
	NodeClick	The NodeClick event occurs on clicking a mouse on node.
	NodeDblClick	The NodeDblClick event occurs on double-clicking a mouse on node.
	NodeDrag	The NodeDrag event occurs on moving the dragged node along tree elements.
	NodeDragEnd	The NodeDragEnd event occurs before ending of node moving.
	NodeDragFinished	The NodeDragFinished event occurs after ending of node moving.
	NodeDragStart	The NodeDragStart event occurs before start of node moving.
	NodeEditCanceled	The NodeEditCanceled event occurs on canceling cell editing.
	NodeEdited	The NodeEdited event occurs after ending of cell editing.
	NodeEditing	The NodeEditing event occurs before cell editing.
	NodeMouseDown	The NodeMouseDown event occurs on clicking a mouse button on node.
	NodeMouseOut	The NodeMouseOut event occurs on moving mouse cursor from node.
	NodeMouseOver	The NodeMouseOver event occurs on moving mouse cursor to mode.
	NodeMouseUp	The NodeMouseUp event occurs on releasing mouse button on node.
	ToolTipShowing	The ToolTipShowing event occurs on displaying a tooltip.
	VisibleNodesChange	The VisibleNodesChange event occurs before displaying new nodes.
	VisibleNodesChanged	The VisibleNodesChanged event occurs after displaying new nodes.

Properties inherited from the TreeListBase class

	Property name	Brief description
	AllowEmptySelection	The AllowEmptySelection property determines whether zero selection is available.
	DataMappers	The DataMappers property determines data mapping parameters.
	DataObject	The DataObject property determines a tree data source.
	ExpansionMode	The ExpansionMode property determines a node expansion mode.
	FocusedNode	The FocusedNode property determines an identifier of the focused node.
	FilterColumn	The FilterColumn property determines a column index for filter check.
	FilterString	The FilterString property determines filter text.
	NodeChecked	The NodeChecked property determines whether the specified node checkbox is selected.
	NodeChildrenCount	The NodeChildrenCount property determines the number of specified node children.
	NodeChildrenSelected	The NodeChildrenSelected property determines the number of selected children of the specified node.
	NodeClass	The NodeClass property determines a CSS class of the specified node.
	NodeContent	The NodeContent property determines node contents.
	NodeControls	The NodeControls property determines node controls.
	NodeData	The NodeData property determines user data of the specified node.
	NodeEditable	The NodeEditable property determines whether the specified node can be edited.
	NodeExpanded	The NodeExpanded property determines whether the specified node is expanded.
	NodeFixedExpanded	The NodeFixedExpanded property determines whether the specified node can be expanded or collapsed.
	NodeFixedFocused	The NodeFixedFocused property determines whether the specified node can be focused.
	NodeFixedSelected	The NodeFixedSelected property determines whether the specified node can be selected.
	NodeFocused	The NodeFocused property determines whether the specified node is focused.
	NodeImageIndex	The NodeImageIndex property determines icon index of the specified node.
	NodeIndex	The NodeIndex property determines number of the specified node at the current level.
	NodeParent	The NodeParent property determines a parent key of the specified node.
	NodeSelected	The NodeSelected property determines whether the specified node is selected.
	NodeStyle	The NodeStyle property determines style of the specified node.
	NodeVisible	The NodeVisible property determines whether the specified node is visible.
	RequestTimeout	The RequestTimeout property determines delay before tree rendering.
	SelectionMode	The SelectionMode property determines selection mode.
	SortColumn	The SortColumn property determines a sorting column.
	SortDirection	The SortDirection property determines sorting direction.
	SortMethod	The SortMethod property determines a sorting method.

Methods inherited from the TreeListBase class

	Method name	Brief description
	beginUpdate	The beginUpdate method selects update block checkbox.
	checkExpansion	The checkExpansion method checks if nodes are expanded correctly.
	checkSelection	The checkSelection method checks if nodes are selected correctly.
	clearNodes	The clearNodes method clears all tree nodes.
	deleteNode	The deleteNode method deletes the specified tree node.
	endUpdate	The beginUpdate method deselects update block checkbox.
	find	The find method returns key of the node containing the searched row in the corresponding column.
	findText	The findText method searches full match of value in the first column.
	focusNode	The focuseNode method sets focus on the specified node.
	getAllCheckedNodes	The getAllCheckedNodes method returns array of nodes depending on the checkbox status.
	getAllExpandedNodes	The getAllExpandedNodes method returns array of nodes depending on the expander status.
	getAllNodes	The getAllNodes method returns all nodes.
	getAllNodesCount	The getAllNodesCount method returns the number of nodes.
	getLastExpandedNode	The getLastExpandedNode method returns key of the last expanded node.
	getLastSelectedNode	The getLastSelectedNode method returns key of the last selected node.
	getNodeByPosition	The getNodeByPosition method returns key of the node by its number.
	getNodeChildren	The getNodeChildren method returns array of keys of the specified node children.
	getNodeChildrenVisible	The getNodeChildrenVisible method returns whether specified node children are visible.
	getNodeExist	The getNodeExist method returns whether the specified node exists.
	getNodeIsFirst	The getNodeIsFirst method returns whether the specified node is the first in the list.
	getNodeLevel	The getNodeLevel method returns level of the specified node.
	getNodePosition	The getNodePosition method returns number of the specified node.
	getNodes	The getNodes method returns an array of nodes to be rendered.
	getNodesCount	The getNodesCount method returns the number of nodes to be rendered.
	getRequestItemByIndex	The getRequestItemByIndex method returns index of the node and its parent by their number.
	getRequestParentByIndex	The getRequestParentByIndex method returns parent index by node's number.
	getSelectedNodes	The getSelectedNodes method returns selected nodes.
	isFilterActive	The isFilterActive method returns whether filter is used.
	isHierarchicalDataObject	The isHierarchicalDataObject method returns whether the Children data mapping is used.
	isNodeExist	The isNodeExist method returns whether the specified node exists.
	isPartialRequestPossible	The isPartialRequestPossible method determines whether branches can be partially loaded.
	isSortActive	The isSortActive method returns whether sorting is active.
	isUpdating	The isUpdateing method returns whether update mode is active.
	loadNodes	The loadNodes method loads nodes from object.
	moveNode	The moveNode method moves the specified node.
	preserveSelection	The preserveSelection method remembers the current selection for the setSelectedFromToIndex method.
	refresh	The refresh method refreshes the tree.
	removeFocus	The removeFocus method removes the current focus.
	requestData	The requestData method requests dynamic tree loading.
	setCheckedForAll	The setCheckedForAll method sets values to all tree checkboxes.
	setCheckedForNodeAncestors	The setCheckedForNodeAncestors method sets value to checkboxes of each ancestor of the specified node.
	setCheckedForNodes	The setCheckedForNodes method sets value to checkboxes of the specified nodes.
	setExpandedForAll	The setExpandedForAll method sets expander values to all nodes.
	setExpandedForNodeAncestors	The setExpandedForNodeAncestors method sets expander values to each ancestor of the specified node.
	setExpandedForNodes	The setExpandedForNodes method sets expander values to array of nodes.
	setFilter	The setFilter method sets filter for tree.
	setSelectedForAll	The setSelectedForAll method selects all nodes.
	setSelectedForChildren	The setSelectedForChildren method selects all children of the specified node.
	setSelectedForLevel	The setSelectedForLevel method selects all nodes of the specified level.
	setSelectedForNodes	The setSelectedForNodes method selects the specified array of nodes.
	setSelectedFromToIndex	The setSelectedFromToIndex method changes the current selection for range of nodes.
	setSort	The setSort method sorts tree elements.
	updateDataObject	The updateDataObject method creates an empty object with data if it is missing.
	updateIndexes	The updateIndexes method refreshes visible nodes.
	updateMappers	The updateMappers method refreshes data mapping objects.
	updateNode	The updateNode method refreshes the specified node.
	updateNodeStyle	The updateNodeStyle method refreshes styles of the specified node.
	updateTree	The updateTree method rebuilds a tree.

Events inherited from the TreeListBase class

	Event name	Brief description
	CheckedChanged	The CheckedChanged event occurs after changing checkbox status.
	CheckedChanging	The CheckedChanging event occurs before changing checkbox status.
	DataRequest	The DataRequest event occurs before changing sorting.
	ExpansionChanged	The ExpansionChanged event occurs after changing expander value.
	ExpansionChanging	The ExpansionChanging event occurs before changing expander value.
	FilterChanged	The FilterChanged event occurs after filter is changed.
	FilterChanging	The FilterChanging event occurs before filter is changed.
	Finding	The Finding event occurs before applying search.
	Found	The Found event occurs after applying search.
	FocusChanged	The FocusChanged event occurs after changing focus.
	FocusChanging	The FocusChanging event occurs before changing focus.
	SelectionChanged	The SelectionChanged event occurs after changing selection.
	SelectionChanging	The SelectionChanging event occurs before changing selection.
	SortChanged	The SortChanged event occurs after changing sorting.
	SortChanging	The SortChanging event occurs before changing sorting.

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 sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

	Property name	Brief description
	ActiveNode	The ActiveNode property determines expanded node key.
	AnimationDuration	The AnimationDuration property determines paging animation speed.

	Method name	Brief description
	drillTo	The drillTo method moves to the specified node.
	getFullTreeHeight	The getFullTreeHeight method returns a full tree height considering border and indents.

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left 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.

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.