Class ProblemContribution

Representation of a tabbar toolbar contribution.

Hierarchy (View Summary)

AbstractViewContribution<ProblemWidget>
- ProblemContribution

Implements

Constructors

constructor

new ProblemContribution(): ProblemContribution
Returns ProblemContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:68

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(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:35

Methods

`Protected`addToClipboard

addToClipboard(content: string): void
Parameters
- content: string
Returns void
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:206

closeView

closeView(): Promise<undefined | ProblemWidget>
Returns Promise<undefined | ProblemWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

`Protected`collapseAllProblems

collapseAllProblems(): Promise<void>
Returns Promise<void>
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:196

`Protected`copy

copy(selection: ProblemSelection): void
Parameters
- selection: ProblemSelection
Returns void
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:218

`Protected`copyMessage

copyMessage(selection: ProblemSelection): void
Parameters
- selection: ProblemSelection
Returns void
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:236

`Protected`getStatusBarTooltip

getStatusBarTooltip(stat: ProblemStat): string
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.
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:111

initializeLayout

initializeLayout(app: FrontendApplication): Promise<void>
Called after the application shell has been attached in case there is no previous workbench layout state. Should return a promise if it runs asynchronously.
Parameters
- app: FrontendApplication
Returns Promise<void>
Implementation of FrontendApplicationContribution.initializeLayout
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:85

onStart

onStart(app: FrontendApplication): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.
Parameters
- app: FrontendApplication
Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:80

openView

openView(args?: Partial<OpenViewArguments>): Promise<ProblemWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<ProblemWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

registerCommands

registerCommands(commands: CommandRegistry): void
Register commands and handlers.
Parameters
- commands: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:129

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Inherited from AbstractViewContribution.registerKeybindings
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:42

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:162

registerToolbarItems

registerToolbarItems(toolbarRegistry: TabBarToolbarRegistry): Promise<void>
Registers toolbar items.
Parameters
- toolbarRegistry: TabBarToolbarRegistry
  the tabbar toolbar registry.
Returns Promise<void>
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:181

`Protected`setStatusBarElement

setStatusBarElement(problemStat: ProblemStat): void
Parameters
- problemStat: ProblemStat
Returns void
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:90

toggleView

toggleView(): Promise<ProblemWidget>
Returns Promise<ProblemWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:40

tryGetWidget

tryGetWidget(): undefined | ProblemWidget
Returns undefined | ProblemWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

`Protected`withWidget

withWidget<T>(
widget?: undefined | Widget,
cb: (problems: ProblemWidget) => T,
): false | T
Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- cb: (problems: ProblemWidget) => T
Returns false | T
- Defined in packages/markers/src/browser/problem/problem-contribution.ts:241

Class ProblemContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ProblemContribution

Properties

Protected Readonlyoptions

Protected ReadonlyproblemManager

Protected ReadonlyquickView

Protected ReadonlyselectionService

Protected Readonlyshell

Protected ReadonlystatusBar

Optional ReadonlytoggleCommand

ProtectedupdateStatusBarElement

Protected ReadonlywidgetManager

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

ProtectedaddToClipboard

Parameters

Returns void

closeView

Returns Promise<undefined | ProblemWidget>

ProtectedcollapseAllProblems

Returns Promise<void>

Protectedcopy

Parameters

Returns void

ProtectedcopyMessage

Parameters

Returns void

ProtectedgetStatusBarTooltip

Parameters

Returns string

initializeLayout

Parameters

Returns Promise<void>

onStart

Parameters

Returns void

openView

Parameters

Returns Promise<ProblemWidget>

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

registerMenus

Parameters

Returns void

registerToolbarItems

Parameters

Returns Promise<void>

ProtectedsetStatusBarElement

Parameters

Returns void

toggleView

Returns Promise<ProblemWidget>

tryGetWidget

Returns undefined | ProblemWidget

ProtectedwithWidget

Type Parameters

Parameters

Returns false | T

Settings

`Protected` `Readonly`options

`Protected` `Readonly`problemManager

`Protected` `Readonly`quickView

`Protected` `Readonly`selectionService

`Protected` `Readonly`shell

`Protected` `Readonly`statusBar

`Optional` `Readonly`toggleCommand

`Protected`updateStatusBarElement

`Protected` `Readonly`widgetManager

`Protected`addToClipboard

`Protected`collapseAllProblems

`Protected`copy

`Protected`copyMessage

`Protected`getStatusBarTooltip

`Protected`setStatusBarElement

`Protected`withWidget