Class PreferencesEditorWidget

Hierarchy

BaseWidget
- PreferencesEditorWidget

Implements

StatefulWidget

Constructors

constructor

new PreferencesEditorWidget(options?): PreferencesEditorWidget
Parameters
- Optional options: IOptions
Returns PreferencesEditorWidget
Inherited from BaseWidget.constructor
- Defined in packages/core/lib/browser/widgets/widget.d.ts:59

Properties

`Protected` commonlyUsedRenderers

commonlyUsedRenderers: Map<string, GeneralPreferenceNodeRenderer> = ...

`Protected` currentModelSelectionId

currentModelSelectionId: string = ''

Guards against scroll events and selection events looping into each other. Set before this widget initiates a selection.

`Protected` firstVisibleChildID

firstVisibleChildID: string = ''

`Protected` isAtScrollTop

isAtScrollTop: boolean = true

`Protected` lastUserSelection

lastUserSelection: string = ''

Permits the user to expand multiple nodes without each one being collapsed on a new selection.

`Protected` `Readonly` model

model: PreferenceTreeModel

onScroll

onScroll: DebouncedFuncLeading<any> = ...

`Protected` preferenceDataKeys

preferenceDataKeys: Map<string, string> = ...

`Protected` `Readonly` preferenceService

preferenceService: PreferenceService

`Protected` `Readonly` rendererFactory

rendererFactory: PreferenceNodeRendererFactory

`Protected` `Readonly` rendererRegistry

rendererRegistry: PreferenceNodeRendererCreatorRegistry

`Protected` renderers

renderers: Map<string, GeneralPreferenceNodeRenderer> = ...

`Protected` `Readonly` schemaProvider

schemaProvider: PreferenceSchemaProvider

`Protected` scrollContainer

scrollContainer: HTMLDivElement

scrollOptions

scrollOptions: Options = DEFAULT_SCROLL_OPTIONS

`Protected` `Readonly` tabbar

tabbar: PreferencesScopeTabBar

`Static` `Readonly` ID

ID: "settings.editor" = 'settings.editor'

`Static` `Readonly` LABEL

LABEL: "Settings Editor" = 'Settings Editor'

Methods

`Protected` allRenderers

allRenderers(): IterableIterator<[string, GeneralPreferenceNodeRenderer, Map<string, GeneralPreferenceNodeRenderer>]>
Returns IterableIterator<[string, GeneralPreferenceNodeRenderer, Map<string, GeneralPreferenceNodeRenderer>]>
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:195

`Protected` analyzeIDAndGetRendererGroup

analyzeIDAndGetRendererGroup(nodeID): {
    collection: Map<string, GeneralPreferenceNodeRenderer>;
    group: string;
    id: string;
}
Parameters
- nodeID: string
Returns {
    collection: Map<string, GeneralPreferenceNodeRenderer>;
    group: string;
    id: string;
}
- collection: Map<string, GeneralPreferenceNodeRenderer>
- group: string
- id: string
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:329

`Protected` doResetScroll

doResetScroll(nodeIDToScrollTo?, filterWasCleared?): void
Parameters
- Optional nodeIDToScrollTo: string
- filterWasCleared: boolean = false
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:238

`Protected` findFirstVisibleChildID

findFirstVisibleChildID(): undefined | string
Returns undefined | string
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:268

`Protected` getScrollContainer

getScrollContainer(): HTMLElement
Returns HTMLElement
Overrides BaseWidget.getScrollContainer
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:335

`Protected` handleDisplayChange

handleDisplayChange(e): void
Parameters
- e: PreferenceFilterChangeEvent
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:107

`Protected` handlePreferenceChanges

handlePreferenceChanges(e): void
Parameters
- e: PreferenceChanges
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:204

`Protected` handleRegistryChange

handleRegistryChange(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:123

`Protected` handleSchemaChange

handleSchemaChange(isFiltered): void
Parameters
- isFiltered: boolean
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:131

`Protected` handleScopeChange

handleScopeChange(isFiltered?): void
Parameters
- isFiltered: boolean = ...
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:164

`Protected` handleSearchChange

handleSearchChange(isFiltered, leavesAreVisible): void
Parameters
- isFiltered: boolean
- leavesAreVisible: boolean
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:177

`Protected` handleSelectionChange

handleSelectionChange(selectionEvent): void
Parameters
- selectionEvent: readonly Readonly<SelectableTreeNode>[]
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:305

`Protected` hasSchemaChanged

hasSchemaChanged(renderer, node): boolean
Parameters
- renderer: GeneralPreferenceNodeRenderer
- node: LeafNode
Returns boolean
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:173

`Protected` hideIfFailsFilters

hideIfFailsFilters(renderer, isFiltered): boolean
Parameters
- renderer: GeneralPreferenceNodeRenderer
- isFiltered: boolean
Returns boolean
true if the renderer is hidden, false otherwise.
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:214

`Protected` init

init(): void
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:75

`Protected` resetScroll

resetScroll(nodeIDToScrollTo?, filterWasCleared?): void
Parameters
- Optional nodeIDToScrollTo: string
- filterWasCleared: boolean = false
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:225

restoreState

restoreState(oldState): void
Parameters
- oldState: PreferencesEditorState
Returns void
Implementation of StatefulWidget.restoreState
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:345

`Protected` setFirstVisibleChildID

setFirstVisibleChildID(id?): void
Parameters
- Optional id: string
Returns void
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:278

storeState

storeState(): PreferencesEditorState
Returns PreferencesEditorState
Implementation of StatefulWidget.storeState
- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:339

Class PreferencesEditorWidget

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PreferencesEditorWidget

Properties

Protected commonlyUsedRenderers

Protected currentModelSelectionId

Protected firstVisibleChildID

Protected isAtScrollTop

Protected lastUserSelection

Protected Readonly model

onScroll

Protected preferenceDataKeys

Protected Readonly preferenceService

Protected Readonly rendererFactory

Protected Readonly rendererRegistry

Protected renderers

Protected Readonly schemaProvider

Protected scrollContainer

scrollOptions

Protected Readonly tabbar

Static Readonly ID

Static Readonly LABEL

Methods

Protected allRenderers

Returns IterableIterator<[string, GeneralPreferenceNodeRenderer, Map<string, GeneralPreferenceNodeRenderer>]>

Protected analyzeIDAndGetRendererGroup

Parameters

Returns { collection: Map<string, GeneralPreferenceNodeRenderer>; group: string; id: string; }

collection: Map<string, GeneralPreferenceNodeRenderer>

group: string

id: string

Protected areLeavesVisible

Returns boolean

Protected createContainers

Returns void

Protected doInit

Returns Promise<void>

Protected doOnScroll

Returns void

Protected doResetScroll

Parameters

Returns void

Protected findFirstVisibleChildID

Returns undefined | string

Protected getScrollContainer

Returns HTMLElement

Protected handleDisplayChange

Parameters

Returns void

Protected handlePreferenceChanges

Parameters

Returns void

Protected handleRegistryChange

Returns void

Protected handleSchemaChange

Parameters

Returns void

Protected handleScopeChange

Parameters

Returns void

Protected handleSearchChange

Parameters

Returns void

Protected handleSelectionChange

Parameters

Returns void

Protected hasSchemaChanged

Parameters

Returns boolean

Protected hideIfFailsFilters

Parameters

Returns boolean

`Protected` commonlyUsedRenderers

`Protected` currentModelSelectionId

`Protected` firstVisibleChildID

`Protected` isAtScrollTop

`Protected` lastUserSelection

`Protected` `Readonly` model

`Protected` preferenceDataKeys

`Protected` `Readonly` preferenceService

`Protected` `Readonly` rendererFactory

`Protected` `Readonly` rendererRegistry

`Protected` renderers

`Protected` `Readonly` schemaProvider

`Protected` scrollContainer

`Protected` `Readonly` tabbar

`Static` `Readonly` ID

`Static` `Readonly` LABEL

`Protected` allRenderers

`Protected` analyzeIDAndGetRendererGroup

Returns {
collection: Map<string, GeneralPreferenceNodeRenderer>;
group: string;
id: string;
}

`Protected` areLeavesVisible

`Protected` createContainers

`Protected` doInit

`Protected` doOnScroll

`Protected` doResetScroll

`Protected` findFirstVisibleChildID

`Protected` getScrollContainer

`Protected` handleDisplayChange

`Protected` handlePreferenceChanges

`Protected` handleRegistryChange

`Protected` handleSchemaChange

`Protected` handleScopeChange

`Protected` handleSearchChange

`Protected` handleSelectionChange

`Protected` hasSchemaChanged

`Protected` hideIfFailsFilters

`Protected` init

`Protected` resetScroll

`Protected` setFirstVisibleChildID