Disposable Extends
Class that provides the basic implementation for disposable objects. If your class holds one or more references to COM objects, DOM nodes, or other disposable objects, it should extend this class or implement the disposable interface (defined in goog.disposable.IDisposable).

Inheritance

Constructor

goog.Disposable()

Instance Methods

Public Protected Private
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() {
    goog.base(this);
    // 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.
    goog.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

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.Disposable.clearUndisposedObjects()
Clears the registry of undisposed objects but doesn't dispose of them.
code »
goog.Disposable.getUndisposedObjects() !Array.<!goog.Disposable>
No description.
Returns: !Array.<!goog.Disposable>  All goog.Disposable objects that haven't been disposed of.
code »
goog.Disposable.isDisposed(obj) boolean
Returns True if we can verify the object is disposed. Calls isDisposed on the argument if it supports it. If obj is not an object with an isDisposed() method, return false.
Arguments:
obj : *
The object to investigate.
Returns: boolean  True if we can verify the object is disposed.
code »

Static Properties

goog.Disposable.INCLUDE_STACK_ON_CREATION :
No description.
Code »
goog.Disposable.MONITORING_MODE :
No description.
Code »
goog.Disposable.instances_ :
Maps the unique ID of every undisposed goog.Disposable object to the object itself.
Code »

Enumerations

goog.Disposable.MonitoringMode :
No description.
Constants:
INTERACTIVE
No description.
OFF
No description.
PERMANENT
No description.
Code »

Package Disposable

Package Reference