com.nostra13.universalimageloader.core

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

从以下版本开始:

1.0.0

字段概要

字段

限定符和类型	字段和说明
static String	TAG

构造器概要

构造器

限定符	构造器和说明
protected	ImageLoader()

方法概要

限定符和类型	方法和说明
void	cancelDisplayTask(ImageAware imageAware) Cancel the task of loading and displaying image for passed ImageAware.
void	cancelDisplayTask(android.widget.ImageView imageView) Cancel the task of loading and displaying image for passed ImageView.
void	clearDiscCache() 已过时。 Use clearDiskCache() instead
void	clearDiskCache() Clears disk cache.
void	clearMemoryCache() Clears memory cache
void	denyNetworkDownloads(boolean denyNetworkDownloads) Denies or allows ImageLoader to download images from the network.
void	destroy() Stops ImageLoader and clears current configuration.
void	displayImage(String uri, ImageAware imageAware) Adds display image task to execution pool.
void	displayImage(String uri, ImageAware imageAware, DisplayImageOptions options) Adds display image task to execution pool.
void	displayImage(String uri, ImageAware imageAware, DisplayImageOptions options, ImageLoadingListener listener) Adds display image task to execution pool.
void	displayImage(String uri, ImageAware imageAware, DisplayImageOptions options, ImageLoadingListener listener, ImageLoadingProgressListener progressListener) Adds display image task to execution pool.
void	displayImage(String uri, ImageAware imageAware, DisplayImageOptions options, ImageSize targetSize, ImageLoadingListener listener, ImageLoadingProgressListener progressListener) Adds display image task to execution pool.
void	displayImage(String uri, ImageAware imageAware, ImageLoadingListener listener) Adds display image task to execution pool.
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, DisplayImageOptions options, ImageLoadingListener listener, ImageLoadingProgressListener progressListener) Adds display image task to execution pool.
void	displayImage(String uri, android.widget.ImageView imageView, ImageLoadingListener listener) Adds display image task to execution pool.
void	displayImage(String uri, android.widget.ImageView imageView, ImageSize targetImageSize) Adds display image task to execution pool.
DiskCache	getDiscCache() 已过时。 Use getDiskCache() instead
DiskCache	getDiskCache() Returns disk cache
static ImageLoader	getInstance() Returns singleton class instance
String	getLoadingUriForView(ImageAware imageAware) Returns URI of image which is loading at this moment into passed ImageAware
String	getLoadingUriForView(android.widget.ImageView imageView) Returns URI of image which is loading at this moment into passed ImageView
MemoryCache	getMemoryCache() Returns memory cache
void	handleSlowNetwork(boolean handleSlowNetwork) Sets option whether ImageLoader will use FlushedInputStream for network downloads to handle	void	init(ImageLoaderConfiguration configuration) Initializes ImageLoader instance with configuration.
boolean	isInited() Returns true - if ImageLoader is initialized with configuration; false - otherwise
void	loadImage(String uri, DisplayImageOptions options, ImageLoadingListener listener) Adds load image task to execution pool.
void	loadImage(String uri, ImageLoadingListener listener) Adds load image task to execution pool.
void	loadImage(String uri, ImageSize targetImageSize, DisplayImageOptions options, ImageLoadingListener listener) Adds load image task to execution pool.
void	loadImage(String uri, ImageSize targetImageSize, DisplayImageOptions options, ImageLoadingListener listener, ImageLoadingProgressListener progressListener) Adds load image task to execution pool.
void	loadImage(String uri, ImageSize targetImageSize, ImageLoadingListener listener) Adds load image task to execution pool.
android.graphics.Bitmap	loadImageSync(String uri) Loads and decodes image synchronously.
android.graphics.Bitmap	loadImageSync(String uri, DisplayImageOptions options) Loads and decodes image synchronously.
android.graphics.Bitmap	loadImageSync(String uri, ImageSize targetImageSize) Loads and decodes image synchronously.
android.graphics.Bitmap	loadImageSync(String uri, ImageSize targetImageSize, DisplayImageOptions options) Loads and decodes image synchronously.
void	pause() Pause ImageLoader.
void	resume() Resumes waiting "load&display" tasks
void	setDefaultLoadingListener(ImageLoadingListener listener) Sets a default loading listener for all display and loading tasks.
void	stop() Cancels all running and scheduled display image tasks.

从类继承的方法 java.lang.Object

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

字段详细资料

TAG

public static final String TAG

构造器详细资料

ImageLoader

protected ImageLoader()

方法详细资料

getInstance

public static ImageLoader getInstance()

Returns singleton class instance

init

public void init(ImageLoaderConfiguration configuration)

Initializes ImageLoader instance with configuration.
If configurations was set before ( isInited() == true) then this method does nothing.
To force initialization with new configuration you should destroy ImageLoader at first.

参数:

configuration - ImageLoader configuration

抛出:

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,
                         ImageAware imageAware)

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

参数:

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

imageAware - Image aware view which should display image

抛出:

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

IllegalArgumentException - if passed imageAware is null

displayImage

public void displayImage(String uri,
                         ImageAware imageAware,
                         ImageLoadingListener listener)

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

参数:

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

imageAware - Image aware view which should display image

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

抛出:

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

IllegalArgumentException - if passed imageAware is null

displayImage

public void displayImage(String uri,
                         ImageAware imageAware,
                         DisplayImageOptions options)

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

参数:

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

imageAware - Image aware view which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

抛出:

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

IllegalArgumentException - if passed imageAware is null

displayImage

public void displayImage(String uri,
                         ImageAware imageAware,
                         DisplayImageOptions options,
                         ImageLoadingListener listener)

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

参数:

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

imageAware - Image aware view which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

抛出:

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

IllegalArgumentException - if passed imageAware is null

displayImage

public void displayImage(String uri,
                         ImageAware imageAware,
                         DisplayImageOptions options,
                         ImageLoadingListener listener,
                         ImageLoadingProgressListener progressListener)

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

参数:

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

imageAware - Image aware view which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

progressListener - Listener for image loading progress. Listener fires events on UI thread if this method is called on UI thread. Caching on disk should be enabled in options to make this listener work.

抛出:

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

IllegalArgumentException - if passed imageAware is null

displayImage

public void displayImage(String uri,
                         ImageAware imageAware,
                         DisplayImageOptions options,
                         ImageSize targetSize,
                         ImageLoadingListener listener,
                         ImageLoadingProgressListener progressListener)

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

参数:

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

imageAware - Image aware view which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

targetSize - ImageSize Image target size. If null - size will depend on the view

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

progressListener - Listener for image loading progress. Listener fires events on UI thread if this method is called on UI thread. Caching on disk should be enabled in options to make this listener work.

抛出:

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

IllegalArgumentException - if passed imageAware is null

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

参数:

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

imageView - ImageView which should display image

抛出:

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,
                         ImageSize targetImageSize)

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

参数:

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

imageView - ImageView which should display image

抛出:

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

参数:

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

imageView - ImageView which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

抛出:

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

参数:

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 if this method is called on UI thread.

抛出:

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

参数:

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

imageView - ImageView which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

抛出:

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,
                         ImageLoadingProgressListener progressListener)

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

参数:

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

imageView - ImageView which should display image

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

progressListener - Listener for image loading progress. Listener fires events on UI thread if this method is called on UI thread. Caching on disk should be enabled in options to make this listener work.

抛出:

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

IllegalArgumentException - if passed imageView is null

loadImage

public void loadImage(String uri,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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 if this method is called on UI thread.

抛出:

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

loadImage

public void loadImage(String uri,
                      ImageSize targetImageSize,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

targetImageSize - Minimal size for Bitmap which will be returned in ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}. Downloaded image will be decoded and scaled to Bitmap of the size which is equal or larger (usually a bit larger) than incoming targetImageSize.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

抛出:

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

loadImage

public void loadImage(String uri,
                      DisplayImageOptions options,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

抛出:

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

loadImage

public void loadImage(String uri,
                      ImageSize targetImageSize,
                      DisplayImageOptions options,
                      ImageLoadingListener listener)

Adds load image task to execution pool. Image will be returned with ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

targetImageSize - Minimal size for Bitmap which will be returned in ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}. Downloaded image will be decoded and scaled to Bitmap of the size which is equal or larger (usually a bit larger) than incoming targetImageSize.

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

抛出:

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

loadImage

public void loadImage(String uri,
                      ImageSize targetImageSize,
                      DisplayImageOptions options,
                      ImageLoadingListener listener,
                      ImageLoadingProgressListener progressListener)

Adds load image task to execution pool. Image will be returned with ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

targetImageSize - Minimal size for Bitmap which will be returned in ImageLoadingListener.onLoadingComplete(String, View, Bitmap) callback}. Downloaded image will be decoded and scaled to Bitmap of the size which is equal or larger (usually a bit larger) than incoming targetImageSize.

options - Options for image decoding and displaying. If null - default display image options from configuration will be used.

listener - Listener for image loading process. Listener fires events on UI thread if this method is called on UI thread.

progressListener - Listener for image loading progress. Listener fires events on UI thread if this method is called on UI thread. Caching on disk should be enabled in options to make this listener work.

抛出:

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

loadImageSync

public android.graphics.Bitmap loadImageSync(String uri)

Loads and decodes image synchronously.
Default display image options from configuration will be used.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

返回:

Result image Bitmap. Can be null if image loading/decoding was failed or cancelled.

抛出:

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

loadImageSync

public android.graphics.Bitmap loadImageSync(String uri,
                                             DisplayImageOptions options)

Loads and decodes image synchronously.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

options - Options for image decoding and scaling. If null - default display image options from configuration will be used.

返回:

Result image Bitmap. Can be null if image loading/decoding was failed or cancelled.

抛出:

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

loadImageSync

public android.graphics.Bitmap loadImageSync(String uri,
                                             ImageSize targetImageSize)

Loads and decodes image synchronously.
Default display image options from configuration will be used.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

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

返回:

Result image Bitmap. Can be null if image loading/decoding was failed or cancelled.

抛出:

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

loadImageSync

public android.graphics.Bitmap loadImageSync(String uri,
                                             ImageSize targetImageSize,
                                             DisplayImageOptions options)

Loads and decodes image synchronously.
NOTE: init(ImageLoaderConfiguration) method must be called before this method call

参数:

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

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

options - Options for image decoding and scaling. If null - default display image options from configuration will be used.

返回:

Result image Bitmap. Can be null if image loading/decoding was failed or cancelled.

抛出:

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

setDefaultLoadingListener

public void setDefaultLoadingListener(ImageLoadingListener listener)

Sets a default loading listener for all display and loading tasks.

getMemoryCache

public MemoryCache getMemoryCache()

Returns memory cache

抛出:

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

clearMemoryCache

public void clearMemoryCache()

Clears memory cache

抛出:

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

getDiscCache

@Deprecated
public DiskCache getDiscCache()

已过时。 Use getDiskCache() instead

Returns disk cache

抛出:

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

getDiskCache

public DiskCache getDiskCache()

Returns disk cache

抛出:

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

clearDiscCache

@Deprecated
public void clearDiscCache()

已过时。 Use clearDiskCache() instead

Clears disk cache.

抛出:

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

clearDiskCache

public void clearDiskCache()

Clears disk cache.

抛出:

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

getLoadingUriForView

public String getLoadingUriForView(ImageAware imageAware)

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

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(ImageAware imageAware)

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

参数:

imageAware - ImageAware for which display task will be cancelled

cancelDisplayTask

public void cancelDisplayTask(android.widget.ImageView imageView)

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

参数:

imageView - ImageView for which display task will be cancelled

denyNetworkDownloads

public void denyNetworkDownloads(boolean denyNetworkDownloads)

Denies or allows ImageLoader to download images from the network.

If downloads are denied and if image isn't cached then ImageLoadingListener.onLoadingFailed(String, View, FailReason) callback will be fired with FailReason.FailType#NETWORK_DENIED

参数:

denyNetworkDownloads - pass true - to deny engine to download images from the network; false - to allow engine to download images from network.

handleSlowNetwork

public void handleSlowNetwork(boolean handleSlowNetwork)

Sets option whether ImageLoader will use FlushedInputStream for network downloads to handle this known problem or not.

参数:

handleSlowNetwork - pass true - to use FlushedInputStream for network downloads; false - otherwise.

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()

Cancels all running and scheduled display image tasks.
NOTE: This method doesn't shutdown custom task executors if you set them.
ImageLoader still can be used after calling this method.

destroy

public void destroy()

Stops ImageLoader and clears current configuration.
You can init ImageLoader with new configuration after calling this method.