Timer
Creates an alert that is triggered by a time-related event. For example, before closing a page after a specified time interval has elapsed.
null
| Timeout value (msecs.): | Specify the number of milliseconds before this timer "pops". | Integer |
| Repeatable: | When enabled, the timer will repeat until stopped based on the interval set in the timeout | Boolean |
| Initially stopped: | When true the timer does not start running until specifically started with the start() method. | Boolean |
| Events | ||||||||
| On Timeout: |
| |||||||
| On Boundary Event: |
| |||||||
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add or replace the CSS classes for this view.
| Name | Type | Default | Description |
| name | {string} | The CSS class names to add to the view. For multiple classes, use space to separate the class names. | |
| replaced | {string} | The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names. |
Example
| Button.addClass("green"); |
getTicks()
Returns:
{integer}
Returns the current number of timer ticks
getTimeout()
Returns:
{integer}
Gets the timeout value (milliseconds)
getType()
Returns:
{string}
Get descriptive string representing the type of control
isRepeatable()
Returns:
{boolean}
gets the value of the Repeatable flag
isRunning()
Returns:
{boolean}
Indicates whether or not the timer is started
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagate the value change of the view up through the parent views.
| Name | Type | Default | Description |
| event | {Event} | Value change event (usually an onchange event) |
Example
| MyView.propagateUp(event); |
resetTicks([ticks])
Sets the current number of timer ticks to the specified value or 0 when unspecified
| Name | Type | Default | Description |
| ticks | {integer} | 0 | Number of ticks to set |
Inherited
setLabelVisible(visible)
Show or hide the view label.
| Name | Type | Default | Description |
| visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
| MyView.setLabelVisible(false); |
setRepeatable(flag)
sets the Repeatable flag
| Name | Type | Default | Description |
| flag | {boolean} | {true | false} Set to true to make the timer repeatable |
setTimeout(timeout)
Sets the timeout value (milliseconds)
| Name | Type | Default | Description |
| timeout | {integer} | Milliseconds until timer ticks |
Inherited
setViewData(data, createPseudoBinding)
Set or update the bound data associated with the view. It applies only to views with bound data.
Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the
Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the
binding.set pattern, as described in the Binding data and configuration options documentation section.| Name | Type | Default | Description |
| data | {Object} | The value of the bound data. The parameter type must match the type of the bound data. | |
| createPseudoBinding | {boolean} | If the value is set to true, the parameter creates a pseudo binding if there is no current binding. |
Example
| MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
start()
Starts a timer
stop()
Stops a timer
toggle()
Toggles the timer on or off
Inherited
triggerFormulaUpdates([phase])
Broadcast 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(); |