Label

The Label widget displays text that cannot be edited by a user, and it is enabled for multilingual support.

Implementation base

The Label widget is a Dojo-based widget.

The Label widget can also be implemented by using the HTML <label> tag.

Properties

The following properties can be configured for the Label widget.
Table 1. Properties that can be configured for the Label widget
Property Description
id The id is the identifier for the widget.
dataName The dataName property is the name of the data element to which the widget is bound. This property is mandatory.
text Is the text that is displayed on the label for a user if a value has not been assigned for the dataName property. This is an optional property.
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.
fieldReference The fieldReference property specifies a widget to which the Label widget is associated. If you do not want the Label widget to be associated with another widget, specify no widget. The fieldReference property is an optional property.
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

If you specify a data element to which the widget is bound in the dataName property, the name of the data element is used as the text that is displayed on the label. If you do not specify a data element to which the data is bound in the dataName property, the value that you assign in the text property is used as the text that is displayed on the label.

ECA editor support

The following events and properties can be configured for the Label widget with the ECA editor.
Note: The ECA editor does not support the configuration of functions for the Label widget.
Table 2. Events that can be added to the Label widget by using the ECA editor.
Event Description
onClick Is fired when the left mouse button is clicked.
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 Label widget by using the ECA editor.
Property Description
text Is the text that is displayed on the label for a user if a value has not been assigned for the dataName property. This is an optional property.
Note: This property can be used in the Condition and Actions part of ECA rule.
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.
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
Note: This property can be used in the Actions part of ECA rule.
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 part of ECA rule.