NavigationItem

Description

The NavigationItem component is a child element of the NavigationBar component, this is a tab that consists of a header and a drop-down panel.

The panel opens on clicking the title. A control can be set for the tab's title. By default the CheckBox component is set. This control can be hidden.

Events that occur on collapsing and expanding the panel are implemented in the component. Contents of panel is custom.

Comments

The component is implemented by the NavigationItem class.

Example

An example of component creation is given in the Example of Creating the NavigationBar Component.

Constructor

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

Properties

  Property name Brief description
Caption The Caption property sets and returns tab header.
HeaderControl The HeaderControl property sets a control to be displayed in a tab header.
IsHeaderControlVisible The IsHeaderControlVisible property determines whether a control is displayed in the tab header.
Title The Title property sets tab title.

Methods

  Method name Brief description
addHeaderClass The addHeaderClass method adds a CSS class to DOM node of tab.
collapse The collapse method collapses a panel.
expand The expand method expands a panel.
getContentSize The getContentSize method returns panel contents size.
getHeightOfCDomNode The getHeightOfCDomNode method returns height of tab DOM node.
getIsCollapsed The getIsCollapsed method returns whether a panel is collapsed.
getIsRendered The getIsRendered method returns whether a tab is rendered.
getScrollBox The getScrollBox method returns scrolling region of a tab.
hideScrolls The hideScrolls method hides scrollbars.
showScrolls The showScrolls method shows scrollbars.
updateScrolls The updateScrolls method refreshes scrollbars on tab scrolling.

Events

  Event name Brief description
Collapsing The Collapsing event occurs on closing a tab.
Disposing The Disposing event occurs after deleting a tab.
EnableChanged The EnableChanged event occurs after changing tab availability.
Expanding The Expanding event occurs on expanding a tab.
Toggled The Toggled event occurs when expanding or collapsing a tab is completed.
Toggling The Toggling event occurs on expanding or collapsing a tab.
VisibleChanged The VisibleChanged event occurs after changing tab visibility.
VisibleChanging The VisibleChanging event occurs on changing tab visibility.

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 Object class

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the Object class

  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