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:

Description:	Triggers when the timer times out. Will trigger multiple times if timer is set to repeatable.
Example:	`${CounterDisplay}.setText(me.getTicks())`

On Boundary Event:

Description:	Triggers upon reaching a Stay On Page event after a boundary event is fired through this control. For information on the status context variable see the context.trigger() method in the Knowledge Center.
Example:	`alert("Stay on Page status '" + status + "'")`

Context Variables	status {string}

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

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}

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

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

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/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'

start()

Starts a timer

stop()

Stops a timer

toggle()

Toggles the timer on or off

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