documentation

Documentation generator: JsDoc Toolkit 2.4.0
Template: Wink 1.0
Generated on:

Class wink.net.ImagesLoader

Implement an image loader utility. You can preload images using the load method. Load images and warn the user when the task is complete

Class Summary
Constructor Attributes Constructor Name and Description
 
Compatibility
Compatibility list Supported platforms / browsers
iOS2, iOS3, iOS4, iOS5, iOS6, Android 1.1, Android 1.5, Android 2.1, Android 2.2, Android 2.3, Android 3.0, Android 3.1, Android 4.0, BlackBerry 6, BlackBerry 7, Bada 1.0, Windows Phone 7.5, Windows Phone 8

Method Summary

Class Detail

wink.net.ImagesLoader()
datas = new Array('./image_1.jpg', './image_2.jpg');

imagesLoader = new wink.net.ImagesLoader();

imagesLoader.load(datas);
See:
Test page

Field Detail

{integer} uId
Unique identifier

Method Detail

  • load(data)
    Start processing the datas datas can be a single image or a collection of images
    Parameters:
    {array} data
    The image(s) you want to preload. It must be a string or an array of strings

Event Detail

/imagesloader/events/load
An image has been loaded
Parameters:
{object} param
The parameters object
{integer} param.items
The list of items currently being processed
{integer} param.progress
The index of the currently loaded item in the list of items
{boolean} param.success
True if the file was loaded successfuly, false otherwise
/imagesloader/events/loadend
All the images have been preloaded
Parameters:
{object} param
The parameters object
{integer} param.items
The list of items currently being processed
/imagesloader/events/loadstart
Starts preloading images
Parameters:
{object} param
The parameters object
{integer} param.items
The list of items currently being processed