Class PreferencesScopeTabBar

Hierarchy

TabBar<Widget>
- PreferencesScopeTabBar

Implements

StatefulWidget

Constructors

constructor

new PreferencesScopeTabBar(options?): PreferencesScopeTabBar
Construct a new tab bar.
Parameters
- Optional options: IOptions<Widget>
  The options for initializing the tab bar.
Returns PreferencesScopeTabBar
Inherited from TabBar<Widget>.constructor
- Defined in node_modules/@phosphor/widgets/lib/tabbar.d.ts:20

Properties

`Protected` `Readonly` commandRegistry

commandRegistry: CommandRegistry

`Protected` `Readonly` contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

`Protected` currentSelection

currentSelection: SelectedScopeDetails = Preference.DEFAULT_SCOPE

`Protected` currentWorkspaceRoots

currentWorkspaceRoots: FileStat[] = []

`Protected` editorScrollAtTop

editorScrollAtTop: boolean = true

`Protected` folderTitle

folderTitle: Title<Widget>

`Protected` `Readonly` labelProvider

labelProvider: LabelProvider

`Protected` `Readonly` menuModelRegistry

menuModelRegistry: MenuModelRegistry

`Readonly` onScopeChanged

onScopeChanged: Event<SelectedScopeDetails> = ...

`Protected` `Readonly` onScopeChangedEmitter

onScopeChangedEmitter: Emitter<SelectedScopeDetails> = ...

`Protected` `Readonly` preferencesMenuFactory

preferencesMenuFactory: PreferenceScopeCommandManager

`Protected` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` workspaceService

workspaceService: WorkspaceService

`Static` ID

ID: string = 'preferences-scope-tab-bar'

Accessors

currentScope

get currentScope(): SelectedScopeDetails
Returns SelectedScopeDetails
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:70

Methods

`Protected` addOrUpdateFolderTab

addOrUpdateFolderTab(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:187

`Protected` addTabIndexToTabs

addTabIndexToTabs(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:141

`Protected` addUserTab

addUserTab(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:160

`Protected` addWorkspaceTab

addWorkspaceTab(currentWorkspace): Title<Widget>
Parameters
- currentWorkspace: FileStat
Returns Title<Widget>
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:169

dispose

dispose(): void
Returns void
Overrides TabBar.dispose
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:340

`Protected` doUpdateDisplay

doUpdateDisplay(newRoots): void
Parameters
- newRoots: FileStat[]
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:270

`Protected` emitNewScope

emitNewScope(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:295

`Protected` folderSelectionCallback

folderSelectionCallback(newScope): void
Parameters
- newScope: SelectedScopeDetails
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:233

`Protected` getDetailsForResource

getDetailsForResource(resource): undefined | SelectedScopeDetails
Parameters
- resource: URI
Returns undefined | SelectedScopeDetails
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:312

`Protected` getDetailsForScope

getDetailsForScope(scope): undefined | SelectedScopeDetails
Parameters
- scope: User | Workspace
Returns undefined | SelectedScopeDetails
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:306

`Protected` getFolderContextMenu

getFolderContextMenu(workspaceRoots?): void
Parameters
- workspaceRoots: FileStat[] = ...
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:235

`Protected` getWorkspaceDataset

getWorkspaceDataset(currentWorkspace): SelectedScopeDetails
Parameters
- currentWorkspace: FileStat
Returns SelectedScopeDetails
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:181

handleEvent

handleEvent(): void
Returns void
Overrides TabBar.handleEvent
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:239

`Protected` init

init(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:88

`Protected` onUpdateRequest

onUpdateRequest(msg): void
Parameters
- msg: Message
Returns void
Overrides TabBar.onUpdateRequest
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:136

`Protected` openContextMenu

openContextMenu(tabRect, folderTabNode, source): void
Parameters
- tabRect: DOMRect | ClientRect
- folderTabNode: HTMLElement
- source: "click" | "keypress"
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:243

restoreState

restoreState(oldState): void
Parameters
- oldState: PreferencesScopeTabBarState
Returns void
Implementation of StatefulWidget.restoreState
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:329

`Protected` setFolderTitleProperties

setFolderTitleProperties(multipleFolderRootsAreAvailable): void
Parameters
- multipleFolderRootsAreAvailable: boolean
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:217

`Protected` setNewScopeSelection

setNewScopeSelection(newSelection): void
Parameters
- newSelection: SelectedScopeDetails
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:74

setScope

setScope(scope): void
Parameters
- scope: URI | User | Workspace
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:299

`Protected` setupInitialDisplay

setupInitialDisplay(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:128

storeState

storeState(): PreferencesScopeTabBarState
Returns PreferencesScopeTabBarState
Implementation of StatefulWidget.storeState
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:323

`Protected` toDataSet

toDataSet(scopeDetails): Dataset
Parameters
- scopeDetails: SelectedScopeDetails
Returns Dataset
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:119

`Protected` toScopeDetails

toScopeDetails(title?): undefined | SelectedScopeDetails
Parameters
- Optional title: SelectedScopeDetails | Title<Widget>
Returns undefined | SelectedScopeDetails
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:107

toggleShadow

toggleShadow(showShadow): void
Parameters
- showShadow: boolean
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:336

`Protected` updateWorkspaceTab

updateWorkspaceTab(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-scope-tabbar-widget.tsx:283