Development tools : XUI editor : XUI widgets and containers : Widget descriptions : RichText
  
RichText
The RichText widget allows a user to enter rich text.
See
Implementation base
Properties that can be configured for the RichText widget
Data binding
See also
Widget descriptions
Implementation base
The RichText widget is a Dojo-based widget:
dijit.Editor
See also
RichText
Properties that can be configured for the RichText widget
 
Property
Description
id
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.
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.
readOnly
To prevent a user from changing the value, set readOnly to true. The default value is false.
hint
A description of the widget that is displayed as a tooltip for a user. This 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.
See also
RichText
Data binding
Text that is entered by a user into a RichText widget is submitted as a value of a data field in a context. Note also that client-side and server-side validation and formatting is applied according to the data type to which the RichText widget is bound.
See
ECA editor support
See also
RichText
ECA editor support
The following events, properties, and functions can be configured for the RichText widget with the ECA editor.
Events that can be added to the RichText widget by using the ECA editor
 
Events
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.
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.
onChange
Is fired when the value of the widget changes.
Properties that can be configured for the RichText widget by using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
value
The value of the value property is the text that is entered in the widget.
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.
This property can be used in the Condition and Actions part of ECA rule.
readOnly
This property can be used in the Condition and Actions part of ECA rule.
styleClass
This property can be used in the Action 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.
This property can be used in the Action part of ECA rule.
Functions that can be configured for the RichText widget by using the ECA editor
 
Function
Description
isFocusable
This property can be used in the Condition part of ECA rule.
focus
This property can be used in the Action part of ECA rule.
See also
Data binding