Class OutlineDecoratorService

Decorator service for the outline.

Hierarchy (View Summary)

AbstractTreeDecoratorService
- OutlineDecoratorService

Index

Constructors

Properties

contributions decorators onDidChangeDecorations onDidChangeDecorationsEmitter toDispose

Methods

deflateDecorators dispose getDecorations inflateDecorators

Constructors

constructor

new OutlineDecoratorService(
contributions: ContributionProvider<TreeDecorator>,
): OutlineDecoratorService
Parameters
- contributions: ContributionProvider<TreeDecorator>
Returns OutlineDecoratorService
Overrides AbstractTreeDecoratorService.constructor
- Defined in packages/outline-view/src/browser/outline-decorator-service.ts:32

Properties

`Protected` `Readonly`contributions

contributions: ContributionProvider<TreeDecorator>

`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: Map<string, WidgetDecoration.Data[]>): object
Transforms the decoration data into an object, so that it can be safely serialized into JSON.
Parameters
- decorations: Map<string, WidgetDecoration.Data[]>
  the decoration data that should be deflated
Returns object
the decoration data as serializable JSON object
Inherited from AbstractTreeDecoratorService.deflateDecorators
- Defined in packages/core/lib/browser/tree/tree-decorator.d.ts:125

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from AbstractTreeDecoratorService.dispose
- Defined in packages/core/lib/browser/tree/tree-decorator.d.ts:123

getDecorations

getDecorations(tree: Tree): Promise<Map<string, WidgetDecoration.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, WidgetDecoration.Data[]>>
(a promise of) the computed decoration data
Inherited from AbstractTreeDecoratorService.getDecorations
- Defined in packages/core/lib/browser/tree/tree-decorator.d.ts:124

inflateDecorators

inflateDecorators(state: any): Map<string, WidgetDecoration.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, WidgetDecoration.Data[]>
the deserialized `decoration data
Inherited from AbstractTreeDecoratorService.inflateDecorators
- Defined in packages/core/lib/browser/tree/tree-decorator.d.ts:126