com.nostra13.universalimageloader.core
Class ImageLoader

java.lang.Object
  com.nostra13.universalimageloader.core.ImageLoader

public class ImageLoader
extends Object

Singletone for image loading and displaying at ImageViews
NOTE: init(ImageLoaderConfiguration) method must be called before any other method.

Author:

Sergey Tarasevich (nostra13[at]gmail[dot]com)

Field Summary

static String

TAG

Constructor Summary

protected

ImageLoader()

Method Summary

void	cancelDisplayTask(android.widget.ImageView imageView) Cancel the task of loading and displaying image for passed ImageView.
void	clearDiscCache() Clears disc cache.
void	clearMemoryCache() Clears memory cache
void	displayImage(String uri, android.widget.ImageView imageView) Adds display image task to execution pool.
void	displayImage(String uri, android.widget.ImageView imageView, DisplayImageOptions options) Adds display image task to execution pool.
void	displayImage(String uri, android.widget.ImageView imageView, DisplayImageOptions options, ImageLoadingListener listener) Adds display image task to execution pool.
void	displayImage(String uri, android.widget.ImageView imageView, ImageLoadingListener listener) Adds display image task to execution pool.
DiscCacheAware	getDiscCache() Returns disc cache
static ImageLoader	getInstance() Returns singleton class instance
String	getLoadingUriForView(android.widget.ImageView imageView) Returns URI of image which is loading at this moment into passed ImageView
MemoryCacheAware<String,android.graphics.Bitmap>	getMemoryCache() Returns memory cache
void	init(ImageLoaderConfiguration configuration) Initializes ImageLoader's singleton instance with configuration.
boolean	isInited() Returns true - if ImageLoader is initialized with configuration; false - otherwise
void	loadImage(android.content.Context context, String uri, DisplayImageOptions options, ImageLoadingListener listener) Adds load image task to execution pool.
void	loadImage(android.content.Context context, String uri, ImageLoadingListener listener) Adds load image task to execution pool.
void	loadImage(android.content.Context context, String uri, ImageSize minImageSize, DisplayImageOptions options, ImageLoadingListener listener) Adds load image task to execution pool.
void	loadImage(android.content.Context context, String uri, ImageSize minImageSize, ImageLoadingListener listener) Adds load image task to execution pool.
void	pause() Pause ImageLoader.
void	resume() Resumes waiting "load&display" tasks
void	stop() Stops all running display image tasks, discards all other scheduled tasks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static final String TAG

Constructor Detail

ImageLoader

protected ImageLoader()

Method Detail

getInstance

public static ImageLoader getInstance()

Returns singleton class instance

init

public void init(ImageLoaderConfiguration configuration)

Initializes ImageLoader's singleton instance with configuration. Method should be called once (each following call will have no effect)

Parameters:

configuration - ImageLoader configuration

Throws:

IllegalArgumentException - if configuration parameter is null

isInited

public boolean isInited()

Returns true - if ImageLoader is initialized with configuration; false - otherwise

displayImage

public void displayImage(String uri,
                         android.widget.ImageView imageView)

Adds display image task to execution pool. Image will be set to ImageView when it's turn.
Default display image options from configuration will be used.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

imageView - ImageView which should display image

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

IllegalArgumentException - if passed imageView is null

displayImage

public void displayImage(String uri,
                         android.widget.ImageView imageView,
                         DisplayImageOptions options)

Adds display image task to execution pool. Image will be set to ImageView when it's turn.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

imageView - ImageView which should display image

options - Display image options for image displaying. If null - default display image options from configuration will be used.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

IllegalArgumentException - if passed imageView is null

displayImage

public void displayImage(String uri,
                         android.widget.ImageView imageView,
                         ImageLoadingListener listener)

Adds display image task to execution pool. Image will be set to ImageView when it's turn.
Default display image options from configuration will be used.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

imageView - ImageView which should display image

listener - Listener for image loading process. Listener fires events on UI thread.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

IllegalArgumentException - if passed imageView is null

displayImage

public void displayImage(String uri,
                         android.widget.ImageView imageView,
                         DisplayImageOptions options,
                         ImageLoadingListener listener)

Adds display image task to execution pool. Image will be set to ImageView when it's turn.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

imageView - ImageView which should display image

options - Display image options for image displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

IllegalArgumentException - if passed imageView is null

loadImage

public void loadImage(android.content.Context context,
                      String uri,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with callback.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

context - Application context (used for creation of fake ImageView)

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

listener - Listener for image loading process. Listener fires events on UI thread.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

loadImage

public void loadImage(android.content.Context context,
                      String uri,
                      ImageSize minImageSize,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with callback.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

context - Application context (used for creation of fake ImageView)

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

minImageSize - Minimal size for Bitmap which will be returned in callback. Downloaded image will be decoded and scaled to Bitmap of the size which is equal or larger (usually a bit larger) than incoming minImageSize .

listener - Listener for image loading process. Listener fires events on UI thread.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

loadImage

public void loadImage(android.content.Context context,
                      String uri,
                      DisplayImageOptions options,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with callback.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

context - Application context (used for creation of fake ImageView)

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

options - Display image options for image displaying. If null - default display image options from configuration will be used.
Incoming options should contain FakeBitmapDisplayer as displayer.

listener - Listener for image loading process. Listener fires events on UI thread.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

loadImage

public void loadImage(android.content.Context context,
                      String uri,
                      ImageSize minImageSize,
                      DisplayImageOptions options,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with callback.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

Parameters:

context - Application context (used for creation of fake ImageView)

uri - Image URI (i.e. "http://site.com/image.png", "file:///mnt/sdcard/image.png")

minImageSize - Minimal size for Bitmap which will be returned in callback. Downloaded image will be decoded and scaled to Bitmap of the size which is equal or larger (usually a bit larger) than incoming minImageSize .

options - Display image options for image displaying. If null - default display image options from configuration will be used.
Incoming options should contain FakeBitmapDisplayer as displayer.

listener - Listener for image loading process. Listener fires events on UI thread.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

getMemoryCache

public MemoryCacheAware<String,android.graphics.Bitmap> getMemoryCache()

Returns memory cache

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

clearMemoryCache

public void clearMemoryCache()

Clears memory cache

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

getDiscCache

public DiscCacheAware getDiscCache()

Returns disc cache

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

clearDiscCache

public void clearDiscCache()

Clears disc cache.

Throws:

IllegalStateException - if init(ImageLoaderConfiguration) method wasn't called before

getLoadingUriForView

public String getLoadingUriForView(android.widget.ImageView imageView)

Returns URI of image which is loading at this moment into passed ImageView

cancelDisplayTask

public void cancelDisplayTask(android.widget.ImageView imageView)

Cancel the task of loading and displaying image for passed ImageView.

Parameters:

imageView - ImageView for which display task will be cancelled

pause

public void pause()

Pause ImageLoader. All new "load&display" tasks won't be executed until ImageLoader is resumed.
Already running tasks are not paused.

resume

public void resume()

Resumes waiting "load&display" tasks

stop

public void stop()

Stops all running display image tasks, discards all other scheduled tasks