new Decimal()
This constructor is never used explicitly.
Extends
Members
Methods
-
inherited addClass(name, replaced)
-
Add/replace CSS class(es) for this control
Name Type Description namestring CSS class name(s) to add to the control. Separate class names by a space if more than one class. replacedstring 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
-
inherited getData(){Object}
-
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description Object Value of bound data. undefinedif 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 -
inherited hide(collapseFlag)
-
Hide this view/control
Name Type Description collapseFlagboolean Set to trueto collapse the view (equivalent to a view setting of "NONE")Example
MyView.hide(); -
inherited isBound(){boolean}
-
Indicates bound status of control.
Returns:
Type Description boolean True if the control is bound to coach data. -
inherited isEnabled(){boolean}
-
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 -
inherited isValid(){boolean}
-
Returns the valid status as last set by the setValid() method.
Returns:
Type Description boolean Validity status. trueifsetValid(false, ...)was never calledExample
var valid = MyView.isValid(); -
inherited isVisible(){boolean}
-
Checks whether or not view is visible
Returns:
Type Description boolean Visibility status Example
var visible = MyView.isVisible(); -
inherited propagateUpValueChange(event){boolean}
-
Propagates value change of control up through parent views
Name Type Description eventEvent 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); -
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 setData(value)
-
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description valueObject 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' -
inherited setEnabled(enabled, required)
-
Enable/disable this view/control
Name Type Description enabledboolean Enabled/read-only flag ( trueto enable view,falseto disable/make read-only)requiredboolean 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 labelstring 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 placementstring placementstring "T"|"TOP"=Top | "L"|"LEFT"=Left Example
me.setLabelPlacement("L") -
setLabelVisible(flag)
-
Set label visibility for this control
Name Type Description flagboolean sets the visibility {true | false} -
setPlaceholder(text)
-
Set placeholder text for this control
Name Type Description textstring 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 stylestring "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large -
setTabIndex(tabIndex)
-
Sets tab index of this control
Name Type Description tabIndexinteger Tab indices start at 1 and may be set sparsely -
setTextColor(textColor)
-
Sets color of characters in control
Name Type Description textColorstring 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 Description validboolean Valid/invalid flag ( trueto set view valid,falseto make it invalid - which typically shows the view with "invalid" styling and indicator)errorTextstring 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 valnumber Value to set in control -
inherited setVisible(visible, collapse)
-
Show/hide this view/control
Name Type Description visibleboolean Visibility flag ( trueto show view,falseto hide)collapseboolean Set to trueto collapse the control space whenvisibleis set tofalse.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 widthstring sets the width of the control -
Show this view/control
Example
MyView.show(); -
inherited triggerFormulaUpdates(phase)
-
Broadcasts the expression trigger for the specified view
Name Type Default Description phaseint bpmext.ui.PHASE_NORMAL optional The phase we are currently in Example
MyView.triggerFormulaUpdates();