Class PreferenceLeafNodeRenderer<ValueType, InteractableType>Abstract

Protected gutter

Protected headlineWrapper

Protected inspection

Protected interactable

Protected isModifiedFromDefault

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

• addEventHandlerToModifiedScope(scope, scopeWrapper): void

• Parameters

  • scope: PreferenceScope
  • scopeWrapper: HTMLElement

  Returns void

Protected addModifiedMarking

• addModifiedMarking(): void

• Returns void

Protected compareOtherModifiedScopes

• compareOtherModifiedScopes(headlineWrapper, currentSuffix): void

• Parameters

  • headlineWrapper: HTMLDivElement
  • currentSuffix: HTMLElement

  Returns void

Protected createDomNode

• createDomNode(): HTMLLIElement

• Returns HTMLLIElement

Protected Abstract createInteractable

• createInteractable(container): void

• 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): HTMLSpanElement

• Parameters

  • scope: PreferenceScope

  Returns HTMLSpanElement

Protected createOtherModifiedScopes

• createOtherModifiedScopes(headlineWrapper): void

• Parameters

  • headlineWrapper: HTMLDivElement

  Returns void

Protected Abstract doHandleValueChange

• doHandleValueChange(): void

• This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.

  Returns void

Protected Abstract getFallbackValue

• getFallbackValue(): ValueType

• 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

• Returns string

Protected getModifiedScopesAsStrings

• getModifiedScopesAsStrings(): PreferenceScope[]

• Returns PreferenceScope[]

Protected getValue

• getValue(): null | ValueType

• Returns null | ValueType

Protected handleCogAction

• handleCogAction(__namedParameters): void

• Parameters

  • __namedParameters: MouseEvent | KeyboardEvent

  Returns void

Protected hideCog

• hideCog(): void

• Returns void

Protected init

• init(): void

• Returns void

Protected openLink

• openLink(event): void

• Parameters

  • event: MouseEvent

  Returns void

Protected removeModifiedMarking

• removeModifiedMarking(): void

• Returns void

Protected setPreferenceImmediately

• setPreferenceImmediately(value): Promise<void>

• Parameters

  • value: undefined | ValueType

  Returns Promise<void>

Protected showCog

• showCog(): void

• Returns void

Protected updateHeadline

• updateHeadline(filtered?): void

• Parameters

  • filtered: boolean = ...

  Returns void

Protected updateInspection

• updateInspection(): void

• Returns void

Protected updateModificationStatus

• updateModificationStatus(knownCurrentValue?): void

• Parameters

  • Optional knownCurrentValue: JSONValue

  Returns void