async.Delay Extends goog.Disposable
A Delay object invokes the associated function after a specified delay. The interval duration can be specified once in the constructor, or can be defined each time the delay is started. Calling start on an active delay will reset the timer.

Inheritance

Constructor

goog.async.Delay(listeneropt_intervalopt_handler)

Parameters

listener : Function
Function to call when the delay completes.
opt_interval : number=
The default length of the invocation delay (in milliseconds).
opt_handler : Object=
The object scope to invoke the function in.

Instance Methods

Public Protected Private
disposeInternal()
Disposes of the object, cancelling the timeout if it is still outstanding and removing all object references.
code »
doAction_()
Invokes the callback function after the delay successfully completes.
code »
fire()
Fires delay's action even if timer has already gone off or has not been started yet; guarantees action firing. Stops the delay timer.
code »
fireIfActive()
Fires delay's action only if timer is currently active. Stops the delay timer.
code »
isActive() boolean
No description.
Returns: boolean  True if the delay is currently active, false otherwise.
code »
start(opt_interval)
Starts the delay timer. The provided listener function will be called after the specified interval. Calling start on an active timer will reset the delay interval.
Arguments:
opt_interval : number=
If specified, overrides the object's default interval with this one (in milliseconds).
code »
stop()
Stops the delay timer if it is active. No action is taken if the timer is not in use.
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

callback_ :
Cached callback function invoked when the delay finishes.
Code »
constructor :
No description.
Code »
handler_ :
The object context to invoke the callback in.
Code »
id_ :
Identifier of the active delay timeout, or 0 when inactive.
Code »
interval_ :
The default amount of time to delay before invoking the callback.
Code »
listener_ :
The function that will be invoked after a delay.
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 Properties

goog.async.Delay.superClass_ :
No description.
Code »

Package async

Package Reference