Class WorkspaceBreadcrumbsContribution

Hierarchy (View Summary)

FilepathBreadcrumbsContribution
- WorkspaceBreadcrumbsContribution

Index

Constructors

Properties

breadcrumbsFileTreeWidget fileSystem labelProvider onDidChangeBreadcrumbsEmitter priority type workspaceService

Accessors

onDidChangeBreadcrumbs

Methods

attachPopupContent computeBreadcrumbs createRootNode filterBreadcrumbs getContainerClassCreator getIconClassCreator

Constructors

constructor

new WorkspaceBreadcrumbsContribution(): WorkspaceBreadcrumbsContribution
Returns WorkspaceBreadcrumbsContribution
Inherited from FilepathBreadcrumbsContribution.constructor

Properties

`Protected` `Readonly`breadcrumbsFileTreeWidget

breadcrumbsFileTreeWidget: BreadcrumbsFileTreeWidget

`Protected` `Readonly`fileSystem

fileSystem: FileService

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`onDidChangeBreadcrumbsEmitter

onDidChangeBreadcrumbsEmitter: Emitter<URI>

`Readonly`priority

priority: number

The priority of this breadcrumbs contribution. Contributions are rendered left to right in order of ascending priority.

`Readonly`type

type: symbol

The breadcrumb type. Breadcrumbs returned by #computeBreadcrumbs(uri) should have this as Breadcrumb#type.

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

onDidChangeBreadcrumbs

get onDidChangeBreadcrumbs(): Event<URI>
An event emitter that should fire when breadcrumbs change for a given URI.

Returns Event<URI>
Inherited from FilepathBreadcrumbsContribution.onDidChangeBreadcrumbs
- Defined in packages/filesystem/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts:18

Methods

attachPopupContent

attachPopupContent(
breadcrumb: Breadcrumb,
parent: HTMLElement,
): Promise<undefined | Disposable>
Attaches the breadcrumb popup content for the given breadcrumb as child to the given parent. If it returns a Disposable, it is called when the popup closes.
Parameters
- breadcrumb: Breadcrumb
- parent: HTMLElement
Returns Promise<undefined | Disposable>
Inherited from FilepathBreadcrumbsContribution.attachPopupContent
- Defined in packages/filesystem/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts:25

computeBreadcrumbs

computeBreadcrumbs(uri: URI): Promise<Breadcrumb[]>
Computes breadcrumbs for a given URI.
Parameters
- uri: URI
Returns Promise<Breadcrumb[]>
Inherited from FilepathBreadcrumbsContribution.computeBreadcrumbs
- Defined in packages/filesystem/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts:21

`Protected`createRootNode

createRootNode(folderToOpen: FileStat): Promise<undefined | DirNode>
Parameters
- folderToOpen: FileStat
Returns Promise<undefined | DirNode>
Inherited from FilepathBreadcrumbsContribution.createRootNode
- Defined in packages/filesystem/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts:26

`Protected`filterBreadcrumbs

filterBreadcrumbs(uri: URI, breadcrumb: FilepathBreadcrumb): boolean
Parameters
- uri: URI
- breadcrumb: FilepathBreadcrumb
Returns boolean
Overrides FilepathBreadcrumbsContribution.filterBreadcrumbs
- Defined in packages/workspace/src/browser/workspace-breadcrumbs-contribution.ts:51

getContainerClassCreator

getContainerClassCreator(fileURI: URI): FilepathBreadcrumbClassNameFactory
Parameters
- fileURI: URI
Returns FilepathBreadcrumbClassNameFactory
Overrides FilepathBreadcrumbsContribution.getContainerClassCreator
- Defined in packages/workspace/src/browser/workspace-breadcrumbs-contribution.ts:29

getIconClassCreator

getIconClassCreator(fileURI: URI): FilepathBreadcrumbClassNameFactory
Parameters
- fileURI: URI
Returns FilepathBreadcrumbClassNameFactory
Overrides FilepathBreadcrumbsContribution.getIconClassCreator
- Defined in packages/workspace/src/browser/workspace-breadcrumbs-contribution.ts:41