Signature
Allows users to put their signature on the screen using a touch screen or a mouse.
Appearance
Color style: | Color style of signature box {Default | Primary | Success | Info | Warning | Danger} |
SignatureColorStyle |
Border width: | Thickness of border in px | String |
Border radius: | Corner roundness in px | String |
Box shadow: | Enable or disable the background shadow of the signature box. | Boolean |
Width: | Width in pixels | String |
Height: | Height in pixels | String |
Behavior
Ink color: | Color to sign with | String |
Events | ||||||
On Load: |
| |||||
On Changed: |
|
Extends:
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"); |
clear()
Clears the signature in the 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(); |
getType()
Returns:
{string}
Get descriptive string representing the type of control
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.
isEmpty()
Returns:
{boolean}
Returns whether the control is empty or not
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled(); |
Inherited
isLabelVisible()
Returns:
{boolean}
Checks if control label is visible
Example
var labelVisible = MyView.isLabelVisible(); |
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(); |
obfuscate()
This obscures the image of the signature
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,
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 |
Inherited
setLabelVisible(visible)
Show/hide the label of this view/control
Name | Type | Default | Description |
visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
MyView.setLabelVisible(false); |
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 |
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
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 OptionsName | 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" |
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(); |