• index
• goog
• search: Go

The goog.Timer Class

goog.Timer
> goog.events.EventTarget
> goog.Disposable

goog.Timer(opt_interval, opt_timerObject)

Class for handling timing events.

opt_interval {number=}

Number of ms between ticks (Default: 1ms).

opt_timerObject {Object=}

An object that has setTimeout, setInterval, clearTimeout and clearInterval (eg Window).

.TICK {string}

Constant for the timer's event type

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.callOnce(listener, opt_delay, opt_handler)

Calls the given function once, after the optional pause. The function is always called asynchronously, even if the delay is 0. This is a common trick to schedule a function to run after a batch of browser event processing.

listener {Function}

Function or object that has a handleEvent method.

opt_delay {number=}

Milliseconds to wait; default is 0.

opt_handler {Object=}

Object in whose scope to call the listener.

returns {number}

A handle to the timer ID.

.clear(timerId)

Clears a timeout initiated by callOnce

timerId {?number}

a timer ID.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.defaultTimerObject {Object}

An object that implements setTimout, setInterval, clearTimeout and clearInterval. We default to the window object. Changing this on goog.Timer.prototype changes the object for all timer instances which can be useful if your environment has some other implementation of timers than the window object.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}

Event object.

returns {boolean}

If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispatchTick()

Dispatches the TICK event. This is its own method so subclasses can override.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

.enabled {boolean}

Whether this timer is enabled

.getInterval()

Gets the interval of the timer.

returns {number}

interval Number of ms between ticks.

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}

The parent EventTarget or null if there is no parent.

.intervalScale {number}

A variable that controls the timer error correction. If the timer is called before the requested interval times intervalScale, which often happens on mozilla, the timer is rescheduled. See also this.last_

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.setInterval(interval)

Sets the interval of the timer.

interval {number}

Number of ms between ticks.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}

Parent EventTarget (null if none).

.start()

Starts the timer.

.stop()

Stops the timer.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.