Class SearchInWorkspaceFrontendContribution

Representation of a tabbar toolbar contribution.

Hierarchy (View Summary)

AbstractViewContribution<SearchInWorkspaceWidget>
- SearchInWorkspaceFrontendContribution

Implements

Constructors

constructor

new SearchInWorkspaceFrontendContribution(): SearchInWorkspaceFrontendContribution
Returns SearchInWorkspaceFrontendContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:139

Properties

`Protected` `Readonly`clipboardService

clipboardService: ClipboardService

`Protected` `Readonly`contextKeyService

contextKeyService: SearchInWorkspaceContextKeyService

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`shell

shell: ApplicationShell

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

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 | SearchInWorkspaceWidget>
Returns Promise<undefined | SearchInWorkspaceWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

`Protected`getSearchTerm

getSearchTerm(): string
Get the search term based on current editor selection.

Returns string
the selection if available.
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:342

`Protected`init

init(): void
Returns void
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:153

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/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:160

`Protected`newMultiUriAwareCommandHandler

newMultiUriAwareCommandHandler(
handler: UriCommandHandler<URI[]>,
): UriAwareCommandHandler<URI[]>
Parameters
- handler: UriCommandHandler<URI[]>
Returns UriAwareCommandHandler<URI[]>
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:496

`Protected`newUriAwareCommandHandler

newUriAwareCommandHandler(
handler: UriCommandHandler<URI>,
): UriAwareCommandHandler<URI>
Parameters
- handler: UriCommandHandler<URI>
Returns UriAwareCommandHandler<URI>
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:492

openView

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

registerToolbarItems

registerToolbarItems(toolbarRegistry: TabBarToolbarRegistry): Promise<void>
Registers toolbar items.
Parameters
- toolbarRegistry: TabBarToolbarRegistry
  the tabbar toolbar registry.
Returns Promise<void>
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:452

toggleView

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

tryGetWidget

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

`Protected`withWidget

withWidget<T>(
widget?: undefined | Widget,
fn: (widget: SearchInWorkspaceWidget) => T,
): false | T
Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- fn: (widget: SearchInWorkspaceWidget) => T
Returns false | T
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-frontend-contribution.ts:331

Class SearchInWorkspaceFrontendContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SearchInWorkspaceFrontendContribution

Properties

Protected ReadonlyclipboardService

Protected ReadonlycontextKeyService

Protected ReadonlyeditorManager

Protected ReadonlyfileService

Protected ReadonlylabelProvider

Protected Readonlyoptions

Protected ReadonlyquickView

Protected ReadonlyselectionService

Protected Readonlyshell

Optional ReadonlytoggleCommand

Protected ReadonlywidgetManager

Protected ReadonlyworkspaceService

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

closeView

Returns Promise<undefined | SearchInWorkspaceWidget>

ProtectedgetSearchTerm

Returns string

Protectedinit

Returns void

initializeLayout

Parameters

Returns Promise<void>

ProtectednewMultiUriAwareCommandHandler

Parameters

Returns UriAwareCommandHandler<URI[]>

ProtectednewUriAwareCommandHandler

Parameters

Returns UriAwareCommandHandler<URI>

openView

Parameters

Returns Promise<SearchInWorkspaceWidget>

registerCommands

Parameters

Returns Promise<void>

registerKeybindings

Parameters

Returns void

registerMenus

Parameters

Returns void

registerThemeStyle

Parameters

Returns void

registerToolbarItems

Parameters

Returns Promise<void>

toggleView

Returns Promise<SearchInWorkspaceWidget>

tryGetWidget

Returns undefined | SearchInWorkspaceWidget

ProtectedwithWidget

Type Parameters

Parameters

Returns false | T

Settings

On This Page

`Protected` `Readonly`clipboardService

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`editorManager

`Protected` `Readonly`fileService

`Protected` `Readonly`labelProvider

`Protected` `Readonly`options

`Protected` `Readonly`quickView

`Protected` `Readonly`selectionService

`Protected` `Readonly`shell

`Optional` `Readonly`toggleCommand

`Protected` `Readonly`widgetManager

`Protected` `Readonly`workspaceService

`Protected`getSearchTerm

`Protected`init

`Protected`newMultiUriAwareCommandHandler

`Protected`newUriAwareCommandHandler

`Protected`withWidget