Class EditorFormatterStatusContribution

Handles formatter-related status bar functionality. Responsible for creating formatter status items, displaying formatter quick picks, and managing pinned formatter items in the status bar.

Index

Constructors

constructor

new EditorFormatterStatusContribution(): EditorFormatterStatusContribution
Returns EditorFormatterStatusContribution

Properties

`Protected` `Readonly`formatterService

formatterService: undefined | FormatterService

`Protected` `Readonly`quickInputService

quickInputService: undefined | QuickInputService

`Static` `Readonly`FORMATTER_STATUS_ITEM_ID

FORMATTER_STATUS_ITEM_ID: "editor-formatter-status" = 'editor-formatter-status'

Methods

`Protected`buildDisplayInfo

buildDisplayInfo(
    status: FormatterStatus,
    availableFormatters: FormatterInfo[],
    useShortLabel?: boolean,
): FormatterDisplayInfo
Builds display info based on the current formatter state.
Parameters
- status: FormatterStatus
  The formatter status
- availableFormatters: FormatterInfo[]
  List of available formatters
- useShortLabel: boolean = false
  If true, uses shorter labels suitable for status bar
Returns FormatterDisplayInfo
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:233

`Protected`buildMultipleFormattersDisplayInfo

buildMultipleFormattersDisplayInfo(
status: FormatterStatus,
formatterCount: number,
): FormatterDisplayInfo
Parameters
- status: FormatterStatus
- formatterCount: number
Returns FormatterDisplayInfo
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:305

`Protected`buildNoFormattersDisplayInfo

buildNoFormattersDisplayInfo(
status: FormatterStatus,
useShortLabel?: boolean,
): FormatterDisplayInfo
Parameters
- status: FormatterStatus
- useShortLabel: boolean = false
Returns FormatterDisplayInfo
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:247

`Protected`buildSingleFormatterDisplayInfo

buildSingleFormatterDisplayInfo(
status: FormatterStatus,
formatter: FormatterInfo,
): FormatterDisplayInfo
Parameters
- status: FormatterStatus
- formatter: FormatterInfo
Returns FormatterDisplayInfo
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:276

createFormatterStatusItem

createFormatterStatusItem(editor: TextEditor): undefined | LanguageStatus
Creates a language status item for the formatter. Returns undefined if no formatter service is available.
Parameters
- editor: TextEditor
Returns undefined | LanguageStatus
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:104

createPinnedStatusBarEntry

createPinnedStatusBarEntry(
editor: undefined | TextEditor,
onclick?: (e: MouseEvent) => void,
): StatusBarEntry
Creates a status bar entry for a pinned formatter item. Includes proper tooltip and icon.
Parameters
- editor: undefined | TextEditor
- Optionalonclick: (e: MouseEvent) => void
Returns StatusBarEntry
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:144

`Protected`determineTargetScope

determineTargetScope(editor: TextEditor): Promise<undefined | PreferenceScope>
Parameters
- editor: TextEditor
Returns Promise<undefined | PreferenceScope>
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:380

`Protected`getFormatterDisplayInfo

getFormatterDisplayInfo(
editor: TextEditor,
useShortLabel?: boolean,
): FormatterDisplayInfo
Gets the formatter display info for the given editor. Caches the status to avoid repeated service calls.
Parameters
- editor: TextEditor
- useShortLabel: boolean = false
Returns FormatterDisplayInfo
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:221

getTooltip

getTooltip(editor: TextEditor): string
Gets the tooltip text for the formatter status item.
Parameters
- editor: TextEditor
Returns string
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:132

hasConfigureAction

hasConfigureAction(editor: TextEditor): boolean
Returns true if the configure action should be available for the given editor. Configure is available when there are multiple formatters or an invalid configuration.
Parameters
- editor: TextEditor
Returns boolean
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:209

isAvailable

isAvailable(): boolean
Returns true if the formatter service is available.

Returns boolean
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:201

showFormatterQuickPick

showFormatterQuickPick(editor: TextEditor): Promise<void>
Shows the formatter selection quick pick dialog.
Parameters
- editor: TextEditor
Returns Promise<void>
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:169

`Protected`showFormatterSelectionPick

showFormatterSelectionPick(
editor: TextEditor,
formatters: FormatterInfo[],
): Promise<undefined | QuickPickItem>
Parameters
- editor: TextEditor
- formatters: FormatterInfo[]
Returns Promise<undefined | QuickPickItem>
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:349

`Protected`showScopeSelectionPick

showScopeSelectionPick(): Promise<undefined | PreferenceScope>
Returns Promise<undefined | PreferenceScope>
- Defined in packages/editor/src/browser/language-status/editor-formatter-status-contribution.ts:393

Class EditorFormatterStatusContribution

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EditorFormatterStatusContribution

Properties

Protected ReadonlyformatterService

Protected ReadonlyquickInputService

Static ReadonlyFORMATTER_STATUS_ITEM_ID

Methods

ProtectedbuildDisplayInfo

Parameters

Returns FormatterDisplayInfo

ProtectedbuildMultipleFormattersDisplayInfo

Parameters

Returns FormatterDisplayInfo

ProtectedbuildNoFormattersDisplayInfo

Parameters

Returns FormatterDisplayInfo

ProtectedbuildSingleFormatterDisplayInfo

Parameters

Returns FormatterDisplayInfo

createFormatterStatusItem

Parameters

Returns undefined | LanguageStatus

createPinnedStatusBarEntry

Parameters

Returns StatusBarEntry

ProtecteddetermineTargetScope

Parameters

Returns Promise<undefined | PreferenceScope>

ProtectedgetFormatterDisplayInfo

Parameters

Returns FormatterDisplayInfo

getTooltip

Parameters

Returns string

hasConfigureAction

Parameters

Returns boolean

isAvailable

Returns boolean

showFormatterQuickPick

Parameters

Returns Promise<void>

ProtectedshowFormatterSelectionPick

Parameters

Returns Promise<undefined | QuickPickItem>

ProtectedshowScopeSelectionPick

Returns Promise<undefined | PreferenceScope>

Settings

On This Page

`Protected` `Readonly`formatterService

`Protected` `Readonly`quickInputService

`Static` `Readonly`FORMATTER_STATUS_ITEM_ID

`Protected`buildDisplayInfo

`Protected`buildMultipleFormattersDisplayInfo

`Protected`buildNoFormattersDisplayInfo

`Protected`buildSingleFormatterDisplayInfo

`Protected`determineTargetScope

`Protected`getFormatterDisplayInfo

`Protected`showFormatterSelectionPick

`Protected`showScopeSelectionPick