class sap.ui.core.IntervalTrigger

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/IntervalTrigger
Application Component: CA-UI5-COR

Provides a trigger that triggers in a set interval and calls all registered listeners. If the interval is <= 0 the trigger is switched off and won't trigger at all.


Constructor

Creates an instance of EventBus.

new sap.ui.core.IntervalTrigger(iInterval)
Param Type Default Value Description
iInterval int

is the interval the trigger should be used. If the trigger is >0 triggering starts/runs and if the interval is set to <=0 triggering stops.


Methods Overview

Method Description
addListener

Adds a listener to the list that should be triggered.

sap.ui.core.IntervalTrigger.addListener

Adds a listener to the list that should be triggered.

destroy

Destructor method for objects.

sap.ui.core.IntervalTrigger.extend

Creates a new subclass of class sap.ui.core.IntervalTrigger with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.Object.extend.

sap.ui.core.IntervalTrigger.getMetadata

Returns a metadata object for class sap.ui.core.IntervalTrigger.

removeListener

Removes corresponding listener from list.

sap.ui.core.IntervalTrigger.removeListener

Removes corresponding listener from list.

setInterval

Sets the trigger interval. If the value is >0 triggering will start if there are any registered listeners. If the interval is set to <=0 triggering will stop.

addListener

Adds a listener to the list that should be triggered.

Param Type DefaultValue Description
fnFunction function

is the called function that should be called when the trigger want to trigger the listener.

oListener object

that should be triggered.

sap.ui.core.IntervalTrigger.addListener

Adds a listener to the list that should be triggered.

Param Type DefaultValue Description
fnFunction function

is the called function that should be called when the trigger want to trigger the listener.

oListener object

that should be triggered.

destroy

Destructor method for objects.

sap.ui.core.IntervalTrigger.extend

Creates a new subclass of class sap.ui.core.IntervalTrigger with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.Object.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.core.IntervalTrigger.getMetadata

Returns a metadata object for class sap.ui.core.IntervalTrigger.

removeListener

Removes corresponding listener from list.

Param Type DefaultValue Description
fnFunction function

is the previously registered function

oListener object

that should be removed

sap.ui.core.IntervalTrigger.removeListener

Removes corresponding listener from list.

Param Type DefaultValue Description
fnFunction function

is the previously registered function

oListener object

that should be removed

setInterval

Sets the trigger interval. If the value is >0 triggering will start if there are any registered listeners. If the interval is set to <=0 triggering will stop.

Param Type DefaultValue Description
iInterval int

sets the interval in milliseconds when a new triggering should occur.