Class OutputContribution

OpenHandler should be implemented to provide a new opener.

Hierarchy (View Summary)

AbstractViewContribution<OutputWidget>
- OutputContribution

Implements

OpenHandler

Index

Constructors

constructor

new OutputContribution(): OutputContribution
Returns OutputContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/output/src/browser/output-contribution.ts:53

Properties

`Protected` `Readonly`clipboardService

clipboardService: ClipboardService

`Protected` `Readonly`commandService

commandService: CommandService

`Readonly`id

id: string = ...

A unique id of this handler.

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`outputChannelManager

outputChannelManager: OutputChannelManager

`Protected` `Readonly`quickPickService

quickPickService: QuickPickService

`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

canHandle

canHandle(uri: URI): MaybePromise<number>
Test whether this handler can open the given URI for given options. Return a nonzero number if this handler can open; otherwise it cannot. Never reject.

A returned value indicating a priority of this handler.
Parameters
- uri: URI
Returns MaybePromise<number>
Implementation of OpenHandler.canHandle
- Defined in packages/output/src/browser/output-contribution.ts:239

closeView

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

`Protected`init

init(): void
Returns void
- Defined in packages/output/src/browser/output-contribution.ts:66

open

open(uri: URI, options?: OpenerOptions): Promise<OutputWidget>
Open a widget for the given URI and options. Resolve to an opened widget or undefined, e.g. if a page is opened. Never reject if canHandle return a positive number; otherwise should reject.
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns Promise<OutputWidget>
Implementation of OpenHandler.open
- Defined in packages/output/src/browser/output-contribution.ts:243

openView

openView(args?: Partial<OpenViewArguments>): Promise<OutputWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<OutputWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

`Protected`pick

pick(
__namedParameters: { channels: OutputChannel[]; placeholder: string },
): Promise<undefined | OutputChannel>
Parameters
- __namedParameters: { channels: OutputChannel[]; placeholder: string }
Returns Promise<undefined | OutputChannel>
- Defined in packages/output/src/browser/output-contribution.ts:258

registerCommands

registerCommands(registry: CommandRegistry): void
Register commands and handlers.
Parameters
- registry: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/output/src/browser/output-contribution.ts:71

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(registry: MenuModelRegistry): void
Registers menus.
Parameters
- registry: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/output/src/browser/output-contribution.ts:220

toggleView

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

tryGetWidget

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

`Protected`withWidget

withWidget(
widget?: undefined | Widget,
predicate?: (output: OutputWidget) => boolean,
): boolean
Parameters
- widget: undefined | Widget = ...
- predicate: (output: OutputWidget) => boolean = ...
Returns boolean
- Defined in packages/output/src/browser/output-contribution.ts:251