Class Index | File Index

Classes


Class preloadObj

Return object
Defined in: mioImagePreloader.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
preloadObj.clearCache()
Empty the _images array and empty the image loading node.
<static>  
preloadObj.createLoadingNode(id)
Creates the loading node.
<static>  
preloadObj.extendImage(name, func)
Access the prototype to _Image to add your own attributes.
<static>  
preloadObj.getImage(url)
Get the image object by url.
<static>  
preloadObj.isLoaded(url)
Check if the image is already preloading.
<static>  
preloadObj.isLoadedComplete(url)
Check if an image is finished loading.
<static>  
preloadObj.preload(url, callback, scope)
Preload an image.
<static>  
preloadObj.removeImage(url)
Remove an object from _images array and from the image loading node.
Class Detail
preloadObj()
Method Detail
<static> preloadObj.clearCache()
Empty the _images array and empty the image loading node.

<static> preloadObj.createLoadingNode(id)
Creates the loading node.
Parameters:
id
See:
_loadingNodeId

<static> preloadObj.extendImage(name, func)
Access the prototype to _Image to add your own attributes.
Parameters:
{String} name
Name of the reference in prototype.
{Function} func
The function that will be referenced by name.

<static> {Object} preloadObj.getImage(url)
Get the image object by url.
Parameters:
{String} url
The url of image to lookup.
Returns:
{Object} _Image
Requires:
Requires the image is preloaded.

<static> preloadObj.isLoaded(url)
Check if the image is already preloading.
Parameters:
{String} url
The url to check if _Image object exists for.

<static> preloadObj.isLoadedComplete(url)
Check if an image is finished loading.
Parameters:
{String} url
The url to check if _Image object has finished loading image for.

<static> preloadObj.preload(url, callback, scope)
Preload an image.
Parameters:
{String} url
The url of the image to load. Absolute or relative.
{Function} callback
A function to be called when load is complete.
{Object} scope
[optional] The scope to call the callback in. Defaults to window.

<static> preloadObj.removeImage(url)
Remove an object from _images array and from the image loading node.
Parameters:
{String} url
The url of _Image object to remove.

Documentation generated by JsDoc Toolkit 2.0.1 on Sun Sep 30 2012 23:13:13 GMT-0400 (EDT)