Class PreferencesContribution

Hierarchy

AbstractViewContribution<PreferencesWidget>
- PreferencesContribution

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PreferencesContribution(): PreferencesContribution

Overrides AbstractViewContribution<PreferencesWidget>.constructor
- Defined in packages/preferences/src/browser/preferences-contribution.ts:54
Returns PreferencesContribution

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 workspacePreferenceProvider

workspacePreferenceProvider: WorkspacePreferenceProvider

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

defaultViewOptions

get defaultViewOptions(): WidgetOptions

- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:49
Returns WidgetOptions

viewId

get viewId(): string

- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:47
Returns string

viewLabel

get viewLabel(): string

- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:48
Returns string

widget

get widget(): Promise<T>

- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:50
Returns Promise<T>

Methods

closeView

closeView(): Promise<undefined | PreferencesWidget>

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

Private obtainConfigUri

obtainConfigUri(serializedScope: number, activeScopeIsFolder: boolean, resource?: string): Promise<undefined | default>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:236
Parameters
- serializedScope: number
- activeScopeIsFolder: boolean
- Optional resource: string
Returns Promise<undefined | default>

Protected openFolderPreferences

openFolderPreferences(callback: (root: FileStat) => unknown): Promise<void>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:222
Prompts which workspace root folder to open the JSON settings.

Parameters
- callback: (root: FileStat) => unknown
  - - (root: FileStat): unknown
    - Parameters
      - root: FileStat
      Returns unknown
Returns Promise<void>

Protected openJson

openJson(scope: PreferenceScope, resource?: string): Promise<void>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:212
Parameters
- scope: PreferenceScope
- Optional resource: string
Returns Promise<void>

Protected openPreferencesJSON

openPreferencesJSON(opener: string | PreferencesWidget): Promise<void>

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

openView

openView(args?: Partial<OpenViewArguments>): Promise<PreferencesWidget>

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

registerCommands

registerCommands(commands: CommandRegistry): void

Overrides AbstractViewContribution.registerCommands
- Defined in packages/preferences/src/browser/preferences-contribution.ts:66
Parameters
- commands: CommandRegistry
Returns void

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void

Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/preferences/src/browser/preferences-contribution.ts:169
Parameters
- keybindings: KeybindingRegistry
Returns void

registerMenus

registerMenus(menus: MenuModelRegistry): void

Overrides AbstractViewContribution.registerMenus
- Defined in packages/preferences/src/browser/preferences-contribution.ts:141
Parameters
- menus: MenuModelRegistry
Returns void

registerToolbarItems

registerToolbarItems(toolbar: TabBarToolbarRegistry): void

- Defined in packages/preferences/src/browser/preferences-contribution.ts:176
Parameters
- toolbar: TabBarToolbarRegistry
Returns void

toggleView

toggleView(): Promise<PreferencesWidget>

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

tryGetWidget

tryGetWidget(): undefined | PreferencesWidget

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

Protected withWidget

withWidget<T>(widget?: undefined | Widget, fn: (widget: PreferencesWidget) => T): false | T

- Defined in packages/preferences/src/browser/preferences-contribution.ts:255
Determine if the current widget is the PreferencesWidget.

Type parameters
- T
Parameters
- widget: undefined | Widget = ...
- fn: (widget: PreferencesWidget) => T
  - - (widget: PreferencesWidget): T
    - Parameters
      - widget: PreferencesWidget
      Returns T
Returns false | T