Class PreferencesContribution

An abstract superclass for frontend contributions that add a view to the application shell.

Hierarchy (View Summary)

AbstractViewContribution<PreferencesWidget>
- PreferencesContribution

Constructors

constructor

new PreferencesContribution(): PreferencesContribution
Returns PreferencesContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/preferences/src/browser/preferences-contribution.ts:51

Properties

`Protected` `Readonly`clipboardService

clipboardService: ClipboardService

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`quickInputService

quickInputService: QuickInputService

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`scopeTracker

scopeTracker: PreferencesWidget

`Protected` `Readonly`shell

shell: ApplicationShell

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:35

Methods

closeView

closeView(): Promise<undefined | PreferencesWidget>
Returns Promise<undefined | PreferencesWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

`Protected`openFolderPreferences

openFolderPreferences(callback: (root: FileStat) => unknown): Promise<void>
Prompts which workspace root folder to open the JSON settings.
Parameters
- callback: (root: FileStat) => unknown
Returns Promise<void>
- Defined in packages/preferences/src/browser/preferences-contribution.ts:217

`Protected`openJson

openJson(scope: PreferenceScope, resource?: string): Promise<void>
Parameters
- scope: PreferenceScope
- Optionalresource: string
Returns Promise<void>
- Defined in packages/preferences/src/browser/preferences-contribution.ts:207

`Protected`openPreferencesJSON

openPreferencesJSON(opener: string | PreferencesWidget): Promise<void>
Parameters
- opener: string | PreferencesWidget
Returns Promise<void>
- Defined in packages/preferences/src/browser/preferences-contribution.ts:180

openView

openView(args?: Partial<OpenViewArguments>): Promise<PreferencesWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<PreferencesWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/preferences/src/browser/preferences-contribution.ts:61

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/preferences/src/browser/preferences-contribution.ts:164

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/preferences/src/browser/preferences-contribution.ts:136

registerToolbarItems

registerToolbarItems(toolbar: TabBarToolbarRegistry): void
Parameters
- toolbar: TabBarToolbarRegistry
Returns void
- Defined in packages/preferences/src/browser/preferences-contribution.ts:171

toggleView

toggleView(): Promise<PreferencesWidget>
Returns Promise<PreferencesWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:40

tryGetWidget

tryGetWidget(): undefined | PreferencesWidget
Returns undefined | PreferencesWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

`Protected`withWidget

withWidget<T>(
widget?: undefined | Widget,
fn: (widget: PreferencesWidget) => T,
): false | T
Determine if the current widget is the PreferencesWidget.
Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- fn: (widget: PreferencesWidget) => T
Returns false | T
- Defined in packages/preferences/src/browser/preferences-contribution.ts:250