RichText

The RichText widget allows a user to enter rich text.

Implementation base

The RichText widget is a Dojo-based widget:
  • dijit.Editor

Properties

The following properties can be configured for the RichText widget.
Table 1. Properties that can be configured for the RichText widget.
Property Description
dataName The dataName property is the name of the data element to which the widget is bound. This property is optional.
styleClass The styleClass property specifies the class selector that is associated with the widget. If you do not configure the styleClass property, the default class selector is used instead.
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 The readOnly property is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. If you select a value of true for the readOnly property, the widget is displayed on a GUI but a user cannot interact with it. If a widget has the value of its readOnly property set to true and the value of its disabled property set to false, the data of the widget is taken into account during form submission. The default value for the readOnly property is false.
id The id is the identifier for the widget.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
width The width property specifies the width of the widget.
height The length property specifies the length of the widget.

Data mapping

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.

ECA editor support

The following events, properties, and functions can be configured for the RichText widget with the ECA editor.
Table 2. 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.
Table 3. Properties that can be configured for the RichText widget by using the ECA editor.
Property Description
value The value of the value property is the text that is entered in the widget.
Table 4. Functions that can be configured for the RichText 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.
focus Specifies that the widget should be focused.