• index
• goog
• net
• search: Go

The goog.net.ImageLoader Class

goog.net.ImageLoader
> goog.events.EventTarget
> goog.Disposable

goog.net.ImageLoader(opt_parent)

Image loader utility class. Raises a {@link goog.events.EventType.LOAD} event for each image loaded, with an {@link Image} object as the target of the event, normalized to have {@code naturalHeight} and {@code naturalWidth} attributes. To use this class, run:

   var imageLoader = new goog.net.ImageLoader();
   goog.events.listen(imageLoader, goog.net.EventType.COMPLETE,
       function(e) { ... });
   imageLoader.addImage("image_id", "http://path/to/image.gif");
   imageLoader.start();
 

opt_parent {Element=}

An optional parent element whose document object should be used to load images.

.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.

.addImage(id, image)

Adds an image to the image loader, and associates it with the given ID string. If an image with that ID already exists, it is silently replaced. When the image in question is loaded, the target of the LOAD event will be an {@code Image} object with {@code id} and {@code src} attributes based on these arguments.

id {string}

The ID of the image to load.

image {string|Image}

Either the source URL of the image or the HTML image element itself (or any object with a {@code src} property, really).

.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.

.creationStack {string}

Inherited from goog.Disposable .

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

.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.

.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
};

.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.

.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.

.removeImage(id)

Removes the image associated with the given ID string from the image loader. If the image was previously loading, removes any listeners for its events and dispatches a COMPLETE event if all remaining images have now completed.

id {string}

The ID of the image to remove.

.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 loading all images in the image loader in parallel. Raises a LOAD event each time an image finishes loading, and a COMPLETE event after all images have finished loading.

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