Class OutlineBreadcrumbsContribution

Implements

BreadcrumbsContribution

Index

Constructors

Properties

breadcrumbsService currentBreadcrumbs currentUri labelProvider onDidChangeBreadcrumbsEmitter outlineFactory outlineView outlineViewService priority roots type

Accessors

onDidChangeBreadcrumbs

Methods

attachPopupContent computeBreadcrumbs findSelectedNode init toOutlinePath updateOutlineItems

Constructors

constructor

new OutlineBreadcrumbsContribution(): OutlineBreadcrumbsContribution
Returns OutlineBreadcrumbsContribution

Properties

`Protected` `Readonly`breadcrumbsService

breadcrumbsService: BreadcrumbsService

`Protected`currentBreadcrumbs

currentBreadcrumbs: OutlineBreadcrumb[] = []

`Protected`currentUri

currentUri: undefined | URI = undefined

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`onDidChangeBreadcrumbsEmitter

onDidChangeBreadcrumbsEmitter: Emitter<URI> = ...

`Protected` `Readonly`outlineFactory

outlineFactory: BreadcrumbPopupOutlineViewFactory

`Protected`outlineView

outlineView: BreadcrumbPopupOutlineView

`Protected` `Readonly`outlineViewService

outlineViewService: OutlineViewService

`Readonly`priority

priority: number = 200

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

`Protected`roots

roots: OutlineSymbolInformationNode[] = []

`Readonly`type

type: symbol = OutlineBreadcrumbType

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/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:76

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/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:151

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/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:144

`Protected`findSelectedNode

findSelectedNode(
roots: OutlineSymbolInformationNode[],
): undefined | OutlineSymbolInformationNode
Find the node that is selected. Returns after the first match.
Parameters
- roots: OutlineSymbolInformationNode[]
Returns undefined | OutlineSymbolInformationNode
- Defined in packages/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:193

init

init(): void
Returns void
- Defined in packages/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:81

`Protected`toOutlinePath

toOutlinePath(
node: undefined | OutlineSymbolInformationNode,
path?: OutlineSymbolInformationNode[],
): undefined | OutlineSymbolInformationNode[]
Returns the path of the given outline node.
Parameters
- node: undefined | OutlineSymbolInformationNode
- path: OutlineSymbolInformationNode[] = []
Returns undefined | OutlineSymbolInformationNode[]
- Defined in packages/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:180

`Protected`updateOutlineItems

updateOutlineItems(
uri: URI,
selectedNode: undefined | OutlineSymbolInformationNode,
): Promise<void>
Parameters
- uri: URI
- selectedNode: undefined | OutlineSymbolInformationNode
Returns Promise<void>
- Defined in packages/outline-view/src/browser/outline-breadcrumbs-contribution.tsx:104