in.srain.cube.image

Class ImageTask

java.lang.Object

in.srain.cube.image.ImageTask

public class ImageTask
extends java.lang.Object

A wrapper of the related information used in loading a bitmap

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_BAD_FORMAT
static int	ERROR_NETWORK
protected static java.lang.String	LOG_TAG
protected android.graphics.Point	mBitmapOriginSize
protected in.srain.cube.image.ImageTask.ImageViewHolder	mFirstImageViewHolder
protected int	mId
protected ImageTaskStatistics	mImageTaskStatistics
protected java.lang.String	mOriginUrl
protected ImageLoadRequest	mRequest
protected android.graphics.Point	mRequestSize

Constructor Summary

Constructors

Constructor and Description
ImageTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addImageView(CubeImageView imageView) Bind ImageView with ImageTask
protected void	clearForRecycle()
boolean	equals(java.lang.Object object)
java.lang.String	generateFileCacheKeyForReuse(java.lang.String sizeKey)
protected java.lang.String	generateIdentityKey() Generate the identity key.
protected java.lang.String	generateIdentityUrl(java.lang.String originUrl) Deprecated. Do not overwrite this method, use NameGenerator instead. should be used.
android.graphics.Point	getBitmapOriginSize()
java.lang.String	getFileCacheKey() Return the cache key for file cache.
java.lang.String	getIdentityKey() Return the key which identifies this Image Wrapper object.
java.lang.String	getIdentityUrl() For accessing the identity url
java.lang.String	getOriginUrl() Return the origin request url
java.lang.String	getRemoteUrl() If you have a thumbnail web service which can return multiple size image according the url, you can implements this method to return the specified url according the request size.
ImageLoadRequest	getRequest()
android.graphics.Point	getRequestSize()
ImageTaskStatistics	getStatistics()
boolean	isLoading()
boolean	isLoadingThisUrl(ImageLoadRequest request) Check the given ImageLoadRequest is loading.
boolean	isPreLoad()
static java.lang.String	joinSizeInfoToKey(java.lang.String key, int w, int h) Join the key and the size information.
static java.lang.String	joinSizeTagToKey(java.lang.String key, java.lang.String tag) Join the tag with the key.
void	notifyLoading(ImageLoadHandler handler, CubeImageView imageView) notify loading
static ImageTask	obtain()
void	onLoading(ImageLoadHandler handler) When loading from network
void	onLoadTaskCancel()
void	onLoadTaskFinish(android.graphics.drawable.BitmapDrawable drawable, ImageLoadHandler handler) Will be called when begin load image data from dish or network
void	removeImageView(CubeImageView imageView) Remove the ImageView from ImageTask
ImageTask	renewForRequest(ImageLoadRequest request)
void	setBitmapOriginSize(int width, int height)
void	setError(int errorCode)
void	setIsPreLoad()
ImageTask	setOriginUrl(java.lang.String originUrl)
ImageTask	setRequestSize(int requestWidth, int requestHeight)
boolean	stillHasRelatedImageView() Check if this ImageTask has any related ImageViews.
java.lang.String	toString()
void	tryToRecycle()

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final java.lang.String LOG_TAG

ERROR_NETWORK

public static final int ERROR_NETWORK

See Also:

Constant Field Values

ERROR_BAD_FORMAT

public static final int ERROR_BAD_FORMAT

See Also:

Constant Field Values

mId

protected int mId

mOriginUrl

protected java.lang.String mOriginUrl

mRequestSize

protected android.graphics.Point mRequestSize

mBitmapOriginSize

protected android.graphics.Point mBitmapOriginSize

mRequest

protected ImageLoadRequest mRequest

mFirstImageViewHolder

protected in.srain.cube.image.ImageTask.ImageViewHolder mFirstImageViewHolder

mImageTaskStatistics

protected ImageTaskStatistics mImageTaskStatistics

Constructor Detail

ImageTask

public ImageTask()

Method Detail

clearForRecycle

protected void clearForRecycle()

obtain

public static ImageTask obtain()

tryToRecycle

public void tryToRecycle()

renewForRequest

public ImageTask renewForRequest(ImageLoadRequest request)

setOriginUrl

public ImageTask setOriginUrl(java.lang.String originUrl)

setRequestSize

public ImageTask setRequestSize(int requestWidth,
                       int requestHeight)

getIdentityUrl

public java.lang.String getIdentityUrl()

For accessing the identity url

Returns:

generateIdentityUrl

@Deprecated
protected java.lang.String generateIdentityUrl(java.lang.String originUrl)

Deprecated. Do not overwrite this method, use NameGenerator instead. should be used.

In some situations, we may store the same image in some different servers. So the same image will related to some different urls. Generate the identity url according your situation. mIdentityUrl

Returns:

generateIdentityKey

protected java.lang.String generateIdentityKey()

Generate the identity key.

This key should be related to the unique image this task is requesting: the size, the remote url.

Returns:

isPreLoad

public boolean isPreLoad()

setIsPreLoad

public void setIsPreLoad()

isLoading

public boolean isLoading()

isLoadingThisUrl

public boolean isLoadingThisUrl(ImageLoadRequest request)

Check the given ImageLoadRequest is loading.

Parameters:

request -

Returns:

Identify the given url, if same to mIdentityUrl return true.

addImageView

public void addImageView(CubeImageView imageView)

Bind ImageView with ImageTask

Parameters:

imageView -

removeImageView

public void removeImageView(CubeImageView imageView)

Remove the ImageView from ImageTask

Parameters:

imageView -

stillHasRelatedImageView

public boolean stillHasRelatedImageView()

Check if this ImageTask has any related ImageViews.

Returns:

onLoading

public void onLoading(ImageLoadHandler handler)

When loading from network

Parameters:

handler -

notifyLoading

public void notifyLoading(ImageLoadHandler handler,
                 CubeImageView imageView)

notify loading

Parameters:

handler -

imageView -

onLoadTaskFinish

public void onLoadTaskFinish(android.graphics.drawable.BitmapDrawable drawable,
                    ImageLoadHandler handler)

Will be called when begin load image data from dish or network

Parameters:

drawable -

onLoadTaskCancel

public void onLoadTaskCancel()

setError

public void setError(int errorCode)

getRemoteUrl

public java.lang.String getRemoteUrl()

If you have a thumbnail web service which can return multiple size image according the url,

you can implements this method to return the specified url according the request size.

Returns:

getOriginUrl

public java.lang.String getOriginUrl()

Return the origin request url

Returns:

setBitmapOriginSize

public void setBitmapOriginSize(int width,
                       int height)

getBitmapOriginSize

public android.graphics.Point getBitmapOriginSize()

getRequestSize

public android.graphics.Point getRequestSize()

getIdentityKey

public java.lang.String getIdentityKey()

Return the key which identifies this Image Wrapper object.

joinSizeInfoToKey

public static java.lang.String joinSizeInfoToKey(java.lang.String key,
                                 int w,
                                 int h)

Join the key and the size information.

Parameters:

key -

w -

h -

Returns:

"$key" + "_" + "$w" + "_" + "$h"

joinSizeTagToKey

public static java.lang.String joinSizeTagToKey(java.lang.String key,
                                java.lang.String tag)

Join the tag with the key.

Parameters:

key -

tag -

Returns:

"$key" + "_" + "$tag"

getFileCacheKey

public java.lang.String getFileCacheKey()

Return the cache key for file cache.

Returns:

the cache key for file cache.

generateFileCacheKeyForReuse

public java.lang.String generateFileCacheKeyForReuse(java.lang.String sizeKey)

Parameters:

sizeKey -

Returns:

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStatistics

public ImageTaskStatistics getStatistics()

getRequest

public ImageLoadRequest getRequest()