Class PreferenceLeafNodeRenderer<ValueType, InteractableType>Abstract

Protectedgutter

ProtectedheadlineWrapper

Protectedinspection

Protectedinteractable

ProtectedisSet

Protected ReadonlymarkdownRenderer

Protected ReadonlymenuRenderer

Protected Readonlymodel

Protected ReadonlyopenerService

Protected ReadonlypreferenceNode

Protected ReadonlypreferenceService

Protected ReadonlyscopeTracker

Protected Readonlysearchbar

ProtectedsetPreferenceWithDebounce

ProtectedaddEventHandlerToModifiedScope

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

  Parameters

  • scope: PreferenceScope
  • scopeWrapper: HTMLElement

  Returns void

ProtectedaddModifiedMarking

• addModifiedMarking(): void

  Returns void

ProtectedcompareOtherModifiedScopes

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

  Parameters

  • headlineWrapper: HTMLDivElement
  • currentSuffix: HTMLElement

  Returns void

ProtectedcreateDomNode

• createDomNode(): HTMLLIElement

  Returns HTMLLIElement

Protected AbstractcreateInteractable

• createInteractable(container: HTMLElement): 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

ProtectedcreateModifiedScopeMessage

• createModifiedScopeMessage(scope: PreferenceScope): HTMLSpanElement

  Parameters

  • scope: PreferenceScope

  Returns HTMLSpanElement

ProtectedcreateOtherModifiedScopes

• createOtherModifiedScopes(headlineWrapper: HTMLDivElement): void

  Parameters

  • headlineWrapper: HTMLDivElement

  Returns void

Protected AbstractdoHandleValueChange

• doHandleValueChange(): void

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

  Returns void

ProtectedgetDefaultValue

• getDefaultValue(): ValueType

  Returns the default value for this preference.

  Returns ValueType

  The default value from the inspection or the fallback value if no default is specified.

Protected AbstractgetFallbackValue

• 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.

ProtectedgetModifiedMessagePrefix

• getModifiedMessagePrefix(): string

  Returns string

ProtectedgetModifiedScopesAsStrings

• getModifiedScopesAsStrings(): PreferenceScope[]

  Returns PreferenceScope[]

ProtectedgetValue

• getValue(): null | ValueType

  Many preferences allow null and even use it as a default regardless of the declared type.

  Returns null | ValueType

ProtectedhandleCogAction

• handleCogAction(__namedParameters: KeyboardEvent | MouseEvent): void

  Parameters

  • __namedParameters: KeyboardEvent | MouseEvent

  Returns void

ProtectedhideCog

• hideCog(): void

  Returns void

Protectedinit

• init(): void

  Returns void

ProtectedopenLink

• openLink(event: MouseEvent): void

  Parameters

  • event: MouseEvent

  Returns void

ProtectedremoveModifiedMarking

• removeModifiedMarking(): void

  Returns void

ProtectedsetPreferenceImmediately

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

  Parameters

  • value: undefined | ValueType

  Returns Promise<void>

ProtectedshowCog

• showCog(): void

  Returns void

ProtectedupdateHeadline

• updateHeadline(filtered?: boolean): void

  Parameters

  • filtered: boolean = ...

  Returns void

ProtectedupdateInspection

• updateInspection(): void

  Returns void

ProtectedupdateModificationStatus

• updateModificationStatus(): void

  Returns void

ProtectedupdateSessionOverrideState

• updateSessionOverrideState(): void

  Adds (or removes) a subtle "Overridden by session" suffix in the headline when a session override (set via --session-preference) is active for this preference. Styled like the existing "Modified in:" suffix so it reads as a hint, not a warning. Editing remains enabled; writing a new value clears the session override via PreferenceServiceImpl.evictSessionOverride.

  Returns void