Image

Displays an image and makes it clickable if needed.

Appearance

Border radius: Radius of curvature for the image corners. String

Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String

Height: Height in px, em\r\nFor example\: 50px, 0.4em. If no unit is specified, px is assumed. String

Behavior

Prevent multiple clicks: Prevent the user from clicking the image more than once. Boolean

Image URL type: URL type. Note: For images that are not hosted on the local server, use External.
{Web | External} URLType

Image app acronym: The acronym of the process app or toolkit that contains the image. String

Default image URL: If the view is not bound, this is the URL for the image. String

Default image URL type: If the view is not bound this is the URL type. Note: For images that are not hosted on the local server, use External.
{Web | External} URLType

Default image app acronym: The default acronym of the process app or toolkit that contains the image. String

Events

On Load:

Description: Triggers whenever the view is loaded.

Example:

console.log("Img1 successfully loaded")

On Click:

Description: Triggers when image is clicked, before navigating away from page. If evaluated expression returns false, the click will not fire a boundary event.

Example:

return ${Text1}.isValid();

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

click()

Programmatically click this image

getHeight() Returns: {string}

Get configured size for image (including unit)

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured size for image (including unit)

Inherited hide(collapseFlag)

Hide the view.

Name Type Default Description

collapseFlag {boolean} Set to true to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

setHeight(height)

Set size of image (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

height {string} the height of the image

setImage(img, type)

Set the image to be displayed

Name Type Default Description

img {string} Image url

type {string} "External" | "Web" | "Server" | "Design"

Example

${Image1}.setImage("Image1.png", "Web");

setRadius(radius)

Sets radius (roundness) of image

Name Type Default Description

radius {string} Border radius

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited setVisible(visible, collapse)

Show or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option visible is set to false.

Examples

MyView.setVisible(false, false); //Equivalent to MyView.hide()

MyView.setVisible(false, true); // Sets visibility to "None"

setWidth(width)

Set size of image (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

width {string} the width of the image

Inherited show()

Show this view.

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers