Output Text
The Output Text control is a text option that displays read-only text.
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 control. {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 control 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
| Allow HTML: | Display the bound data as HTML formatted text. | Boolean |
Formula
| Text formula: | The formula or expression to calculate the output text. | String |
| Events | ||||||
| On Load: |
| |||||
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
| Name | Type | Default | 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} | 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(); |
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
| Name | Type | Default | Description |
| 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,
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"
| Name | Type | Default | 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)
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
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| Name | Type | Default | 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)
Set the label for the output text control
| Name | Type | Default | Description |
| 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"
| Name | Type | Default | Description |
| placement | {string} | "T"|"TOP"=Top | "L"|"LEFT"=Left |
setLabelVisible(flag)
Set the label visibility for the output text control
| Name | Type | Default | Description |
| flag | {boolean} | {true | false} |
setLabelWidth(labelWidth)
Set label width of OutputText control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| labelWidth | {string} | Control's label width |
setSizeStyle(style)
Sets the size style of the control
| Name | Type | Default | 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)
Set the text for the output text control
| Name | Type | Default | Description |
| text | {string} | Output text of control |
Inherited
setVisible(visible, collapse)
Show/hide this view/control
| Name | Type | Default | 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)
Set the width of the output text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| width | {string} | Width of control |
Inherited
triggerFormulaUpdates([phase])
Broadcasts 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(); |