Class: TextReader

TextReader

The Text Reader control allows long sections of text to be displayed in a collapsible pane, which may be toggled to show more/less data. A TextReader control provides the following configuration properties in Process Designer:

Appearance

Width: The width of the text box in (%, px, em) string
Height: The height of the text box in (%, px, em) string
Size Style: Set the size style for the control
{Default | Large | Small}
string
Label Placement: Set the label placement for the control
{Top | Left}
string

Behavior

Max Text Length: Maximum number of characters displayed until the "read more" hint is shown. If not specified or < 1, then 128 characters is assumed by default. integer
Read More Hint: Text displayed for the "read more" hint string
Read Less Hint: Text displayed for the "read less" hint string
Initially Expanded: When enabled, text reader will be expanded on load boolean

Events

On Load:
Description: Triggers when control loads
Example:
if (${DeviceSensor}.getDeviceInfo().isIPhone) {me.setExpanded(false);} else {me.setExpanded(true);}
On Click:
Description: Triggers when control is clicked
Example:
me.toggleExpanded()
On Expand:
Description: Triggers when user expands text
Example:
${TextReader2}.setExpanded(false)
On Collapse:
Description: Triggers when user collapses text
Example:
${TextReader2}.setExpanded(true)

new TextReader()

This constructor is never used explicitly.

Extends

Members

Methods

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

getHeight(){string}

Get configured height for text reader control (including unit)
Returns:
Type Description
string

getLabel(){string}

Get label associated with text reader control
Returns:
Type Description
string

getLabelPlacement(){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"
Returns:
Type Description
string
Example
if(me.getLabelPlacement == "L"){me.setLabelPlacement("T");}

getReadLessHint(){string}

Gets the "read less hint" text of the reader control
Returns:
Type Description
string

getReadMoreHint(){string}

Gets the "read more hint" text of the reader control
Returns:
Type Description
string

getSizeStyle(){string}

Gets size style of control. NOTE: This always returns the size style as set, to avoid ambiguity always set the size style using "D"|"S"|"L"
Returns:
Type Description
string

getText(){string}

Get text for text reader control
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for text reader control (including unit)
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.

isExpanded(){boolean}

Gets the expanded stated of text reader control
Returns:
Type Description
boolean true if reader is currently expanded, false otherwise

isLabelVisible(){boolean}

Get label visibility for text reader control
Returns:
Type Description
boolean
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
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);
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
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'

setExpanded(flag){boolean}

Sets the expanded stated of text reader control. This has no effect is the text length in the control is not greater than the max text length allowed
Name Type Description
flag boolean indicating the desired expanded state
Returns:
Type Description
boolean State after function is executed

setHeight(height)

Set height of text reader control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
height string height of the control

setLabel(label)

Set label for text reader control
Name Type Description
label string label for the text reader

setLabelPlacement(placement)

Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name Type Description
placement string "T"|"TOP"=Top | "L"|"LEFT"=Left
Example
me.setLabelPlacement("L");

setLabelVisible(flag)

Set label visibility for text reader control
Name Type Description
flag boolean set the visibility of the text reader

setReadLessHint(text)

Sets the "read less hint" text of the reader control
Name Type Description
text string Text to set for the read less hint

setReadMoreHint(text)

Sets the "read more hint" text of the reader control
Name Type Description
text string Text to set for the read more hint

setSizeStyle(style)

Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
Name Type Description
style string "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large

setText(text)

Set text for text reader control
Name Type Description
text string the text in the text reader
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)

Set width of text reader control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string width of the control
Show this view/control
Example
MyView.show();

toggleExpanded(){boolean}

Sets the expanded stated of text reader control. This has no effect is the text length in the control is not greater than the max text length allowed
Returns:
Type Description
boolean State after function is executed
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();