Decimal

Allows users to enter or view only decimal values.

Appearance

Width:	The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed.	`String`
Size:	The size of the view. {Default \| Large \| Small}	`TextSizeStyle`
Label placement:	The position of the label. {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`

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`
Decimal separator:	The value or symbol that separates the actual value and decimal places. The currency format overrides this value.	`String`
Prefix:	A symbol that is placed before the input value.	`String`
Postfix:	A symbol that is placed after the input value.	`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. {Custom \| Auto}	`AutoCustomSelection`
Thousands separator:	The symbol used to separate thousands. For example if you use ',' the value displays as 1,000,000. The currency format overrides this value.	`String`
Hide thousands separator:	Hides the thousands separator. By default, the thousands separator is shown.	`Boolean`
Decimal places:	The number of decimal places to display.	`Integer`
Currency:	The currency format of the decimal view inlcuding the separators and currency symbol. To specify a custom format, use the Thousand separator, Decimal separator, Prefix and Postfix instead. {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}	`CurrencyCodeSelectionType`
Currency symbol:	The symbol used for the currency. This value overrides the default symbol of the given currency. To use the default currency symbol, leave this value blank.	`String`

Formula

Value formula: Formula to calculate the value stored in this view. 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

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add/replace CSS class(es) for this control

Name	Type	Default	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}`		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

Inherited getData() Returns: {Object}

Retrieve bound data associated this view/control. Only works for views/controls with bound data.

Example

var dec1 = MyDecimal.getData();

getLabel() Returns: {string}

Get label associated with this 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 Decimal control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

getPlaceholder() Returns: {string}

Get placeholder text associated with this control

getSizeStyle() Returns: {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"

getTabIndex() Returns: {integer}

Get tab index for this control

getTextColor() Returns: {string}

Gets color of characters in control

getType() Returns: {string}

Get descriptive string representing the type of control

getValue() Returns: {number}

Get value currently in control

getWidth() Returns: {string}

Get configured width for this control (including unit)

Inherited hide(collapseFlag)

Hide this view/control

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}

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

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

Inherited setEnabled(enabled, required)

Enable/disable this view/control

Name	Type	Default	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	Default	Description
label	`{string}`		set the label name

setLabelPlacement(null, placement)

Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"

Name	Type	Default	Description
	`{string}`		placement
placement	`{string}`		"T"\|"TOP"=Top \| "L"\|"LEFT"=Left

Example

me.setLabelPlacement("L")

setLabelVisible(flag)

Set label visibility for this control

Name	Type	Default	Description
flag	`{boolean}`		sets the visibility {true \| false}

setLabelWidth(labelWidth)

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

Name	Type	Default	Description
labelWidth	`{string}`		Control's label width

setPlaceholder(text)

Set placeholder text for this control

Name	Type	Default	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	Default	Description
style	`{string}`		"DEFAULT"\|"DEF"\|"NORMAL"\|"D"=Default \| "SMALL"\|"S"=Small \| "LARGE"\|"L"=Large

setTabIndex(tabIndex)

Sets tab index of this control

Name	Type	Default	Description
tabIndex	`{integer}`		Tab indices start at 1 and may be set sparsely

setTextColor(textColor)

Sets color of characters in control

Name	Type	Default	Description
textColor	`{string}`		Color of input when formatted (all valid css values accepted - e.g. red, #ff0000, rgb(255,0,0))

Inherited setValid(valid, errorText)

Flag this view/control 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, "Please fix your data entry"); //Make MyView invalid

setValue(val)

Set value for control

Name	Type	Default	Description
val	`{number}`		Value to set in control

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

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

Name	Type	Default	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	Default	Description
width	`{string}`		sets the width of the control

Inherited show()

Show this view/control

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcasts 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