NavigatorBox

Описание

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

Комментарии

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

Пример

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

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

Конструктор

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

Свойства

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

События

  Имя события Краткое описание
FolderTreeContextMenu

Событие FolderTreeContextMenu наступает при вызове контекстного меню для элемента дерева папок.

ObjectListContextMenu

Событие ObjectListContextMenu наступает при вызове контекстного меню для объекта в списке.

ObjectListObjectsLoaded Событие ObjectListObjectsLoaded наступает при загрузке списка объектов репозитория.
ObjectListSelectionChanged Событие ObjectListSelectionChanged наступает при изменении выделения объектов.
ObjectSelected Событие ObjectSelected наступает при изменении отметки в списке объектов.
OpenObjects Событие OpenObjects наступает при двойном щелчке по объекту из списка.
PasteBufferStateChanged Событие PasteBufferStateChanged наступает после изменения состояния буфера обмена.

Свойства, унаследованные от класса 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-компоненты