Class OutlineViewContribution

Representation of a tabbar toolbar contribution.

Hierarchy (View Summary)

AbstractViewContribution<OutlineViewWidget>
- OutlineViewContribution

Implements

Index

Constructors

constructor

new OutlineViewContribution(): OutlineViewContribution
Returns OutlineViewContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/outline-view/src/browser/outline-view-contribution.ts:55

Properties

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`shell

shell: ApplicationShell

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`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

closeView

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

`Protected`collapseAllItems

collapseAllItems(): Promise<void>
Collapse all nodes in the outline view tree.

Returns Promise<void>
- Defined in packages/outline-view/src/browser/outline-view-contribution.ts:110

`Protected`expandAllItems

expandAllItems(): Promise<void>
Returns Promise<void>
- Defined in packages/outline-view/src/browser/outline-view-contribution.ts:118

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/outline-view/src/browser/outline-view-contribution.ts:70

openView

openView(args?: Partial<OpenViewArguments>): Promise<OutlineViewWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<OutlineViewWidget>
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/outline-view/src/browser/outline-view-contribution.ts:74

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
Inherited from AbstractViewContribution.registerMenus
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:41

registerToolbarItems

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

toggleView

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

tryGetWidget

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

`Protected`withWidget

withWidget<T>(
widget?: undefined | Widget,
cb: (widget: OutlineViewWidget) => T,
): false | T
Determine if the current widget is the outline-view.
Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- cb: (widget: OutlineViewWidget) => T
Returns false | T
- Defined in packages/outline-view/src/browser/outline-view-contribution.ts:126