Working with Trees > Classes > ListCaptions
Namespace: PP.Ui ;
ListCaptions
The ListCaptions class implements the tree title consisting of column titles.
Consist of the group of titles: PP.Ui.ListCaption.
It is used as a title for the following components:
PP.initClass(PP.Ui.ListCaptions, PP.Ui.Control, "ListCaptions");
| Constructor name | Brief description | |
 |
ListCaptions | The ListCaptions constructor creates an instance of the ListCaptions class. |
| Property name | Brief description | |
 |
Captions | The Captions property contains array of titles. |
|
EnableMenu | The EnableMenu property determines whether column visibility menu is active. |
|
EnableResize | The EnableResize property determines whether column can be manually resized. |
|
EnableSort | The EnableSort property determines whether columns can be sorted. |
|
LeftMargin | The LeftMargin property determines left margin of titles. |
|
RightMargin | The RightMargin property determines right margin of titles. |
|
ScrollLeft | The ScrollLeft property determines displaying of titles at the specified value of horizontal scrollbar. |
|
VScrollMargin | The VScrollMargin property determines vertical scrollbar margin. |
| Method name | Brief description | |
|
add | The add method adds a new title to the end. |
|
clear | The clear method removes all titles. |
|
getCaptionIndex | The getCaptionIndex method returns title index. |
|
getCaptionsWidth | The getCaptionsWidth method returns total width of all titles not including margins. |
|
getCount | The getCount method returns the number of titles including hidden ones. |
|
getFirstVisibleIndex | The getFirstVisibleIndex method returns index of the first visible title. |
|
getFixedCaptionsCount | The getFixedCaptionsCount method returns the number of titles with fixed width. |
|
getFullContentWidth | The getFullContentWidth method returns width of all titles including msrgins. |
|
getItem | The getItem method returns title by its index. |
|
getItemIsVisible | The getItemIsVisible method returns whether title is visible by the specified index. |
|
getItemWidth | The getItemWidth method returns title width by its index. |
|
getMenuButtonWidth | The getMenuButtonWidth method returns menu button width. |
|
getStretchCaptionsCount | The getStretchCaptionsCount method returns the number of titles with relative width. |
|
getVisibleCaptions | The getVisibleCaptions method returns array of visible titles. |
|
getVisibleCaptionsCount | The getVisibleCaptionsCount method returns the number of visible titles. |
|
hideMenu | The hideMenu method hides column visibility menu. |
|
insert | The insert method adds a new title by the specified index. |
|
remove | The remove method removes the specified title. |
|
setHorizontalSizes | The setHorizontalSizes method sets size required for calculating title size. |
| Event name | Brief description | |
 |
AutoSize | The AutoSize event occurs before title width autofit. |
|
Changed | The Changed event occurs after changing any title properties affecting displaying. |
|
Changing | The Changing event occurs before changing any title properties affecting displaying. |
|
SortChanged | The SortChanged event occurs after changing sorting. |
|
SortChanging | The SortChanging event occurs before changing sorting. |
| 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. |
| Method name | Brief description | |
|
The addClass method adds a CSS class to the component. | |
|
addEventHandler | The addEventHandler method adds an event handler to a DOM node. |
|
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | |
|
The addToNode method adds a component to the specified node. | |
|
bindEvents | The bindEvents method subscribes an element to all available events. |
|
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | |
|
The getClass method returns the current CSS classes of the component. | |
|
The getCssStyle method returns style for the specified node. | |
|
The getDomNode method returns main DOM node of the component. | |
|
The getFocused method determines whether the component is focused. | |
|
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. |
|
The hide method hides a control. | |
|
The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown. | |
|
refreshStyle | The refreshStyle method refreshes element CSS styles. |
|
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. |
|
The removeStateClasses method removes CSS classes of the component. | |
|
The setDraggable method determines whether a component can be dragged on the HTML page. | |
|
The setFocus method sets the component focus. | |
|
The setIsHovered method sets up component displaying only on mouseover. | |
|
The setSize method establishes the sizes of the component. | |
|
The show method displays a control. | |
|
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. |
|
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | |
|
The updateSize method updates the component size on changing the size of the container that contains the component. |
| 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. |
| Property name | Brief description | |
|
The Id property determines a repository object identifier. |
| 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:
