Construct the settings menu.
Readonly commandsThe command registry used by the menu.
Readonly nodeGet the DOM node owned by the widget.
Readonly rendererThe renderer used by the menu.
A signal emitted just before the menu is closed.
This signal is emitted when the menu receives a 'close-request'
message, just before it removes itself from the DOM.
This signal is not emitted if the menu is already detached from
the DOM when it receives the 'close-request' message.
Set the index of the currently active menu item.
If the item cannot be activated, the index will be set to -1.
The menu content node.
This is the node which holds the menu item 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.
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.
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 signal emitted when a new menu is requested by the user.
This signal is emitted whenever the user presses the right or left arrow keys, and a submenu cannot be opened or closed in response.
This signal is useful when implementing menu bars in order to open the next or previous menu in response to a user key press.
This signal is only emitted for the root menu in a hierarchy.
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.
Menu rank.
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.
Post an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Activate the next selectable item in the menu.
If no item is selectable, the index will be set to -1.
Activate the previous selectable item in the menu.
If no item is selectable, the index will be set to -1.
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.
Add a group of menu items specific to a particular plugin.
The rank can be set for all items in the group using the function argument or per item.
the list of menu items to add.
Optional rank: numberthe default rank in the menu in which to insert the group.
Disposable of the group
Add a menu item to the end of the menu.
The options for creating the menu item.
The menu item added to the menu.
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.
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.
Insert a menu item into the menu at the specified index.
The index at which to insert the item.
The options for creating the menu item.
The menu item added to the menu.
The index will be clamped to the bounds of the items.
Protected notifyInvoke 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.
Protected onProtected onA message handler invoked on an 'after-attach' message.
The default implementation of this handler is a no-op.
Protected onProtected onA message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on an 'after-show' message.
The default implementation of this handler is a no-op.
Protected onProtected onA message handler invoked on a 'before-detach' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
Protected 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 onA message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
Protected onA message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
Protected onOpen the menu at the specified location.
The client X coordinate of the menu location.
The client Y coordinate of the menu location.
Optional options: IOpenOptionsThe additional options for opening the menu.
The menu will be opened at the given location unless it will not fully fit on the screen. If it will not fit, it will be adjusted to fit naturally on the screen.
The menu will be attached under the host element in the DOM
(or document.body if host is null) and before the ref
element (or as the last child of host if ref is null).
The menu may be displayed outside of the host element
following the rules of CSS absolute positioning.
This is a no-op if the menu is already attached to the DOM.
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 an item from the menu.
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.
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.
Trigger the active menu item.
If the active item is a submenu, it will be opened and the first item will be activated.
If the active item is a command, the command will be executed.
If the menu is not attached, this is a no-op.
If there is no active item, this is a no-op.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
Static saveSave window data used for menu positioning in transient cache.
In order to avoid layout trashing it is recommended to invoke this method immediately prior to opening the menu and any DOM modifications (like closing previously visible menu, or adding a class to menu widget).
The transient cache will be released upon open() call.
An extensible Settings menu for the application.