PluginTree | Theia TypeDoc

Hierarchy

TreeImpl
- PluginTree

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PluginTree(): PluginTree

Inherited from TreeImpl.constructor
- Defined in packages/core/lib/browser/tree/tree.d.ts:155
Returns PluginTree

Properties

Private _isEmpty

_isEmpty: boolean

Private _proxy

_proxy: undefined | TreeViewsExt

Protected _root

_root: undefined | TreeNode

Private _viewInfo

_viewInfo: undefined | View

Protected Readonly identifier

identifier: TreeViewWidgetIdentifier

Protected nodes

nodes: {}

Type declaration

[id: string]: Mutable<TreeNode> | undefined

Protected Readonly notification

notification: MessageService

Protected Readonly onChangedEmitter

onChangedEmitter: Emitter<void>

Readonly onDidChangeBusy

onDidChangeBusy: Event<TreeNode>

Protected Readonly onDidChangeBusyEmitter

onDidChangeBusyEmitter: Emitter<TreeNode>

Readonly onDidChangeWelcomeState

onDidChangeWelcomeState: Event<void> = ...

Protected Readonly onDidChangeWelcomeStateEmitter

onDidChangeWelcomeStateEmitter: Emitter<void> = ...

Protected Readonly onNodeRefreshedEmitter

onNodeRefreshedEmitter: Emitter<CompositeTreeNode & WaitUntilEvent>

Protected Readonly sharedStyle

sharedStyle: PluginSharedStyle

Protected Readonly toDispose

toDispose: DisposableCollection

Accessors

isEmpty

get isEmpty(): boolean

- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:118
Returns boolean

onChanged

get onChanged(): Event<void>

- Defined in packages/core/lib/browser/tree/tree.d.ts:160
Returns Event<void>

onNodeRefreshed

get onNodeRefreshed(): Event<CompositeTreeNode & WaitUntilEvent>

- Defined in packages/core/lib/browser/tree/tree.d.ts:162
Returns Event<CompositeTreeNode & WaitUntilEvent>

proxy

get proxy(): undefined | TreeViewsExt
set proxy(proxy: undefined | TreeViewsExt): void

- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:110
Returns undefined | TreeViewsExt
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:107
Parameters
- proxy: undefined | TreeViewsExt
Returns void

root

get root(): undefined | TreeNode
set root(root: undefined | TreeNode): any

- Defined in packages/core/lib/browser/tree/tree.d.ts:158
Returns undefined | TreeNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:159
Parameters
- root: undefined | TreeNode
Returns any

viewInfo

set viewInfo(viewInfo: View): void

- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:114
Parameters
- viewInfo: View
Returns void

Methods

Protected addNode

addNode(node: undefined | TreeNode): void

Inherited from TreeImpl.addNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:171
Parameters
- node: undefined | TreeNode
Returns void

Protected createTreeNode

createTreeNode(item: TreeViewItem, parent: CompositeTreeNode): TreeNode

- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:149
Parameters
- item: TreeViewItem
- parent: CompositeTreeNode
Returns TreeNode

dispose

dispose(): void

Inherited from TreeImpl.dispose
- Defined in packages/core/lib/browser/tree/tree.d.ts:157
Returns void

Protected doMarkAsBusy

doMarkAsBusy(node: Mutable<TreeNode>, ms: number, token: CancellationToken): Promise<void>

Inherited from TreeImpl.doMarkAsBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:173
Parameters
- node: Mutable<TreeNode>
- ms: number
- token: CancellationToken
Returns Promise<void>

Protected doResetBusy

doResetBusy(node: Mutable<TreeNode>): void

Inherited from TreeImpl.doResetBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:175
Parameters
- node: Mutable<TreeNode>
Returns void

Protected doSetBusy

doSetBusy(node: Mutable<TreeNode>): void

Inherited from TreeImpl.doSetBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:174
Parameters
- node: Mutable<TreeNode>
Returns void

Protected fetchChildren

fetchChildren(proxy: TreeViewsExt, parent: CompositeTreeNode): Promise<TreeViewItem[]>

- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:130
Parameters
- proxy: TreeViewsExt
- parent: CompositeTreeNode
Returns Promise<TreeViewItem[]>

Protected fireChanged

fireChanged(): void

Inherited from TreeImpl.fireChanged
- Defined in packages/core/lib/browser/tree/tree.d.ts:161
Returns void

Protected fireNodeRefreshed

fireNodeRefreshed(parent: CompositeTreeNode): Promise<void>

Inherited from TreeImpl.fireNodeRefreshed
- Defined in packages/core/lib/browser/tree/tree.d.ts:163
Parameters
- parent: CompositeTreeNode
Returns Promise<void>

getNode

getNode(id: undefined | string): undefined | TreeNode

Inherited from TreeImpl.getNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:164
Parameters
- id: undefined | string
Returns undefined | TreeNode

Protected getRootNode

getRootNode(node: TreeNode): TreeNode

Inherited from TreeImpl.getRootNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:170
Parameters
- node: TreeNode
Returns TreeNode

markAsBusy

markAsBusy(raw: TreeNode, ms: number, token: CancellationToken): Promise<void>

Inherited from TreeImpl.markAsBusy
- Defined in packages/core/lib/browser/tree/tree.d.ts:172
Parameters
- raw: TreeNode
- ms: number
- token: CancellationToken
Returns Promise<void>

refresh

refresh(raw?: CompositeTreeNode): Promise<undefined | CompositeTreeNode>

Inherited from TreeImpl.refresh
- Defined in packages/core/lib/browser/tree/tree.d.ts:166
Parameters
- Optional raw: CompositeTreeNode
Returns Promise<undefined | CompositeTreeNode>

Protected removeNode

removeNode(node: undefined | TreeNode): void

Inherited from TreeImpl.removeNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:169
Parameters
- node: undefined | TreeNode
Returns void

Protected resolveChildren

resolveChildren(parent: CompositeTreeNode): Promise<TreeNode[]>

Overrides TreeImpl.resolveChildren
- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:122
Parameters
- parent: CompositeTreeNode
Returns Promise<TreeNode[]>

Protected setChildren

setChildren(parent: CompositeTreeNode, children: TreeNode[]): Promise<undefined | CompositeTreeNode>

Inherited from TreeImpl.setChildren
- Defined in packages/core/lib/browser/tree/tree.d.ts:168
Parameters
- parent: CompositeTreeNode
- children: TreeNode[]
Returns Promise<undefined | CompositeTreeNode>

Protected toIconClass

toIconClass(item: TreeViewItem): undefined | string

- Defined in packages/plugin-ext/src/main/browser/view/tree-view-widget.tsx:190
Parameters
- item: TreeViewItem
Returns undefined | string

validateNode

validateNode(node: undefined | TreeNode): undefined | TreeNode

Inherited from TreeImpl.validateNode
- Defined in packages/core/lib/browser/tree/tree.d.ts:165
Parameters
- node: undefined | TreeNode
Returns undefined | TreeNode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PluginTree

Properties

Private _isEmpty

Private _proxy

Protected _root

Private _viewInfo

Protected Readonly identifier

Protected nodes

Type declaration

[id: string]: Mutable<TreeNode> | undefined

Protected Readonly notification

Protected Readonly onChangedEmitter

Readonly onDidChangeBusy

Protected Readonly onDidChangeBusyEmitter

Readonly onDidChangeWelcomeState

Protected Readonly onDidChangeWelcomeStateEmitter

Protected Readonly onNodeRefreshedEmitter

Protected Readonly sharedStyle

Protected Readonly toDispose

Accessors

isEmpty

Returns boolean

onChanged

Returns Event<void>

onNodeRefreshed

Returns Event<CompositeTreeNode & WaitUntilEvent>

proxy

Returns undefined | TreeViewsExt

Parameters

proxy: undefined | TreeViewsExt

Returns void

root

Returns undefined | TreeNode

Parameters

root: undefined | TreeNode

Returns any

viewInfo

Parameters

viewInfo: View

Returns void

Methods

Protected addNode

Parameters

node: undefined | TreeNode

Returns void

Protected createTreeNode

Parameters

item: TreeViewItem

parent: CompositeTreeNode

Returns TreeNode

dispose

Returns void

Protected doMarkAsBusy

Parameters

node: Mutable<TreeNode>

ms: number

token: CancellationToken

Returns Promise<void>

Protected doResetBusy

Parameters

node: Mutable<TreeNode>

Returns void

Protected doSetBusy

Parameters

node: Mutable<TreeNode>

Returns void

Protected fetchChildren

Parameters

proxy: TreeViewsExt

parent: CompositeTreeNode

Returns Promise<TreeViewItem[]>

Protected fireChanged