Class for handling timing events.

Inheritance

Constructor

goog.Timer(opt_intervalopt_timerObject)

Parameters

opt_interval : number=
Number of ms between ticks (Default: 1ms).
opt_timerObject : Object=
An object that has setTimeout, setInterval, clearTimeout and clearInterval (eg Window).

Instance Methods

Public Protected Private
Defined in goog.Timer
dispatchTick()
Dispatches the TICK event. This is its own method so subclasses can override.
code »
disposeInternal()
No description.
code »
getInterval() number
Gets the interval of the timer.
Returns: number  interval Number of ms between ticks.
code »
setInterval(interval)
Sets the interval of the timer.
Arguments:
interval : number
Number of ms between ticks.
code »
start()
Starts the timer.
code »
stop()
Stops the timer.
code »
tick_()
Callback for the setTimeout used by the timer
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

Defined in goog.Timer
boundTick_ :
Cached tick_ bound to the object for later use in the timer.
Code »
constructor :
No description.
Code »
enabled :
Whether this timer is enabled
Code »
interval_ :
Number of ms between ticks
Code »
last_ :
Firefox browser often fires the timer event sooner (sometimes MUCH sooner) than the requested timeout. So we compare the time to when the event was last fired, and reschedule if appropriate. See also goog.Timer.intervalScale
Code »
timerObject_ :
An object that implements setTimeout, 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.
Code »
timer_ :
Variable for storing the result of setInterval
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Methods

goog.Timer.callOnce(opt_delayopt_handler) number
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.
Arguments:
: function(this:SCOPE) | {handleEvent:function()
No description.
opt_delay : number=
Milliseconds to wait; default is 0.
opt_handler : SCOPE=
Object in whose scope to call the listener.
Returns: number  A handle to the timer ID.
code »
goog.Timer.clear(timerId)
Clears a timeout initiated by callOnce
Arguments:
timerId : ?number
a timer ID.
code »

Static Properties

goog.Timer.MAX_TIMEOUT_ :
Maximum timeout value. Timeout values too big to fit into a signed 32-bit integer may cause overflow in FF, Safari, and Chrome, resulting in the timeout being scheduled immediately. It makes more sense simply not to schedule these timeouts, since 24.8 days is beyond a reasonable expectation for the browser to stay open.
Code »
goog.Timer.TICK :
Constant for the timer's event type
Code »
goog.Timer.defaultTimerObject :
An object that implements setTimout, setInterval, clearTimeout and clearInterval. We default to the global object. Changing goog.Timer.defaultTimerObject changes the object for all timer instances which can be useful if your environment has some other implementation of timers you'd like to use.
Code »
goog.Timer.intervalScale :
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_
Code »
goog.Timer.superClass_ :
No description.
Code »

Package Timer

Package Reference