Methods

addClass
click
getColorStyle
getLabel
getSize
getType
hide
isBound
isEnabled
isLabelVisible
isVisible
propagateUpValueChange
setColorStyle
setEnabled
setIcon
setIconSize
setLabel
setLabelVisible
setOutline
setRadius
setSize
setViewData
setVisible
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
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/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
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 this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Inherited isBound() Returns: {boolean}
Indicates bound status of control.
Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();
Inherited isLabelVisible() Returns: {boolean}
Checks if control label is visible
Example
var labelVisible = MyView.isLabelVisible();
Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
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"
NameTypeDefaultDescription
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/disable this view/control
NameTypeDefaultDescription
enabled{boolean}Enabled/read-only flag (true to enable view, false to disable/make read-only)
required{boolean}Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only
setIcon(icon)
Sets icon to display on the icon
NameTypeDefaultDescription
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
NameTypeDefaultDescription
size{string}Icon size
setLabel(label)
Set label for Icon control
NameTypeDefaultDescription
label{string}Control label
Inherited setLabelVisible(visible)
Show/hide the label of this view/control
NameTypeDefaultDescription
visible{boolean}Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);
setOutline(outline)
Sets outline style of icon
NameTypeDefaultDescription
outline{boolean}{true | false} Set to true to use outline only
setRadius(radius)
Sets radius (roundness) of icon
NameTypeDefaultDescription
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)
NameTypeDefaultDescription
size{string}Size of icon container
Inherited setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
data{Object}Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding{boolean}If set to true, 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/hide this view/control
NameTypeDefaultDescription
visible{boolean}Visibility flag (true to show view, false to hide)
collapse{boolean}Set to true to collapse the control space when 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/control
Example
MyView.show();
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();