OutputText

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:

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

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 the bound data associated with the view. It applies only to views 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}

Indicate the bound status of the view.

isLabelVisible() Returns: {boolean}

Get the label visibility for the output text control

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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

setHelpText(helptext)

Set help text for the control

Name Type Default Description

helptext {string} Help text for the control

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}

setLabelWeightNormal(null)

Sets the label-weight-normal value

Name Type Default Description

{boolean}

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 setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter 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 or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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])

Broadcast 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();

Methods

Parent

Helpers