Class MainMenu

The main menu class. It is intended to be used as a singleton.

Hierarchy

  • MenuBar
    • MainMenu

Implements

Constructors

constructor

Properties

_commands _editMenu _fileMenu _helpMenu _items _kernelMenu _runMenu _settingsMenu _tabsMenu _viewMenu node renderer

Accessors

activeIndex activeMenu childMenu contentNode dataset disposed editMenu fileMenu helpMenu hiddenMode id isAttached isDisposed isHidden isVisible kernelMenu layout menus overflowIndex overflowMenu parent runMenu settingsMenu tabsMenu title viewMenu

Methods

_onMenuDisposed 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 generateMenu

Constructors

constructor

Properties

Private _commands

_commands: CommandRegistry

Private _editMenu

_editMenu: EditMenu

Private _fileMenu

_fileMenu: FileMenu

Private _helpMenu

_helpMenu: HelpMenu

Private _items

_items: IRankItem[] = []

Private _kernelMenu

_kernelMenu: KernelMenu

Private _runMenu

_runMenu: RunMenu

Private _settingsMenu

_settingsMenu: SettingsMenu

Private _tabsMenu

_tabsMenu: TabsMenu

Private _viewMenu

_viewMenu: ViewMenu

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Readonly renderer

renderer: 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

  • 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

activeMenu

  • get activeMenu(): null | Menu

  • Get the currently active menu.

    Returns null | Menu

  • set activeMenu(value): void

  • Set the currently active menu.

    Notes

    If the menu does not exist, the menu will be set to null.

    Parameters

    Returns void

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

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

  • get dataset(): DOMStringMap

  • The dataset for the widget's DOM node.

    Returns DOMStringMap

disposed

  • get disposed(): ISignal<this, void>

  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

editMenu

fileMenu

helpMenu

hiddenMode

  • get hiddenMode(): HiddenMode

  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void

  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

id

  • get id(): string

  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void

  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean

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

    Returns boolean

isDisposed

  • get isDisposed(): boolean

  • Test whether the widget has been disposed.

    Returns boolean

isHidden

  • get isHidden(): boolean

  • Test whether the widget is explicitly hidden.

    Returns boolean

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

kernelMenu

layout

  • get layout(): null | Layout

  • Get the layout for the widget.

    Returns null | Layout

  • 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

menus

  • A read-only array of the menus in the menu bar.

    Returns readonly Menu[]

overflowIndex

  • get overflowIndex(): number

  • The overflow index of the menu bar.

    Returns number

overflowMenu

  • get overflowMenu(): null | Menu

  • The overflow menu of the menu bar.

    Returns null | Menu

parent

  • get parent(): null | Widget

  • Get the parent of the widget.

    Returns null | Widget

  • 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

    Returns void

runMenu

settingsMenu

tabsMenu

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>

viewMenu

Methods

Private _onMenuDisposed

activate

  • activate(): void

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

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

addMenu

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.

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

clearMenus

  • clearMenus(): void

  • Remove all menus from the menu bar.

    Returns void

close

  • close(): void

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

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.

dispose

fit

  • fit(): void

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

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

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.

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

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.

    • Optional update: boolean

    Returns void

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

Protected onActivateRequest

  • onActivateRequest(msg): void

  • A message handler invoked on an 'activate-request' message.

    Parameters

    • msg: Message

    Returns void

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

Protected onAfterDetach

  • onAfterDetach(msg): void

  • A message handler invoked on an 'after-detach' message.

    Parameters

    • msg: Message

    Returns void

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

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

Protected onBeforeAttach

  • onBeforeAttach(msg): void

  • A message handler invoked on a 'before-attach' message.

    Parameters

    • msg: Message

    Returns void

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

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

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

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

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

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

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

Protected onResize

  • onResize(msg): void

  • A message handler invoked on a 'resize' message.

    Parameters

    • msg: ResizeMessage

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg): void

  • A message handler invoked on an 'update-request' message.

    Parameters

    • msg: Message

    Returns void

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

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

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

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.

    • Optional update: boolean

    Returns void

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.

    • Optional update: boolean

    Returns void

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

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

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

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

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.

update

  • update(): void

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Static generateMenu

Settings

Member Visibility

Theme

On This Page

constructor_commands_editMenu_fileMenu_helpMenu_items_kernelMenu_runMenu_settingsMenu_tabsMenu_viewMenunoderendereractiveIndexactiveMenuchildMenucontentNodedatasetdisposededitMenufileMenuhelpMenuhiddenModeidisAttachedisDisposedisHiddenisVisiblekernelMenulayoutmenusoverflowIndexoverflowMenuparentrunMenusettingsMenutabsMenutitleviewMenu_onMenuDisposedactivateaddClassaddMenuchildrenclearFlagclearMenusclosecontainsdisposefithandleEventhasClasshideinsertMenunotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonFitRequestonResizeonUpdateRequestopenActiveMenuprocessMessageremoveClassremoveMenuremoveMenuAtsetFlagsetHiddenshowtestFlagtoggleClassupdategenerateMenu