Class TreeViewsExtImpl

Implements

TreeViewsExt

Index

Constructors

Properties

Methods

$checkStateChanged $dragEnd $dragStarted $drop $getChildren $hasResolveTreeItem $resolveTreeItem $setExpanded $setSelection $setVisible createTreeView getTreeView registerTreeDataProvider toTreeElement

Constructors

constructor

new TreeViewsExtImpl(
rpc: RPCProtocol,
commandRegistry: CommandRegistryImpl,
): TreeViewsExtImpl
Parameters
- rpc: RPCProtocol
- commandRegistry: CommandRegistryImpl
Returns TreeViewsExtImpl
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:44

Properties

`Readonly`commandRegistry

commandRegistry: CommandRegistryImpl

Methods

$checkStateChanged

$checkStateChanged(
treeViewId: string,
itemIds: { checked: boolean; id: string }[],
): Promise<void>
Parameters
- treeViewId: string
- itemIds: { checked: boolean; id: string }[]
Returns Promise<void>
Implementation of TreeViewsExt.$checkStateChanged
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:59

$dragEnd

$dragEnd(treeViewId: string): Promise<void>
Parameters
- treeViewId: string
Returns Promise<void>
Implementation of TreeViewsExt.$dragEnd
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:66

$dragStarted

$dragStarted(
    treeViewId: string,
    treeItemIds: string[],
    token: CancellationToken,
): Promise<undefined | UriComponents[]>
Parameters
- treeViewId: string
- treeItemIds: string[]
- token: CancellationToken
Returns Promise<undefined | UriComponents[]>
Implementation of TreeViewsExt.$dragStarted
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:62

$drop

$drop(
    treeViewId: string,
    treeItemId: undefined | string,
    dataTransferItems: [string, string | DataTransferFileDTO][],
    token: CancellationToken,
): Promise<void>
Parameters
- treeViewId: string
- treeItemId: undefined | string
- dataTransferItems: [string, string | DataTransferFileDTO][]
- token: CancellationToken
Returns Promise<void>
Implementation of TreeViewsExt.$drop
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:70

$getChildren

$getChildren(
treeViewId: string,
treeItemId: string,
): Promise<undefined | TreeViewItem[]>
Parameters
- treeViewId: string
- treeItemId: string
Returns Promise<undefined | TreeViewItem[]>
Implementation of TreeViewsExt.$getChildren
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:152

$hasResolveTreeItem

$hasResolveTreeItem(treeViewId: string): Promise<boolean>
Parameters
- treeViewId: string
Returns Promise<boolean>
Implementation of TreeViewsExt.$hasResolveTreeItem
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:162

$resolveTreeItem

$resolveTreeItem(
    treeViewId: string,
    treeItemId: string,
    token: CancellationToken,
): Promise<undefined | TreeViewItem>
Parameters
- treeViewId: string
- treeItemId: string
- token: CancellationToken
Returns Promise<undefined | TreeViewItem>
Implementation of TreeViewsExt.$resolveTreeItem
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:158

$setExpanded

$setExpanded(
    treeViewId: string,
    treeItemId: string,
    expanded: boolean,
): Promise<any>
Parameters
- treeViewId: string
- treeItemId: string
- expanded: boolean
Returns Promise<any>
Implementation of TreeViewsExt.$setExpanded
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:166

$setSelection

$setSelection(treeViewId: string, treeItemIds: string[]): Promise<void>
Parameters
- treeViewId: string
- treeItemIds: string[]
Returns Promise<void>
Implementation of TreeViewsExt.$setSelection
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:176

$setVisible

$setVisible(treeViewId: string, isVisible: boolean): Promise<void>
Parameters
- treeViewId: string
- isVisible: boolean
Returns Promise<void>
Implementation of TreeViewsExt.$setVisible
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:180

createTreeView

createTreeView<T>(
    plugin: Plugin,
    treeViewId: string,
    options: TreeViewOptions<T>,
): TreeView<T>
Type Parameters
- T
Parameters
- plugin: Plugin
- treeViewId: string
- options: TreeViewOptions<T>
Returns TreeView<T>
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:87

`Protected`getTreeView

getTreeView(treeViewId: string): TreeViewExtImpl<any>
Parameters
- treeViewId: string
Returns TreeViewExtImpl<any>
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:184

registerTreeDataProvider

registerTreeDataProvider<T>(
    plugin: Plugin,
    treeViewId: string,
    treeDataProvider: TreeDataProvider<T>,
): Disposable
Type Parameters
- T
Parameters
- plugin: Plugin
- treeViewId: string
- treeDataProvider: TreeDataProvider<T>
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:78

`Protected`toTreeElement

toTreeElement(treeViewItemRef: TreeViewItemReference): any
Parameters
- treeViewItemRef: TreeViewItemReference
Returns any
- Defined in packages/plugin-ext/src/plugin/tree/tree-views.ts:74

Class TreeViewsExtImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TreeViewsExtImpl

Properties

ReadonlycommandRegistry

Methods

$checkStateChanged

Parameters

Returns Promise<void>

$dragEnd

Parameters

Returns Promise<void>

$dragStarted

Parameters

Returns Promise<undefined | UriComponents[]>

$drop

Parameters

Returns Promise<void>

$getChildren

Parameters

Returns Promise<undefined | TreeViewItem[]>

$hasResolveTreeItem

Parameters

Returns Promise<boolean>

$resolveTreeItem

Parameters

Returns Promise<undefined | TreeViewItem>

$setExpanded

Parameters

Returns Promise<any>

$setSelection

Parameters

Returns Promise<void>

$setVisible

Parameters

Returns Promise<void>

createTreeView

Type Parameters

Parameters

Returns TreeView<T>

ProtectedgetTreeView

Parameters

Returns TreeViewExtImpl<any>

registerTreeDataProvider

Type Parameters

Parameters

Returns Disposable

ProtectedtoTreeElement

Parameters

Returns any

Settings

On This Page

`Readonly`commandRegistry

`Protected`getTreeView

`Protected`toTreeElement