Class OutlineViewService

A WidgetFactory is used to create new widgets. Factory-specific information (options) can be passed as serializable JSON data. The common WidgetManager collects WidgetFactory contributions and delegates to the corresponding factory when a widget should be created or restored. To identify widgets the WidgetManager uses a description composed of the factory id and the options. The WidgetFactory does support both, synchronous and asynchronous widget creation.

Example usage

export class MyWidget extends BaseWidget {
}

@injectable()
export class MyWidgetFactory implements WidgetFactory {
    id = 'myWidgetFactory';

    createWidget(): MaybePromise<Widget> {
        return new MyWidget();
   }
}

Implements

WidgetFactory

Index

Constructors

constructor

new OutlineViewService(factory: OutlineViewWidgetFactory): OutlineViewService
Parameters
- factory: OutlineViewWidgetFactory
Returns OutlineViewService
- Defined in packages/outline-view/src/browser/outline-view-service.ts:35

Properties

`Protected`factory

factory: OutlineViewWidgetFactory

id

id: string = 'outline-view'

The factory id.

`Protected` `Readonly`onDidChangeOpenStateEmitter

onDidChangeOpenStateEmitter: Emitter<boolean> = ...

`Protected` `Readonly`onDidChangeOutlineEmitter

onDidChangeOutlineEmitter: Emitter<OutlineSymbolInformationNode[]> = ...

`Protected` `Readonly`onDidOpenEmitter

onDidOpenEmitter: Emitter<OutlineSymbolInformationNode> = ...

`Protected` `Readonly`onDidSelectEmitter

onDidSelectEmitter: Emitter<OutlineSymbolInformationNode> = ...

`Protected` `Readonly`onDidTapNodeEmitter

onDidTapNodeEmitter: Emitter<OutlineSymbolInformationNode> = ...

`Protected` `Optional`widget

widget?: OutlineViewWidget

Accessors

onDidChangeOpenState

get onDidChangeOpenState(): Event<boolean>
Returns Event<boolean>
- Defined in packages/outline-view/src/browser/outline-view-service.ts:49

onDidChangeOutline

get onDidChangeOutline(): Event<OutlineSymbolInformationNode[]>
Returns Event<OutlineSymbolInformationNode[]>
- Defined in packages/outline-view/src/browser/outline-view-service.ts:45

onDidOpen

get onDidOpen(): Event<OutlineSymbolInformationNode>
Returns Event<OutlineSymbolInformationNode>
- Defined in packages/outline-view/src/browser/outline-view-service.ts:41

onDidSelect

get onDidSelect(): Event<OutlineSymbolInformationNode>
Returns Event<OutlineSymbolInformationNode>
- Defined in packages/outline-view/src/browser/outline-view-service.ts:37

onDidTapNode

get onDidTapNode(): Event<OutlineSymbolInformationNode>
Returns Event<OutlineSymbolInformationNode>
- Defined in packages/outline-view/src/browser/outline-view-service.ts:53

open

get open(): boolean
Returns boolean
- Defined in packages/outline-view/src/browser/outline-view-service.ts:57

Methods

createWidget

createWidget(): Promise<Widget>
Creates a widget using the given options.

Returns Promise<Widget>
the newly created widget or a promise of the widget
Implementation of WidgetFactory.createWidget
- Defined in packages/outline-view/src/browser/outline-view-service.ts:79

didTapNode

didTapNode(node: OutlineSymbolInformationNode): void
Parameters
- node: OutlineSymbolInformationNode
Returns void
- Defined in packages/outline-view/src/browser/outline-view-service.ts:61

publish

publish(roots: OutlineSymbolInformationNode[]): void
Publish the collection of outline view symbols.
- Publishing includes setting the OutlineViewWidget tree with symbol information.
Parameters
- roots: OutlineSymbolInformationNode[]
  the list of outline symbol information nodes.
Returns void
- Defined in packages/outline-view/src/browser/outline-view-service.ts:70

Class OutlineViewService

Example usage

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OutlineViewService

Properties

Protectedfactory

id

Protected ReadonlyonDidChangeOpenStateEmitter

Protected ReadonlyonDidChangeOutlineEmitter

Protected ReadonlyonDidOpenEmitter

Protected ReadonlyonDidSelectEmitter

Protected ReadonlyonDidTapNodeEmitter

Protected Optionalwidget

Accessors

onDidChangeOpenState

Returns Event<boolean>

onDidChangeOutline

Returns Event<OutlineSymbolInformationNode[]>

onDidOpen

Returns Event<OutlineSymbolInformationNode>

onDidSelect

Returns Event<OutlineSymbolInformationNode>

onDidTapNode

Returns Event<OutlineSymbolInformationNode>

open

Returns boolean

Methods

createWidget

Returns Promise<Widget>

didTapNode

Parameters

Returns void

publish

Parameters

Returns void

Settings

On This Page

`Protected`factory

`Protected` `Readonly`onDidChangeOpenStateEmitter

`Protected` `Readonly`onDidChangeOutlineEmitter

`Protected` `Readonly`onDidOpenEmitter

`Protected` `Readonly`onDidSelectEmitter

`Protected` `Readonly`onDidTapNodeEmitter

`Protected` `Optional`widget