Theia API Documentation v1.66.0
    Preparing search index...

    Class MenuBarWidgetAbstract

    A widget which displays menus as a canonical menu bar.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    node renderer

    Accessors

    activeIndex activeMenu childMenu contentNode dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible layout menus overflowIndex overflowMenu parent title

    Methods

    activate activateMenu 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 triggerMenuItem update

    Constructors

    Properties

    node: HTMLElement

    Get the DOM node owned by the widget.

    renderer: MenuBar.IRenderer

    The renderer used by the menu bar.

    Accessors

    • get activeIndex(): number

      Get the index of the currently active menu.

      This will be -1 if no menu is active.

      Returns number

    • set activeIndex(value: number): void

      Set the index of the currently active menu.

      If the menu cannot be activated, the index will be set to -1.

      Parameters

      • value: number

      Returns void

    • get activeMenu(): null | Menu

      Get the currently active menu.

      Returns null | Menu

    • set activeMenu(value: null | Menu): void

      Set the currently active menu.

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

      Parameters

      Returns void

    • get childMenu(): null | Menu

      The child menu of the menu bar.

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

      Returns null | Menu

    • get contentNode(): HTMLUListElement

      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.

      Returns HTMLUListElement

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

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

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get hiddenMode(): HiddenMode

      Get the method for hiding the widget.

      Returns HiddenMode

    • set hiddenMode(value: HiddenMode): void

      Set the method for hiding the widget.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): void

      Set the id of the widget's DOM node.

      Parameters

      • value: string

      Returns void

    • get isAttached(): boolean

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

      Returns boolean

    • get isDisposed(): boolean

      Test whether the widget has been disposed.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      Returns boolean

    • get isVisible(): boolean

      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.

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

    • set layout(value: null | Layout): void

      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.

      Parameters

      Returns void

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

      Returns readonly Menu[]

    • get overflowIndex(): number

      The overflow index of the menu bar.

      Returns number

    • get overflowMenu(): null | Menu

      The overflow menu of the menu bar.

      Returns null | Menu

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

    • set parent(value: null | Widget): void

      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.

      Parameters

      Returns void

    • get title(): Title<Widget>

      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.

      Returns Title<Widget>

    Methods

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

      This is a simple convenience method for posting the message.

      Returns void

    • Add a class name to the widget's DOM node.

      Parameters

      • name: string

        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.

      Returns void

    • Add a menu to the end of the menu bar.

      Parameters

      • menu: Menu

        The menu to add to the menu bar.

        If the menu is already added to the menu bar, it will be moved.

      • Optionalupdate: boolean

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      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.

      Parameters

      Returns void

    • Remove all menus from the menu bar.

      Returns void

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

      This is a simple convenience method for sending the message.

      Returns void

    • 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 of the resources held by the widget.

      Returns void

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

      This is a simple convenience method for posting the message.

      Returns void

    • Handle the DOM events for the menu bar.

      Parameters

      • event: Event

        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.

      Returns void

    • 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 the widget and make it hidden to its parent widget.

      This causes the isHidden property to be true.

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

      Returns 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.

        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.

      • Optionalupdate: boolean

      Returns void

    • Invoke the message processing routine of the widget's layout.

      Parameters

      • msg: Message

        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.

      Returns void

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

      Parameters

      Returns void

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

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

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

      Parameters

      Returns void

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

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

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

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

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

      Parameters

      Returns void

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

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

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

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

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

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'child-added' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'child-removed' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'close-request' message.

      The default implementation unparents or detaches the widget.

      Parameters

      Returns void

    • A message handler invoked on a 'fit-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

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

      Parameters

      Returns void

    • Open the active menu and activate its first menu item.

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

      Returns void

    • Process a message sent to the widget.

      Parameters

      • msg: Message

        The message sent to the widget.

        Subclasses may reimplement this method as needed.

      Returns void

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        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.

      Returns void

    • Remove a menu from the menu bar.

      Parameters

      • menu: Menu

        The menu to remove from the menu bar.

        This is a no-op if the menu is not in the menu bar.

      • Optionalupdate: boolean

      Returns void

    • Remove the menu at a given index from the menu bar.

      Parameters

      • index: number

        The index of the menu to remove.

        This is a no-op if the index is out of range.

      • Optionalupdate: boolean

      Returns void

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

        true to hide the widget, or false to show it.

        This is a convenience method for hide() and show().

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

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

      Returns void

    • Test whether the given widget flag is set.

      This will not typically be called directly by user code.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

      • Optionalforce: 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.

      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.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods