Class MenuBar

A widget which displays menus as a canonical menu bar.

Hierarchy (view full)

Widget
- MenuBar

Index

Constructors

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

Constructors

constructor

new MenuBar(options?): MenuBar
Construct a new menu bar.
Parameters
- options: MenuBar.IOptions = {}
  The options for initializing the menu bar.
Returns MenuBar
Overrides Widget.constructor
- Defined in widgets/src/menubar.ts:43

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

get activeIndex(): number
Get the index of the currently active menu.

Notes
This will be -1 if no menu is active.

Returns number
- Defined in widgets/src/menubar.ts:132
set activeIndex(value): void
Set the index of the currently active menu.

Notes
If the menu cannot be activated, the index will be set to -1.
Parameters
- value: number
Returns void
- Defined in widgets/src/menubar.ts:142

activeMenu

get activeMenu(): null | Menu
Get the currently active menu.

Returns null | Menu
- Defined in widgets/src/menubar.ts:112
set activeMenu(value): void
Set the currently active menu.

Notes
If the menu does not exist, the menu will be set to null.
Parameters
- value: null | Menu
Returns void
- Defined in widgets/src/menubar.ts:122

childMenu

get childMenu(): null | Menu
The child menu of the menu bar.

Notes
This will be null if the menu bar does not have an open menu.

Returns null | Menu
- Defined in widgets/src/menubar.ts:77

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
- Defined in widgets/src/menubar.ts:103

dataset

get dataset(): DOMStringMap
The dataset for the widget's DOM node.

Returns DOMStringMap
Inherited from Widget.dataset
- Defined in widgets/src/widget.ts:163

disposed

get disposed(): ISignal<this, void>
A signal emitted when the widget is disposed.

Returns ISignal<this, void>
Inherited from Widget.disposed
- Defined in widgets/src/widget.ts:90

hiddenMode

get hiddenMode(): HiddenMode
Get the method for hiding the widget.

Returns HiddenMode
Inherited from Widget.hiddenMode
- Defined in widgets/src/widget.ts:170
set hiddenMode(value): void
Set the method for hiding the widget.
Parameters
- value: HiddenMode
Returns void
Inherited from Widget.hiddenMode
- Defined in widgets/src/widget.ts:177

id

get id(): string
Get the id of the widget's DOM node.

Returns string
Inherited from Widget.id
- Defined in widgets/src/widget.ts:149
set id(value): void
Set the id of the widget's DOM node.
Parameters
- value: string
Returns void
Inherited from Widget.id
- Defined in widgets/src/widget.ts:156

isAttached

get isAttached(): boolean
Test whether the widget's node is attached to the DOM.

Returns boolean
Inherited from Widget.isAttached
- Defined in widgets/src/widget.ts:109

isDisposed

get isDisposed(): boolean
Test whether the widget has been disposed.

Returns boolean
Inherited from Widget.isDisposed
- Defined in widgets/src/widget.ts:102

isHidden

get isHidden(): boolean
Test whether the widget is explicitly hidden.

Returns boolean
Inherited from Widget.isHidden
- Defined in widgets/src/widget.ts:116

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
Inherited from Widget.isVisible
- Defined in widgets/src/widget.ts:127

layout

get layout(): null | Layout
Get the layout for the widget.

Returns null | Layout
Inherited from Widget.layout
- Defined in widgets/src/widget.ts:243
set layout(value): 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
- value: null | Layout
Returns void
Inherited from Widget.layout
- Defined in widgets/src/widget.ts:256

menus

get menus(): readonly Menu[]
A read-only array of the menus in the menu bar.

Returns readonly Menu[]
- Defined in widgets/src/menubar.ts:168

overflowIndex

get overflowIndex(): number
The overflow index of the menu bar.

Returns number
- Defined in widgets/src/menubar.ts:84

overflowMenu

get overflowMenu(): null | Menu
The overflow menu of the menu bar.

Returns null | Menu
- Defined in widgets/src/menubar.ts:91

parent

get parent(): null | Widget
Get the parent of the widget.

Returns null | Widget
Inherited from Widget.parent
- Defined in widgets/src/widget.ts:204
set parent(value): 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
- value: null | Widget
Returns void
Inherited from Widget.parent
- Defined in widgets/src/widget.ts:219

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>
Inherited from Widget.title
- Defined in widgets/src/widget.ts:142

Methods

`Private` _closeChildMenu

_closeChildMenu(): void
Close the child menu immediately.

This is a no-op if a child menu is not open.

Returns void
- Defined in widgets/src/menubar.ts:828

`Private` _evtFocusOut

_evtFocusOut(event): void
Handle the 'focusout' event for the menu bar.
Parameters
- event: FocusEvent
Returns void
- Defined in widgets/src/menubar.ts:751

`Private` _evtKeyDown

_evtKeyDown(event): 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
- Defined in widgets/src/menubar.ts:567

`Private` _evtMouseDown

_evtMouseDown(event): void
Handle the 'mousedown' event for the menu bar.
Parameters
- event: MouseEvent
Returns void
- Defined in widgets/src/menubar.ts:649

`Private` _evtMouseMove

_evtMouseMove(event): void
Handle the 'mousemove' event for the menu bar.
Parameters
- event: MouseEvent
Returns void
- Defined in widgets/src/menubar.ts:696

`Private` _focusItemAt

_focusItemAt(index): void
Focus an item in the menu bar.

Notes
Does not open the associated menu.
Parameters
- index: number
Returns void
- Defined in widgets/src/menubar.ts:764

`Private` _onMenuAboutToClose

_onMenuAboutToClose(sender): void
Handle the aboutToClose signal of a menu.
Parameters
- sender: Menu
Returns void
- Defined in widgets/src/menubar.ts:853

`Private` _onMenuMenuRequested

_onMenuMenuRequested(sender, args): void
Handle the menuRequested signal of a child menu.
Parameters
- sender: Menu
- args: "next" | "previous"
Returns void
- Defined in widgets/src/menubar.ts:875

`Private` _onTitleChanged

_onTitleChanged(): void
Handle the changed signal of a title object.

Returns void
- Defined in widgets/src/menubar.ts:902

`Private` _openChildMenu

_openChildMenu(options?): 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
- Defined in widgets/src/menubar.ts:777

`Private` _positionForMenu

_positionForMenu(index): 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
- Defined in widgets/src/menubar.ts:739

`Private` _updateOverflowIndex

_updateOverflowIndex(): void
Calculate and update the current overflow index.

Returns void
- Defined in widgets/src/menubar.ts:525

activate

activate(): void
Post an 'activate-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.activate
- Defined in widgets/src/widget.ts:396

addClass

addClass(name): void
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
Inherited from Widget.addClass
- Defined in widgets/src/widget.ts:326

addMenu

addMenu(menu, update?): void
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
- Defined in widgets/src/menubar.ts:202

children

children(): IterableIterator<Widget>
Create an iterator over the widget's children.

Returns IterableIterator<Widget>
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.
Inherited from Widget.children
- Defined in widgets/src/widget.ts:283

clearFlag

clearFlag(flag): void
Clear the given widget flag.

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns void
Inherited from Widget.clearFlag
- Defined in widgets/src/widget.ts:506

clearMenus

clearMenus(): void
Remove all menus from the menu bar.

Returns void
- Defined in widgets/src/menubar.ts:320

close

close(): void
Send a 'close-request' message to the widget.

Notes
This is a simple convenience method for sending the message.

Returns void
Inherited from Widget.close
- Defined in widgets/src/widget.ts:406

contains

contains(widget): boolean
Test whether a widget is a descendant of this widget.
Parameters
- widget: Widget
  The descendant widget of interest.
Returns boolean
true if the widget is a descendant, false otherwise.
Inherited from Widget.contains
- Defined in widgets/src/widget.ts:296

dispose

dispose(): void
Dispose of the resources held by the widget.

Returns void
Overrides Widget.dispose
- Defined in widgets/src/menubar.ts:60

fit

fit(): void
Post a 'fit-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.fit
- Defined in widgets/src/widget.ts:386

handleEvent

handleEvent(event): void
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
- Defined in widgets/src/menubar.ts:354

hasClass

hasClass(name): boolean
Test whether the widget's DOM node has the given class name.
Parameters
- name: string
  The class name of interest.
Returns boolean
true if the node has the class, false otherwise.
Inherited from Widget.hasClass
- Defined in widgets/src/widget.ts:312

hide

hide(): void
Hide the widget and make it hidden to its parent widget.

Notes
This causes the isHidden property to be true.

If the widget is explicitly hidden, this is a no-op.

Returns void
Inherited from Widget.hide
- Defined in widgets/src/widget.ts:445

insertMenu

insertMenu(index, menu, update?): void
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
- Defined in widgets/src/menubar.ts:218

`Protected` notifyLayout

notifyLayout(msg): void
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
Inherited from Widget.notifyLayout
- Defined in widgets/src/widget.ts:604

`Protected` onActivateRequest

onActivateRequest(msg): void
A message handler invoked on an 'activate-request' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onActivateRequest
- Defined in widgets/src/menubar.ts:401

`Protected` onAfterAttach

onAfterAttach(msg): void
A message handler invoked on an 'after-attach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterAttach
- Defined in widgets/src/widget.ts:702

`Protected` onAfterDetach

onAfterDetach(msg): void
A message handler invoked on an 'after-detach' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onAfterDetach
- Defined in widgets/src/menubar.ts:389

`Protected` onAfterHide

onAfterHide(msg): void
A message handler invoked on an 'after-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterHide
- Defined in widgets/src/widget.ts:686

`Protected` onAfterShow

onAfterShow(msg): void
A message handler invoked on an 'after-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterShow
- Defined in widgets/src/widget.ts:670

`Protected` onBeforeAttach

onBeforeAttach(msg): void
A message handler invoked on a 'before-attach' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onBeforeAttach
- Defined in widgets/src/menubar.ts:378

`Protected` onBeforeDetach

onBeforeDetach(msg): void
A message handler invoked on a 'before-detach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeDetach
- Defined in widgets/src/widget.ts:710

`Protected` onBeforeHide

onBeforeHide(msg): void
A message handler invoked on a 'before-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeHide
- Defined in widgets/src/widget.ts:678

`Protected` onBeforeShow

onBeforeShow(msg): void
A message handler invoked on a 'before-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeShow
- Defined in widgets/src/widget.ts:662

`Protected` onChildAdded

onChildAdded(msg): void
A message handler invoked on a 'child-added' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ChildMessage
Returns void
Inherited from Widget.onChildAdded
- Defined in widgets/src/widget.ts:726

`Protected` onChildRemoved

onChildRemoved(msg): void
A message handler invoked on a 'child-removed' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ChildMessage
Returns void
Inherited from Widget.onChildRemoved
- Defined in widgets/src/widget.ts:734

`Protected` onCloseRequest

onCloseRequest(msg): void
A message handler invoked on a 'close-request' message.

Notes
The default implementation unparents or detaches the widget.
Parameters
- msg: Message
Returns void
Inherited from Widget.onCloseRequest
- Defined in widgets/src/widget.ts:616

`Protected` onFitRequest

onFitRequest(msg): void
A message handler invoked on a 'fit-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onFitRequest
- Defined in widgets/src/widget.ts:646

`Protected` onResize

onResize(msg): void
A message handler invoked on a 'resize' message.
Parameters
- msg: ResizeMessage
Returns void
Overrides Widget.onResize
- Defined in widgets/src/menubar.ts:410

`Protected` onUpdateRequest

onUpdateRequest(msg): void
A message handler invoked on an 'update-request' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onUpdateRequest
- Defined in widgets/src/menubar.ts:418

openActiveMenu

openActiveMenu(): void
Open the active menu and activate its first menu item.

Notes
If there is no active menu, this is a no-op.

Returns void
- Defined in widgets/src/menubar.ts:178

processMessage

processMessage(msg): void
Process a message sent to the widget.
Parameters
- msg: Message
  The message sent to the widget.
  
  Notes
  Subclasses may reimplement this method as needed.
Returns void
Inherited from Widget.processMessage
- Defined in widgets/src/widget.ts:518

removeClass

removeClass(name): void
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
Inherited from Widget.removeClass
- Defined in widgets/src/widget.ts:340

removeMenu

removeMenu(menu, update?): void
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
- Defined in widgets/src/menubar.ts:279

removeMenuAt

removeMenuAt(index, update?): void
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
- Defined in widgets/src/menubar.ts:291

setFlag

setFlag(flag): void
Set the given widget flag.

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns void
Inherited from Widget.setFlag
- Defined in widgets/src/widget.ts:496

setHidden

setHidden(hidden): void
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
Inherited from Widget.setHidden
- Defined in widgets/src/widget.ts:472

show

show(): void
Show the widget and make it visible to its parent widget.

Notes
This causes the isHidden property to be false.

If the widget is not explicitly hidden, this is a no-op.

Returns void
Inherited from Widget.show
- Defined in widgets/src/widget.ts:418

testFlag

testFlag(flag): boolean
Test whether the given widget flag is set.

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns boolean
Inherited from Widget.testFlag
- Defined in widgets/src/widget.ts:486

toggleClass

toggleClass(name, force?): boolean
Toggle a class name on the widget's DOM node.
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
true if the class is now present, false otherwise.

Notes
The class name must not contain whitespace.
Inherited from Widget.toggleClass
- Defined in widgets/src/widget.ts:358

update

update(): void
Post an 'update-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.update
- Defined in widgets/src/widget.ts:376

Class MenuBar

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MenuBar

Properties

Private _activeIndex

Private _childMenu

Private _forceItemsPosition

Private _menuItemSizes

Private _menus

Private _overflowIndex

Private _overflowMenu

Private _overflowMenuOptions

Private _tabFocusIndex

Readonly node

Readonly renderer

Accessors

activeIndex

Returns number

Parameters

Returns void

activeMenu

Returns null | Menu

Parameters

Returns void

childMenu

Returns null | Menu

contentNode

Returns HTMLUListElement

dataset

Returns DOMStringMap

disposed

Returns ISignal<this, void>

hiddenMode

Returns HiddenMode

Parameters

Returns void

id

Returns string

Parameters

Returns void

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Returns boolean

isVisible

Returns boolean

layout

Returns null | Layout

Parameters

Returns void

menus

Returns readonly Menu[]

overflowIndex

Returns number

overflowMenu

Returns null | Menu

parent

Returns null | Widget

Parameters

Returns void

title

Returns Title<Widget>

Methods

Private _closeChildMenu

Returns void

Private _evtFocusOut

Parameters

Returns void

Private _evtKeyDown

Parameters

`Private` _activeIndex

`Private` _childMenu

`Private` _forceItemsPosition

`Private` _menuItemSizes

`Private` _menus

`Private` _overflowIndex

`Private` _overflowMenu

`Private` _overflowMenuOptions

`Private` _tabFocusIndex

`Readonly` node

`Readonly` renderer

`Private` _closeChildMenu

`Private` _evtFocusOut

`Private` _evtKeyDown

`Private` _evtMouseDown

`Private` _evtMouseMove

`Private` _focusItemAt

`Private` _onMenuAboutToClose

`Private` _onMenuMenuRequested

`Private` _onTitleChanged

`Private` _openChildMenu

`Optional` left?: number

`Optional` top?: number

`Private` _positionForMenu

`Private` _updateOverflowIndex