Class Tree<T>

Extension of TreeList that represents the root of a tree control

tree <ul>
├ treeItem <li>
├ treeItem <li>
│ └ treeList <ul>
│   ├ treeItem <li>
│   └ treeItem <li>
└ treeItem <li>

Type Parameters

Hierarchy (View Summary)

TreeList<T>
- Tree

Index

Constructors

constructor

new Tree<T>(_controller: TreeController<T>, _root: T): Tree<T>
Type Parameters
- T
Parameters
- _controller: TreeController<T>
- _root: T
Returns Tree<T>
Overrides TreeList.constructor
- Defined in CustomElement/Tree/Tree.ts:24

Properties

controller

controller: TreeController<T>

Methods

[iterator]

"[iterator]"(): Iterator<TreeItem<T>>
Returns Iterator<TreeItem<T>>
Inherited from TreeList.[iterator]
- Defined in CustomElement/Tree/TreeList.ts:155

addChildren

addChildren(_children: T[], _target: T, _index?: number): void
Adds the given children to the given target at the given index. If no index is given, the children are appended at the end of the list.
Parameters
- _children: T[]
- _target: T
- Optional_index: number
Returns void
- Defined in CustomElement/Tree/Tree.ts:87

addItems

addItems(_items: TreeItem<T>[]): void
Adds the given TreeItems at the end of this list
Parameters
- _items: TreeItem<T>[]
Returns void
Inherited from TreeList.addItems
- Defined in CustomElement/Tree/TreeList.ts:82

clearSelection

clearSelection(): void
Clear the current selection

Returns void
- Defined in CustomElement/Tree/Tree.ts:52

delete

delete(_data: T[]): TreeItem<T>[]
Parameters
- _data: T[]
Returns TreeItem<T>[]
Inherited from TreeList.delete
- Defined in CustomElement/Tree/TreeList.ts:127

displaySelection

displaySelection(_data: T[]): void
Parameters
- _data: T[]
Returns void
Inherited from TreeList.displaySelection
- Defined in CustomElement/Tree/TreeList.ts:95

expand

expand(_paths: T[][]): void
Expands the tree along the given paths to show the objects the paths include.
Parameters
- _paths: T[][]
Returns void
Inherited from TreeList.expand
- Defined in CustomElement/Tree/TreeList.ts:21

findItem

findItem(_data: T): TreeItem<T>
Returns the TreeItem of this list referencing the given object or null, if not found
Parameters
- _data: T
Returns TreeItem<T>
Inherited from TreeList.findItem
- Defined in CustomElement/Tree/TreeList.ts:71

findVisible

findVisible(_data: T): TreeItem<T>
Parameters
- _data: T
Returns TreeItem<T>
Inherited from TreeList.findVisible
- Defined in CustomElement/Tree/TreeList.ts:140

getExpanded

getExpanded(): TreeItem<T>[]
Returns all expanded TreeItems that are a descendant of this list.

Returns TreeItem<T>[]
Inherited from TreeList.getExpanded
- Defined in CustomElement/Tree/TreeList.ts:151

getFocussed

getFocussed(): T
Return the object in focus or null if none is focussed

Returns T
- Defined in CustomElement/Tree/Tree.ts:60

getItems

getItems(): TreeItem<T>[]
Returns the content of this list as array of TreeItems

Returns TreeItem<T>[]
Inherited from TreeList.getItems
- Defined in CustomElement/Tree/TreeList.ts:91

refresh

refresh(): void
Refresh the whole tree to synchronize with the data the tree is based on

Returns void
- Defined in CustomElement/Tree/Tree.ts:72

restructure

restructure(_tree: TreeList<T>): void
Restructures the list to sync with the given list. TreeItems referencing the same object remain in the list, new items get added in the order of appearance, obsolete ones are deleted.
Parameters
- _tree: TreeList<T>
  A list to sync this with
Returns void
Inherited from TreeList.restructure
- Defined in CustomElement/Tree/TreeList.ts:49

selectAll

selectAll(): void
Returns void
Inherited from TreeList.selectAll
- Defined in CustomElement/Tree/TreeList.ts:122

selectInterval

selectInterval(_dataStart: T, _dataEnd: T): void
Parameters
- _dataStart: T
- _dataEnd: T
Returns void
Inherited from TreeList.selectInterval
- Defined in CustomElement/Tree/TreeList.ts:101

show

show(_path: T[]): void
Expands the tree along the given path to show the objects the path includes.
Parameters
- _path: T[]
Returns void
Inherited from TreeList.show
- Defined in CustomElement/Tree/TreeList.ts:29

Class Tree<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Tree<T>

Properties

controller

Methods

[iterator]

Returns Iterator<TreeItem<T>>

addChildren

Parameters

Returns void

addItems

Parameters

Returns void

clearSelection

Returns void

delete

Parameters

Returns TreeItem<T>[]

displaySelection

Parameters

Returns void

expand

Parameters

Returns void

findItem

Parameters

Returns TreeItem<T>

findVisible

Parameters

Returns TreeItem<T>

getExpanded

Returns TreeItem<T>[]

getFocussed

Returns T

getItems

Returns TreeItem<T>[]

refresh

Returns void

restructure

Parameters

Returns void

selectAll

Returns void

selectInterval

Parameters

Returns void

show

Parameters

Returns void

Settings

On This Page