Class FilepathBreadcrumbsContribution

Hierarchy (View Summary)

FilepathBreadcrumbsContribution
- WorkspaceBreadcrumbsContribution

Implements

BreadcrumbsContribution

Index

Constructors

Properties

breadcrumbsFileTreeWidget fileSystem labelProvider onDidChangeBreadcrumbsEmitter priority type

Accessors

onDidChangeBreadcrumbs

Methods

attachPopupContent computeBreadcrumbs createRootNode filterBreadcrumbs getContainerClassCreator getIconClassCreator

Constructors

constructor

new FilepathBreadcrumbsContribution(): FilepathBreadcrumbsContribution
Returns FilepathBreadcrumbsContribution

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 = 100

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

`Readonly`type

type: symbol = FilepathBreadcrumbType

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

Accessors

onDidChangeBreadcrumbs

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

Returns Event<URI>
Implementation of BreadcrumbsContribution.onDidChangeBreadcrumbs
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:46

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>
Implementation of BreadcrumbsContribution.attachPopupContent
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:87

computeBreadcrumbs

computeBreadcrumbs(uri: URI): Promise<Breadcrumb[]>
Computes breadcrumbs for a given URI.
Parameters
- uri: URI
Returns Promise<Breadcrumb[]>
Implementation of BreadcrumbsContribution.computeBreadcrumbs
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:53

`Protected`createRootNode

createRootNode(folderToOpen: FileStat): Promise<undefined | DirNode>
Parameters
- folderToOpen: FileStat
Returns Promise<undefined | DirNode>
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:121

`Protected`filterBreadcrumbs

filterBreadcrumbs(_: URI, breadcrumb: FilepathBreadcrumb): boolean
Parameters
- _: URI
- breadcrumb: FilepathBreadcrumb
Returns boolean
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:83

`Protected`getContainerClassCreator

getContainerClassCreator(fileURI: URI): FilepathBreadcrumbClassNameFactory
Parameters
- fileURI: URI
Returns FilepathBreadcrumbClassNameFactory
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:75

`Protected`getIconClassCreator

getIconClassCreator(fileURI: URI): FilepathBreadcrumbClassNameFactory
Parameters
- fileURI: URI
Returns FilepathBreadcrumbClassNameFactory
- Defined in packages/filesystem/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts:79