Methods

addClass
getColorStyle
getData
getHelpText
getIsLabelWeightNormal
getLabel
getLabelPlacement
getLabelWidth
getSizeStyle
getText
getType
getWidth
isBound
isLabelVisible
isVisible
propagateUpValueChange
recalculate
setColorStyle
setHelpText
setLabel
setLabelPlacement
setLabelVisible
setLabelWeightNormal
setLabelWidth
setSizeStyle
setText
setViewData
setVisible
setWidth
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Display text
Displays read-only text. You can use it to display static text such as messages.
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 output text. 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 text size. Applies to the text and the label.
{Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller}		 OutputTextSizeStyle
Text weight: 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
Use normal font weight for label: (Classic theme only) By default, the label font weight is bold. By clicking this option, you'll use the normal font weight as defined in the theme. Boolean
Behavior
Allow HTML: Display the bound data as HTML formatted text. Boolean
Wrap text: Control how text is wrapped to a new line.
{Default | Normal | Keep all | Anywhere | Break word}		 TextWrap
Formula
Text formula: The formula or expression to calculate the output text. String
Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
me.setText("Some default text...")
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 the color style of the control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "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();
getHelpText() Returns: {string}
Get help text associated with the control
getIsLabelWeightNormal() Returns: {boolean}
Gets the label-weight-normal value
getLabel() Returns: {string}
Get the label associated with the text control
getLabelPlacement() Returns: {string}
Get the label placement for the 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 OutputText control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getSizeStyle() Returns: {string}
Gets the size style of the control
getText() Returns: {string}
Get the text for the output output output text control
getType() Returns: {string}
Get the descriptive string representing the type of the control
getWidth() Returns: {string}
Get the configured width for the output text control (including unit)
Inherited isBound() Returns: {boolean}
Indicates bound status of control.
isLabelVisible() Returns: {boolean}
Get the label visibility for the output text control
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 the color style of the control. NOTE: to avoid ambiguity always set the color using "D"|"M"|"L"|"P"|"I"|"S"|"W"|"G"|"T"
NameTypeDefaultDescription
style{string}"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
setHelpText(helptext)
Set help text for the control
NameTypeDefaultDescription
helptext{string}Help text for the control
setLabel(text)
Set the label for the output text control
NameTypeDefaultDescription
text{string}Label for control
setLabelPlacement(placement)
Set the label placement for the 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 the label visibility for the output text control
NameTypeDefaultDescription
flag{boolean}{true | false}
setLabelWeightNormal(null)
Sets the label-weight-normal value
NameTypeDefaultDescription
{boolean}
setLabelWidth(labelWidth)
Set label width of OutputText control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width
setSizeStyle(style)
Sets the size style of the control
NameTypeDefaultDescription
style{string}"R","SUPER"=Super large | "X","EXTRA-LARGE"=Extra large | "G","LARGER"=Larger | "L","LARGE"=Large | "S","SMALL"=Small | "M","SMALLER"=Smaller | "D","DEFAULT"=Default
setText(text)
Set the text for the output text control
NameTypeDefaultDescription
text{string}Output text of control
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 the width of the output text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
width{string}Width of control
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();