MaskedText

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

focus()

Set focus on this control

getAutoClear() Returns: {boolean}

Get the autoclear option for MaskedText control

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

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 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.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

isLabelVisible() Returns: {boolean}

Get label visibility for MaskedText control

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

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

setAutoClear(flag)

Sets the autoclear option of MaskedText control

Name Type Default Description

flag {boolean} Set to true to enable autoclearing invalid data

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

setHelpText(helptext)

Set help text for the control

Name Type Default Description

helptext {string} Help text for the control

setLabel(label)

Set label for MaskedText control

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

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

setLabelVisible(flag)

Set label visibility for MaskedText control

Name Type Default Description

flag {boolean} {true | false}

setLabelWidth(labelWidth)

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

Name Type Default Description

labelWidth {string} Control's label width

setMask(mask)

Sets the mask of MaskedText control

Name Type Default Description

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

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

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

setTabIndex(tabIndex)

Sets tab index of MaskedText control

Name Type Default Description

tabIndex {integer} Tab indices start at 1 and may be set sparsely

setText(text)

Set text for MaskedText control

Name Type Default Description

text {string} Text to set in control

Inherited setValid(valid, errorText)

Flag the view as valid or invalid.

Name Type Default 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, "Fix your data entry"); //Make MyView invalid

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

Name Type Default Description

width {string} Control width

Inherited show()

Show this view.

Example

MyView.show();

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