Class AbstractTreeDecoratorService`Abstract`

Abstract decorator service implementation which emits events from all known tree decorators and caches the current state.

Implements

TreeDecoratorService

Index

Constructors

Properties

decorators onDidChangeDecorations onDidChangeDecorationsEmitter toDispose

Methods

deflateDecorators dispose getDecorations inflateDecorators

Constructors

constructor

new AbstractTreeDecoratorService(decorators): AbstractTreeDecoratorService
Parameters
- decorators: readonly TreeDecorator[]
Returns AbstractTreeDecoratorService
- Defined in packages/core/src/browser/tree/tree-decorator.ts:173

Properties

`Protected` `Readonly` decorators

decorators: readonly TreeDecorator[]

`Readonly` onDidChangeDecorations

onDidChangeDecorations: Event<void> = ...

Fired when any of the available tree decorators has changes.

`Protected` `Readonly` onDidChangeDecorationsEmitter

onDidChangeDecorationsEmitter: Emitter<void> = ...

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

Methods

deflateDecorators

deflateDecorators(decorations): object
Transforms the decoration data into an object, so that it can be safely serialized into JSON.
Parameters
- decorations: Map<string, core.Data[]>
  the decoration data that should be deflated
Returns object
the decoration data as serializable JSON object
Implementation of TreeDecoratorService.deflateDecorators
- Defined in packages/core/src/browser/tree/tree-decorator.ts:200

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of TreeDecoratorService.dispose
- Defined in packages/core/src/browser/tree/tree-decorator.ts:182

getDecorations

getDecorations(tree): Promise<Map<string, core.Data[]>>
Computes the decorations for the tree based on the actual state of this decorator service.
Parameters
- tree: Tree
  the tree to decorate
Returns Promise<Map<string, core.Data[]>>
(a promise of) the computed decoration data
Implementation of TreeDecoratorService.getDecorations
- Defined in packages/core/src/browser/tree/tree-decorator.ts:186

inflateDecorators

inflateDecorators(state): Map<string, core.Data[]>
Counterpart of the deflateDecorators method. Restores the argument into a Map of tree node IDs and the corresponding decorations data array (decoration data).
Parameters
- state: any
Returns Map<string, core.Data[]>
the deserialized `decoration data
Implementation of TreeDecoratorService.inflateDecorators
- Defined in packages/core/src/browser/tree/tree-decorator.ts:210