Class ProblemDecorator

deprecated: since 1.25.0 URI-based decorators should implement DecorationsProvider and contribute decorations via the DecorationsService.

Hierarchy

ProblemDecorator

Implements

TreeDecorator

Constructors

constructor

new ProblemDecorator(problemManager: ProblemManager): ProblemDecorator

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:48
Parameters
- problemManager: ProblemManager
Returns ProblemDecorator

Properties

Protected Readonly emitter

emitter: Emitter<((tree: Tree) => Map<string, Data>)>

Readonly id

id: "theia-problem-decorator" = 'theia-problem-decorator'

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected Readonly problemManager

problemManager: ProblemManager

Protected problemPreferences

problemPreferences: ProblemPreferences

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

onDidChangeDecorations

get onDidChangeDecorations(): Event<((tree: Tree) => Map<string, Data>)>

Implementation of TreeDecorator.onDidChangeDecorations
- Defined in packages/markers/src/browser/problem/problem-decorator.ts:72
Returns Event<((tree: Tree) => Map<string, Data>)>

Methods

Protected appendContainerMarkers

appendContainerMarkers(node: TreeNode, decoration: Data, decorations: Map<string, Data>): void

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:123
Traverses up the tree from the given node and attaches decorations to any parents.

Parameters
- node: TreeNode
- decoration: Data
- decorations: Map<string, Data>
Returns void

Protected collectDecorators

collectDecorators(tree: Tree): Map<string, Data>

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:80
Parameters
- tree: Tree
Returns Map<string, Data>

Protected collectMarkers

collectMarkers(tree: Tree): Map<string, Data>

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:141
Parameters
- tree: Tree
Returns Map<string, Data>
a map matching stringified URI's to a decoration whose features reflect the highest-severity problem found and the number of problems found (based on )

Protected compare

compare(left: Marker<Diagnostic>, right: Marker<Diagnostic>): number

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:208
Parameters
- left: Marker<Diagnostic>
- right: Marker<Diagnostic>
Returns number

Protected compareDecorators

compareDecorators(left: Data, right: Data): number

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:212
Parameters
- left: Data
- right: Data
Returns number

decorations

decorations(tree: Tree): Promise<Map<string, Data>>

Implementation of TreeDecorator.decorations
- Defined in packages/markers/src/browser/problem/problem-decorator.ts:68
Parameters
- tree: Tree
Returns Promise<Map<string, Data>>

Protected filterMarker

filterMarker(marker: Marker<Diagnostic>): boolean

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:197
Returns true if the diagnostic (data) of the marker argument has Error, Warning, or Information severity. Otherwise, returns false.

Parameters
- marker: Marker<Diagnostic>
Returns boolean

Protected fireDidChangeDecorations

fireDidChangeDecorations(event: ((tree: Tree) => Map<string, Data>)): void

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:76
Parameters
- event: ((tree: Tree) => Map<string, Data>)
  - - (tree: Tree): Map<string, Data>
    - Parameters
      - tree: Tree
      Returns Map<string, Data>
Returns void

Protected generateCaptionSuffix

generateCaptionSuffix(nodeURI: URI): string

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:102
Parameters
- nodeURI: URI
Returns string

Protected getColor

getColor(marker: Marker<Diagnostic>): string

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:169
Parameters
- marker: Marker<Diagnostic>
Returns string

Protected getPriority

getPriority(marker: Marker<Diagnostic>): number

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:183
Get the decoration for a given marker diagnostic. Markers with higher severity have a higher priority and should be displayed.

Parameters
- marker: Marker<Diagnostic>
  
  the diagnostic marker.
Returns number

Protected getUriFromNode

getUriFromNode(node: TreeNode): undefined | string

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:204
Parameters
- node: TreeNode
Returns undefined | string

Protected init

init(): void

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:54
Returns void

Protected toDecorator

toDecorator(markers: Marker<Diagnostic>[]): Data

- Defined in packages/markers/src/browser/problem/problem-decorator.ts:154
Parameters
- markers: Marker<Diagnostic>[]
Returns Data