Tree

The Tree widget provides the ability to display multiples lines of items in a tabular format.

Implementation base

The Tree widget is a Dojo-based widget:
  • com.ibm.btt.dijit.Tree

Properties

The following properties can be configured for the Tree widget.
Table 1. Properties that can be configured for the Tree widget.
Property Description
id The id is the identifier for the widget.
dataName The dataName property specifies the name of the data element that is used to cache the ID of the tree node that is submitted.
dataNameForTreeContent The dataNameForTreeContent property specifies the name of the data that contains the content for the tree.
visibility The visibility property defines how a widget is displayed on a GUI. The following values can be specified for this property:
visible
The widget is displayed on a GUI and users are able to interact with the widget.
hidden
The widget is not displayed on a GUI, but it occupies space on the GUI.
gone
The widget is not displayed on a GUI, and it does not occupy space on the GUI.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
styleClass The styleClass property specifies the name of the CSS style ( also known as CSS style class) associated with the widget. This property is set by selecting a style from the CSS styles table in the Style tab of the Properties view. If you do not configure the styleClass property, the default style is used instead. For more detailed information, refer to Setting CSS style to widgets
width The width property specifies the width of the widget. This property is set in the Appearance tab of the Properties view.
height The height property specifies the height of the widget. This property is set in the Appearance tab of the Properties view.

Data mapping

The dataName property is mapped to a field element. The dataNameForTreeContent is mapped to a KeyedCollection.

For more detailed information about data mapping, you can see: Binding data to a tree widget

ECA editor support

The following events, properties, and functions can be configured for the Tree widget with the ECA editor.
Table 2. Events that can be added to the Tree widget by using the ECA editor
Event Description
onClick Is fired when the left mouse button is clicked.
onFocus Is fired when the widget receives focus because the user moves the mouse pointer over the widget.
onBlur Is fired when the widget does not receive focus, or when the user clicks outside the widget, or when the widget is hidden.
onKeyDown Is fired when a keyboard key is pressed.
onKeyUp Is fired when a keyboard key is released.
onKeyPress Is fired when a keyboard key is pressed or held down.
onMouseDown Is fired when a mouse button is clicked.
onMouseUp Is fired when a mouse button is released
onMouseEnter Is fired when the mouse pointer moves over the widget.
onMouseLeave Is fired when the mouse pointer moves out of the widget.
onMouseMove Is fired when the mouse pointer moves over nodes that are contained in the widget.
Table 3. Properties that can be configured for the Tree widget by using the ECA editor.
Property Description
styleClass
Note: The styleClass property can be used in the Actions of ECA rule to set the widget style.
visibility The visibility property defines how a widget is displayed on a GUI. The following values can be specified for this property:
visible
The widget is displayed on a GUI and users are able to interact with the widget.
hidden
The widget is not displayed on a GUI, but it occupies space on the GUI.
gone
The widget is not displayed on a GUI, and it does not occupy space on the GUI.
Note: This property can be used in the Condition and Actions part of ECA rule to set the widget style.
value
Note: This property can be used in the Condition and Actions part of ECA rule to set the widget style.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
Note: This property can be used in the Actions of ECA rule to set the widget style.
Table 4. Functions that can be configured for the Tree widget by using the ECA editor.
Function Description
isFocusable Returns a value of true if a widget can be focused and a value of false if it cannot be focused.
Note: This function can be used in the Condition part of ECA rule to set the widget style.
getSelectedLable Returns the lable of the current selected tree node.
Note: This function can be used in the Condition and Actions part of ECA rule to set the widget style.
getSelectedLableNLS Returns the NLS lable of the current selected tree node.
Note: This function can be used in the Condition and Actions part of ECA rule to set the widget style.
getSelectedValue Return the value of the current selected tree node.
Note: This function can be used in the Condition and Actions part of ECA rule to set the widget style.