PreferenceTreeGenerator | Theia TypeDoc

Hierarchy

PreferenceTreeGenerator

Constructors

constructor

new PreferenceTreeGenerator(): PreferenceTreeGenerator

Returns PreferenceTreeGenerator

Properties

Protected _root

_root: CompositeTreeNode

Protected Readonly commonlyUsedPreferences

commonlyUsedPreferences: string[] = ...

Protected Readonly defaultTopLevelCategory

defaultTopLevelCategory: "extensions" = 'extensions'

handleChangedSchema

handleChangedSchema: DebouncedFunc<(() => void)> = ...

Readonly onSchemaChanged

onSchemaChanged: Event<CompositeTreeNode> = ...

Protected Readonly onSchemaChangedEmitter

onSchemaChangedEmitter: Emitter<CompositeTreeNode> = ...

Protected Readonly preferenceConfigs

preferenceConfigs: PreferenceConfigurations

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected Readonly sectionAssignments

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

Protected Readonly topLevelCategories

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

Accessors

root

get root(): CompositeTreeNode

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:76
Returns CompositeTreeNode

Methods

Protected createLeafNode

createLeafNode(property: string, preferencesGroup: Preference.CompositeTreeNode, data: PreferenceDataProperty): LeafNode

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:182
Parameters
- property: string
- preferencesGroup: Preference.CompositeTreeNode
- data: PreferenceDataProperty
Returns LeafNode

Protected createPreferencesGroup

createPreferencesGroup(id: string, group: string, root: CompositeTreeNode): Preference.CompositeTreeNode

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:195
Parameters
- id: string
- group: string
- root: CompositeTreeNode
Returns Preference.CompositeTreeNode

Protected createRootNode

createRootNode(): CompositeTreeNode

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:172
Returns CompositeTreeNode

doHandleChangedSchema

doHandleChangedSchema(): void

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:165
Returns void

Protected doInit

doInit(): Promise<void>

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:85
Returns Promise<void>

generateTree

generateTree(): CompositeTreeNode

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:91
Returns CompositeTreeNode

getCustomLabelFor

getCustomLabelFor(id: string): undefined | string

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:215
Parameters
- id: string
Returns undefined | string

Protected getGroupName

getGroupName(labels: string[]): string

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:145
Parameters
- labels: string[]
Returns string

getNodeId

getNodeId(preferenceId: string): string

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:139
Parameters
- preferenceId: string
Returns string

Protected getOrCreatePreferencesGroup

getOrCreatePreferencesGroup(id: string, group: string, root: CompositeTreeNode, groups: Map<string, Preference.CompositeTreeNode>): Preference.CompositeTreeNode

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:219
Parameters
- id: string
- group: string
- root: CompositeTreeNode
- groups: Map<string, Preference.CompositeTreeNode>
Returns Preference.CompositeTreeNode

Protected getSubgroupName

getSubgroupName(labels: string[], computedGroupName: string): undefined | string

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:157
Parameters
- labels: string[]
- computedGroupName: string
Returns undefined | string

Protected init

init(): void

- Defined in packages/preferences/src/browser/util/preference-tree-generator.ts:81
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PreferenceTreeGenerator

Properties

Protected _root

Protected Readonly commonlyUsedPreferences

Protected Readonly defaultTopLevelCategory

handleChangedSchema

Readonly onSchemaChanged

Protected Readonly onSchemaChangedEmitter

Protected Readonly preferenceConfigs

Protected Readonly schemaProvider

Protected Readonly sectionAssignments

Protected Readonly topLevelCategories

Accessors

root

Returns CompositeTreeNode

Methods

Protected createLeafNode

Parameters

property: string

preferencesGroup: Preference.CompositeTreeNode

data: PreferenceDataProperty

Returns LeafNode

Protected createPreferencesGroup

Parameters

id: string

group: string

root: CompositeTreeNode

Returns Preference.CompositeTreeNode

Protected createRootNode

Returns CompositeTreeNode

doHandleChangedSchema

Returns void

Protected doInit

Returns Promise<void>

generateTree

Returns CompositeTreeNode

getCustomLabelFor

Parameters

id: string

Returns undefined | string

Protected getGroupName

Parameters

labels: string[]

Returns string

getNodeId

Parameters

preferenceId: string

Returns string

Protected getOrCreatePreferencesGroup

Parameters

id: string

group: string

root: CompositeTreeNode

groups: Map<string, Preference.CompositeTreeNode>

Returns Preference.CompositeTreeNode

Protected getSubgroupName

Parameters

labels: string[]

computedGroupName: string

Returns undefined | string

Protected init

Returns void