Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OutlineSymbolInformationNode

Collection of outline symbol information node functions.

Index

Properties

Optional Readonly busy

busy: undefined | number

Whether this node is busy. Greater than 0 then busy; otherwise not.

children

children: ReadonlyArray<TreeNode>

Child nodes of this tree node.

Optional Readonly description

description: undefined | string

A human-readable description of this tree node.

deprecated

use LabelProvider.getLongName instead or move this property to your tree node type

expanded

expanded: boolean

Test whether this tree node is expanded.

Optional focus

focus: undefined | false | true

true if the tree node has the focus. Otherwise, false. Defaults to false.

Optional Readonly icon

icon: undefined | string

A css string for this tree node icon.

deprecated

use LabelProvider.getIcon instead or move this property to your tree node type

iconClass

iconClass: string

The iconClass for the given tree node.

Readonly id

id: string

An unique id of this node.

Optional Readonly name

name: undefined | string

A human-readable name of this tree node.

deprecated

use LabelProvider.getName instead or move this property to your tree node type

Optional Readonly nextSibling

nextSibling: TreeNode

A next sibling of this tree node.

Readonly parent

parent: Readonly<CompositeTreeNode> | undefined

A parent node of this tree node. Undefined if this node is root.

Optional Readonly previousSibling

previousSibling: TreeNode

A previous sibling of this tree node.

selected

selected: boolean

true if the tree node is selected. Otherwise, false.

Optional Readonly visible

visible: undefined | false | true

Test whether this node should be rendered. If undefined then node will be rendered.

Methods

addChild

addChildren

getFirstChild

getLastChild

getVisibleParent

hasFocus

  • hasFocus(node: TreeNode | undefined): boolean

indexOf

is

  • is(node: Object | undefined): node is CompositeTreeNode
  • Determine if the given tree node is an OutlineSymbolInformationNode.

    • The tree node is an OutlineSymbolInformationNode if:
      • The node exists.
      • The node is selectable.
      • The node contains a defined iconClass property.

    Parameters

    • node: Object | undefined

      the tree node.

    Returns node is CompositeTreeNode

    true if the given node is an OutlineSymbolInformationNode.

isAncestor

isCollapsed

  • isCollapsed(node: Object | undefined): node is ExpandableTreeNode

isExpanded

  • isExpanded(node: Object | undefined): node is ExpandableTreeNode

isSelected

  • isSelected(node: TreeNode | undefined): node is SelectableTreeNode

isVisible

  • isVisible(node: TreeNode | undefined): node is SelectableTreeNode

removeChild

setParent