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

    Class Menu

    A widget which displays items as a canonical menu.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    commands node renderer

    Accessors

    aboutToClose activeIndex activeItem childMenu contentNode dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible items layout leafMenu menuRequested parent parentMenu rootMenu title

    Methods

    activate activateNextItem activatePreviousItem addClass addItem children clearFlag clearItems close contains dispose fit handleEvent hasClass hide insertItem notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest open processMessage removeClass removeItem removeItemAt setFlag setHidden show testFlag toggleClass triggerActiveItem update saveWindowData

    Constructors

    Properties

    commands: CommandRegistry

    The command registry used by the menu.

    node: HTMLElement

    Get the DOM node owned by the widget.

    renderer: Menu.IRenderer

    The renderer used by the menu.

    Accessors

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

      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.

      Returns ISignal<this, void>

    • get activeIndex(): number

      Get the index of the currently active menu item.

      This will be -1 if no menu item is active.

      Returns number

    • set activeIndex(value: number): void

      Set the index of the currently active menu item.

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

      Parameters

      • value: number

      Returns void

    • get activeItem(): null | Menu.IItem

      Get the currently active menu item.

      Returns null | Menu.IItem

    • set activeItem(value: null | Menu.IItem): void

      Set the currently active menu item.

      If the item cannot be activated, the item will be set to null.

      Parameters

      Returns void

    • get childMenu(): null | Menu

      The child menu of the menu.

      This is null unless the menu has an open submenu.

      Returns null | Menu

    • get contentNode(): HTMLUListElement

      The menu content node.

      This is the node which holds the menu item 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 items(): readonly Menu.IItem[]

      A read-only array of the menu items in the menu.

      Returns readonly Menu.IItem[]

    • 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

    • get leafMenu(): Menu

      The leaf menu of the menu hierarchy.

      Returns Menu

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

      Returns ISignal<this, "next" | "previous">

    • 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 parentMenu(): null | Menu

      The parent menu of the menu.

      This is null unless the menu is an open submenu.

      Returns null | Menu

    • get rootMenu(): Menu

      The root menu of the menu hierarchy.

      Returns Menu

    • 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

    • Activate the next selectable item in the menu.

      If no item is selectable, the index will be set to -1.

      Returns void

    • Activate the previous selectable item in the menu.

      If no item is selectable, the index will be set to -1.

      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 item to the end of the menu.

      Parameters

      Returns Menu.IItem

      The menu item added to the menu.

    • 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 menu items from the menu.

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

      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.

      Parameters

      • event: Event

        The DOM event sent to the menu.

        This method implements the DOM EventListener interface and is called in response to events on the menu'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 item into the menu at the specified index.

      Parameters

      • index: number

        The index at which to insert the item.

      • options: Menu.IItemOptions

        The options for creating the menu item.

      Returns Menu.IItem

      The menu item added to the menu.

      The index will be clamped to the bounds of the items.

    • 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 a 'after-attach' message.

      Parameters

      Returns void

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

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

      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.

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

      Parameters

      Returns void

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

      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.

      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 a 'resize' 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 menu at the specified location.

      Parameters

      • x: number

        The client X coordinate of the menu location.

      • y: number

        The client Y coordinate of the menu location.

      • Optionaloptions: IOpenOptions

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

      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 an item from the menu.

      Parameters

      • item: Menu.IItem

        The item to remove from the menu.

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

      Returns void

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

      Parameters

      • index: number

        The index of the item to remove.

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

      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.

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

      Returns void

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

      This is a simple convenience method for posting the message.

      Returns void

    • Save 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.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods