Class FileNavigatorContribution

Representation of a tabbar toolbar contribution.

Hierarchy (View Summary)

AbstractViewContribution<FileNavigatorWidget>
- FileNavigatorContribution

Implements

Index

Constructors

constructor

Accessors

defaultViewOptions editorWidgets effectiveWidgetId viewId viewLabel widget

Constructors

constructor

new FileNavigatorContribution(
    fileNavigatorPreferences: FileNavigatorPreferences,
    openerService: OpenerService,
    fileNavigatorFilter: FileNavigatorFilter,
    workspaceService: WorkspaceService,
    workspacePreferences: WorkspacePreferences,
): FileNavigatorContribution
Parameters
- fileNavigatorPreferences: FileNavigatorPreferences
- openerService: OpenerService
- fileNavigatorFilter: FileNavigatorFilter
- workspaceService: WorkspaceService
- workspacePreferences: WorkspacePreferences
Returns FileNavigatorContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/navigator/src/browser/navigator-contribution.ts:168

Properties

`Protected` `Readonly`clipboardService

clipboardService: ClipboardService

`Protected` `Readonly`commandRegistry

commandRegistry: CommandRegistry

`Protected` `Readonly`contextKeyService

contextKeyService: NavigatorContextKeyService

`Protected` `Readonly`fileClipboard

fileClipboard: NavigatorFileClipboard

`Protected` `Readonly`fileNavigatorFilter

fileNavigatorFilter: FileNavigatorFilter

`Protected` `Readonly`fileNavigatorPreferences

fileNavigatorPreferences: FileNavigatorPreferences

`Protected` `Readonly`menuRegistry

menuRegistry: MenuModelRegistry

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`navigatorDiff

navigatorDiff: NavigatorDiff

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`openWithService

openWithService: OpenWithService

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`quickInputService

quickInputService: QuickInputService

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`selectionService

selectionService: SelectionService

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`tabbarToolbarRegistry

tabbarToolbarRegistry: TabBarToolbarRegistry

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Protected` `Readonly`workspaceCommandContribution

workspaceCommandContribution: WorkspaceCommandContribution

`Protected` `Readonly`workspacePreferences

workspacePreferences: WorkspacePreferences

`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

`Protected`editorWidgets

get editorWidgets(): NavigatableWidget[]
Returns NavigatableWidget[]
- Defined in packages/navigator/src/browser/navigator-contribution.ts:362

effectiveWidgetId

get effectiveWidgetId(): string
The widget ID used for shell operations — viewContainerId if set, otherwise widgetId.

Returns string
Inherited from AbstractViewContribution.effectiveWidgetId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

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:37

Methods

`Protected`canPasteIntoNavigator

canPasteIntoNavigator(): boolean
Returns boolean
- Defined in packages/navigator/src/browser/navigator-contribution.ts:385

closeView

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

collapseFileNavigatorTree

collapseFileNavigatorTree(): Promise<void>
Collapse file navigator nodes and set focus on first visible node
- single root workspace: collapse all nodes except root
- multiple root workspace: collapse all nodes, even roots
Returns Promise<void>
- Defined in packages/navigator/src/browser/navigator-contribution.ts:675

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/navigator/src/browser/navigator-contribution.ts:227

`Protected`onCurrentWidgetChangedHandler

onCurrentWidgetChangedHandler(): void
Returns void
- Defined in packages/navigator/src/browser/navigator-contribution.ts:664

openView

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

`Protected`pasteIntoNavigator

pasteIntoNavigator(): Promise<void>
Pastes files into the navigator without a trusted paste event. The default CommonCommands.PASTE handler relies on document.execCommand('paste'), which browsers block for programmatic invocations, e.g. from the menu. Prefers the in-app file clipboard as reading the system clipboard may require a user permission prompt in browsers.

Returns Promise<void>
- Defined in packages/navigator/src/browser/navigator-contribution.ts:396

refreshWorkspace

refreshWorkspace(): Promise<void>
force refresh workspace in navigator

Returns Promise<void>
- Defined in packages/navigator/src/browser/navigator-contribution.ts:696

registerCommands

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

registerKeybindings

registerKeybindings(registry: KeybindingRegistry): void
Registers keybindings.
Parameters
- registry: KeybindingRegistry
  the keybinding registry.
Returns void
Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/navigator/src/browser/navigator-contribution.ts:540

registerMenus

registerMenus(registry: MenuModelRegistry): void
Registers menus.
Parameters
- registry: MenuModelRegistry
  the menu model registry.
Returns void
Overrides AbstractViewContribution.registerMenus
- Defined in packages/navigator/src/browser/navigator-contribution.ts:406

registerMoreToolbarItem

registerMoreToolbarItem(
item: Mutable<RenderedToolbarAction> & { command: string },
): void
Register commands to the More Actions... navigator toolbar item.
Parameters
- item: Mutable<RenderedToolbarAction> & { command: string }
Returns void
- Defined in packages/navigator/src/browser/navigator-contribution.ts:624

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/navigator/src/browser/navigator-contribution.ts:566

selectFileNode

selectFileNode(uri?: URI): Promise<boolean>
Parameters
- Optionaluri: URI
Returns Promise<boolean>
- Defined in packages/navigator/src/browser/navigator-contribution.ts:652

selectWidgetFileNode

selectWidgetFileNode(widget: undefined | Widget): Promise<boolean>
Reveals and selects node in the file navigator to which given widget is related. Does nothing if given widget undefined or doesn't have related resource.
Parameters
- widget: undefined | Widget
  widget file resource of which should be revealed and selected
Returns Promise<boolean>
- Defined in packages/navigator/src/browser/navigator-contribution.ts:648

toggleView

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

tryGetWidget

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

`Protected`withOpenEditorsWidget

withOpenEditorsWidget<T>(
widget: Widget,
cb: (navigator: OpenEditorsWidget) => T,
): false | T
Type Parameters
- T
Parameters
- widget: Widget
- cb: (navigator: OpenEditorsWidget) => T
Returns false | T
- Defined in packages/navigator/src/browser/navigator-contribution.ts:378

`Protected`withWidget

withWidget<T>(
widget?: undefined | Widget,
cb: (navigator: FileNavigatorWidget) => T,
): false | T
Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- cb: (navigator: FileNavigatorWidget) => T
Returns false | T
- Defined in packages/navigator/src/browser/navigator-contribution.ts:371

Class FileNavigatorContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FileNavigatorContribution

Properties

Protected ReadonlyclipboardService

Protected ReadonlycommandRegistry

Protected ReadonlycontextKeyService

Protected ReadonlyfileClipboard

Protected ReadonlyfileNavigatorFilter

Protected ReadonlyfileNavigatorPreferences

Protected ReadonlymenuRegistry

Protected ReadonlymessageService

Protected ReadonlynavigatorDiff

Protected ReadonlyopenerService

Protected ReadonlyopenWithService

Protected Readonlyoptions

Protected ReadonlypreferenceService

Protected ReadonlyquickInputService

Protected ReadonlyquickView

Protected ReadonlyselectionService

Protected Readonlyshell

Protected ReadonlytabbarToolbarRegistry

Optional ReadonlytoggleCommand

Protected ReadonlywidgetManager

Protected ReadonlyworkspaceCommandContribution

Protected ReadonlyworkspacePreferences

Protected ReadonlyworkspaceService

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

ProtectededitorWidgets

Returns NavigatableWidget[]

effectiveWidgetId

Returns string

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

ProtectedcanPasteIntoNavigator

Returns boolean

closeView

Returns Promise<undefined | FileNavigatorWidget>

collapseFileNavigatorTree

Returns Promise<void>

ProtecteddoInit

Returns Promise<void>

ProtectedgetSelectedFileNodes

Returns FileStatNode[]

Protectedinit

Returns void

initializeLayout

Parameters

Returns Promise<void>

ProtectedonCurrentWidgetChangedHandler

Returns void

openView

Parameters

Returns Promise<FileNavigatorWidget>

ProtectedpasteIntoNavigator

Returns Promise<void>

refreshWorkspace

Returns Promise<void>

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

`Protected` `Readonly`clipboardService

`Protected` `Readonly`commandRegistry

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`fileClipboard

`Protected` `Readonly`fileNavigatorFilter

`Protected` `Readonly`fileNavigatorPreferences

`Protected` `Readonly`menuRegistry

`Protected` `Readonly`messageService

`Protected` `Readonly`navigatorDiff

`Protected` `Readonly`openerService

`Protected` `Readonly`openWithService

`Protected` `Readonly`options

`Protected` `Readonly`preferenceService

`Protected` `Readonly`quickInputService

`Protected` `Readonly`quickView

`Protected` `Readonly`selectionService

`Protected` `Readonly`shell

`Protected` `Readonly`tabbarToolbarRegistry

`Optional` `Readonly`toggleCommand

`Protected` `Readonly`widgetManager

`Protected` `Readonly`workspaceCommandContribution

`Protected` `Readonly`workspacePreferences

`Protected` `Readonly`workspaceService

`Protected`editorWidgets

`Protected`canPasteIntoNavigator

`Protected`doInit

`Protected`getSelectedFileNodes

`Protected`init

`Protected`onCurrentWidgetChangedHandler

`Protected`pasteIntoNavigator

`Protected`withOpenEditorsWidget

`Protected`withWidget