Class PreferenceStringInputRenderer

Hierarchy (view full)

PreferenceLeafNodeRenderer<string, HTMLInputElement>
- PreferenceStringInputRenderer
  - PreferenceSingleFilePathInputRenderer

Index

Constructors

constructor

Accessors

group id node nodeId schema visible

Constructors

constructor

new PreferenceStringInputRenderer(): PreferenceStringInputRenderer
Returns PreferenceStringInputRenderer
Inherited from PreferenceLeafNodeRenderer.constructor

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<string>

`Protected` interactable

interactable: HTMLInputElement

`Protected` isModifiedFromDefault

isModifiedFromDefault: boolean = false

`Protected` `Readonly` labelProvider

labelProvider: PreferenceTreeLabelProvider

`Protected` `Readonly` markdownRenderer

markdownRenderer: PreferenceMarkdownRenderer

`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
Returns string
Inherited from PreferenceLeafNodeRenderer.group
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:81

id

get id(): string
Returns string
Inherited from PreferenceLeafNodeRenderer.id
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:77

node

get node(): HTMLElement
Returns HTMLElement
Inherited from PreferenceLeafNodeRenderer.node
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:69

nodeId

get nodeId(): string
Returns string
Inherited from PreferenceLeafNodeRenderer.nodeId
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:73

schema

get schema(): PreferenceDataProperty
Returns PreferenceDataProperty
Inherited from PreferenceLeafNodeRenderer.schema
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:174

visible

get visible(): boolean
Returns boolean
Inherited from PreferenceLeafNodeRenderer.visible
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:85

Methods

`Protected` addEventHandlerToModifiedScope

addEventHandlerToModifiedScope(scope, scopeWrapper): void
Parameters
- scope: PreferenceScope
- scopeWrapper: HTMLElement
Returns void
Inherited from PreferenceLeafNodeRenderer.addEventHandlerToModifiedScope
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:400

`Protected` addModifiedMarking

addModifiedMarking(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.addModifiedMarking
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:277

appendTo

appendTo(parent): void
Parameters
- parent: HTMLElement
Returns void
Inherited from PreferenceLeafNodeRenderer.appendTo
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:118

`Protected` compareOtherModifiedScopes

compareOtherModifiedScopes(headlineWrapper, currentSuffix): void
Parameters
- headlineWrapper: HTMLDivElement
- currentSuffix: HTMLElement
Returns void
Inherited from PreferenceLeafNodeRenderer.compareOtherModifiedScopes
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:337

`Protected` createDomNode

createDomNode(): HTMLLIElement
Returns HTMLLIElement
Inherited from PreferenceLeafNodeRenderer.createDomNode
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:202

`Protected` createInteractable

createInteractable(parent): void
Should create an HTML element that the user can interact with to change the value of the preference.
Parameters
- parent: HTMLElement
  the parent element for the interactable. This method is responsible for adding the new element to its parent.
Returns void
Overrides PreferenceLeafNodeRenderer.createInteractable
- Defined in packages/preferences/src/browser/views/components/preference-string-input.ts:24

`Protected` createModifiedScopeMessage

createModifiedScopeMessage(scope): HTMLSpanElement
Parameters
- scope: PreferenceScope
Returns HTMLSpanElement
Inherited from PreferenceLeafNodeRenderer.createModifiedScopeMessage
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:384

`Protected` createOtherModifiedScopes

createOtherModifiedScopes(headlineWrapper): void
Parameters
- headlineWrapper: HTMLDivElement
Returns void
Inherited from PreferenceLeafNodeRenderer.createOtherModifiedScopes
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:365

dispose

dispose(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.dispose
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:134

`Protected` doHandleValueChange

doHandleValueChange(): void
This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.

Returns void
Overrides PreferenceLeafNodeRenderer.doHandleValueChange
- Defined in packages/preferences/src/browser/views/components/preference-string-input.ts:40

`Protected` getAdditionalNodeClassnames

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

`Protected` getFallbackValue

getFallbackValue(): string
Returns string
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.
Overrides PreferenceLeafNodeRenderer.getFallbackValue
- Defined in packages/preferences/src/browser/views/components/preference-string-input.ts:36

`Protected` handleCogAction

handleCogAction(__namedParameters): void
Parameters
- __namedParameters: MouseEvent | KeyboardEvent
Returns void
Inherited from PreferenceLeafNodeRenderer.handleCogAction
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:262

handleScopeChange

handleScopeChange(isFiltered?): void
Parameters
- isFiltered: boolean = ...
Returns void
Inherited from PreferenceLeafNodeRenderer.handleScopeChange
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:453

handleSearchChange

handleSearchChange(isFiltered?): void
Parameters
- isFiltered: boolean = ...
Returns void
Inherited from PreferenceLeafNodeRenderer.handleSearchChange
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:449

`Protected` handleUserInteraction

handleUserInteraction(): void
Returns void
- Defined in packages/preferences/src/browser/views/components/preference-string-input.ts:54

handleValueChange

handleValueChange(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.handleValueChange
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:458

hide

hide(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.hide
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:126

`Protected` hideCog

hideCog(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.hideCog
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:289

`Protected` init

init(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.init
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:179

insertAfter

insertAfter(previousSibling): void
Parameters
- previousSibling: HTMLElement
Returns void
Inherited from PreferenceLeafNodeRenderer.insertAfter
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:114

insertBefore

insertBefore(nextSibling): void
Parameters
- nextSibling: HTMLElement
Returns void
Inherited from PreferenceLeafNodeRenderer.insertBefore
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:109

`Protected` openLink

openLink(event): void
Parameters
- event: MouseEvent
Returns void
Inherited from PreferenceLeafNodeRenderer.openLink
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:190

prependTo

prependTo(parent): void
Parameters
- parent: HTMLElement
Returns void
Inherited from PreferenceLeafNodeRenderer.prependTo
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:122

`Protected` removeModifiedMarking

removeModifiedMarking(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.removeModifiedMarking
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:281

`Protected` setId

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

`Protected` setPreferenceImmediately

setPreferenceImmediately(value): Promise<void>
Parameters
- value: undefined | string
Returns Promise<void>
Inherited from PreferenceLeafNodeRenderer.setPreferenceImmediately
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:444

show

show(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.show
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:130

`Protected` showCog

showCog(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.showCog
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:285

`Protected` updateHeadline

updateHeadline(filtered?): void
Parameters
- filtered: boolean = ...
Returns void
Inherited from PreferenceLeafNodeRenderer.updateHeadline
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:303

`Protected` updateInspection

updateInspection(): void
Returns void
Inherited from PreferenceLeafNodeRenderer.updateInspection
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:186

`Protected` updateModificationStatus

updateModificationStatus(knownCurrentValue?): void
Parameters
- Optional knownCurrentValue: JSONValue
Returns void
Inherited from PreferenceLeafNodeRenderer.updateModificationStatus
- Defined in packages/preferences/src/browser/views/components/preference-node-renderer.ts:293

Class PreferenceStringInputRenderer

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PreferenceStringInputRenderer

Properties

_group

_id

_subgroup

Protected attached

Protected domNode

Protected gutter

Protected headlineWrapper

Protected inspection

Protected interactable

Protected isModifiedFromDefault

Protected Readonly labelProvider

Protected Readonly 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

Returns void

Protected addModifiedMarking

Returns void

appendTo

Parameters

Returns void

Protected compareOtherModifiedScopes

Parameters

Returns void

Protected createDomNode

Returns HTMLLIElement

Protected createInteractable

Parameters

Returns void

Protected createModifiedScopeMessage

Parameters

Returns HTMLSpanElement

Protected createOtherModifiedScopes

Parameters

Returns void

dispose

Returns void

Protected doHandleValueChange

Returns void

Protected getAdditionalNodeClassnames

Returns Iterable<string>

Protected getFallbackValue

Returns string

Protected getModifiedMessagePrefix

Returns string

Protected getModifiedScopesAsStrings

Returns PreferenceScope[]

Protected getValue

`Protected` attached

`Protected` domNode

`Protected` gutter

`Protected` headlineWrapper

`Protected` inspection

`Protected` interactable

`Protected` isModifiedFromDefault

`Protected` `Readonly` labelProvider

`Protected` `Readonly` markdownRenderer

`Protected` `Readonly` menuRenderer

`Protected` `Readonly` model

`Protected` `Readonly` openerService

`Protected` `Readonly` preferenceNode

`Protected` `Readonly` preferenceService

`Protected` `Readonly` scopeTracker

`Protected` `Readonly` searchbar

`Protected` setPreferenceWithDebounce

`Protected` addEventHandlerToModifiedScope

`Protected` addModifiedMarking

`Protected` compareOtherModifiedScopes

`Protected` createDomNode

`Protected` createInteractable

`Protected` createModifiedScopeMessage

`Protected` createOtherModifiedScopes

`Protected` doHandleValueChange

`Protected` getAdditionalNodeClassnames

`Protected` getFallbackValue

`Protected` getModifiedMessagePrefix

`Protected` getModifiedScopesAsStrings

`Protected` getValue

`Protected` handleBlur

`Protected` handleCogAction

`Protected` handleUserInteraction

`Protected` hideCog

`Protected` init

`Protected` openLink

`Protected` removeModifiedMarking

`Protected` setId

`Protected` setPreferenceImmediately

`Protected` showCog

`Protected` updateHeadline

`Protected` updateInspection

`Protected` updateModificationStatus