Class: OutputText

OutputText

The Output Text control is a text option that displays read-only text. An OutputText control provides the following configuration properties in Process Designer:

Formula
Text Formula: Formula/expression to use for calculating output text string

Appearance
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Text Alignment: Set the alignment of the output text relative to the width of the control
{Left | Center | Right}		 string
Color Style: Set the color style of the output text. Note: The color style only applies to the text, not the label
{Default | Normal | Muted | Light-gray | Primary | Info | Success | Warning | Danger}		 string
Size Style: Set the text size. Applies to both text and label
{Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller}		 string
Text Weight: Set the text weight. Only applies to the text, not the label
{Default | Slim | Normal | Semi-bold | Bold}		 string
Label Placement: Note: Labels on the left will change the specified width of the control
{Top | Left}		 string

Behavior
Allow HTML: Allows the Output Text control to render HTML content as declared in the bound value. (Default action if left unchecked will escape out any HTML content) boolean

Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
me.setText("Some default text...")
Article(s)
Output Text

new OutputText()

OutputText.js, line 49
This constructor is never used explicitly.

Extends

Members

uibpmext.ui.View

Methods

inherited addClass(name, replaced)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2466
Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional 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(){string}

OutputText.js, line 231
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"
Returns:
Type Description
string

inherited getData(){Object}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2101
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getLabel(){string}

OutputText.js, line 150
Get the label associated with the text control
Returns:
Type Description
string

getLabelPlacement(){string}

OutputText.js, line 166
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"
Returns:
Type Description
string

getSizeStyle(){string}

OutputText.js, line 247
Gets the size style of the control
Returns:
Type Description
string {"R"=Super large | "X"=Extra large | "G"=Larger | "L"=Large | "S"=Small | "M"=Smaller | "D"=Default}

getText(){string}

OutputText.js, line 190
Get the text for the output output output text control
Returns:
Type Description
string

getType(){string}

OutputText.js, line 255
Get the descriptive string representing the type of the control
Returns:
Type Description
string

getWidth(){string}

OutputText.js, line 214
Get the configured width for the output text control (including unit)
Returns:
Type Description
string

inherited isBound(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2088
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.

isLabelVisible(){boolean}

OutputText.js, line 174
Get the label visibility for the output text control
Returns:
Type Description
boolean

inherited isVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1943
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();

inherited propagateUpValueChange(event){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2403
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);

inherited recalculate()

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2732
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)

OutputText.js, line 222
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"
Name Type Description
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

inherited setData(value)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2070
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'

setLabel(text)

OutputText.js, line 142
Set the label for the output text control
Name Type Description
text string Label for control

setLabelPlacement(placement)

OutputText.js, line 158
Set the label placement for the control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name Type Description
placement string "T"|"TOP"=Top | "L"|"LEFT"=Left

setLabelVisible(flag)

OutputText.js, line 182
Set the label visibility for the output text control
Name Type Description
flag boolean {true | false}

setSizeStyle(style)

OutputText.js, line 239
Sets the size style of the control
Name Type Description
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)

OutputText.js, line 198
Set the text for the output text control
Name Type Description
text string Output text of control

inherited setVisible(visible, collapse)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1887
Show/hide this view/control
Name Type Description
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)

OutputText.js, line 206
Set the width of the output text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Width of control

inherited triggerFormulaUpdates(phase)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 4229
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();