Private _activePrivate _childPrivate _forcePrivate _menuPrivate _menusPrivate _overflowPrivate _overflowPrivate _overflowPrivate _tabReadonly nodeGet the DOM node owned by the widget.
Readonly rendererThe renderer used by the menu bar.
Set the index of the currently active menu.
If the menu cannot be activated, the index will be set to -1.
Get the menu bar content node.
This is the node which holds the menu title nodes.
Modifying this node directly can lead to undefined behavior.
The dataset for the widget's DOM node.
Get the method for hiding the widget.
Set the method for hiding the widget.
Get the id of the widget's DOM node.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the
widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.
Test whether the widget is visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.
Get the layout for the widget.
Set the layout for the widget.
The layout is single-use only. It cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
A read-only array of the menus in the menu bar.
The overflow index of the menu bar.
Get the parent of the widget.
Set the parent of the widget.
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.
The title object for the widget.
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.
Private _closePrivate _evtHandle the 'focusout' event for the menu bar.
Private _evtHandle the 'keydown' event for the menu bar.
All keys are trapped except the tab key that is ignored.
Private _evtHandle the 'mousedown' event for the menu bar.
Private _evtHandle the 'mousemove' event for the menu bar.
Private _focusPrivate _onHandle the aboutToClose signal of a menu.
Private _onHandle the menuRequested signal of a child menu.
Private _onPrivate _openOpen 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.
Optional left?: numberOptional top?: numberPrivate _positionPrivate _updatePost an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Clear the given widget flag.
This will not typically be called directly by user code.
Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Send a 'close-request' message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Protected notifyProtected onA message handler invoked on an 'activate-request' message.
Protected onProtected onA message handler invoked on an 'after-detach' message.
Protected onProtected onProtected onA message handler invoked on a 'before-attach' message.
Protected onProtected onProtected onProtected onA message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
Protected onProtected onProtected onA message handler invoked on a 'resize' message.
Protected onA message handler invoked on an 'update-request' message.
Open the active menu and activate its first menu item.
If there is no active menu, this is a no-op.
Process a message sent to the widget.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
Remove a menu from the menu bar.
Set the given widget flag.
This will not typically be called directly by user code.
Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Show or hide the widget according to a boolean value.
true to hide the widget, or false to show it.
This is a convenience method for hide() and show().
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optional force: booleanWhether 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.
true if the class is now present, false otherwise.
The class name must not contain whitespace.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
A widget which displays menus as a canonical menu bar.
Notes
See also the related example and its source.