Class EditorLanguageStatusService

Index

Constructors

Properties

commandRegistry currentlyPinnedItems editorAccess formatterService formatterStatusContribution hoverService labelParser languages messageService pendingUpdate pinnedCommands status statusBar toDisposeOnEditorChange LANGUAGE_MODE_ID LANGUAGE_STATUS_ID

Constructors

constructor

new EditorLanguageStatusService(): EditorLanguageStatusService
Returns EditorLanguageStatusService

Properties

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected`currentlyPinnedItems

currentlyPinnedItems: Set<string> = ...

`Protected` `Readonly`editorAccess

editorAccess: CurrentEditorAccess

`Protected` `Readonly`formatterService

formatterService: undefined | FormatterService

`Protected` `Readonly`formatterStatusContribution

formatterStatusContribution: undefined | EditorFormatterStatusContribution

`Protected` `Readonly`hoverService

hoverService: HoverService

`Protected` `Readonly`labelParser

labelParser: LabelParser

`Protected` `Readonly`languages

languages: LanguageService

`Protected` `Readonly`messageService

messageService: MessageService

`Protected`pendingUpdate

pendingUpdate: undefined | Promise<void>

`Protected`pinnedCommands

pinnedCommands: Set<string> = ...

`Protected` `Readonly`status

status: Map<number, LanguageStatus> = ...

`Protected` `Readonly`statusBar

statusBar: StatusBar

`Protected` `Readonly`toDisposeOnEditorChange

toDisposeOnEditorChange: DisposableCollection = ...

`Protected` `Static`LANGUAGE_MODE_ID

LANGUAGE_MODE_ID: string = 'editor-status-language'

`Protected` `Static`LANGUAGE_STATUS_ID

LANGUAGE_STATUS_ID: string = 'editor-language-status-items'

Methods

`Protected`addFormatterCommands

addFormatterCommands(
    commandContainer: HTMLElement,
    item: LanguageStatus,
    editor: TextEditor,
): void
Parameters
- commandContainer: HTMLElement
- item: LanguageStatus
- editor: TextEditor
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:345

`Protected`createFormatterConfigureButton

createFormatterConfigureButton(editor: TextEditor): HTMLElement
Parameters
- editor: TextEditor
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:355

`Protected`createFormatterInfoButton

createFormatterInfoButton(editor: TextEditor): HTMLElement
Parameters
- editor: TextEditor
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:370

`Protected`createFormatterPinnedItem

createFormatterPinnedItem(
item: LanguageStatus,
editor?: TextEditor,
): StatusBarEntry
Parameters
- item: LanguageStatus
- Optionaleditor: TextEditor
Returns StatusBarEntry
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:246

`Protected`createFormatterStatusItem

createFormatterStatusItem(editor: TextEditor): undefined | LanguageStatus
Parameters
- editor: TextEditor
Returns undefined | LanguageStatus
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:164

`Protected`createLabelSection

createLabelSection(item: LanguageStatus): HTMLElement
Parameters
- item: LanguageStatus
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:313

`Protected`createPinButton

createPinButton(item: LanguageStatus, editor?: TextEditor): HTMLElement
Parameters
- item: LanguageStatus
- Optionaleditor: TextEditor
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:408

`Protected`createSeverityIndicator

createSeverityIndicator(severity: Severity, alwaysShow?: boolean): HTMLElement
Parameters
- severity: Severity
- alwaysShow: boolean = false
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:301

`Protected`createTooltip

createTooltip(items: LanguageStatus[], editor?: TextEditor): HTMLElement
Parameters
- items: LanguageStatus[]
- Optionaleditor: TextEditor
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:277

`Protected`createTooltipItem

createTooltipItem(item: LanguageStatus, editor?: TextEditor): HTMLElement
Parameters
- item: LanguageStatus
- Optionaleditor: TextEditor
Returns HTMLElement
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:286

`Protected`doUpdateLanguageStatusItems

doUpdateLanguageStatusItems(editor: undefined | TextEditor): Promise<void>
Performs the actual language status items update.
Parameters
- editor: undefined | TextEditor
Returns Promise<void>
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:178

`Protected`getSeverityIconClasses

getSeverityIconClasses(severity: Severity): string
Parameters
- severity: Severity
Returns string
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:447

`Protected`isFormatterItem

isFormatterItem(item: LanguageStatus): boolean
Parameters
- item: LanguageStatus
Returns boolean
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:242

removeLanguageStatusItem

removeLanguageStatusItem(handle: number): void
Parameters
- handle: number
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:107

`Protected`renderWithIcons

renderWithIcons(host: HTMLElement, text?: string): void
Parameters
- host: HTMLElement
- Optionaltext: string
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:455

`Protected`scheduleUpdate

scheduleUpdate(
editor: undefined | TextEditor,
updateLanguageMode: boolean,
): void
Schedules an update to the status bar. All updates are chained to prevent race conditions.
Parameters
- editor: undefined | TextEditor
  The current editor, or undefined if no editor is active
- updateLanguageMode: boolean
  Whether to update the language mode element (only needed on editor change)
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:134

setLanguageStatusItem

setLanguageStatusItem(handle: number, item: LanguageStatus): void
Parameters
- handle: number
- item: LanguageStatus
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:102

`Protected`setPinProperties

setPinProperties(pin: HTMLElement, id: string): void
Parameters
- pin: HTMLElement
- id: string
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:424

`Protected`togglePinned

togglePinned(item: LanguageStatus, editor?: TextEditor): void
Toggles whether a language status item is pinned to the status bar.
Parameters
- item: LanguageStatus
- Optionaleditor: TextEditor
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:437

`Protected`toPinnedItem

toPinnedItem(item: LanguageStatus, editor?: TextEditor): StatusBarEntry
Parameters
- item: LanguageStatus
- Optionaleditor: TextEditor
Returns StatusBarEntry
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:234

`Protected`updateLanguageModeElement

updateLanguageModeElement(editor: undefined | TextEditor): Promise<void>
Parameters
- editor: undefined | TextEditor
Returns Promise<void>
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:148

updateLanguageStatus

updateLanguageStatus(editor: undefined | TextEditor): void
Parameters
- editor: undefined | TextEditor
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:112

`Protected`updateLanguageStatusItems

updateLanguageStatusItems(editor?: undefined | TextEditor): void
Schedules a language status items update. Called when language status items are added/removed.
Parameters
- editor: undefined | TextEditor = ...
Returns void
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:171

`Protected`updatePinnedItems

updatePinnedItems(items?: LanguageStatus[], editor?: TextEditor): Promise<void>
Updates pinned status bar items. Removes all currently pinned items first, then adds back only those relevant to the current editor context.
Parameters
- Optionalitems: LanguageStatus[]
- Optionaleditor: TextEditor
Returns Promise<void>
- Defined in packages/editor/src/browser/language-status/editor-language-status-service.ts:220

Class EditorLanguageStatusService

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EditorLanguageStatusService

Properties

Protected ReadonlycommandRegistry

ProtectedcurrentlyPinnedItems

Protected ReadonlyeditorAccess

Protected ReadonlyformatterService

Protected ReadonlyformatterStatusContribution

Protected ReadonlyhoverService

Protected ReadonlylabelParser

Protected Readonlylanguages

Protected ReadonlymessageService

ProtectedpendingUpdate

ProtectedpinnedCommands

Protected Readonlystatus

Protected ReadonlystatusBar

Protected ReadonlytoDisposeOnEditorChange

Protected StaticLANGUAGE_MODE_ID

Protected StaticLANGUAGE_STATUS_ID

Methods

ProtectedaddFormatterCommands

Parameters

Returns void

ProtectedcreateCommandLink

Parameters

Returns HTMLElement

ProtectedcreateCommandSection

Parameters

Returns HTMLElement

ProtectedcreateDefaultPinnedItem

Parameters

Returns StatusBarEntry

ProtectedcreateFormatterConfigureButton

Parameters

Returns HTMLElement

ProtectedcreateFormatterInfoButton

Parameters

Returns HTMLElement

ProtectedcreateFormatterPinnedItem

Parameters

Returns StatusBarEntry

ProtectedcreateFormatterStatusItem

Parameters

Returns undefined | LanguageStatus

ProtectedcreateLabelSection

Parameters

Returns HTMLElement

ProtectedcreatePinButton

Parameters

Returns HTMLElement

ProtectedcreateSeverityIndicator

Parameters

Returns HTMLElement

ProtectedcreateTooltip

Parameters

Returns HTMLElement

ProtectedcreateTooltipItem

Parameters

Returns HTMLElement

ProtecteddoUpdateLanguageStatusItems

Parameters

Returns Promise<void>

ProtectedgetSeverityIconClasses

Parameters

Returns string

ProtectedisFormatterItem

Parameters

Returns boolean

removeLanguageStatusItem

Parameters

Returns void

ProtectedrenderWithIcons

Parameters

Returns void

`Protected` `Readonly`commandRegistry

`Protected`currentlyPinnedItems

`Protected` `Readonly`editorAccess

`Protected` `Readonly`formatterService

`Protected` `Readonly`formatterStatusContribution

`Protected` `Readonly`hoverService

`Protected` `Readonly`labelParser

`Protected` `Readonly`languages

`Protected` `Readonly`messageService

`Protected`pendingUpdate

`Protected`pinnedCommands

`Protected` `Readonly`status

`Protected` `Readonly`statusBar

`Protected` `Readonly`toDisposeOnEditorChange

`Protected` `Static`LANGUAGE_MODE_ID

`Protected` `Static`LANGUAGE_STATUS_ID

`Protected`addFormatterCommands

`Protected`createCommandLink

`Protected`createCommandSection

`Protected`createDefaultPinnedItem

`Protected`createFormatterConfigureButton

`Protected`createFormatterInfoButton

`Protected`createFormatterPinnedItem

`Protected`createFormatterStatusItem

`Protected`createLabelSection

`Protected`createPinButton

`Protected`createSeverityIndicator

`Protected`createTooltip

`Protected`createTooltipItem

`Protected`doUpdateLanguageStatusItems

`Protected`getSeverityIconClasses

`Protected`isFormatterItem

`Protected`renderWithIcons

`Protected`scheduleUpdate

`Protected`setPinProperties

`Protected`togglePinned

`Protected`toPinnedItem

`Protected`updateLanguageModeElement

`Protected`updateLanguageStatusItems

`Protected`updatePinnedItems