Construct a new menu bar.
The options for initializing the menu bar.
Get the DOM node owned by the widget.
The renderer used by the menu bar.
The default Renderer
instance.
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.
A signal emitted when the widget is disposed.
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.
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.
Get 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.
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.
Get 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.
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.
Close the child menu immediately.
This is a no-op if a child menu is not open.
Handle the 'keydown'
event for the menu bar.
All keys are trapped except the tab key that is ignored.
Handle the 'mousedown'
event for the menu bar.
Handle the 'mouseleave'
event for the menu bar.
Handle the 'mousemove'
event for the menu bar.
Handle the aboutToClose
signal of a menu.
Handle the menuRequested
signal of a child menu.
Handle the changed
signal of a title object.
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.
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.
Post 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.
Remove all menus from the menu bar.
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.
Dispose of the resources held by the widget.
Post a 'fit-request'
message to the widget.
This is a simple convenience method for posting the message.
Handle the DOM events for the menu bar.
The DOM event sent to the menu bar.
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.
Test whether the widget's DOM node has the given class name.
The class name of interest.
true
if the node has the class, false
otherwise.
Insert a menu into the menu bar at the specified index.
The index at which to insert the menu.
The menu to insert into the menu bar.
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.
Invoke the message processing routine of the widget's layout.
The message to dispatch to the layout.
This is a no-op if the widget does not have a layout.
This will not typically be called directly by user code.
A message handler invoked on an 'activate-request'
message.
A message handler invoked on an 'after-attach'
message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-detach'
message.
A message handler invoked on an 'after-hide'
message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-attach'
message.
A message handler invoked on a 'before-detach'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-show'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'close-request'
message.
The default implementation unparents or detaches the widget.
A message handler invoked on a 'fit-request'
message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
A 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.
Remove the menu at a given index from the menu bar.
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()
.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
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.
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.
Attach a widget to a host DOM node.
The widget of interest.
The DOM node to use as the widget's host.
The child of host
to use as the reference element.
If this is provided, the widget will be inserted before this
node in the host. The default is null
, which will cause the
widget to be added as the last child of the host.
This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.
Generated using TypeDoc
A widget which displays menus as a canonical menu bar. The namespace for the
MenuBar
class statics.