PreferenceLeafNodeRenderer

Type Parameters

ValueType extends JSONValue
InteractableType extends HTMLElement

Hierarchy

PreferenceNodeRenderer
- PreferenceLeafNodeRenderer

Implements

Required<GeneralPreferenceNodeRenderer>

Index

Constructors

constructor

Accessors

Constructors

constructor

new PreferenceLeafNodeRenderer<ValueType, InteractableType>(): PreferenceLeafNodeRenderer<ValueType, InteractableType>

Inherited from PreferenceNodeRenderer.constructor
Type Parameters
- ValueType extends JSONValue
- InteractableType extends HTMLElement
Returns PreferenceLeafNodeRenderer<ValueType, InteractableType>

Properties

_group

_group: string

_id

_id: string

_subgroup

_subgroup: string

Protected attached

attached: boolean = false

Protected domNode

domNode: HTMLElement

Protected gutter

gutter: HTMLDivElement

Protected headlineWrapper

headlineWrapper: HTMLDivElement

Protected inspection

inspection: undefined | PreferenceInspection<ValueType>

Protected interactable

interactable: InteractableType

Protected isModifiedFromDefault

isModifiedFromDefault: boolean = false

Protected Readonly labelProvider

labelProvider: PreferenceTreeLabelProvider

Protected markdownRenderer

markdownRenderer: MarkdownIt

Protected Readonly menuRenderer

menuRenderer: ContextMenuRenderer

Protected Readonly model

model: PreferenceTreeModel

Protected Readonly openerService

openerService: OpenerService

Protected Readonly preferenceNode

preferenceNode: LeafNode

Protected Readonly preferenceService

preferenceService: PreferenceService

Protected Readonly scopeTracker

scopeTracker: PreferencesScopeTabBar

Protected Readonly searchbar

searchbar: PreferencesSearchbarWidget

Protected setPreferenceWithDebounce

setPreferenceWithDebounce: DebouncedFunc<any> = ...

Accessors

group

get group(): string

Implementation of Required.group
Inherited from PreferenceNodeRenderer.group
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:81
Returns string

id

get id(): string

Implementation of Required.id
Inherited from PreferenceNodeRenderer.id
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:77
Returns string

node

get node(): HTMLElement

Implementation of Required.node
Inherited from PreferenceNodeRenderer.node
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:69
Returns HTMLElement

nodeId

get nodeId(): string

Implementation of Required.nodeId
Inherited from PreferenceNodeRenderer.nodeId
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:73
Returns string

schema

get schema(): PreferenceDataProperty

Implementation of Required.schema
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:174
Returns PreferenceDataProperty

visible

get visible(): boolean

Implementation of Required.visible
Inherited from PreferenceNodeRenderer.visible
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:85
Returns boolean

Methods

Protected addEventHandlerToModifiedScope

addEventHandlerToModifiedScope(scope: PreferenceScope, scopeWrapper: HTMLElement): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:427
Parameters
- scope: PreferenceScope
- scopeWrapper: HTMLElement
Returns void

Protected addModifiedMarking

addModifiedMarking(): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:304
Returns void

appendTo

appendTo(parent: HTMLElement): void

Implementation of Required.appendTo
Inherited from PreferenceNodeRenderer.appendTo
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:118
Parameters
- parent: HTMLElement
Returns void

Protected buildMarkdownRenderer

buildMarkdownRenderer(): MarkdownIt

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:191
Returns MarkdownIt

Protected compareOtherModifiedScopes

compareOtherModifiedScopes(headlineWrapper: HTMLDivElement, currentSuffix: HTMLElement): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:364
Parameters
- headlineWrapper: HTMLDivElement
- currentSuffix: HTMLElement
Returns void

Protected createDomNode

createDomNode(): HTMLLIElement

Overrides PreferenceNodeRenderer.createDomNode
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:229
Returns HTMLLIElement

Protected Abstract createInteractable

createInteractable(container: HTMLElement): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:494
Should create an HTML element that the user can interact with to change the value of the preference.

Parameters
- container: HTMLElement
  
  the parent element for the interactable. This method is responsible for adding the new element to its parent.
Returns void

Protected createModifiedScopeMessage

createModifiedScopeMessage(scope: PreferenceScope): HTMLSpanElement

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:411
Parameters
- scope: PreferenceScope
Returns HTMLSpanElement

Protected createOtherModifiedScopes

createOtherModifiedScopes(headlineWrapper: HTMLDivElement): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:392
Parameters
- headlineWrapper: HTMLDivElement
Returns void

dispose

dispose(): void

Implementation of Required.dispose
Inherited from PreferenceNodeRenderer.dispose
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:134
Returns void

Protected Abstract doHandleValueChange

doHandleValueChange(): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:503
This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.

Returns void

Protected getAdditionalNodeClassnames

getAdditionalNodeClassnames(): Iterable<string>

Inherited from PreferenceNodeRenderer.getAdditionalNodeClassnames
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:105
Returns Iterable<string>

Protected Abstract getFallbackValue

getFallbackValue(): ValueType

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:499
Returns ValueType
a fallback default value for a preference of the type implemented by a concrete leaf renderer This function is only called if the default value for a given preference is not specified in its schema.

Protected getModifiedMessagePrefix

getModifiedMessagePrefix(): string

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:423
Returns string

Protected getModifiedScopesAsStrings

getModifiedScopesAsStrings(): PreferenceScope[]

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:443
Returns PreferenceScope[]

Protected getValue

getValue(): null | ValueType

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:461
Returns null | ValueType

Protected handleCogAction

handleCogAction(__namedParameters: KeyboardEvent | MouseEvent): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:289
Parameters
- __namedParameters: KeyboardEvent | MouseEvent
Returns void

handleScopeChange

handleScopeChange(isFiltered?: boolean): void

Implementation of Required.handleScopeChange
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:480
Parameters
- isFiltered: boolean = ...
Returns void

handleSearchChange

handleSearchChange(isFiltered?: boolean): void

Implementation of Required.handleSearchChange
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:476
Parameters
- isFiltered: boolean = ...
Returns void

handleValueChange

handleValueChange(): void

Implementation of Required.handleValueChange
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:485
Returns void

hide

hide(): void

Implementation of Required.hide
Inherited from PreferenceNodeRenderer.hide
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:126
Returns void

Protected hideCog

hideCog(): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:316
Returns void

Protected init

init(): void

Overrides PreferenceNodeRenderer.init
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:179
Returns void

insertAfter

insertAfter(previousSibling: HTMLElement): void

Implementation of Required.insertAfter
Inherited from PreferenceNodeRenderer.insertAfter
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:114
Parameters
- previousSibling: HTMLElement
Returns void

insertBefore

insertBefore(nextSibling: HTMLElement): void

Implementation of Required.insertBefore
Inherited from PreferenceNodeRenderer.insertBefore
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:109
Parameters
- nextSibling: HTMLElement
Returns void

Protected openLink

openLink(event: MouseEvent): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:217
Parameters
- event: MouseEvent
Returns void

prependTo

prependTo(parent: HTMLElement): void

Implementation of Required.prependTo
Inherited from PreferenceNodeRenderer.prependTo
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:122
Parameters
- parent: HTMLElement
Returns void

Protected removeModifiedMarking

removeModifiedMarking(): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:308
Returns void

Protected setId

setId(): void

Inherited from PreferenceNodeRenderer.setId
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:95
Returns void

Protected setPreferenceImmediately

setPreferenceImmediately(value: undefined | ValueType): Promise<void>

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:471
Parameters
- value: undefined | ValueType
Returns Promise<void>

show

show(): void

Implementation of Required.show
Inherited from PreferenceNodeRenderer.show
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:130
Returns void

Protected showCog

showCog(): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:312
Returns void

Protected updateHeadline

updateHeadline(filtered?: boolean): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:330
Parameters
- filtered: boolean = ...
Returns void

Protected updateInspection

updateInspection(): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:187
Returns void

Protected updateModificationStatus

updateModificationStatus(knownCurrentValue?: JSONValue): void

- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:320
Parameters
- Optional knownCurrentValue: JSONValue
Returns void

Type Parameters

ValueType extends JSONValue

InteractableType extends HTMLElement

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

ValueType extends JSONValue

InteractableType extends HTMLElement

Returns PreferenceLeafNodeRenderer<ValueType, InteractableType>

Properties

_group

_id

_subgroup

Protected attached

Protected domNode

Protected gutter

Protected headlineWrapper

Protected inspection

Protected interactable

Protected isModifiedFromDefault

Protected Readonly labelProvider

Protected markdownRenderer

Protected Readonly menuRenderer

Protected Readonly model

Protected Readonly openerService

Protected Readonly preferenceNode

Protected Readonly preferenceService

Protected Readonly scopeTracker

Protected Readonly searchbar

Protected setPreferenceWithDebounce

Accessors

group

Returns string

id

Returns string

node

Returns HTMLElement

nodeId

Returns string

schema

Returns PreferenceDataProperty

visible

Returns boolean

Methods

Protected addEventHandlerToModifiedScope

Parameters

scope: PreferenceScope

scopeWrapper: HTMLElement

Returns void

Protected addModifiedMarking

Returns void

appendTo

Parameters

parent: HTMLElement

Returns void

Protected buildMarkdownRenderer

Returns MarkdownIt

Protected compareOtherModifiedScopes

Parameters

headlineWrapper: HTMLDivElement

currentSuffix: HTMLElement

Returns void

Protected createDomNode

Returns HTMLLIElement

Protected Abstract createInteractable

Parameters

container: HTMLElement

Returns void

Protected createModifiedScopeMessage

Parameters

scope: PreferenceScope

Returns HTMLSpanElement

Protected createOtherModifiedScopes