Image

The Image widget is used to display images. You can also provide a title for the image by specifying a value for the hint property.

Implementation base

The Image widget is a Dojo-based widget.

The image widget can also be implemented by using the HTML <img> tag and the <div> tag with an image background.

Properties

The following properties can be configured for the Image widget.
Table 1. Properties that can be configured for the Image 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.

If you specify a data element to which the image widget is bound in the dataName property, the image is retrieved from the location that is specified in the context. If you specify the relative path of an image in the location property, the image is retrieved from the relative path that has been specified.

location The location property specifies the relative path of the image.
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.

ECA editor support

The following events and properties can be configured for the Image widget with the ECA editor.
Note: The ECA editor does not support functions for the Image widget.
Table 2. Events that can be added to the Image 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.
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 Image widget by using the ECA editor.
Property Description
id The id is the identifier for the widget.
Note: This property can be used in the Condition part of ECA rule.
location The location property specifies the relative path of the image.
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.