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

    Class PreferencesScopeTabBar

    A contract for widgets that want to store and restore their inner state, between sessions.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    allowDeselect commandRegistry contextMenuRenderer currentSelection currentWorkspaceRoots editorScrollAtTop folderTitle insertBehavior labelProvider menuModelRegistry node onScopeChanged onScopeChangedEmitter preferencesMenuFactory removeBehavior renderer tabsMovable toDispose workspaceService ID

    Accessors

    addButtonEnabled addButtonNode addRequested contentNode currentChanged currentIndex currentScope currentTitle dataset disposed document hiddenMode id isAttached isDisposed isHidden isVisible layout name orientation parent tabActivateRequested tabCloseRequested tabDetachRequested tabMoved title titles titlesEditable

    Methods

    activate addClass addOrUpdateFolderTab addTab addTabIndexToTabs addUserTab addWorkspaceTab children clearFlag clearTabs close contains dispose doUpdateDisplay emitNewScope fit folderSelectionCallback getDetailsForResource getDetailsForScope getFolderContextMenu getWorkspaceDataset handleEvent hasClass hide init insertTab notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest openContextMenu processMessage releaseMouse removeClass removeTab removeTabAt restoreState setFlag setFolderTitleProperties setHidden setNewScopeSelection setScope setupInitialDisplay show storeState testFlag toDataSet toggleClass toggleShadow toScopeDetails update updateWorkspaceTab

    Constructors

    Properties

    allowDeselect: boolean

    Whether a tab can be deselected by the user.

    Tabs can be always be deselected programmatically.

    commandRegistry: CommandRegistry
    contextMenuRenderer: ContextMenuRenderer
    currentSelection: SelectedScopeDetails = Preference.DEFAULT_SCOPE
    currentWorkspaceRoots: FileStat[] = []
    editorScrollAtTop: boolean = true
    folderTitle: Title<Widget>
    insertBehavior: InsertBehavior

    The selection behavior when inserting a tab.

    labelProvider: LabelProvider
    menuModelRegistry: MenuModelRegistry
    node: HTMLElement

    Get the DOM node owned by the widget.

    onScopeChanged: Event<SelectedScopeDetails> = ...
    onScopeChangedEmitter: Emitter<SelectedScopeDetails> = ...
    preferencesMenuFactory: PreferenceScopeCommandManager
    removeBehavior: RemoveBehavior

    The selection behavior when removing a tab.

    renderer: TabBar.IRenderer<Widget>

    The renderer used by the tab bar.

    tabsMovable: boolean

    Whether the tabs are movable by the user.

    Tabs can always be moved programmatically.

    toDispose: DisposableCollection = ...
    workspaceService: WorkspaceService
    ID: string = 'preferences-scope-tab-bar'

    Accessors

    • get addButtonEnabled(): boolean

      Whether the add button is enabled.

      Returns boolean

    • set addButtonEnabled(value: boolean): void

      Set whether the add button is enabled.

      Parameters

      • value: boolean

      Returns void

    • get addButtonNode(): HTMLDivElement

      The tab bar add button node.

      This is the node which holds the add button.

      Modifying this node directly can lead to undefined behavior.

      Returns HTMLDivElement

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

      A signal emitted when the tab bar add button is clicked.

      Returns ISignal<this, void>

    • get contentNode(): HTMLUListElement

      The tab bar content node.

      This is the node which holds the tab nodes.

      Modifying this node directly can lead to undefined behavior.

      Returns HTMLUListElement

    • get currentChanged(): ISignal<this, TabBar.ICurrentChangedArgs<T>>

      A signal emitted when the current tab is changed.

      This signal is emitted when the currently selected tab is changed either through user or programmatic interaction.

      Notably, this signal is not emitted when the index of the current tab changes due to tabs being inserted, removed, or moved. It is only emitted when the actual current tab node is changed.

      Returns ISignal<this, TabBar.ICurrentChangedArgs<T>>

    • get currentIndex(): number

      Get the index of the currently selected tab.

      This will be -1 if no tab is selected.

      Returns number

    • set currentIndex(value: number): void

      Set the index of the currently selected tab.

      If the value is out of range, the index will be set to -1.

      Parameters

      • value: number

      Returns void

    • get currentTitle(): null | Title<T>

      Get the currently selected title.

      This will be null if no tab is selected.

      Returns null | Title<T>

    • set currentTitle(value: null | Title<T>): void

      Set the currently selected title.

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

      Parameters

      Returns void

    • 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 document(): Document | ShadowRoot

      The document to use with the tab bar.

      The default is the global document instance.

      Returns Document | ShadowRoot

    • 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

    • get name(): string

      Get the name of the tab bar.

      Returns string

    • set name(value: string): void

      Set the name of the tab bar.

      Parameters

      • value: string

      Returns void

    • get orientation(): TabBar.Orientation

      Get the orientation of the tab bar.

      This controls whether the tabs are arranged in a row or column.

      Returns TabBar.Orientation

    • set orientation(value: TabBar.Orientation): void

      Set the orientation of the tab bar.

      This controls whether the tabs are arranged in a row or column.

      Parameters

      Returns void

    • 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 tabActivateRequested(): ISignal<this, ITabActivateRequestedArgs<T>>

      A signal emitted when a tab is clicked by the user.

      If the clicked tab is not the current tab, the clicked tab will be made current and the currentChanged signal will be emitted first.

      This signal is emitted even if the clicked tab is the current tab.

      Returns ISignal<this, ITabActivateRequestedArgs<T>>

    • get tabCloseRequested(): ISignal<this, ITabCloseRequestedArgs<T>>

      A signal emitted when a tab close icon is clicked.

      This signal is not emitted unless the tab title is closable.

      Returns ISignal<this, ITabCloseRequestedArgs<T>>

    • get tabDetachRequested(): ISignal<this, ITabDetachRequestedArgs<T>>

      A signal emitted when a tab is dragged beyond the detach threshold.

      This signal is emitted when the user drags a tab with the mouse, and mouse is dragged beyond the detach threshold.

      The consumer of the signal should call releaseMouse and remove the tab in order to complete the detach.

      This signal is only emitted once per drag cycle.

      Returns ISignal<this, ITabDetachRequestedArgs<T>>

    • get tabMoved(): ISignal<this, ITabMovedArgs<T>>

      A signal emitted when a tab is moved by the user.

      This signal is emitted when a tab is moved by user interaction.

      This signal is not emitted when a tab is moved programmatically.

      Returns ISignal<this, ITabMovedArgs<T>>

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

    • get titles(): readonly Title<T>[]

      A read-only array of the titles in the tab bar.

      Returns readonly Title<T>[]

    • get titlesEditable(): boolean

      Whether the titles can be user-edited.

      Returns boolean

    • set titlesEditable(value: boolean): void

      Set whether titles can be user edited.

      Parameters

      • value: boolean

      Returns void

    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

    • 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 tabs from the tab 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.

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

      This is a simple convenience method for posting the message.

      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 tab into the tab bar at the specified index.

      Parameters

      • index: number

        The index at which to insert the tab.

      • value: Title<Widget> | Title.IOptions<Widget>

        The title which holds the data for the tab, or an options object to convert to a title.

      Returns Title<Widget>

      The title object added to the tab bar.

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

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

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

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

      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 a 'resize' message.

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

      Parameters

      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

    • Release the mouse and restore the non-dragged tab positions.

      This will cause the tab bar to stop handling mouse events and to restore the tabs to their non-dragged positions.

      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 tab from the tab bar.

      Parameters

      • title: Title<Widget>

        The title for the tab to remove.

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

      Returns void

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

      Parameters

      • index: number

        The index of the tab 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.

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