Class: Decimal

Decimal

The Decimal control is meant to display a decimal value and which can be formatted. A Decimal control provides the following configuration properties in Process Designer:

Formula

Value Formula: Formula for calculating the value stored in this control string

Appearance

Width: Width of the control in (px, %, etc.) string
Size Style: The size of the decimal control
{Default | Large | Small}
string
Label Placement: Label placement 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 value has been entered string
Thousands Separator: Symbol to use to separate thousands (e.g., ',' would cause the value 1 million to display as 1,000,000) string
Decimal Separator: The value or symbol that separates the actual value and decimal places string
Prefix: Symbol to place before the input values. string
Postfix: Symbol to place after the input values. string
Numeric Formatting: Determines whether the thousands separator and the decimal separator are 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
Decimal Places: The amount of decimal places to display (e.g. 2) integer
Currency: The list of currencies that this decimal is formatted to. The currency symbol can be overridden by providing a value for the Currency Symbol configuration option. If this Currency configuration option has a value, the specific Thousands Separator and the Decimal Separator option values are ignored as these are governed by the currency format. To instead specify custom formatting use the Prefix and/or Postfix configuration options.
{None | United Arab Emirates dirham | Afghan afghani | Albanian lek | Armenian dram | Netherlands Antillean guilder | Angolan kwanza | Argentine peso | Australian dollar | Aruban florin | Azerbaijani manat | Bosnia and Herzegovina convertible mark | Barbados dollar | Bangladeshi taka | Bulgarian lev | Bahraini dinar | Burundian franc | Bermudian dollar | Brunei dollar | Boliviano | Bolivian Mvdol | Brazilian real | Bahamian dollar | Bhutanese ngultrum | Botswana pula | Belarusian ruble | Belize dollar | Canadian dollar | Congolese franc | WIR Euro | Swiss franc | WIR Franc | Unidad de Fomento | Chilean peso | Chinese yuan | Colombian peso | Unidad de Valor Real | Costa Rican colon | Cuban convertible peso | Cuban peso | Cape Verde escudo | Czech koruna | Djiboutian franc | Danish krone | Dominican peso | Algerian dinar | Egyptian pound | Eritrean nakfa | Ethiopian birr | Euro | Fiji dollar | Falkland Islands pound | Pound sterling | Georgian lari | Ghanaian cedi | Gibraltar pound | Gambian dalasi | Guinean franc | Guatemalan quetzal | Guyanese dollar | Hong Kong dollar | Honduran lempira | Croatian kuna | Haitian gourde | Hungarian forint | Indonesian rupiah | Israeli new sheqel | Indian rupee | Iraqi dinar | Iranian rial | Icelandic króna | Jamaican dollar | Jordanian dinar | Japanese yen | Kenyan shilling | Kyrgyzstani som | Cambodian riel | Comoro franc | North Korean won | South Korean won | Kuwaiti dinar | Cayman Islands dollar | Kazakhstani tenge | Lao kip | Lebanese pound | Sri Lankan rupee | Liberian dollar | Lesotho loti | Lithuanian litas | Latvian lats | Libyan dinar | Moroccan dirham | Moldovan leu | Malagasy ariary | Macedonian denar | Myanma kyat | Mongolian tugrik | Macanese pataca | Mauritanian ouguiya | Mauritian rupee | Maldivian rufiyaa | Malawian kwacha | Mexican peso | Mexican Unidad de Inversion (UDI) | Malaysian ringgit | Mozambican metical | Namibian dollar | Nigerian naira | Nicaraguan córdoba | Norwegian krone | Nepalese rupee | New Zealand dollar | Omani rial | Panamanian balboa | Peruvian nuevo sol | Papua New Guinean kina | Philippine peso | Pakistani rupee | Polish złoty | Paraguayan guaraní | Qatari riyal | Romanian new leu | Serbian dinar | Russian rouble | Rwandan franc | Saudi riyal | Solomon Islands dollar | Seychelles rupee | Sudanese pound | Swedish krona | Singapore dollar | Saint Helena pound | Sierra Leonean leone | Somali shilling | Surinamese dollar | South Sudanese pound | São Tomé and Príncipe dobra | Syrian pound | Swazi lilangeni | Thai baht | Tajikistani somoni | Turkmenistani manat | Tunisian dinar | Tongan paʻanga | Turkish lira | Trinidad and Tobago dollar | New Taiwan dollar | Tanzanian shilling | Ukrainian hryvnia | Ugandan shilling | United States dollar | United States dollar (next day) | United States dollar (same day) | Uruguay Peso en Unidades Indexadas | Uruguayan peso | Uzbekistan som | Venezuelan bolívar fuerte | Vietnamese dong | Vanuatu vatu | Samoan tala | CFA franc BEAC | Silver | Gold | European Composite Unit (EURCO) | European Monetary Unit (E.M.U.-6) | European Unit of Account 9 (E.U.A.-9) | European Unit of Account 17 (E.U.A.-17) | East Caribbean dollar | Special drawing rights | UIC franc | CFA Franc BCEAO | Palladium | CFP franc | Platinum | Yemeni rial | South African rand | Zambian kwacha | Zimbabwe dollar}
string
Currency Symbol: The list of currencies that this decimal is formatted to. The currency symbol can be overridden by providing a value for the Currency Symbol configuration option. If this Currency configuration option has a value, the specific Thousands Separator and the Decimal Separator option values are ignored as these are governed by the currency format. To instead specify custom formatting use the Prefix and/or Postfix configuration options. string

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

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