Class MenuBar

A widget which displays menus as a canonical menu bar.

Hierarchy

Constructors

constructor

Properties

_activeIndex _childMenu _forceItemsPosition _menuItemSizes _menus _overflowIndex _overflowMenu _overflowMenuOptions _tabFocusIndex node renderer

Accessors

activeIndex activeMenu childMenu contentNode dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible layout menus overflowIndex overflowMenu parent title

Methods

_closeChildMenu _evtKeyDown _evtMouseDown _evtMouseLeave _evtMouseMove _onMenuAboutToClose _onMenuMenuRequested _onTitleChanged _openChildMenu _positionForMenu _updateOverflowIndex activate addClass addMenu children clearFlag clearMenus close contains dispose fit handleEvent hasClass hide insertMenu notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest openActiveMenu processMessage removeClass removeMenu removeMenuAt setFlag setHidden show testFlag toggleClass update

Constructors

constructor

Properties

Private _activeIndex

_activeIndex: number = -1

Private _childMenu

_childMenu: null | Menu = null

Private _forceItemsPosition

_forceItemsPosition: IOpenOptions

Private _menuItemSizes

_menuItemSizes: number[] = []

Private _menus

_menus: Menu[] = []

Private _overflowIndex

_overflowIndex: number = -1

Private _overflowMenu

_overflowMenu: null | Menu = null

Private _overflowMenuOptions

_overflowMenuOptions: IOverflowMenuOptions

Private _tabFocusIndex

_tabFocusIndex: number = 0

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Readonly renderer

renderer: MenuBar.IRenderer

The renderer used by the menu bar.

Accessors

activeIndex

activeMenu

childMenu

contentNode

  • get contentNode(): HTMLUListElement

  • Get the menu bar content node.

    Notes

    This is the node which holds the menu title nodes.

    Modifying this node directly can lead to undefined behavior.

    Returns HTMLUListElement

dataset

disposed

hiddenMode

id

isAttached

  • get isAttached(): boolean

  • Test whether the widget's node is attached to the DOM.

    Returns boolean

isDisposed

isHidden

isVisible

  • get isVisible(): boolean

  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

layout

  • get layout(): null | Layout

  • Get the layout for the widget.

    Returns null | Layout

  • set layout(value: null | Layout): void

  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    Returns void

menus

overflowIndex

overflowMenu

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | Widget

  • set parent(value: null | Widget): void

  • Set the parent of the widget.

    Notes

    Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

    The widget will be automatically removed from its old parent.

    This is a no-op if there is no effective parent change.

    Parameters

    Returns void

title

  • get title(): Title<Widget>

  • The title object for the widget.

    Notes

    The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

    Since not all widgets will use the title, it is created on demand.

    The owner property of the title is set to this widget.

    Returns Title<Widget>

Methods

Private _closeChildMenu

Private _evtKeyDown

  • _evtKeyDown(event: KeyboardEvent): void

  • Handle the 'keydown' event for the menu bar.

    Notes

    All keys are trapped except the tab key that is ignored.

    Parameters

    • event: KeyboardEvent

    Returns void

Private _evtMouseDown

  • _evtMouseDown(event: MouseEvent): void

  • Handle the 'mousedown' event for the menu bar.

    Parameters

    • event: MouseEvent

    Returns void

Private _evtMouseLeave

  • _evtMouseLeave(event: MouseEvent): void

  • Handle the 'mouseleave' event for the menu bar.

    Parameters

    • event: MouseEvent

    Returns void

Private _evtMouseMove

  • _evtMouseMove(event: MouseEvent): void

  • Handle the 'mousemove' event for the menu bar.

    Parameters

    • event: MouseEvent

    Returns void

Private _onMenuAboutToClose

Private _onMenuMenuRequested

  • _onMenuMenuRequested(sender: Menu, args: "next" | "previous"): void

  • Handle the menuRequested signal of a child menu.

    Parameters

    • sender: Menu
    • args: "next" | "previous"

    Returns void

Private _onTitleChanged

Private _openChildMenu

  • _openChildMenu(options?: {
        left?: number;
        top?: number;
    }): void

  • Open the child menu at the active index immediately.

    If a different child menu is already open, it will be closed, even if there is no active menu.

    Parameters

    • options: {
          left?: number;
          top?: number;
      } = {}
      • Optional left?: number
      • Optional top?: number

    Returns void

Private _positionForMenu

  • _positionForMenu(index: number): IPosition

  • Find initial position for the menu based on menubar item position.

    NOTE: this should be called before updating active index to avoid an additional layout and style invalidation as changing active index modifies DOM.

    Parameters

    • index: number

    Returns IPosition

Private _updateOverflowIndex

activate

addClass

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

addMenu

  • Add a menu to the end of the menu bar.

    Parameters

    • menu: Menu

      The menu to add to the menu bar.

      Notes

      If the menu is already added to the menu bar, it will be moved.

    • update: boolean = true

    Returns void

children

  • Create an iterator over the widget's children.

    Returns

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

    Returns IterableIterator<Widget>

clearFlag

clearMenus

close

contains

  • Test whether a widget is a descendant of this widget.

    Returns

    true if the widget is a descendant, false otherwise.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

dispose

fit

handleEvent

  • Handle the DOM events for the menu bar.

    Parameters

    • event: Event

      The DOM event sent to the menu bar.

      Notes

      This method implements the DOM EventListener interface and is called in response to events on the menu bar's DOM nodes. It should not be called directly by user code.

    Returns void

hasClass

  • Test whether the widget's DOM node has the given class name.

    Returns

    true if the node has the class, false otherwise.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

hide

insertMenu

  • Insert a menu into the menu bar at the specified index.

    Parameters

    • index: number

      The index at which to insert the menu.

    • menu: Menu

      The menu to insert into the menu bar.

      Notes

      The index will be clamped to the bounds of the menus.

      If the menu is already added to the menu bar, it will be moved.

    • update: boolean = true

    Returns void

Protected notifyLayout

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

Protected onAfterAttach

Protected onAfterDetach

Protected onAfterHide

Protected onAfterShow

Protected onBeforeAttach

Protected onBeforeDetach

Protected onBeforeHide

Protected onBeforeShow

Protected onChildAdded

Protected onChildRemoved

Protected onCloseRequest

Protected onFitRequest

Protected onResize

Protected onUpdateRequest

openActiveMenu

processMessage

removeClass

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

removeMenu

  • Remove a menu from the menu bar.

    Parameters

    • menu: Menu

      The menu to remove from the menu bar.

      Notes

      This is a no-op if the menu is not in the menu bar.

    • update: boolean = true

    Returns void

removeMenuAt

  • Remove the menu at a given index from the menu bar.

    Parameters

    • index: number

      The index of the menu to remove.

      Notes

      This is a no-op if the index is out of range.

    • update: boolean = true

    Returns void

setFlag

setHidden

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

show

testFlag

toggleClass

  • Toggle a class name on the widget's DOM node.

    Returns

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: boolean

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

update

Settings

Member Visibility

Theme

Generated using TypeDoc