Masked text
Requires users to enter text that must comply with a specified format. For example, a postal code or credit card number.

Appearance
Monospace: Enable monospace. This will prevent the mask from moving as text is entered. Boolean
Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Size: Size-based styling for this view
{Default | Large | Small}
TextSizeStyle
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
Show overflow text in tooltip: Show the full text in a tooltip when the content overflows the view boundaries. Boolean

Behavior
Tab index: The tabbing sequence index of the form view. Indices start at 1, and can be set sparsely. For example, you can use 1, 5, 10. Integer
Placeholder text: The text that is displayed when no value is entered. String
Mask: Text mask. Use \# to indicate where numbers may be entered, 'a' for alpha characters, and '*' for either number or alpha characters. All other characters will be displayed as part of the mask. String
Auto clear invalid text: When enabled, invalid input will cause the view 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}
Extends:
com.ibm.bpm.coach.CoachView
Methods:

Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}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()
Set focus on this control

getAutoClear() Returns: {boolean}
Get the autoclear option for MaskedText control

Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();

getHelpText() Returns: {string}
Get help text associated with the control

getLabel() Returns: {string}
Get label associated with MaskedText 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"

getLabelWidth() Returns: {string}
Get label width of MaskedText control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

getMask() Returns: {string}
Get the mask for MaskedText control

getPlaceholder() Returns: {string}
Get placeholder text associated with MaskedText 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"

getTabIndex() Returns: {integer}
Get tab index for MaskedText control

getText() Returns: {string}
Get text for MaskedText control

getType() Returns: {string}
Get descriptive string representing the type of control

getWidth() Returns: {string}
Get configured width for MaskedText control (including unit)

Inherited hide(collapseFlag)
Hide this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();

Inherited isBound() Returns: {boolean}
Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();

isLabelVisible() Returns: {boolean}
Get label visibility for MaskedText control

Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);

Inherited recalculate()
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
NameTypeDefaultDescription
flag{boolean}Set to true to enable autoclearing invalid data

Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
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

setHelpText(helptext)
Set help text for the control
NameTypeDefaultDescription
helptext{string}Help text for the control

setLabel(label)
Set label for MaskedText control
NameTypeDefaultDescription
label{string}Control label

setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left

setLabelVisible(flag)
Set label visibility for MaskedText control
NameTypeDefaultDescription
flag{boolean}{true | false}

setLabelWidth(labelWidth)
Set label width of MaskedText control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width

setMask(mask)
Sets the mask of MaskedText control
NameTypeDefaultDescription
mask{string}Use # to represent digits [0-9], a to represent letters [a-zA-Z] and * to represent alpha-numerics [A-Za-z0-9]

setPlaceholder(text)
Set placeholder text for MaskedText control
NameTypeDefaultDescription
text{string}Placeholder text

setSizeStyle(style)
Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
NameTypeDefaultDescription
style{string}"DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large

setTabIndex(tabIndex)
Sets tab index of MaskedText control
NameTypeDefaultDescription
tabIndex{integer}Tab indices start at 1 and may be set sparsely

setText(text)
Set text for MaskedText control
NameTypeDefaultDescription
text{string}Text to set in control

Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
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

Inherited setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
data{Object}Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding{boolean}If set to true, 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/hide this view/control
NameTypeDefaultDescription
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)
NameTypeDefaultDescription
width{string}Control width

Inherited show()
Show this view/control
Example
MyView.show();

Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();