Class: Integer

Integer

The Integer control is used for numerical input or output. An Integer control provides the following configuration properties in Process Designer:

Formula

Value Formula: Formula to use to set integer value string

Appearance

Width: Width of the control in (px, %, etc.) string
Size Style: Set the size of the control
{Default | Large | Small}
string
Label Placement: Set the label position
{Top | Left}
string

Behavior

Tab Index: Form control tabbing sequence index. Indices start at 1, and may be set sparsely. integer
Placeholder Text: Text to display when no input has been entered string
Thousands Separator: Symbol to use to separate thousands. e.g., if ',' is used, the value 1 million will be formatted as 1,000,000 string
Prefix: Symbol to be placed before input values string
Postfix: Symbol to be placed after input values. string
Numeric Formatting: Determines whether the thousands separator is based on the current user's locale, or specified as custom configuration options.
{Auto | Custom}
string
Hide Thousands Separator: Hides the thousands separator. By default the thousands separator is shown. boolean

Events

On Load:
Description: This event is triggered when the value is changed.
Example:
me.setValue(0.00);
On Change:
Description: This event is triggered when the value is changed.
Example:
${Decimal1}.setValue(oldValue); ${Decimal2}.setValue(newValue);
Context Variables newValue {decimal} oldValue {decimal}
On Focus:
Description: This event is triggered the control receives the focus.
Example:
${Tooltip1}.setTooltipVisible(true)
On Blur:
Description: This event is triggered the control loses the focus.
Example:
${Tooltip1}.setTooltipVisible(false);
On Format:
Description: This event can be used to give values more custom formatting. The formatting in the control is based on the return value of the statement
Example:
var neg = me.getValue() < 0; if (neg){return "(" + formattedValue + ")"}
Context Variables value {decimal} formatted {string} format {object}
Properties prefix
postfix
thousandsSeparator
decimalSeparator
decimalPlaces
Article(s)
Decimal

new Integer()

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

focus()

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

getPlaceholder(){string}

Get placeholder text associated with this control
Returns:
Type Description
string

getSizeStyle(){string}

Gets size style of the 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 this control
Returns:
Type Description
integer

getTextColor(){string}

Gets color of characters in control
Returns:
Type Description
string Color of characters in control

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getValue(){number}

Get value currently in control
Returns:
Type Description
number

getWidth(){string}

Get configured width for this 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 this 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
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 this control
Name Type Description
label string set the label name

setLabelPlacement(placement, placement)

Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name Type Description
placement string
placement string "T"|"TOP"=Top | "L"|"LEFT"=Left
Example
me.setLabelPlacement("L")

setLabelVisible(flag)

Set label visibility for this control
Name Type Description
flag boolean sets the visibility {true | false}

setPlaceholder(text)

Set placeholder text for this control
Name Type Description
text string sets placeholder text

setSizeStyle(style)

Sets size style of the 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 this control
Name Type Description
tabIndex integer Tab indices start at 1 and may be set sparsely

setTextColor(textColor)

Sets color of characters in control
Name Type Description
textColor string Color of input when formatted (all valid css values accepted - e.g. red, #ff0000, rgb(255,0,0))
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

setValue(val)

Set value for control
Name Type Description
val number Value to set in control
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 this control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string sets the width of the control
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();