The Tree widget represents a standard hierarchical tree widget. It supports expanding and collapsing of nodes, single or multiple selections.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Default IconThe default icon to use for nodes displayed in the tree.
DisabledThe widget cannot be used.
Drag & Drop
HiddenHides the widget from the user.
MaximizeSet this widget to be maximized (take up all available space).
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.

Style

Name Desciption
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Expand/close icon colorThe color of the expand icon.
Expand/close icon hover colorThe color of the expand icon in hover state.
Font SizeSet the font size in pixels for text.
Item hover background colorThe background color on hover for the selected or active item.
Selected item background colorThe background color for the selected or active item.
Text StyleLower case, Upper case and Capitalize. Regardless of how its entered in widget editor.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
Collapse Triggered when a tree node is collapsed.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Drop
Expand Triggered when a tree node is expanded.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.
ItemClick Triggered when an item in a list, table or a calendar is clicked.
ItemDoubleClick Triggered when an item in a list, table or a calendar is double clicked.
Select Event triggered when node is selected.

Function

clearActive ( )

clearSelection ( )

getSelectedRecords ( )

expandAll ( )

getActiveRecord ( )

deleteRecord ( )

addRecord ( )

updateRecord ( )

getParent ( )

getChildren ( )

refresh ( )

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.