MetabaseTreeList

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

Комментарии

Каждый элемент дерева является ссылкой на соответствующий объект репозитория.

Синтаксис

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

Конструктор

Свойства

	Имя свойства	Краткое описание
	DisplayMode	Свойство DisplayMode определяет, что будет отображаться в заголовке вершины: название, идентификатор или название и идентификатор объекта.
	EmptySelection	Свойство EmptySelection определяет, можно ли снять отметку полностью со всех элементов дерева.
	ExpandedKeys	Свойство ExpandedKeys устанавливает ключ объекта или массив ключей объектов, которые отображаются в дереве как развернутые вершины.
	Filter	Свойство Filter определяет список типов объектов, отображаемых в дереве компонента.
	Metabase	Свойство Metabase определяет репозиторий, из которого буду браться данные для построения дерева.
	MultiSelect	Свойство MultiSelect определяет, возможен ли множественный выбор элементов дерева.
	RootKey	Свойство RootKey устанавливает ключ корневой папки.
	SelectedKeys	Свойство SelectedKeys устанавливает массив ключей выделенных объектов.
	ShowAttributes	Свойство ShowAttributes определяет, будут ли отображаться столбцы с атрибутами объектов.
	ShowEmptyFolder	Свойство ShowEmptyFolder определяет, будут ли отображаться в дереве пустые папки.
	ShowOnlyFolders	Свойство ShowOnlyFolders устанавливает коллекцию ключей папок, которые будут отображаться в компоненте.

Методы

	Имя метода	Краткое описание
	addFilter	Метод addFilter добавляет список типов объектов, которые будут отображаться в дереве.
	adjustColumnsWidthByContent	Метод adjustColumnsWidthByContent выравнивает ширину столбцов по содержимому.
	clearFilter	Метод clearFilter очищает список типов объектов, отображающихся в дереве.
	clearSelection	Метод clearSelection снимает выделение со всех вершин дерева.
	deSelectAll	Метод deSelectAll снимает отметку со всех вершин дерева.
	expandNodesTo	Метод expandNodesTo разворачивает все папки, в которых содержится объект с указанным ключом.
	find	Метод find производит поиск объектов в дереве.
	getMbObjectByKey	Метод getMbObjectByKey возвращает объект репозитория по ключу.
	getPathToRoot	Метод getPathToRoot возвращает массив объектов или их ключей, в которые вложен указанный объект.
	getSelectedObjects	Метод getSelectedObjects возвращает массив выбранных объектов - экземпляров класса PP.Mb.Object.
	getShowRootFolder	Метод getShowRootFolder определяет, отображается ли корневая папка.
	invertSelection	Метод invertSelection инвертирует отметку в дереве объектов, то есть отмечает те элементы, которые не были отмечены, и снимает отметку с тех, которые были отмечены.
	refresh	Метод refresh обновляет вершину дерева по ключу.
	refreshAll	Метод refreshAll обновляет все дерево объектов репозитория.
	selectAll	Метод selectAll выделяет все вершины дерева.

События

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

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

	Имя свойства	Краткое описание
	Anchors	Свойство Anchors определяет позицию компонента, размещенного внутри контейнера.
	Animation	Свойство Animation устанавливает параметры анимации для компонента.
	Bottom	Свойство Bottom устанавливает отступ снизу при размещении компонента внутри LayoutPanel.
	Content	Свойство Content устанавливает содержимое компонента.
	ContextMenu	Свойство ContextMenu устанавливает контекстное меню для компонента.
	Data	Свойство Data предназначено для хранения любых пользовательских данных.
	DataContext	Свойство DataContext содержит объект с данными.
	Enabled	Свойство Enabled устанавливает, является ли компонент доступным для использования.
	Height	Свойство Height устанавливает высоту компонента.
	IsResizable	Свойство IsResizable определяет, можно ли изменять размеры компонента.
	IsRTL	Свойство IsRTL устанавливает направление текста справа налево.
	IsVisible	Свойство IsVisible определяет, отображается ли компонент.
	Left	Свойство Left устанавливает отступ слева при размещении компонента внутри GridPanel.
	Offset	Свойство Offset определяет координаты корневой DOM-вершины элемента управления.
	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-класс к компоненту.
	addEvent	Метод addEvent добавляет обработчик события на DOM-вершину.
	addEventHandler	Метод addEventHandler добавляет обработчик события на DOM-вершину.
	addEvents	Метод addEvents добавляет массив обработчиков событий на DOM-вершину.
	addStateClass	Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.
	addStyleBySelector	Метод addStyleBySelector создает блок со стилем с указанным css-селектором.
	addToNode	Метод addToNode добавляет компонент в указанную вершину.
	bindEvents	Метод bindEvents подписывает элемент на все стандартные события.
	clearStylesCache	Метод clearStylesCache очищает кэш стилей компонента.
	getAnchorFlags	Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.
	getClass	Метод getClass возвращает текущие css-классы компонента.
	getCssStyle	Метод getCssStyle возвращает стили для указанной вершины.
	getDomNode	Метод getDomNode возвращает главную DOM-вершину компонента.
	getFocused	Метод getFocused определяет наличие фокуса у компонента.
	getFunctionByName	Метод getFunctionByName возвращает функцию по имени.
	getIsBinded	Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.
	hasClass	Метод hasClass определяет, задан ли для корневой DOM-вершины элемента управления указанный CSS-класс.
	hide	Метод hide скрывает элемент управления.
	hideToolTip	Метод hideToolTip очищает таймаут появления подсказки и скрывает ее, если она был показана.
	isResingNow	Метод isResingNow определяет, изменяются ли в данный момент размеры компонента.
	refreshBindingProperty	Метод refreshBindingProperty обновляет привязанное свойство по имени.
	refreshItemsStyle	Метод refreshItemsStyle обновляет CSS-стили дочерних элементов.
	refreshStyle	Метод refreshStyle обновляет CSS-стили элемента.
	removeClass	Метод removeClass удаляет CSS-класс из компонента.
	removeEvent	Метод removeEvent удаляет обработчик события у DOM-вершины.
	removeEventHandler	Метод removeEventHandler удаляет обработчик события DOM-вершины.
	removeFromDOM	Метод removeFromDOM удаляет вершину из DOM-структуры.
	removeStateClasses	Метод removeStateClasses удаляет CSS-классы компонента.
	setDraggable	Метод setDraggable устанавливает возможность перетаскивания компонента на html-странице.
	setFocus	Метод setFocus устанавливает фокус компонента.
	setIsHovered	Метод setIsHovered отображает компонент как при наведении на него курсора.
	setIsPressed	Метод setIsPressed отображает компонент как при клике по нему.
	setOpacityIE8	Метод setOpacityIE8 устанавливает значение прозрачности компонента в браузере InternetExplorer 8.
	setSize	Метод setSize устанавливает размеры компонента.
	show	Метод show отображает элемент управления.
	unBindEvents	Метод unBindEvents отписывает элемент от всех стандартных событий.
	updatePosition	Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.
	updateSize	Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

	Имя события	Краткое описание
	NodeClick	Событие NodeClick наступает при нажатии на вершину дерева.
	NodeDblClick	Событие NodeDblClick наступает при двойном клике по вершине дерева.
	NodesLoaded	Событие NodesLoaded наступает после загрузки всех вершин дерева.
	SelectionChanged	Событие SelectionChanged наступает после изменения отметки в дереве объектов репозитория.

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

	Имя свойства	Краткое описание
	Data	Свойство Data ассоциирует произвольный объект с данным компонентом.
	Id	Свойство Id устанавливает идентификатор компонента.
	Settings	Свойство Settings задает параметры компонента.

	Имя метода	Краткое описание
	clone	Метод clone создает копию объекта. Не реализован в PP.Ui.Control.
	dispose	Метод dispose уничтожает компонент.
	getTypeName	Метод getTypeName возвращает имя типа объекта без пространства имён, к которому он принадлежит.

MetabaseTreeList

Иерархия наследования

Описание