Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProblemContribution

Hierarchy

Implements

  • FrontendApplicationContribution
  • TabBarToolbarContribution

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Readonly options

options: ViewContributionOptions

Protected Readonly problemManager

problemManager: ProblemManager

Protected Readonly quickView

quickView: QuickViewService

Protected Readonly selectionService

selectionService: SelectionService

Protected Readonly shell

shell: ApplicationShell

Protected Readonly statusBar

statusBar: StatusBar

Optional Readonly toggleCommand

toggleCommand: Command

Protected updateStatusBarElement

updateStatusBarElement: DebouncedFunc<() => void> = ...

Protected Readonly widgetManager

widgetManager: WidgetManager

Accessors

defaultViewOptions

  • get defaultViewOptions(): WidgetOptions

  • Returns WidgetOptions

viewId

  • get viewId(): string

  • Returns string

viewLabel

  • get viewLabel(): string

  • Returns string

widget

  • get widget(): Promise<T>

  • Returns Promise<T>

Methods

Protected addToClipboard

  • addToClipboard(content: string): void

closeView

  • Returns Promise<undefined | ProblemWidget>

Protected collapseAllProblems

  • collapseAllProblems(): Promise<void>

Protected copy

Protected copyMessage

Protected getStatusBarTooltip

  • Get the tooltip to be displayed when hovering over the problem statusbar item.

    • Displays No Problems when no problems are present.
    • Displays a human-readable label which describes for each type of problem stat properties, their overall count and type when any one of these properties has a positive count.

    Parameters

    • stat: ProblemStat

      the problem stat describing the number of errors, warnings and infos.

    Returns string

    the tooltip to be displayed in the statusbar.

initializeLayout

  • initializeLayout(app: FrontendApplication): Promise<void>

onStart

  • onStart(app: FrontendApplication): void

openView

  • openView(args?: Partial<OpenViewArguments>): Promise<ProblemWidget>

  • Parameters

    • Optional args: Partial<OpenViewArguments>

    Returns Promise<ProblemWidget>

registerCommands

  • registerCommands(commands: CommandRegistry): void

registerKeybindings

  • registerKeybindings(keybindings: KeybindingRegistry): void

  • Parameters

    • keybindings: KeybindingRegistry

    Returns void

registerMenus

  • registerMenus(menus: MenuModelRegistry): void

registerToolbarItems

  • registerToolbarItems(toolbarRegistry: TabBarToolbarRegistry): Promise<void>

Protected setStatusBarElement

toggleView

  • Returns Promise<ProblemWidget>

tryGetWidget

  • Returns undefined | ProblemWidget

Protected withWidget

  • withWidget<T>(widget?: undefined | Widget, cb: (problems: ProblemWidget) => T): false | T