Development tools : XUI editor : XUI widgets and containers : Widget descriptions : Message
  
Message
The Message widget has the ability to display error messages, warning messages, and hints. Messages and hints are displayed on a Web page and can also be displayed as a pop-up window. Multilingual support is provided for the messages and hints that are displayed on a GUI.
See
Implementation base
Properties for the Message widget
Data binding
See also
Widget descriptions
Implementation base
The Message widget is a Dojo-based widget. It is a new Dijit that is implemented by UDTT.
See also
Message
Properties for the Message widget
 
Property
Description
dataName
The dataName property is the name of the data element to which the widget is bound. This property is mandatory.
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.
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.
id
The identifier for the widget.
level
The level property specifies the type of the message. The following three values are available to be specified for the level property:
ERROR
INFO
WARN
The default value is ERROR.
See also
Message
Data binding
The message data for the message widget can be retrieved from two different places: a UDTT context and the action rule of the ECA editor.
If you require the message data to be retrieved from a UDTT context, you must specify a data element in the dataName property.
If the message data is being retrieved from the action of an ECA rule, the message is entered into the widget from an API.
See
ECA editor support
See also
Message
ECA editor support
The following properties and functions can be configured for the Message widget with the ECA editor.
The ECA tool does not support the configuration of events for the Message widget.
Properties that can be configured for the Message widget by using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
styleClass
This property can be used in the Action 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.
This property can be used in the Condition and Actions part of ECA rule.
level
The level property specifies the type of the message. The following three values are available to be specified for the level property:
ERROR
INFO
WARN
The default value is ERROR. The level property is an optional property.
This property can be used in the Condition and Actions part of ECA rule.
Functions that can be configured for the Message widget by using the ECA editor
 
Function
Description
display
The display function is used to display messages on the message widget on a GUI. If a value has been specified for the level property, the value of the level property is used as a parameter in the display function. The following three values are available to be specified for the level property:
Error
Info
Warn
The default value is Error. The level property is an optional property.
This property can be used in the Action part of ECA rule.
displayPopup
The displayPopup function is used to display messages in a popup window on GUI. If a value has been specified for the level property, the value of the level property is used as a parameter in the displayPopup function. The following three values are available to be specified for the level property:
Error
Info
Warn
The default value is Error. The level property is an optional property.
This property can be used in the Action part of ECA rule.
closeMessage
The closeMessage function is used to close the Message widget on a GUI.
This property can be used in the Action part of ECA rule.
See also
Data binding