NavBreadcrumb

Description

The NavBreadcrumb component is a visual component that implements workbook attributes wizard.

Example

This component looks as follows:

The example of creating the NavBreadcrumb component is given on the Example of Creating NavBreadcrumb page.

Constructor

  Constructor name Brief description
NavBreadcrumb The NavBreadcrumb constructor creates an instance of the NavBreadcrumb class.

Properties inherited from the NavBreadcrumbView class

  Property name Brief description
Source The Source property implements the current hierarchy.

Methods inherited from the NavBreadcrumbView class

  Method name Brief description
refreshAll The refreshAll method refreshes the entire component according to metadata.
refreshSelections The refreshSelections method refreshes selections in dimension trees for all the attributes.
updateItemContent The updateItemContent method refreshes a caption on a breadcrumb element (depending on selection in the attribute dimension).

Events inherited from the NavBreadcrumbView class

  Event name Brief description
AltHierarchyChanged The AltHierarchyChanged event occurs after changing dimension's alternative hierarchy at the server.
AttributeFilterChanged The AttributeFilterChanged event occurs after enabling or disabling filter in attribute.
AttributeSortChanged The AttributeSortChanged event occurs after changing sorting in the dimension tree.
DimSelectionChanged The DimSelectionChanged event occurs after changing dimension selection at the server.
PropertyChanged The PropertyChanged event occurs on changing properties of instance of the NavBreadcrumbView image.
RequestMetadata The RequestMetadata event occurs after metadata request.
RequestSelectedItemsChanged The RequestSelectedItemsChanged event occurs after moving attributes in the breadcrumb.
TreeNameAttrChanged The TreeNameAttrChanged event occurs after the level names attribute is changed.

Methods inherited from the class Master

  Method name Brief description
addClassToTitles The addClassToTitles method sets an additional style class to titles of all wizard tabs except for the first one.
addMaster The addMaster method adds a child wizard.
addMasterPanel The addMasterPanel method adds a wizard panel.
addNavItem The addNavItem method adds a control to the wizard.
beginUpdate The beginUpdate method starts wizard update.
clearItems The clearItems method clears the list of panels.
endUpdate The endUpdate method finishes wizard update.
expandFirstItem The expandFirstItem method expands the first visible tab if the wizard is visible.
getActiveGroupName The getActiveGroupName method returns the name of the currently shown group of contextual panels.
getActivePanel The getActiveItem method returns the active panel tab of wizard.
getItem The getItem method returns a wizard panel by its type or sequence number in the list of panels.
getItems The getItems method returns array of wizard panels.
hideGroup The hideGroup method hides tab groups by their names.
refresh The refresh method refreshes all wizard panels.
refreshGroup The refreshGroup method refreshes panels that belong to a specific group.
removeMaster The removeMaster method removes child wizard.
removeMasterPanel The removeMasterPanel method removes wizard panel.
removePanelsByGroup The removePanelsByGroup method removes panels by name of the group, to which they belong.
showGroup The showGroup method shows tab groups by their name.
showOnlyGroup The showOnlyGroup method shows only specified groups and hides all the other groups.

Methods inherited from the class ProxyControl

  Method name Brief description
getControl The getControl method returns the basic control that inherits from PP.Ui.Control.

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