Class TreeNode

The TreeNode class provides an item for use with the TreeWidget.

Hierarchy

FlexLayout
- TreeNode

Constructors

constructor

new TreeNode(parent?, text?, image?): TreeNode
Constructs a tree node of the specified type with the given parent, text and image.
Parameters
- Optional parent: TreeNode
- Optional text: string
- Optional image: string
Returns TreeNode
Overrides FlexLayout.constructor
- Defined in view/treewidget.ts:65

Properties

`Private` m_arrow

m_arrow: TreeNodeArrow

`Private` m_autoExpand

m_autoExpand: boolean = false

`Protected` m_children

m_children: Widget[] = []

`Protected` m_content

m_content: Widget

`Protected` m_dom

m_dom: HTMLElement

`Private` m_item

m_item: TreeItem

`Private` m_nodes

m_nodes: TreeNode[] = []

`Protected` m_parent

m_parent: Widget

`Private` m_root

m_root: TreeNodeRoot

Accessors

alignment

get alignment(): Alignment
Returns the alignment along the main axis.

Returns Alignment
Inherited from FlexLayout.alignment
- Defined in layout/flex.ts:61
set alignment(alignment): void
Sets the alignment along the main axis to the given alignment.
Parameters
- alignment: Alignment
Returns void
Inherited from FlexLayout.alignment
- Defined in layout/flex.ts:54

blocked

get blocked(): boolean
Returns true if events are blocked; otherwise returns false.

Returns boolean
Inherited from FlexLayout.blocked
- Defined in abstract/eventwatcher.ts:78
set blocked(blocked): void
If blocked is true, then events emitted by this event watcher will be blocked, meaning that emitting an event will not trigger any callback functions that are bound to it.
Parameters
- blocked: boolean
Returns void
Inherited from FlexLayout.blocked
- Defined in abstract/eventwatcher.ts:85

checkable

get checkable(): boolean
Returns whether this tree node is checkable.

Returns boolean
- Defined in view/treewidget.ts:256
set checkable(checkable): void
Sets whether this tree node is checkable. If checkable is true, the node can be checked by the user; otherwise the user cannot check the node.
Parameters
- checkable: boolean
Returns void
- Defined in view/treewidget.ts:263

checked

get checked(): boolean
Returns the check state of this tree node.

Returns boolean
- Defined in view/treewidget.ts:270
set checked(checked): void
Sets the check state of this tree node to checked.
Parameters
- checked: boolean
Returns void
- Defined in view/treewidget.ts:277

children

get children(): readonly Widget[]
Returns the list of children.

Returns readonly Widget[]
Inherited from FlexLayout.children
- Defined in widget/widget.ts:104

color

get color(): Color
Returns the color of this tree node.

Returns Color
- Defined in view/treewidget.ts:228
set color(color): void
Sets the color of this tree node to the given color.
Parameters
- color: Color
Returns void
- Defined in view/treewidget.ts:235

count

get count(): number
Returns the number of all child nodes including any hidden nodes.

Returns number
- Defined in view/treewidget.ts:438

css

set css(style): void
Sets the style of this widget. See also id addClass.
Parameters
- style: Partial<StyleSheets>
Returns void
Inherited from FlexLayout.css
- Defined in widget/widget.ts:246

dom

get dom(): HTMLElement
Returns the native DOM of this widget, user can directly manipulate the native DOM.

Returns HTMLElement
Inherited from FlexLayout.dom
- Defined in widget/widget.ts:111

enabled

get enabled(): boolean
Returns whether this widget or its parent chain is enabled or not. By default, the value of this property is true.

Returns boolean
Inherited from FlexLayout.enabled
- Defined in widget/widget.ts:208
set enabled(enabled): void
Sets whether this widget is enabled or not. Disabling a widget implicitly disables all its children, it is not possible to explicitly enable a child widget while its parent widget remains disabled.
Parameters
- enabled: boolean
Returns void
Inherited from FlexLayout.enabled
- Defined in widget/widget.ts:216

expanded

get expanded(): boolean
Returns true if the tree node is expanded, otherwise returns false.

Returns boolean
- Defined in view/treewidget.ts:334
set expanded(expanded): void
Expands the tree node if expanded is true, otherwise collapses the node.
Parameters
- expanded: boolean
Returns void
- Defined in view/treewidget.ts:346

height

get height(): number
Returns the height of this widget.

Returns number
Inherited from FlexLayout.height
- Defined in widget/widget.ts:160
set height(height): void
Sets the height of this widget to the given height.
Parameters
- height: number
  
  The unit of height is px.
Returns void
Inherited from FlexLayout.height
- Defined in widget/widget.ts:177

id

get id(): string
Returns the id of this widget.

Returns string
Inherited from FlexLayout.id
- Defined in widget/widget.ts:223
set id(id): void
Set the id of this widget to the given id. The id is utilized to set the style of the widget. See also css
Parameters
- id: string
Returns void
Inherited from FlexLayout.id
- Defined in widget/widget.ts:232

image

get image(): string
Returns the image of this tree node.

Returns string
- Defined in view/treewidget.ts:214
set image(image): void
Sets the image of this tree node to the given image.
Parameters
- image: string
Returns void
- Defined in view/treewidget.ts:221

item

get item(): TreeItem
Returns the item of this tree node.

Returns TreeItem
- Defined in view/treewidget.ts:284

left

get left(): number
Returns the left coordinate of this widget within its parent widget.

Returns number
Inherited from FlexLayout.left
- Defined in widget/widget.ts:283
set left(left): void
Sets the left coordinate of this widget within its parent widget.
Parameters
- left: number
  
  The unit of left is px.
Returns void
Inherited from FlexLayout.left
- Defined in widget/widget.ts:276

orientation

get orientation(): Orientation
Returns the orientation of this flex layout.

Returns Orientation
Inherited from FlexLayout.orientation
- Defined in layout/flex.ts:24
set orientation(orientation): void
Sets the orientation of this flex layout to the given orientation.
Parameters
- orientation: Orientation
Returns void
Inherited from FlexLayout.orientation
- Defined in layout/flex.ts:31

parent

get parent(): TreeNode
Returns the parent of this tree node.

Returns TreeNode
Overrides FlexLayout.parent
- Defined in view/treewidget.ts:148
set parent(parent): void
Sets the parent of this tree node to the given parent.
Parameters
- parent: TreeNode
Returns void
Overrides FlexLayout.parent
- Defined in view/treewidget.ts:155

position

get position(): Point
Returns the position of this widget within its parent widget.

Returns Point
Inherited from FlexLayout.position
- Defined in widget/widget.ts:314
set position(position): void
Sets the position of this widget to the given position.
Parameters
- position: Point
  
  The unit of position is px.
Returns void
Inherited from FlexLayout.position
- Defined in widget/widget.ts:306

rect

get rect(): Rect
Returns the rect of this widget within the desktop.

Returns Rect
Inherited from FlexLayout.rect
- Defined in widget/widget.ts:321

row

get row(): number
Returns the index of this tree node in its parent. If its parent is undefined, returns -1.

Returns number
- Defined in view/treewidget.ts:478

selected

get selected(): boolean
Returns true if this tree node is selected; otherwise returns false.

Returns boolean
- Defined in view/treewidget.ts:303
set selected(selected): void
Sets the selected state of this tree node to the given select.
Parameters
- selected: boolean
Returns void
- Defined in view/treewidget.ts:310

size

get size(): Size
Returns the size of this widget.

Returns Size
Inherited from FlexLayout.size
- Defined in widget/widget.ts:118
set size(size): void
Sets the size of this widget to the given size. If the size is Size(0, 0) will cause the widget to not appear on screen.
Parameters
- size: Size
  
  The unit of size is px.
Returns void
Inherited from FlexLayout.size
- Defined in widget/widget.ts:128

spacing

get spacing(): number
Returns the spacing between widgets inside this flex layout.

Returns number
Inherited from FlexLayout.spacing
- Defined in layout/flex.ts:47
set spacing(spacing): void
Set the spacing to the given pacing.
Parameters
- spacing: number
Returns void
Inherited from FlexLayout.spacing
- Defined in layout/flex.ts:39

style

get style(): CSSStyleDeclaration
Returns the style of this widget.

Returns CSSStyleDeclaration
Inherited from FlexLayout.style
- Defined in widget/widget.ts:239

text

get text(): string
Returns the text of this tree node.

Returns string
- Defined in view/treewidget.ts:242
set text(text): void
Sets the text of this tree node to text.
Parameters
- text: string
Returns void
- Defined in view/treewidget.ts:249

tooltip

get tooltip(): string
Returns the tooltip of this tree node.

Returns string
Overrides FlexLayout.tooltip
- Defined in view/treewidget.ts:200
set tooltip(tooltip): void
Sets the tooltip of this tree node to the given tooltip.
Parameters
- tooltip: string
Returns void
Overrides FlexLayout.tooltip
- Defined in view/treewidget.ts:207

top

get top(): number
Returns the top coordinate of this widget within its parent widget.

Returns number
Inherited from FlexLayout.top
- Defined in widget/widget.ts:298
set top(top): void
Sets the top coordinate of this widget to the given top.
Parameters
- top: number
  
  The unit of top is px.
Returns void
Inherited from FlexLayout.top
- Defined in widget/widget.ts:291

treeWidget

get treeWidget(): TreeWidget
Returns the tree widget that contains this tree node. If this tree node is not in any tree widget, returns undefined.

Returns TreeWidget
- Defined in view/treewidget.ts:292

visible

get visible(): boolean
Returns whether this widget or its parent chain is visible or not. By default, the value of this property is true.

Returns boolean
Inherited from FlexLayout.visible
- Defined in widget/widget.ts:185
set visible(visible): void
Sets whether this widget is visible or not. If an ancestor widget is not visible, the widget won't become visible until all its ancestors are visible.
Parameters
- visible: boolean
Returns void
Inherited from FlexLayout.visible
- Defined in widget/widget.ts:193

width

get width(): number
Returns the width of this widget.

Returns number
Inherited from FlexLayout.width
- Defined in widget/widget.ts:136
set width(width): void
Sets the width of this widget to the given width.
Parameters
- width: number
  
  The unit of width is px.
Returns void
Inherited from FlexLayout.width
- Defined in widget/widget.ts:153

`Static` sender

get sender(): EventWatcher
Returns the object that sent the event.

Returns EventWatcher
Inherited from FlexLayout.sender
- Defined in abstract/eventwatcher.ts:21

Methods

add

add(node): void
Adds the given node as a child node to this tree node.
Parameters
- node: TreeNode
Returns void
- Defined in view/treewidget.ts:400

addAttr

addAttr(attr): void
Adds the attribute of this widget. The attribute is utilized to set the style. See also css
Parameters
- attr: string
Returns void
Inherited from FlexLayout.addAttr
- Defined in widget/widget.ts:379

addClass

addClass(className): void
Adds the class name of this widget. The class name is utilized to set the style. See also css. All widgets with the same class name use the same style.
Parameters
- className: string
Returns void
Inherited from FlexLayout.addClass
- Defined in widget/widget.ts:348

addNode

addNode(text, image?): TreeNode
Adds a child node with a text and an image to this tree node.
Parameters
- text: string
- Optional image: string
Returns TreeNode
- Defined in view/treewidget.ts:383

`Protected` align2Str

align2Str(align): string
Parameters
- align: Alignment
Returns string
Inherited from FlexLayout.align2Str
- Defined in layout/flex.ts:66

at

at(index): TreeNode
Returns the child node at position index in this tree node.
Parameters
- index: number
Returns TreeNode
- Defined in view/treewidget.ts:445

`Protected` attach

attach(): void
Returns void
Overrides FlexLayout.attach
- Defined in view/treewidget.ts:83

bind

bind<K>(name, callback): void
Adds a callback function that's going to be called when the event is emitted.
Type Parameters
- K extends keyof EventMap
Parameters
- name: K
- callback: ((...data) => void)
  - - (...data): void
    - Parameters
      
      Rest ...data: EventMap[K]
      
      Returns void
Returns void
Inherited from FlexLayout.bind
- Defined in abstract/eventwatcher.ts:28
bind(name, callback): void
Parameters
- name: string
- callback: ((...data) => void)
  - - (...data): void
    - Parameters
      
      Rest ...data: any[]
      
      Returns void
Returns void
Inherited from FlexLayout.bind
- Defined in abstract/eventwatcher.ts:29

clear

clear(): void
Removes all child nodes.

Returns void
- Defined in view/treewidget.ts:425

clearChildren

clearChildren(): void
Clears all widgets in the list of children.

Returns void
Inherited from FlexLayout.clearChildren
- Defined in widget/widget.ts:454

close

close(): void
Closes this widget. This function is equivalent to setting this widget's parent to undefined. If the widget has no resources to free, call this function directly.

Returns void
Inherited from FlexLayout.close
- Defined in widget/widget.ts:62

`Private` create

create(): void
Returns void
- Defined in view/treewidget.ts:163

delegate

delegate<K>(watcher, name): void
Delegates this event watcher to handle the given watcher's event named name.
Type Parameters
- K extends keyof EventMap
Parameters
- watcher: EventWatcher
- name: K
Returns void
Inherited from FlexLayout.delegate
- Defined in abstract/eventwatcher.ts:67
delegate(watcher, name): void
Parameters
- watcher: EventWatcher
- name: string
Returns void
Inherited from FlexLayout.delegate
- Defined in abstract/eventwatcher.ts:68

`Private` deselect

deselect(): void
Returns void
- Defined in view/treewidget.ts:121

destroy

destroy(): void
Destroys the widget, all the widget's children are destroyed first. The widget is destroyed when it's parent is destroyed. When the widget is destroyed, make sure to release all resources, such as timers, etc. Releases the resources in the protected function free(), and the system will call this function automatically when the parent widget or itself is destroyed. See also free.

Returns void
Inherited from FlexLayout.destroy
- Defined in widget/widget.ts:39

`Protected` detach

detach(): void
Returns void
Overrides FlexLayout.detach
- Defined in view/treewidget.ts:102

emit

emit<K>(name, ...data): boolean
Emits an arbitrary set of arguments to the callback function which is bound to the event named name.
Type Parameters
- K extends keyof EventMap
Parameters
- name: K
- Rest ...data: EventMap[K]
Returns boolean
Inherited from FlexLayout.emit
- Defined in abstract/eventwatcher.ts:48
emit(name, ...data): boolean
Parameters
- name: string
- Rest ...data: any[]
Returns boolean
Inherited from FlexLayout.emit
- Defined in abstract/eventwatcher.ts:49

forEach

forEach(callback): void
Performs the specified action for each child node.
Parameters
- callback: ((node) => void)
  - - (node): void
    - Parameters
      
      node: TreeNode
      
      Returns void
Returns void
- Defined in view/treewidget.ts:452

`Protected` free

free(): void
Frees the resources.See also destroy.

Returns void
Inherited from FlexLayout.free
- Defined in widget/widget.ts:54

hasAttr

hasAttr(attr): boolean
Returns whether this widget contains the attribute.
Parameters
- attr: string
Returns boolean
Inherited from FlexLayout.hasAttr
- Defined in widget/widget.ts:393

hasClass

hasClass(className): boolean
Returns whether this widget contains the class name.
Parameters
- className: string
Returns boolean
Inherited from FlexLayout.hasClass
- Defined in widget/widget.ts:362

hide

hide(): void
Hides the widget and its child widgets. This function is equivalent to setting the visible property to false.

Returns void
Inherited from FlexLayout.hide
- Defined in widget/widget.ts:78

insert

insert(index, node): void
Inserts the given node as a child node into this tree node at the position index.
Parameters
- index: number
- node: TreeNode
Returns void
- Defined in view/treewidget.ts:408

insertChild

insertChild(index, widget): void
Inserts the child widget at index in the list of children.
Parameters
- index: number
- widget: Widget
Returns void
Inherited from FlexLayout.insertChild
- Defined in widget/widget.ts:435

insertNode

insertNode(index, text, image?): TreeNode
Inserts a child node with a text and an image into this tree node at the position index.
Parameters
- index: number
- text: string
- Optional image: string
Returns TreeNode
- Defined in view/treewidget.ts:390

`Private` link

link(node): void
Parameters
- node: TreeNode
Returns void
- Defined in view/treewidget.ts:369

raise

raise(): boolean
Raises this widget to the front of the parent widget's children. The display order of this widget is determined by the order in which they appear in the parent widget's children.

Returns boolean
Inherited from FlexLayout.raise
- Defined in widget/widget.ts:410

remove

remove(node): void
Removes the given node from this tree node.
Parameters
- node: TreeNode
Returns void
- Defined in view/treewidget.ts:418

removeAttr

removeAttr(attr): void
Removes the attribute of this widget.
Parameters
- attr: string
Returns void
Inherited from FlexLayout.removeAttr
- Defined in widget/widget.ts:386

removeClass

removeClass(className): void
Removes the class name of this widget.
Parameters
- className: string
Returns void
Inherited from FlexLayout.removeClass
- Defined in widget/widget.ts:355

setFlex

setFlex(orientation, alignItem?, spacing?): void
Sets whether the widget uses flex layout.
Parameters
- orientation: Orientation
  
  Horizontal or vertical.
- Optional alignItem: "center" | "inherit" | "stretch" | "flex-start" | "flex-end" | "initial" | "baseline"
  
  @see(https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)
- Optional spacing: number
  
  the spacing between widgets inside the layout.
Returns void
Inherited from FlexLayout.setFlex
- Defined in widget/widget.ts:332

show

show(): void
Shows the widget and its child widgets. This function is equivalent to setting the visible property to true.

Returns void
Inherited from FlexLayout.show
- Defined in widget/widget.ts:70

`Protected` str2Align

str2Align(str): Alignment
Parameters
- str: string
Returns Alignment
Inherited from FlexLayout.str2Align
- Defined in layout/flex.ts:79

toggleAttr

toggleAttr(attr, on): void
If param attr is true, adds the attribute, otherwise removes the attribute.
Parameters
- attr: string
- on: boolean
  
  true or false
Returns void
Inherited from FlexLayout.toggleAttr
- Defined in widget/widget.ts:402

toggleClass

toggleClass(className, on): void
If param on is true, adds the class name, otherwise removes the class name.
Parameters
- className: string
- on: boolean
  
  true or false
Returns void
Inherited from FlexLayout.toggleClass
- Defined in widget/widget.ts:371

traverse

traverse(callback): void
Performs the specified action for all child nodes and itself.
Parameters
- callback: ((node) => void)
  - - (node): void
    - Parameters
      
      node: TreeNode
      
      Returns void
Returns void
- Defined in view/treewidget.ts:459

unbind

unbind<K>(name): void
Removes the specified watcher for the event named name.
Type Parameters
- K extends keyof EventMap
Parameters
- name: K
Returns void
Inherited from FlexLayout.unbind
- Defined in abstract/eventwatcher.ts:37
unbind(name): void
Parameters
- name: string
Returns void
Inherited from FlexLayout.unbind
- Defined in abstract/eventwatcher.ts:38

`Private` unlink

unlink(node): void
Parameters
- node: TreeNode
Returns void
- Defined in view/treewidget.ts:373

`Private` updateContent

updateContent(): void
Returns void
- Defined in view/treewidget.ts:467

Class TreeNode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional parent: TreeNode

Optional text: string

Optional image: string

Returns TreeNode

Properties

Private m_arrow

Private m_autoExpand

Protected m_children

Protected m_content

Protected m_dom

Private m_item

Private m_nodes

Protected m_parent

Private m_root

Accessors

alignment

Returns Alignment

Parameters

alignment: Alignment

Returns void

blocked

Returns boolean

Parameters

blocked: boolean

Returns void

checkable

Returns boolean

Parameters

checkable: boolean

Returns void

checked

Returns boolean

Parameters

checked: boolean

Returns void

children

Returns readonly Widget[]

color

Returns Color

Parameters

color: Color

Returns void

count

Returns number

css

Parameters

style: Partial<StyleSheets>

Returns void

dom

Returns HTMLElement

enabled

Returns boolean

Parameters

enabled: boolean

Returns void

expanded

Returns boolean

Parameters

expanded: boolean

Returns void

height

Returns number

Parameters

height: number

Returns void

id

Returns string

Parameters

id: string

Returns void

`Optional` parent: TreeNode

`Optional` text: string

`Optional` image: string

`Private` m_arrow

`Private` m_autoExpand

`Protected` m_children

`Protected` m_content

`Protected` m_dom

`Private` m_item

`Private` m_nodes

`Protected` m_parent

`Private` m_root