TreeList

Описание

Компонент TreeList служит для отображения ветвящихся иерархических структур, таких как дерево наследования объектов.

Основные возможности компонента

Комментарии

Компонент реализован классом TreeList. Вершины реализованы классом TreeNode, столбцы - классом TreeColumn. Коллекция столбцов реализована классом TreeColumns, коллекция вершин - классом TreeNodes. Классы TreeColumns и TreeNodes наследуются от базового класса List.

Пример

Компонент имеет следующий вид:

Пример создания компонента TreeList

Пример динамического создания компонента TreeList

Конструктор

  Имя конструктора Краткое описание
TreeList Конструктор TreeList создает экземпляр компонента TreeList.

Свойства

  Имя свойства Краткое описание
ActiveColor Свойство ActiveColor определяет цвет активной вершины дерева.
ActiveFont Свойство ActiveFont определяет параметры шрифта активной вершины дерева.
ActiveParentColor Свойство ActiveParentColor определяет цвет выделения родительских вершин активного элемента дерева.
AreaSelect Свойство AreaSelect определяет, доступно ли выделение области дерева мышью.
CaptionVisible Свойство CaptionVisible определяет, отображается ли строка заголовков.
CheckBoxes Свойство CheckBoxes определяет, отображаются ли флажки для вершин компонента.
ChildrenCount Свойство ChildrenCount содержит количество вершин в корневой ветви.
Columns Свойство Columns устанавливает коллекцию столбцов для компонента.
ContentColor Свойство ContentColor определяет цвет фона содержимого вершины дерева.
ContentFont Свойство ContentFont определяет параметры шрифта вершин дерева.
CutOverflow Свойство CutOverflow определяет, нужно ли отображать многоточие на месте невмещающегося текста.
DblClickExpand Свойство DblClickExpand определяет, раскрывается ли вершина дерева при двойном клике по ней.
DragAndDropDelay Свойство DragAndDropDelay определяет, сколько времени нужно продержать курсор над вершиной с одновременным нажатием на кнопку мыши, чтобы активировался режим Drag&Drop.
DragAndDropDetectDistance Свойство DragAndDropDetectDistance определяет дистанцию, после которой включается режим Drag&Drop.
DragAndDropMode Свойство DragAndDropMode устанавливает режим работы Drag&Drop.
EmptySelection Свойство EmptySelection определяет, можно ли снимать отметку со всех вершин дерева.
EnableColumnsMenu Свойство EnableColumnsMenu определяет видимость пиктограммы меню в заголовке дерева и возможность вызова меню, управляющее видимостью колонок.
EnableDragAndDrop Свойство EnableDragAndDrop определяет, возможно ли перемещать вершины при помощи механизма Drag&Drop.
EnableEdit Свойство EnableEdit определяет, возможно ли редактирование значений в ячейках таблицы.
EnableHighlight Свойство EnableHighlight определяет, доступна ли подсветка элементов дерева.
EnableKeyNavigation Свойство EnableKeyNavigation определяет возможность перемещения по списку при помощи клавиатуры.
EnableResizeColumn Свойство EnableResizeColumn определяет, возможно ли изменять ширину столбцов.
EnableSearch Свойство EnableSearch определяет возможность поиска элементов дерева.
EnableSelectedHighlight Свойство EnableSelectedHighlight определяет, возможна ли подсветка выделенных вершин дерева.
EnableSortColumns Свойство EnableSortColumns определяет, возможна ли сортировка в столбцах.
FilterCaseSensitive Свойство FilterCaseSensitive определяет, будет ли фильтрация регистрозависимой.
FilterDeSelect Свойство FilterDeSelect определяет сброс выделения вершин при фильтрации.
FirstShiftSelectClearing Свойство FirstShiftSelectClearing устанавливает режим, при котором первое нажатие кнопки мыши по вершине с зажатой кнопкой SHIFT снимает выделение со всех вершин, кроме нажатой.
HighlightColor Свойство HighlightColor определяет цвет подсветки элемента дерева.
HighlightFont Свойство HighlightFont определяет шрифт подсвечиваемой вершины дерева.
HoverColor Свойство HoverColor определяет цвет вершины дерева, на которую наведен курсор мыши.
HoverFont Свойство HoverFont определяет параметры шрифта вершины дерева, на которую наведен курсор.
IgnoreRightPadding Свойство IgnoreRightPadding определяет игнорирование правого отступа.
ImageList Свойство ImageList устанавливает невизуальный компонент ImageList.
IsCSMultiSelect Свойство IsCSMultiSelect определяет, включена ли возможность множественной отметки при помощи клавиш SHIFT и CTRL.
KeepHasChild Свойство KeepHasChild определяет изменение отображения иерархического дерева и изменение свойства HasChild у вершин во время работы режима Drag&Drop.
LoadingTimeout Свойство LoadingTimeout определяет промежуток времени, через который произойдет загрузка дерева.
MultiSelect Свойство MultiSelect определяет возможность множественной отметки элементов.
Nodes Свойство Nodes устанавливает коллекцию вершин.
RightButtonSelect Свойство RightButtonSelect определяет, возможен ли выбор вершины при клике правой клавишей мыши.
RowSelect Свойство RowSelect определяет, подсвечивается ли при выборе элемента вся строка.
SearchColor Свойство SearchColor определяет цвет искомого текста.
SearchFont Свойство SearchFont определяет параметры шрифта искомого текста.
SelectedHighlightColor Свойство SelectedHighlightColor определяет цвет подсветки выделенных вершин дерева.
SelectedHighlightFont Свойство SelectedHighlightFont определяет шрифт подсвеченной выделенной вершины дерева.
SelectEditorText Свойство SelectEditorText определяет, будет ли выделяться редактируемый текст.
ShowColumns Свойство ShowColumns определяет, отображаются ли столбцы.
ShowGridLines Свойство ShowGridLines определяет, отображается ли сетка таблицы.
ShowLines Свойство ShowLines определяет, будут ли отображаться линии, соединяющие вершину с ее потомками.
ShowToolTips Свойство ShowToolTips определяет отображение всплывающих подсказок при наведении курсора мыши на вершину дерева.
SortSequence Свойство SortSequence определяет порядок изменения сортировки.
UseCtrlSelect Свойство UseCtrlSelect определяет возможность выбора нескольких вершин при удержании клавиши «Ctrl».
UseShiftSelect Свойство UseShiftSelect определяет возможность выбора нескольких последовательно расположенных вершин при удержании клавиши «Shift».
WordWrap Свойство WordWrap определяет, осуществляется ли перенос текста вершины по словам.

Методы

  Имя метода Краткое описание
beginUpdate Метод beginUpdate отключает перерисовку дерева, пока не будет вызван endUpdate.
checkSelection Метод checkSelection снимает выделение со всех вершин кроме последней выбранной.
clearSelection Метод clearSelection снимает выделение со всех элементов дерева.
collapseAll Метод collapseAll сворачивает все вершины дерева.
deleteNode Метод deleteNode удаляет вершину иерархического дерева.
deSelectAll Метод deSelectAll удаляет отметку с выбранных элементов.
deSelectLevel Метод deSelectLevel снимет отметку с элементов указанного уровня.
endUpdate Метод endUpdate обновляет дерево и включает перерисовку.
expandAll Метод expandAll разворачивает все вершины дерева.
expandToKeyNode Метод expandToKeyNode ищет в дереве вершину с указанным ключом и раскрывает дерево на уровне этой вершины.
expandToNode Метод expandToNode раскрывает все вершины вплоть до указанной.
filter Метод filter фильтрует вершины в иерархическом дереве.
find Метод find осуществляет поиск элемента дерева.
findText Метод findText возвращает вершину дерева, значение которой полностью совпадает с переданным значением.
getAllCollapsedKeys Метод getAllCollapsedKeys возвращает массив ключей, принадлежащих всем закрытым вершинам дерева и вершинам, не имеющим потомков.
getAllExpandedKeys Метод getAllExpandedKeys возвращает массив ключей, принадлежащих всем раскрытым вершинам дерева.
getAllNodes Метод getAllNodes возвращает одномерный массив, содержащий все вершины дерева с текущим порядком сортировки.
getAllSelectedKeys Метод getAllSelectedKeys возвращает массив ключей, принадлежащих всем выделенным вершинам дерева.
getCaptionHeight Метод getCaptionHeight возвращает высоту заголовков столбцов.
getFirstVisibleIndex Метод getFirstVisibleIndex возвращает индекс первой видимой вершины в дереве.
getFocusedNode Метод getFocusedNode возвращает вершину в фокусе.
getFullTreeHeight Метод getFullTreeHeight возвращает высоту дерева.
getHasSecondLevel Метод getHasSecondLevel определяет, имеет ли дерево дочерние вершины.
getHorizontalScroll Метод getHorizontalScroll возвращает горизонтальную полосу прокрутки.
getLastFound Метод getLastFound возвращает последнюю найденную вершину.
getLastSearch Метод getLastSearch возвращает последнюю искомую строку.
getMaximalWidthForColumn Метод getMaximalWidthForColumn возвращает максимальную ширину содержимого в колонке, в видимых строках.
getMaximalWidthForColumnFull Метод getMaximalWidthForColumnFull возвращает максимальную ширину содержимого в столбце, во всех строках.
getNodeByIndex Метод  getNodeByIndex возвращает вершину дерева по ее индексу.
getNodeByKey Метод getNodeByKey возвращает вершину первого уровня по ее ключу.
getNodeLevel Метод getNodeLevel определяет уровень, на котором расположена указанная вершина.
getNodes Метод getNodes возвращает объект класса PP.Ui.TreeNodes, содержащий вершины иерархического дерева.
getOptimalWidthForColumn Метод getOptimalWidthForColumn возвращает оптимальную ширину столбца.
getPixelHeight Метод getPixelHeight возвращает значение высоты (в пикселях) компонента дерева.
getPixelWidth Метод getPixelWidth возвращает значение ширины (в пикселях) компонента дерева.
getRootNode Метод getRootNode возвращает объект, ассоциированный с корнем дерева.
getSelectedNodes Метод getSelectedNodes возвращает выделенные вершины.
getSelectedNodesCount Метод getSelectedNodesCount возвращает число выделенных вершин в дереве
getSort Метод getSort возвращает объект с параметрами сортировки.
getSortColumn Метод getSortColumn возвращает номер столбца, в котором производится сортировка.
getSortMethod Метод getSortMethod возвращает способ сортировки.
getSortProperty Метод getSortProperty возвращает название свойства вершины, по которому будет производиться сортировка.
getSortRecursive Метод getSortRecursive определяет, производится ли сортировка в дочерних вершинах.
getTopMargin Метод getTopMargin возвращает отступ верхней вершины.
getTopShift Метод getTopShift возвращает смещение верхней вершины.
getVerticalScroll Метод getVerticalScroll возвращает вертикальную полосу прокрутки.
getVisibleNodes Метод getVisibleNodes возвращает одномерный массив, содержащий вершины дерева, отображаемые в нем в настоящий момент.
getVisibleNodesCount Метод getVisibleNodesCount возвращает количество отображаемых в текущий момент вершин дерева.
highlight Метод highlight подсвечивает указанный текст в подписях вершин дерева.
isDraging Метод IsDraging определяет признак режима перетаскивания.
isEditing Метод IsEditing определяет признак режима редактирования.
isSelecting Метод IsSelecting определяет признак режима выделения.
redraw Метод redraw полностью перерисовывает иерархическое дерево.
removeFocus Метод removeFocus снимает фокус с вершины.
removeHover Метод removeHover снимает эффекты с вершины, появляющиеся при наведении курсора мыши на нее.
scrollToNode Метод scrollToNode осуществляет прокрутку дерева до указанной вершины.
selectAll Метод selectAll выделяет все вершины дерева.
selectLevel Метод selectLevel выбирает все вершины указанного уровня.
setExpandedByKeys Метод setExpandedByKeys раскрывает вершины по ключам, указанным в массиве keys.
setExpandedForNode Метод setExpandedForNode открывает или скрывает вершину, в зависимости от переданного значения.
setHoveredNode Метод setHoveredNode устанавливает вершину, которая будет отображаться как при наведении на нее курсора.
setSelectedByKeys Метод setSelectedByKeys устанавливает отметку для всех вершин дерева с указанными ключами.
showSearch Метод showSearch открывает строку поиска.
sort Метод sort осуществляет сортировку элементов дерева по столбцу.
startEditing Метод startEditing активирует режим редактирования указанной вершины.
update Метод update обновляет отображение дерева.

События

   Имя события Краткое описание
BeforeCollapse Событие BeforeCollapse наступает перед сворачиванием вершины дерева.
BeforeExpand Событие BeforeExpand наступает перед разворачиванием вершины дерева.
CheckBoxClick Событие CheckBoxClick наступает при клике мыши по флажку.
CheckedChanged Событие CheckedChanged наступает при смене состояния флажка.
Collapse Событие Collapse наступает при сворачивании вершин дерева.
ColumnVisibilityChanged Событие ColumnVisibilityChanged наступает после изменения видимости столбца дерева.
ColumnVisibilityChanging

Событие ColumnVisibilityChanging наступает при изменении видимости столбца дерева.

Expand Событие Expand наступает при разворачивании вершин.
FilterChanged Событие FilterChanged наступает после фильтрации вершин иерархического дерева.
Finding Событие Find наступает в начале поиска элемента.
Found Событие Found наступает, когда найден элемент дерева.
LoadSubNodesOf Событие LoadSubNodesOf наступает при загрузке вершины в дерево.
MouseDownNode Событие MouseDownNode наступает при нажатии и удержании клавиши мыши у вершины компонента.
NodeClick Событие NodeClick наступает при щелчке мыши по элементу списка.
NodeDblClick Событие NodeDblClick наступает при двойном щелчке мыши по элементу списка.
NodeDrag Событие NodeDrag наступает во время перетаскивания вершины.
NodeDragEnd Событие NodeDragEnd наступает при окончании перетаскивания вершины.
NodeDragFinished Событие NodeDragFinished наступает после помещения вершины в новую позицию.
NodeDragStart Событие NodeDragStart наступает в начале перетаскивания вершины (в момент нажатия и удержания клавиши мыши).
NodeEditCanceled Событие NodeEditCanceled наступает при отмене редактирования.
NodeEdited Событие NodeEdited наступает после редактирования названия вершины.
NodeEditFinish Событие NodeEditFinish наступает после завершения редактирования вершины иерархического дерева.
NodeEditing Событие NodeEditing наступает во время редактирования значения в ячейке таблицы.
NodeHovered Событие NodeHovered наступает при наведении курсора на вершину.
NodeUnHovered Событие NodeUnHovered наступает, когда с вершины снимается признак того, что на нее наведен курсор.
SelectionChanged Событие SelectionChanged наступает после выбора элемента.
SelectionChanging Событие SelectionChanging наступает во время выбора элемента.
Sort Событие Sort наступает во время сортировки коллекции вершин компонента.
SortChanged Событие SortChanged наступает после завершения изменения сортировки столбца иерархического дерева.
SortChanging Событие SortChanging наступает во время изменения сортировки столбца иерархического дерева.
ToolTipShowing Событие ToolTipShowing наступает, когда курсор мыши наведен на вершину иерархического дерева.

Свойства, унаследованные от класса Control

  Имя свойства Краткое описание
Anchors Свойство Anchors определяет позицию компонента, размещенного внутри контейнера.
Animation Свойство Animation определяет параметры анимации для компонента.
Bottom Свойство Bottom определяет отступ снизу при размещении компонента внутри LayoutPanel.
Content Свойство Content определяет содержимое компонента.
ContextMenu Свойство ContextMenu определяет контекстное меню для компонента.
Data Свойство Data предназначено для хранения любых пользовательских данных.
Enabled Свойство Enabled определяет признак доступности компонента для использования.
Height Свойство Height определяет высоту компонента.
IsRTL Свойство IsRTL определяет признак расположения элементов компонента по правому краю.
IsVisible Свойство IsVisible определяет признак отображения компонента.
Left Свойство Left определяет отступ слева при размещении компонента внутри GridPanel.
Opacity Свойство Opacity определяет прозрачность компонента.
Parent Свойство Parent определяет родительский компонент элемента управления.
ParentNode Свойство ParentNode определяет родительскую DOM-вершину.
ResourceKey Свойство ResourceKey определяет ресурсный ключ для компонента.
Right Свойство Right определяет отступ справа при размещении компонента внутри LayoutPanel.
Rotate Свойство Rotate определяет угол поворота компонента.
ShowToolTip Свойство ShowToolTip определяет признак возможности отображения всплывающей подсказки компонента.
Style Свойство Style определяет стиль для компонента.
TabIndex Свойство TabIndex определяет последовательность перехода элемента управления внутри контейнера.
Tag Свойство Tag определяет JSON-объект, ассоциированный с компонентом.
ToolTip Свойство ToolTip определяет текст всплывающей подсказки компонента.
Top Свойство Top определяет отступ сверху при размещении компонента внутри GridPanel.
Value Свойство Value определяет значение компонента.
Width Свойство Width определяет ширину компонента.

Методы, унаследованные от класса Control

  Имя метода Краткое описание

addClass

Метод addClass добавляет CSS-класс к компоненту.
addEventHandler Метод addEventHandler добавляет обработчик события на DOM-вершину.

addStateClass

Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.

addToNode

Метод addToNode добавляет компонент в указанную вершину.
bindEvents Метод bindEvents подписывает элемент на все стандартные события.

getAnchorFlags

Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.

getClass

Метод getClass возвращает текущие css-классы компонента.

getCssStyle

Метод getCssStyle возвращает стили для указанной вершины.

getDomNode

Метод getDomNode возвращает главную DOM-вершину компонента.

getFocused

Метод getFocused определяет наличие фокуса у компонента.
getIsBinded Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.

hide

Метод hide скрывает элемент управления.

hideToolTip

Метод hideToolTip очищает таймаут появления подсказки и скрывает её, если она был показана.
refreshStyle Метод refreshStyle обновляет CSS-стили элемента.

removeClass

Метод removeClass удаляет CSS-класс из компонента.
removeEventHandler Метод removeEventHandler удаляет обработчик события DOM-вершины.
removeFromDOM Метод removeFromDOM удаляет вершину из DOM-структуры.

removeStateClasses

Метод removeStateClasses удаляет CSS-классы компонента.

setDraggable

Метод setDraggable устанавливает возможность перетаскивания компонента на HTML-странице.

setFocus

Метод setFocus устанавливает фокус компонента.

setIsHovered

Метод setIsHovered настраивает отображение компонента только при наведении на него курсора.

setSize

Метод setSize устанавливает размеры компонента.

show

Метод show отображает элемент управления.
unBindEvents Метод unBindEvents отписывает элемент от всех стандартных событий.

updatePosition

Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.

updateSize

Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

События, унаследованные от класса Control

  Имя события Краткое описание
Drag Событие Drag наступает при нажатии и удерживании клавиши мыши.
DragEnd Событие DragEnd наступает при окончании перетаскивания компонента.
DragStart Событие DragStart наступает, когда начинается перетаскивание компонента.
OnContextMenu Событие OnContextMenu наступает при вызове контекстного меню компонента.
SizeChanged Событие SizeChanged наступает после изменения размеров компонента.
SizeChanging Событие SizeChanging наступает во время изменения размеров компонента.

Свойства, унаследованные от класса Object

  Имя свойства Краткое описание

Id

Свойство Id определяет идентификатор объекта репозитория.

Методы, унаследованные от класса Object

  Имя метода Краткое описание
clone Метод clone создает копию объекта.
dispose Метод dispose уничтожает компонент.
getHashCode Метод getHashCode возвращает хэш-код объекта репозитория.
getId Метод getId возвращает идентификатор объекта репозитория.
getSettings Метод getSettings возвращает настройки объекта репозитория.
getTypeName Метод getTypeName возвращает имя типа объекта без пространства имен, к которому он принадлежит.
isEqual Метод isEqual определяет, равен ли заданный объект текущему объекту репозитория.
isLive Метод isLive определяет действительность объекта репозитория.
removeAllEvents Метод removeAllEvents удаляет все обработчики событий объекта по заданному контексту.
setId Метод setId определяет идентификатор объекта репозитория.
setSettings Метод setSettings задает настройки объекта репозитория.
defineProps Метод defineProps создает методы get и set из массива имен для указанного класса.
keys Метод keys возвращает массив названий методов и свойств для указанного объекта.

См. также:

DHTML-компоненты