Methods

addClass
getColorStyle
getData
getLabel
getLabelPlacementt
getLabelWidth
getLinkURL
getSizeStyle
getTabIndex
getText
getType
getWidth
hide
isBound
isEnabled
isLabelVisible
isValid
isVisible
propagateUpValueChange
recalculate
setColorStyle
setEnabled
setLabel
setLabelPlacement
setLabelVisible
setLabelWidth
setLinkURL
setSizeStyle
setTabIndex
setText
setValid
setViewData
setVisible
setWidth
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Link
Creates a link to an external web page or another page in your app.
Appearance
Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Text alignment: The alignment of the output text relative to the width of the view.
{Default | Left | Center | Right}		 TextAlignment
Color style: The color style of the link. Note\: The color style applies only to the text, not the label.
{Default | Normal | Muted | Light-gray | Primary | Info | Success | Warning | Danger}		 ParagraphColorStyle
Size: The size of the text. Note\: The text size applies to both text and label.
{Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller}		 OutputTextSizeStyle
Text weight: The weight of the link text. Note\: The text weight applies only to the text, not the label
{Default | Slim | Normal | Semi-bold | Bold}		 OutputTextWeightStyle
Label placement: The position of the label. If you select Left, the width of the view changes.
{Top | Left}		 LabelPlacement
Label width: The width of the label in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Behavior
Tab index: The tabbing sequence index of the form view. Indices start at 1, and can be set sparsely. For example, you can use 1, 5, 10. Integer
Link text: Text to set for the link String
Prevent multiple clicks: Prevents the user from clicking the link more than once. Only effective for a Boundary Event link type. Boolean
Link type: Set to Boundary Event to emit a boundary event within the service, URL to go to an outside page
{Boundary Event | URL}		 LinkType
Link URL: Only effective if Link Type is URL String
Open in same window: Open URL in the same window. The link type must be URL. Boolean
Formula
Text formula: The formula or expression to calculate link text. String
Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
me.setText("Link to google!")
On Click:
Description: Triggers when link is clicked, before navigating away from page. If evaluated expression returns false, the click will not fire a boundary event.
Example: 
return me.getText() != ""
On Boundary Event:
Description: Triggers upon reaching a Stay On Page event after a boundary event is fired through this control. For information on the status context variable see the context.trigger() method in the Knowledge Center.
Context Variables status {string}
Example: 
me.setColorStyle("G")
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");
getColorStyle() Returns: {string}
Gets color style of control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "H"|"D"|"M"|"L"|"P"|"I"|"S"|"W"|"G"|"T"
Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();
getLabel() Returns: {string}
Get label associated with link controls
getLabelPlacementt() Returns: {string}
Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"
getLabelWidth() Returns: {string}
Get label width of Link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getLinkURL() Returns: {string}
Get URL for link control
getSizeStyle() Returns: {string}
Gets size style of control. NOTE: This always returns the size as set, to avoid ambiguity always set the size using "R"|"X"|"G"|"L"|"S"|"M"|"D"
getTabIndex() Returns: {integer}
Get tab index for text control
getText() Returns: {string}
Get text for link control
getType() Returns: {string}
Get descriptive string representing the type of control
getWidth() Returns: {string}
Get configured width for link control (including unit)
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();
isLabelVisible() Returns: {boolean}
Get label visibility for link control
Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();
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);
Inherited recalculate()
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula
for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time
setColorStyle(style)
Sets color style of control. NOTE: to avoid ambiguity always set the color using "H"|"D"|"M"|"L"|"P"|"I"|"S"|"W"|"G"|"T"
NameTypeDefaultDescription
style{string}"NORMAL"|H"=Normal | "DEFAULT"|"DEF"|"D"=Default | "MUTED"|"M"=Muted | "LIGHT_GRAY"|"GRAY"|"LIGHTGRAY"|"LIGHT GRAY"|"LIGHT"|"L"=Light | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "ERROR"|"ERR"|"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
setLabel(text)
Set label for control
NameTypeDefaultDescription
text{string}Label for control
setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left
setLabelVisible(flag)
Set label visibility for text control
NameTypeDefaultDescription
flag{boolean}{true | false}
setLabelWidth(labelWidth)
Set label width of Link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width
setLinkURL(url)
Set URL for link control
NameTypeDefaultDescription
url{string}Set URL of control
setSizeStyle(style)
Sets size style of control. NOTE: to avoid ambiguity always set the size using "R"|"X"|"G"|"L"|"S"|"M"|"D"
NameTypeDefaultDescription
style{string}"SUPER-LARGE"|"SUPER LARGE"|"SUPER"|"R"=Super large | "EXTRA-LARGE"|"EXTRA LARGE"|"EXTRA"|"X"=Extra large | "LARGER"|"G"=Larger | "LARGE"|"L"=Large | "SMALL"|"S"=Small | "SMALLER"|"M"=Smaller | "DEFAULT"|"DEF"|"D"=Default
setTabIndex(tabIndex)
Sets tab index of text control
NameTypeDefaultDescription
tabIndex{integer}tab indices start at 1 and may be set sparsely
setText(text)
Set text for link control
NameTypeDefaultDescription
text{string}Output text of control
Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
valid{boolean}Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText{string}Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid
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"
setWidth(width)
Set width of link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
width{string}Width of control
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();