Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TabGroups

Represents the main editor area which consists of multple groups which contain tabs.

Hierarchy

  • TabGroups

Index

Properties(4)

Methods(1)

Properties(4)

Readonly all

all: readonly TabGroup[]

All the groups within the group container.

Readonly activeTabGroup

activeTabGroup: TabGroup

The currently active group.

Readonly onDidChangeTabGroups

onDidChangeTabGroups: Event<TabGroupChangeEvent>

An event which fires when tab groups have changed.

Readonly onDidChangeTabs

onDidChangeTabs: Event<TabChangeEvent>

An event which fires when tabs have changed.

Methods(1)

close

  • Closes the tab. This makes the tab object invalid and the tab should no longer be used for further actions. Note: In the case of a dirty tab, a confirmation dialog will be shown which may be cancelled. If cancelled the tab is still valid

    Parameters

    • tab: Tab | readonly Tab[]

      The tab to close.

    • Optional preserveFocus: boolean

      When true focus will remain in its current position. If false it will jump to the next tab.

    Returns Thenable<boolean>

    A promise that resolves to true when all tabs have been closed.

  • Closes the tab group. This makes the tab group object invalid and the tab group should no longer be used for further actions.

    Parameters

    • tabGroup: TabGroup | readonly TabGroup[]

      The tab group to close.

    • Optional preserveFocus: boolean

      When true focus will remain in its current position.

    Returns Thenable<boolean>

    A promise that resolves to true when all tab groups have been closed.

Generated by TypeDoc. Maintained by 洛竹