NavigatorBox

Description

The NavigatorBox component is a container for the tree of folders and the list of repository objects.

Comments

This component is implemented by the NavigatorBox class. It is included into the Navigator component.

Example

This component may look as follows:

Example of Creating the NavigatorBox Component

Constructor

  Constructor name Brief description
NavigatorBox The NavigatorBox constructor creates an instance of the NavigatorBox component.

Properties

  Property name Brief description
FolderTreeFilter

The FolderTreeFilter property determines, which container objects are displayed in the folder tree.

HideObjectListColumnsMenu The HideObjectListColumnsMenu property determines whether the columns menu is hidden.
ObjectListDisplayMode

The ObjectListDisplayMode property determines, which information is displayed in the object name in the objects list.

ObjectListFilters

The ObjectListFilters property determines types of objects to be displayed in the object list.

ObjectListMultiSelect

The ObjectListMultiSelect property determines whether multiple objects can be selected in the list.

RootKey The RootKey property sets key of the root folder.
SelectedKeys The SelectedKeys property sets an array of selected objects' keys.
SelectedObjects The SelectedObjects property contains the collection of selected objects of navigator tree.
ShowEmptyFolder The ShowEmptyFolder property determines whether empty folders are displayed in the tree.
ShowNavigationPanel The ShowNavigationPanel property determines whether the folder tree is displayed.
ShowOnlyFolders The ShowOnlyFolders property sets the collection that contains keys of the folders to be shown displayed in the component.

Methods

  Method name Brief description
adjustColumnsWidthByContent The adjustColumnsWidthByContent method sets columns width according to the width of object list contents.
copy The copy method adds a copy of selected objects to clipboard without changing original objects.
copyObjects The copyObjects method places copies of several objects to clipboard.
createFolder The createFolder method creates a folder.
createObject The createObject method creates a repository object.
createShortcut The createShortcut method creates a shortcut for the selected object.
cut The cut method adds selected objects to clipboard and removes the objects from their initial location.
deleteObjects The deleteObjects method deletes selected objects.
getCurrentModeControl The getCurrentModeControl method returns navigator object view class.
getCustomClassObject The getCustomClasses method sends a request to get custom classes of the repository.
getFocusedObject The getFocusedObject method returns the selected repository object.
getObjectsListRootKey The getObjectsListRootKey method returns key of opened folder.
getObjectsListRootMbObject The getObjectsListRootMbObject method returns parent object for the object selected in the tree.
getPathToRoot The getPathToRoot method returns path of the repository objects from the root to the current directory.
getSelectedFolderTreeObject The getSelectedFolderTreeObject method returns the object selected in the tree.
invertSelection The invertSelection method inverts selection in the list of objects, that is, it selects unselected elements and deselects elements that were selected.
isContainer The isContainer method returns whether repository object is a container.
moveObjects The moveObjects method moves objects between folders.
openFoldersTo The openFoldersTo method opens all folders up to the selected object.
openParentFolder The openParentFolder method opens parent folder of the object selected in the tree.
paste The paste method pastes object from clipboard.
refresh The refresh method refreshes the folder tree and the objects list.
refreshForKey The refreshForKey method refreshes contents of the folder with the specified key.
removeSelection The removeSelection method deselects all objects in the list.
selectAll The selectAll method selects all objects in the list.
setObjectListMode The setObjectListMode method sets the type of object list.

Events

  Event name Brief description
FolderTreeContextMenu

The FolderTreeContextMenu event occurs when the user opens context menu for a folder tree element.

ObjectListContextMenu

The ObjectListContextMenu event occurs on opening context menu for an object in the list.

ObjectListObjectsLoaded The ObjectListObjectsLoaded event occurs on loading a list of repository objects.
ObjectListSelectionChanged The ObjectListSelectionChanged event occurs on changing selection of objects.
ObjectSelected The ObjectSelected event occurs on changing selection in the objects list.
OpenObjects The OpenObjects event occurs on double-clicking an object in the list.
PasteBufferStateChanged The PasteBufferStateChanged event occurs after the clipboard state is changed.

Properties inherited from the class Control

  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.

Methods inherited from the class Control

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

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.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

  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.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  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:

DHTML Components