Class: MaskedText

MaskedText

The Maked Text control allows for text entry within a mask.  This can be useful for entering formatted text like phone numbers, postal codes, etc A MaskedText control provides the following configuration properties in Process Designer:

Appearance

Monospace: Enable monospace. This will prevent the mask from moving as text is entered. boolean
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Size Style: Size-based styling for this control
{Default | Large | Small}
string
Label Placement: Set the label position for the control. Note: Labels on the left will change the specified width of the control
{Top | Left}
string

Behavior

Tab Index: Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely. integer
Placeholder Text: Placeholder text to display when no value has been entered string
Mask: Text mask. Use # to indicate where numbers may be entered, 'a' for alpha characters and * for alphanumeric characters. All other characters will be displayed as part of the mask string
Auto Clear Invalid Text: When enabled, invalid input will cause the control to automatically clear boolean

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setMask(${CountryCodeData}.getValue() == "uk" ? "(###) ####-####" : (###) ###-####)
On Change:
Description: Triggers when the data bound to this control changes.
Example:
me.setValid(@validNumber(newText),"Please enter a valid phone number")
Context Variables newText {string} oldText {string}
On Focus:
Description: Triggers when the view gains focus.
Example:
me.setSizeStyle("L")
On Blur:
Description: Triggers when the view loses focus.
Example:
me.setSizeStyle("D")
On Input:
Description: Triggers when text is input. If expression returns false, input will not be taken.
Example:
return potential.substr(0,3) != "555"
Context Variables current {string} potential {string} selection {object {start, end} } type {string}
Article(s)
MaskedText

new MaskedText()

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");
Set focus on this control

getAutoClear(){boolean}

Get the autoclear option for MaskedText control
Returns:
Type Description
boolean
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}

Get label associated with MaskedText 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

getMask(){string}

Get the mask for MaskedText control
Returns:
Type Description
string

getPlaceholder(){string}

Get placeholder text associated with MaskedText 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

getTabIndex(){integer}

Get tab index for MaskedText control
Returns:
Type Description
integer

getText(){string}

Get text for MaskedText 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 MaskedText 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.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

isLabelVisible(){boolean}

Get label visibility for MaskedText control
Returns:
Type Description
boolean
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();
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

setAutoClear(flag)

Sets the autoclear option of MaskedText control
Name Type Description
flag boolean Set to true to enable autoclearing invalid data
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'
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)

Set label for MaskedText control
Name Type Description
label string Control label

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

setLabelVisible(flag)

Set label visibility for MaskedText control
Name Type Description
flag boolean {true | false}

setMask(mask)

Sets the mask of MaskedText control
Name Type Description
mask string Use # to represent digits (0-9), a represent alphabets (a-z & A-Z)

setPlaceholder(text)

Set placeholder text for MaskedText control
Name Type Description
text string Placeholder text

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

setTabIndex(tabIndex)

Sets tab index of MaskedText control
Name Type Description
tabIndex integer Tab indices start at 1 and may be set sparsely

setText(text)

Set text for MaskedText control
Name Type Description
text string Text to set in control
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
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 MaskedText control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Control width
Show this view/control
Example
MyView.show();
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();