Icon

Adds a custom icon to your app. You can program your icon as a clickable button.

Appearance

Color style: The color style for this view.
{Default | Primary | Info | Success | Warning | Danger | Transparent} IconColorStyle

Icon size: Font size of the icon in px or em.\r\nFor example\: 35px, 0.4em. If no unit is specified, px is assumed. String

Outline only: The view shows its color-based style only when a user hovers over it. Boolean

Icon: Icon name, for example: calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc... Check http://fontawesome.io/icons for a comprehensive list. (Note that the "fa-" prefix is optional) String

Border radius: Radius of curvature for container 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

Behavior

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

Show as icon: Display the icon as a static, non-clickable element. Boolean

Events

On Load:

Description: This event is fired when the icon is loaded.

Example:

me.setIcon("gears")/pre>

On Click:

Description: This event is fired when the icon is clicked.

Example:

return confirm("Are you sure?")

On Boundary Event:

Description: Triggers upon reaching a Stay On Page event after a boundary event is fired through this control. Additional parameters passed: status. For information on the status context variable see the context.trigger() method in the Knowledge Center.

Example:

alert("Stay on Page status '" + status + "'")

Context Variables	status {string}

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 icon

getColorStyle() Returns: {string}

Gets color style of icon. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"|"T"

getLabel() Returns: {string}

Get the label associated with the icon control

getSize() Returns: {string}

Get configured size for icon (including unit)

getType() Returns: {string}

Get descriptive string representing the type of control

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 isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

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);

setColorStyle(style)

Sets color style of icon. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"|"T"

Name Type Default Description

style {string} "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger | "TRANSPARENT"|"T"=Transparent

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

setIcon(icon)

Sets icon to display on the icon

Name Type Default Description

icon {string} See {@link http://fontawesome.io/icons Font Awesome} for a comprehensive list of icons (note the "fa-" prefix is optional). Refer to the knowledge center for the latest Font Awesome version.

setIconSize(size)

Sets size of icon. Note that this changes the size of the icon itself (the image), not the container

Name Type Default Description

size {string} Icon size

setLabel(label)

Set label for Icon control

Name Type Default Description

label {string} Control label

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default Description

visible {boolean} Label visibility flag (true to show view label, false to hide)

Example

MyView.setLabelVisible(false);

setOutline(outline)

Sets outline style of icon

Name Type Default Description

outline {boolean} {true | false} Set to true to use outline only

setRadius(radius)

Sets radius (roundness) of icon

Name Type Default Description

radius {string} Radius of curvature for icon container corners

setSize(size)

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

Name Type Default Description

size {string} Size of icon container

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"

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