Class FoldersPreferencesProvider

Hierarchy

PreferenceProvider
- FoldersPreferencesProvider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FoldersPreferencesProvider(): FoldersPreferencesProvider

Inherited from PreferenceProvider.constructor
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:49
Returns FoldersPreferencesProvider

Properties

Protected _pendingChanges

_pendingChanges: Promise<boolean>

Protected Readonly _ready

_ready: Deferred<void>

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected deferredChanges

deferredChanges: undefined | PreferenceProviderDataChanges

Protected fireDidPreferencesChanged

fireDidPreferencesChanged: () => Promise<boolean>

Type declaration

- (): Promise<boolean>
- Returns Promise<boolean>

Protected Readonly folderPreferenceProviderFactory

folderPreferenceProviderFactory: FolderPreferenceProviderFactory

Readonly onDidPreferencesChanged

onDidPreferencesChanged: Event<PreferenceProviderDataChanges>

Protected Readonly onDidPreferencesChangedEmitter

onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges>

Protected Readonly preferenceOverrideService

preferenceOverrideService: PreferenceLanguageOverrideService

Protected Readonly providers

providers: Map<string, FolderPreferenceProvider> = ...

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

pendingChanges

get pendingChanges(): Promise<boolean>

- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:54
Returns Promise<boolean>

ready

get ready(): Promise<void>

- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:102
Resolved when the preference provider is ready to provide preferences It should be resolved by subclasses.

Returns Promise<void>

Methods

Protected createProvider

createProvider(uri: default, section: string, folder: FileStat): FolderPreferenceProvider

- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:229
Parameters
- uri: default
- section: string
- folder: FileStat
Returns FolderPreferenceProvider

dispose

dispose(): void

Inherited from PreferenceProvider.dispose
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:51
Returns void

Protected emitPreferencesChangedEvent

emitPreferencesChangedEvent(changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]): Promise<boolean>

Inherited from PreferenceProvider.emitPreferencesChangedEvent
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:59
Informs the listeners that one or more preferences of this provider are changed. The listeners are able to find what was changed from the emitted event.

Parameters
- changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]
Returns Promise<boolean>

get

get<T>(preferenceName: string, resourceUri?: string): undefined | T

Inherited from PreferenceProvider.get
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:71
Retrieve the stored value for the given preference and resource URI.

Type parameters
- T
Parameters
- preferenceName: string
  
  the preference identifier.
- Optional resourceUri: string
  
  the uri of the resource for which the preference is stored. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.
Returns undefined | T

the value stored for the given preference and resourceUri if it exists, otherwise undefined.

getConfigUri

getConfigUri(resourceUri?: string, sectionName?: string): undefined | default

Overrides PreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:80
Parameters
- Optional resourceUri: string
- sectionName: string = ...
Returns undefined | default

getContainingConfigUri

getContainingConfigUri(resourceUri?: string, sectionName?: string): undefined | default

Overrides PreferenceProvider.getContainingConfigUri
- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:90
Parameters
- Optional resourceUri: string
- sectionName: string = ...
Returns undefined | default

getDomain

getDomain(): string[]

Overrides PreferenceProvider.getDomain
- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:100
Returns string[]

Protected getFolderProviders

getFolderProviders(resourceUri?: string): FolderPreferenceProvider[]

- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:207
Parameters
- Optional resourceUri: string
Returns FolderPreferenceProvider[]

Protected getParsedContent

getParsedContent(jsonData: any): {}

Inherited from PreferenceProvider.getParsedContent
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:130
Parameters
- jsonData: any
Returns {}
- [key: string]: any

getPreferences

getPreferences(resourceUri?: string): {}

Overrides PreferenceProvider.getPreferences
- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:120
Parameters
- Optional resourceUri: string
Returns {}
- [p: string]: any

Protected groupProvidersByConfigName

groupProvidersByConfigName(resourceUri?: string): Map<string, FolderPreferenceProvider[]>

- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:192
Parameters
- Optional resourceUri: string
Returns Map<string, FolderPreferenceProvider[]>

Protected init

init(): Promise<void>

- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:42
Returns Promise<void>

Protected mergePreferenceProviderDataChange

mergePreferenceProviderDataChange(change: PreferenceProviderDataChange): void

Inherited from PreferenceProvider.mergePreferenceProviderDataChange
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:60
Parameters
- change: PreferenceProviderDataChange
Returns void

resolve

resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T>

Overrides PreferenceProvider.resolve
- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:104
Type parameters
- T
Parameters
- preferenceName: string
- Optional resourceUri: string
Returns PreferenceResolveResult<T>

setPreference

setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean>

Overrides PreferenceProvider.setPreference
- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:135
Parameters
- preferenceName: string
- value: any
- Optional resourceUri: string
Returns Promise<boolean>

Protected updateProviders

updateProviders(): void

- Defined in packages/preferences/src/browser/folders-preferences-provider.ts:55
Returns void

Static deepEqual

deepEqual(a: undefined | null | string | number | boolean | JSONObject | JSONArray, b: undefined | null | string | number | boolean | JSONObject | JSONArray): boolean

Inherited from PreferenceProvider.deepEqual
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:129
Handles deep equality with the possibility of undefined

Parameters
- a: undefined | null | string | number | boolean | JSONObject | JSONArray
- b: undefined | null | string | number | boolean | JSONObject | JSONArray
Returns boolean

Static merge

merge(source: undefined | null | string | number | boolean | JSONObject | JSONArray, target: JSONValue): JSONValue

Inherited from PreferenceProvider.merge
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:125
Parameters
- source: undefined | null | string | number | boolean | JSONObject | JSONArray
- target: JSONValue
Returns JSONValue