TextReader

Text reader

Allows long sections of text to be displayed in a collapsible pane, which may be toggled to show more or less data.

Appearance

Width: The width of the text box in (%, px, em) String

Height: The height of the text box in (%, px, em) String

Size: The text size.
{Default | Large | Small} TextSizeStyle

Label placement: The label placement for the view.
{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

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

Use arrow icons: Enables you to use arrow icons that expand and collapse the text area. 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)

Extends:

com.ibm.bpm.coach.CoachView

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

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

getHeight() Returns: {string}

Get configured height for text reader control (including unit)

getHelpText() Returns: {string}

Get help text associated with the control

getLabel() Returns: {string}

Get label associated with text reader control

getLabelPlacement() Returns: {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"

Example

if(me.getLabelPlacement == "L"){me.setLabelPlacement("T");}

getLabelWidth() Returns: {string}

Get label width of text reader control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

getReadLessHint()

Gets the "read less hint" text of the reader control

getReadMoreHint()

Gets the "read more hint" text of the reader control

getSizeStyle() Returns: {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"

getText() Returns: {string}

Get text for text reader control

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured width for text reader control (including unit)

Inherited hide(collapseFlag)

Hide the view.

Name Type Default Description

collapseFlag {boolean} Set to true to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

isExpanded() Returns: {boolean}

Gets the expanded stated of text reader control

isLabelVisible() Returns: {boolean}

Get label visibility for text reader 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

setExpanded(flag) Returns: {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 Default Description

flag {boolean} indicating the desired expanded state

setHeight(height)

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

Name Type Default Description

height {string} height of the control

setHelpText(helptext)

Set help text for the control

Name Type Default Description

helptext {string} Help text for the control

setLabel(label)

Set label for text reader control

Name Type Default 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 Default Description

placement {string} "T"|"TOP"=Top | "L"|"LEFT"=Left

Example

me.setLabelPlacement("L");

setLabelVisible(flag)

Set label visibility for text reader control

Name Type Default Description

flag {boolean} set the visibility of the text reader

setLabelWidth(labelWidth)

Set label width of text reader control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

labelWidth {string} Control's label width

setReadLessHint(text)

Sets the "read less hint" text of the reader control

Name Type Default 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 Default 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 Default Description

style {string} "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large

setText(text)

Set text for text reader control

Name Type Default Description

text {string} the text in the text reader

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 width of text reader control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

width {string} width of the control

Inherited show()

Show this view.

Example

MyView.show();

toggleExpanded() Returns: {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

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