PreferencesEditorWidget | Theia TypeDoc

Hierarchy

BaseWidget
- PreferencesEditorWidget

Implements

StatefulWidget

Constructors

constructor

new PreferencesEditorWidget(options?: IOptions): PreferencesEditorWidget

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

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: DebouncedFunc<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>]>

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

Protected analyzeIDAndGetRendererGroup

analyzeIDAndGetRendererGroup(nodeID: string): { collection: Map<string, GeneralPreferenceNodeRenderer>; group: string; id: string }

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

Protected areLeavesVisible

areLeavesVisible(): boolean

- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:188
Returns boolean

Protected createContainers

createContainers(): void

- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:95
Returns void

Protected doInit

doInit(): Promise<void>

- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:79
Returns Promise<void>

Protected doOnScroll

doOnScroll(): void

- Defined in packages/preferences/src/browser/views/preference-editor-widget.ts:253
Returns void

Protected doResetScroll

doResetScroll(nodeIDToScrollTo?: string, filterWasCleared?: boolean): void

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

Protected findFirstVisibleChildID

findFirstVisibleChildID(): undefined | string

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

Protected getScrollContainer

getScrollContainer(): HTMLElement

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

Protected handleDisplayChange

handleDisplayChange(e: PreferenceFilterChangeEvent): void

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

Protected handlePreferenceChanges

handlePreferenceChanges(e: PreferenceChanges): void

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

Protected handleRegistryChange

handleRegistryChange(): void

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

Protected handleSchemaChange

handleSchemaChange(isFiltered: boolean): void

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

Protected handleScopeChange

handleScopeChange(isFiltered?: boolean): void

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

Protected handleSearchChange

handleSearchChange(isFiltered: boolean, leavesAreVisible: boolean): void

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

Protected handleSelectionChange

handleSelectionChange(selectionEvent: readonly Readonly<SelectableTreeNode>[]): void

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

Protected hasSchemaChanged

hasSchemaChanged(renderer: GeneralPreferenceNodeRenderer, node: LeafNode): boolean

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

Protected hideIfFailsFilters

hideIfFailsFilters(renderer: GeneralPreferenceNodeRenderer, isFiltered: boolean): boolean

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

Protected init

init(): void

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

Protected resetScroll

resetScroll(nodeIDToScrollTo?: string, filterWasCleared?: boolean): void

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

restoreState

restoreState(oldState: PreferencesEditorState): void

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

Protected setFirstVisibleChildID

setFirstVisibleChildID(id?: string): void

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

storeState

storeState(): PreferencesEditorState

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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: IOptions

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

nodeID: string

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

Optional nodeIDToScrollTo: string

filterWasCleared: boolean = false

Returns void

Protected findFirstVisibleChildID

Returns undefined | string

Protected getScrollContainer

Returns HTMLElement

Protected handleDisplayChange

Parameters

e: PreferenceFilterChangeEvent

Returns void

Protected handlePreferenceChanges

Parameters

e: PreferenceChanges

Returns void

Protected handleRegistryChange

Returns void

Protected handleSchemaChange

Parameters

isFiltered: boolean

Returns void

Protected handleScopeChange

Parameters

isFiltered: boolean = ...

Returns void

Protected handleSearchChange

Parameters

isFiltered: boolean

leavesAreVisible: boolean

Returns void