Class: Text

Text

The Text control is used for entering or displaying any text data. A Text control provides the following configuration properties in Process Designer:

Formula
Text Expression: Formula/expression to use for calculating value string

Appearance
Width: The width 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 this control
{Top | Left}		 string

Behavior
Tab Index: Form control tabbing sequence index. Indices start at 1, and may be set sparsely integer
Placeholder Text: Placeholder text to show when no text has been entered string
Regular Expression: Regular expression to use for validating text entries against string
Select Text On Focus: Selects all text currently entered in control on focus boolean

Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
me.setText("Some default text on load.")
On Change:
Description: This event is fired when the text is changed.
Example: 
if(newText != oldText){return confirm ("Are you sure you want to change the text field?");}
Context Variables newText {string} oldText {string}
On Focus:
Description: This event is fired when the focus moves to the text field.
Example: 
me.setLabelPlacement("T")
On Blur:
Description: This event is fired when when the user exits the text field.
Example: 
me.setLabelPlacement("L")
On Input:
Description: This event is fired when the user inputs text. If expression returns false, input will not be taken.
Example: 
return potential.length<=10;
Context Variables current {string} potential {string} selection {object {start, end} } type {string}
Article(s)
Text

new Text()

Text.js, line 7
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");

focus()

Text.js, line 341
Set focus on this control

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}

Text.js, line 195
Gets the label associated with the control
Returns:
Type Description
string

getLabelPlacement(){string}

Text.js, line 212
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

getPlaceholder(){string}

Text.js, line 261
Get placeholder text associated with the control
Returns:
Type Description
string

getSizeStyle(){string}

Text.js, line 293
Gets size style of text control
Returns:
Type Description
string {"L"=Large | "S"=Small | "D"=Default}

getTabIndex(){integer}

Text.js, line 309
Gets tab index for the control
Returns:
Type Description
integer

getText(){string}

Text.js, line 237
Gets text for the control
Returns:
Type Description
string

getType(){string}

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

getValidationExpression(){string}

Text.js, line 325
Get validation (regular) expression for the control
Returns:
Type Description
string

getWidth(){string}

Text.js, line 277
Gets configured width for the control (including unit)
Returns:
Type Description
string

inherited hide(collapseFlag)

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

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.

inherited isEnabled(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2034
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

isLabelVisible(){boolean}

Text.js, line 221
Gets label visibility for the control
Returns:
Type Description
boolean

isSelectAll(){boolean}

Text.js, line 333
Get whether or not all text is selected on focus
Returns:
Type Description
boolean

inherited isValid(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2370
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();

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

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'

inherited setEnabled(enabled, required)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1959
Enable/disable this view/control
Name Type Description
enabled boolean Enabled/read-only flag (true to enable view, false to disable/make read-only)
required boolean Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

setLabel(label)

Text.js, line 187
Sets the label for the control
Name Type Description
label string the label for the control

setLabelPlacement(placement)

Text.js, line 203
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)

Text.js, line 229
Sets label visibility for the control
Name Type Description
flag boolean set visibility

setPlaceholder(text)

Text.js, line 253
Set placeholder text for the control
Name Type Description
text string sets placeholder text

setSizeStyle(style)

Text.js, line 285
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

setTabIndex(tabIndex)

Text.js, line 301
Sets tab index of the control
Name Type Description
tabIndex integer tab indices start at 1 and may be set sparsely

setText(text)

Text.js, line 245
Sets text for the control
Name Type Description
text string to be set in the control

inherited setValid(valid, errorText)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2342
Flag this view/control as valid or invalid
Name Type Description
valid boolean Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText string Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid

setValidationExpression(re)

Text.js, line 317
Set validation (regular) expression of the control
Name Type Description
re string regular expression

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)

Text.js, line 269
Sets width of the control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string sets the width of the control

inherited show()

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1849
Show this view/control
Example
MyView.show();

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