MetabaseTreeList

The MetabaseTreeList class implements the MetabaseTreeList component: that is, a hierarchical tree that displays the list of repository objects.

Comments

Syntax

PP.initClass(PP.Mb.Ui.MetabaseTreeList, PP.Ui.ProxyControl, "MetabaseTreeList");

Constructor

Properties

	Property name	Brief description
	DisplayMode	The DisplayMode property determines which information is displayed in the node header: name, identifier, or both name and identifier of the object.
	EmptySelection	The EmptySelection property determines whether the selection can be fully removed from all tree elements.
	ExpandedKeys	The ExpandedKeys property sets object key or an array of object keys for the objects that are displayed as expanded nodes in the tree.
	Filter	The Filter property determines a list of object types to be displayed in the component's tree.
	Metabase	The Metabase property determines a repository, which data will be used to build a tree.
	MultiSelect	The MultiSelect property determines whether multiple selection of tree elements is available.
	RootKey	The RootKey property sets key of the root folder.
	SelectedKeys	The SelectedKeys property sets the array of selected objects' keys.
	ShowAttributes	The ShowAttributes property determines whether columns that contain object attributes are displayed.
	ShowEmptyFolder	The ShowEmptyFolder property determines whether empty folders are displayed in the tree.
	ShowOnlyFolders	The ShowOnlyFolders property sets the collection with keys of the folders to be displayed in the component.

Methods

	Method name	Brief description
	addFilter	The addFilter method adds a list of object types to be displayed in the tree.
	adjustColumnsWidthByContent	The adjustColumnsWidthByContent method adjusts columns width by their contents.
	clearFilter	The clearFilter method clears the list of object types shown in the tree.
	clearSelection	The clearSelection method removes selection from all tree nodes.
	deSelectAll	The deSelectAll method deselects all tree nodes.
	expandNodesTo	The expandNodesTo method expands all folders that contain an object with the specified key.
	find	The find method searches for tree objects.
	getMbObjectByKey	The getMbObjectByKey method returns repository object by its key.
	getPathToRoot	The getPathToRoot method returns an array of objects, or keys of objects, into which the specified object is included.
	getSelectedObjects	The getSelectedObjects method returns an array of selected objects, that is, instances of the PP.Mb.Object class.
	getShowRootFolder	The getShowRootFolder method determines whether the root folder is displayed.
	invertSelection	The invertSelection method inverts selection in the tree of objects, that is, it selects unselected elements and deselects elements that were selected.
	refresh	The refresh method refreshes tree node by its key.
	refreshAll	The refreshAll method refreshes the entire tree of repository objects.
	selectAll	The selectAll method selects all tree nodes.

Events

Method inherited from the class ProxyControl

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
	addClass	The addClass method adds a CSS class to the component.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	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.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	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 a component can be dragged on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method sets up component displaying only on mouseover.
	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.

Events inherited from the class Control

Properties inherited from the class Object

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.

	Event name	Brief description
	NodeClick	The NodeClick event occurs on clicking a tree node.
	NodeDblClick	The NodeDblClick event occurs on double-clicking a tree node.
	NodesLoaded	The NodesLoaded event occurs after all the tree nodes are loaded.
	SelectionChanged	The SelectionChanged event occurs after change of selection in the tree of repository objects.

	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.