Class TreeViewDataElement

Contains data about a single piece of content and all its children. This element may be visible and represented by a UI element, but might not (for example its parent is collapsed).

Hierarchy (view full)

FrameworkObject
- TreeViewDataElement

Constructors

constructor

new TreeViewDataElement(isInternalConstructor?): TreeViewDataElement
Parameters
- OptionalisInternalConstructor: boolean
Returns TreeViewDataElement
Overrides FrameworkObject.constructor

Accessors

childCount

get childCount(): number
Checks is the provided element part of the parent hierarchy of this element.

Returns number

doubleClickBehavior

get doubleClickBehavior(): EnumValue<TreeViewElementDoubleClickBehavior, number>
Returns EnumValue<TreeViewElementDoubleClickBehavior, number>
set doubleClickBehavior(value): void
Parameters
- value: EnumValue<TreeViewElementDoubleClickBehavior, number>
Returns void

height

get height(): number
Sets the optional height for the element, if not set, the tree element uses the element height of the tree.

Returns number
set height(value): void
Parameters
- value: number
Returns void

iconImage

get iconImage(): Image
The current icon image.

Returns Image
set iconImage(value): void
The current icon image.
Parameters
- value: Image
Returns void

iconImageHandle

get iconImageHandle(): ResourceHandle<Image>
The current icon image.

Returns ResourceHandle<Image>
set iconImageHandle(value): void
Parameters
- value: Image | ResourceHandle<Image>
Returns void

id

get id(): UUID
The ID of the element, useful to correlate the tree element to the object it represents.

Returns UUID
set id(value): void
Parameters
- value: UUID
Returns void

isDisabled

get isDisabled(): boolean
Determines if the element is currently Disabled.

Returns boolean
set isDisabled(value): void
Parameters
- value: boolean
Returns void

isEditable

get isEditable(): boolean
Determines if the element is currently Editable.

Returns boolean
set isEditable(value): void
Parameters
- value: boolean
Returns void

isExpandable

get isExpandable(): boolean
Determines if the element is currently Expandable.

Returns boolean
set isExpandable(value): void
Parameters
- value: boolean
Returns void

isExpanded

get isExpanded(): boolean
Determines if the element is currently Expanded.

Returns boolean

isHighlighted

get isHighlighted(): boolean
Determines if the element is currently Highlighted.

Returns boolean
set isHighlighted(value): void
Parameters
- value: boolean
Returns void

isSelected

get isSelected(): boolean
Determines if the element is currently Selected.

Returns boolean

isVisible

get isVisible(): boolean
Determines if the element is currently visible.

Returns boolean
set isVisible(value): void
Parameters
- value: boolean
Returns void

name

get name(): string
The current name.

Returns string
set name(value): void
Parameters
- value: string
Returns void

parent

get parent(): TreeViewDataElement
The parent item.

Returns TreeViewDataElement

tintColor

get tintColor(): Immutable<Color>
The current tint color.

Returns Immutable<Color>
set tintColor(value): void
Parameters
- value: Immutable<Color>
Returns void

visualElement

get visualElement(): TreeViewVisualElement
Gets the visual element if the data element is currently visible on screen.

Returns TreeViewVisualElement
Note
Not all data element have a visual representation. If the element is currently scrolled out of view, it is possible that it has no visual element representation.

Methods

addChild

addChild(element): boolean
Adds the element.
Parameters
- element: TreeViewDataElement
Returns boolean

checkIsParent

checkIsParent(element): boolean
Checks is the provided element part of the parent hierarchy of this element.
Parameters
- element: TreeViewDataElement
Returns boolean

getChildAtIndex

getChildAtIndex(index): TreeViewDataElement
Gets the element at the specified index.
Parameters
- index: number
Returns TreeViewDataElement

getIndexOfChild

getIndexOfChild(element): number
Gets the index for the element or no value if the element is not a child of this instance.
Parameters
- element: TreeViewDataElement
Returns number

insertChildAtIndex

insertChildAtIndex(element, index): boolean
Adds the element at the specified index.
Parameters
- element: TreeViewDataElement
- index: number
Returns boolean

removeChild

removeChild(element): TreeViewDataElement
Removes the element and returns the removed element, or null if the element was not removed.
Parameters
- element: TreeViewDataElement
Returns TreeViewDataElement

removeChildAtIndex

removeChildAtIndex(index): TreeViewDataElement
Removes the element at the specified index and returns the removed element.
Parameters
- index: number
Returns TreeViewDataElement