NavigatorBox

Компонент NavigatorBox представляет собой контейнер для дерева папок и списка объектов репозитория.

Комментарии

Компонент реализован классом NavigatorBox. Входит в состав компонента Navigator.

Пример

Компонент может выглядеть следующим образом:

Конструктор

Свойства

	Имя свойства	Краткое описание
	FolderTreeFilter	Свойство FolderTreeFilter определяет, какие контейнерные объекты будут отображаться в дереве папок.
	HideObjectListColumnsMenu	Свойство HideObjectListColumnsMenu определяет, будет ли скрыто меню для столбцов.
	ObjectListDisplayMode	Свойство ObjectListDisplayMode определяет, что будет отображаться в названии объекта в списке объектов.
	ObjectListFilters	Свойство ObjectListFilters определяет типы объектов, которые будут отображаться в списке объектов.
	ObjectListMultiSelect	Свойство ObjectListMultiSelect устанавливает возможность множественного выбора объектов в списке.
	RootKey	Свойство RootKey устанавливает ключ корневой папки.
	SelectedKeys	Свойство SelectedKeys устанавливает массив ключей отмеченных объектов.
	SelectedObjects	Свойство SelectedObjects содержит коллекцию выделенных объектов дерева навигатора.
	ShowEmptyFolder	Свойство ShowEmptyFolder определяет, будут ли отображаться в дереве пустые папки.
	ShowNavigationPanel	Свойство ShowNavigationPanel определяет, отображается ли дерево папок.
	ShowOnlyFolders	Свойство ShowOnlyFolders устанавливает коллекцию ключей папок, которые будут отображаться в компоненте.

Методы

	Имя метода	Краткое описание
	adjustColumnsWidthByContent	Метод adjustColumnsWidthByContent устанавливает ширину столбцам по ширине содержимого списка объектов.
	copy	Метод copy добавляет в буфер обмена копию выбранных объектов, не изменяя оригинал.
	copyObjects	Метод copyObjects помещает в буфер обмена копии нескольких объектов.
	createFolder	Метод createFolder создает папку.
	createObject	Метод createObject создает объект репозитория.
	createShortcut	Метод createShortcut создает ярлык для выделенного объекта.
	cut	Метод cut добавляет выбранные объекты в буфер обмена, при этом удаляя их.
	deleteObjects	Метод deleteObjects удаляет выделенные объекты.
	getCustomClassObject	Метод getCustomClasses отправляет запрос на получение пользовательских классов репозитория.
	getFocusedObject	Метод getFocusedObject возвращает выделенный объект репозитория.
	getObjectsListRootKey	Метод getObjectsListRootKey возвращает ключ открытой папки.
	getObjectsListRootMbObject	Метод getObjectsListRootMbObject возвращает объект, который является родительским для выделенного в дереве объекта.
	getPathToRoot	Метод getPathToRoot возвращает путь из объектов репозитория от корня до текущей директории.
	getSelectedFolderTreeObject	Метод getSelectedFolderTreeObject возвращает выделенный в дереве объект.
	invertSelection	Метод invertSelection инвертирует отметку в списке объектов, то есть отмечает те элементы, которые не были отмечены, и снимает отметку с тех, которые были отмечены.
	isContainer	Метод isContainer возвращает признак того, является ли объект репозитория контейнером.
	moveObjects	Метод moveObjects переносит объекты из одной папки в другую.
	openFoldersTo	Метод openFoldersTo раскрывает все папки до заданного объект.
	openParentFolder	Метод openParentFolder открывает родительскую папку объекта, выделенного в дереве.
	paste	Метод paste осуществляет вставку объекта из буфера обмена.
	refresh	Метод refresh обновляет дерево папок и список объектов.
	refreshForKey	Метод refreshForKey обновляет содержимое папки с заданным ключом.
	removeSelection	Метод removeSelection снимет выделение со всех объектов списка.
	selectAll	Метод selectAll выделяет все объекты в списке.
	setObjectListMode	Метод setObjectListMode устанавливает тип списка объектов.

События

Свойства, унаследованные от класса 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 обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

	Имя события	Краткое описание
	FolderTreeContextMenu	Событие FolderTreeContextMenu наступает при вызове контекстного меню для элемента дерева папок.
	ObjectListContextMenu	Событие ObjectListContextMenu наступает при вызове контекстного меню для объекта в списке.
	ObjectListObjectsLoaded	Событие ObjectListObjectsLoaded наступает при загрузке списка объектов репозитория.
	ObjectListSelectionChanged	Событие ObjectListSelectionChanged наступает при изменении выделения объектов.
	ObjectSelected	Событие ObjectSelected наступает при изменении отметки в списке объектов.
	OpenObjects	Событие OpenObjects наступает при двойном клике по объекту из списка.
	PasteBufferStateChanged	Событие PasteBufferStateChanged наступает после изменения состояния буфера обмена.

	Имя события	Краткое описание
	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 возвращает имя типа объекта без пространства имён, к которому он принадлежит.

NavigatorBox

Описание