Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.octo.android.robospice.spicelist.BaseSpiceArrayAdapter Maven / Gradle / Ivy
package com.octo.android.robospice.spicelist;
import java.io.File;
import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import roboguice.util.temp.Ln;
import android.content.Context;
import android.content.res.Resources;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.graphics.drawable.TransitionDrawable;
import android.os.AsyncTask;
import android.os.Build;
import android.view.View;
import android.view.ViewGroup;
import android.widget.ArrayAdapter;
import android.widget.ImageView;
import com.octo.android.robospice.SpiceManager;
import com.octo.android.robospice.persistence.DurationInMillis;
import com.octo.android.robospice.persistence.exception.SpiceException;
import com.octo.android.robospice.request.SpiceRequest;
import com.octo.android.robospice.request.listener.RequestListener;
import com.octo.android.robospice.request.simple.IBitmapRequest;
/**
* An adapter that is optimized for {@link SpiceListView} instances. It offers to update ImageViews
* contained in {@link SpiceListItemView} instances with images loaded from the network. All you
* have to do is to Override {@link #createRequest(Object)} to define a bitmapRequest for each
* object in the list that is associated an image to display. Also please note that in your
* {@link #getView(int, android.view.View, android.view.ViewGroup)} method, you must call
* {@link #updateListItemViewAsynchronously(Object, SpiceListItemView)} in order for your
* {@link SpiceListItemView} to be updated automagically.
* @author sni
* @param
* the type of data displayed by the list.
*/
public abstract class BaseSpiceArrayAdapter extends ArrayAdapter {
protected int imageWidth = 0;
protected int imageHeight = 0;
/**
* Indicates wether to use the network to update data. This is set by the {@link SpiceListView}.
*/
protected boolean isNetworkFetchingAllowed = true;
/**
* A {@link SpiceManager} that will be used to fetch binaries. It's lifecycle has to be managed
* at the context level (usually fragment or activity).
*/
protected SpiceManager spiceManagerBinary;
/**
* List of event listeners to get notified of network fetching allowed changes.
*/
private List networkFetchingAuthorizationStateChangeListenerList = Collections
.synchronizedList(new ArrayList());
/**
* Contains all images that have been added recently to the list. They will be animated when
* first displayed.
*/
private Set freshDrawableSet = new HashSet();
/** The default drawable to display during image loading from the network. */
protected Drawable defaultDrawable;
// ----------------------------
// --- CONSTRUCTOR
// ----------------------------
public BaseSpiceArrayAdapter(final Context context, final SpiceManager spiceManagerBinary) {
this(context, spiceManagerBinary, new ArrayList());
}
public BaseSpiceArrayAdapter(final Context context, final SpiceManager spiceManagerBinary, final T[] objects) {
this(context, spiceManagerBinary, Arrays.asList(objects));
}
/**
* Used for testing only.
*/
protected BaseSpiceArrayAdapter(final Context context, final SpiceManager spiceManagerBinary, final List objects) {
super(context, 0, objects);
initialize(context, spiceManagerBinary);
}
// ----------------------------
// --- PUBLIC API
// ----------------------------
public final void setDefaultDrawable(final Drawable defaultDrawable) {
this.defaultDrawable = defaultDrawable;
}
/* package-private */final void setNetworkFetchingAllowed(final boolean isNetworkFetchingAllowed) {
boolean changed = isNetworkFetchingAllowed != this.isNetworkFetchingAllowed;
this.isNetworkFetchingAllowed = isNetworkFetchingAllowed;
if (isNetworkFetchingAllowed && changed) {
fireOnNetworkFetchingAllowedChange();
Ln.d("calling state change listeners");
}
}
/**
* Updates a {@link SpiceListItemView} containing some data. The method
* {@link #createRequest(Object)} will be applied to data to know which bitmapRequest to execute
* to get data from network if needed. This method must be called during
* {@link #getView(int, android.view.View, android.view.ViewGroup)}.
* @param data
* the data to update the {@link SpiceListItemView} with.
* @param spiceListItemView
* the {@link SpiceListItemView} that displays an image to represent data.
*/
protected final void updateListItemViewAsynchronously(final T data, final SpiceListItemView spiceListItemView) {
if (!registered(spiceListItemView)) {
addSpiceListItemView(spiceListItemView);
freshDrawableSet.add(data);
}
for (int imageIndex = 0; imageIndex < spiceListItemView.getImageViewCount(); imageIndex++) {
imageWidth = Math.max(imageWidth, spiceListItemView.getImageView(imageIndex).getWidth());
imageHeight = Math.max(imageHeight, spiceListItemView.getImageView(imageIndex).getHeight());
performBitmapRequestAsync(spiceListItemView, data, imageIndex);
}
}
@SuppressWarnings("unchecked")
@Override
public View getView(final int position, final View convertView, final ViewGroup parent) {
SpiceListItemView spiceListItemView;
T currentItem = getItem(position);
if (convertView != null) {
spiceListItemView = (SpiceListItemView) convertView;
} else {
spiceListItemView = createView(getContext(), parent);
}
spiceListItemView.update(currentItem);
// this is the most important line. It will update views automatically
// ----------------------------------------
updateListItemViewAsynchronously(currentItem, spiceListItemView);
// ----------------------------------------
return (View) spiceListItemView;
}
public final void performBitmapRequestAsync(final SpiceListItemView spiceListItemView, final T data, final int imageIndex) {
new ThumbnailAsynTask(createRequest(data, imageIndex, imageWidth, imageHeight)).execute(data, spiceListItemView, imageIndex);
}
public abstract SpiceListItemView createView(Context context, ViewGroup parent);
public abstract IBitmapRequest createRequest(T data, int imageIndex, int requestImageWidth, int requestImageHeight);
// ----------------------------
// --- PRIVATE API
// ----------------------------
private void addSpiceListItemView(final SpiceListItemView spiceListItemView) {
this.networkFetchingAuthorizationStateChangeListenerList.add(new NetworkFetchingAuthorizationStateChangeAdapter(spiceListItemView));
}
private boolean registered(final SpiceListItemView view) {
for (NetworkFetchingAuthorizationStateChangeAdapter listener : networkFetchingAuthorizationStateChangeListenerList) {
if (listener.getView() == view) {
return true;
}
}
return false;
}
private void fireOnNetworkFetchingAllowedChange() {
synchronized (networkFetchingAuthorizationStateChangeListenerList) {
for (NetworkFetchingAuthorizationStateChangeAdapter networkFetchingAuthorizationStateChangeListener : networkFetchingAuthorizationStateChangeListenerList) {
Ln.d("calling state change listener");
networkFetchingAuthorizationStateChangeListener.onNetworkFetchingAllowedChange(isNetworkFetchingAllowed);
}
}
}
private void initialize(final Context context, final SpiceManager spiceManagerBinary) {
this.spiceManagerBinary = spiceManagerBinary;
defaultDrawable = context.getResources().getDrawable(android.R.drawable.picture_frame);
}
// ----------------------------
// --- INNER CLASSES
// ----------------------------
protected class ImageRequestListener implements RequestListener {
private SpiceListItemView spiceListItemView;
private T data;
private ImageView thumbImageView;
private String imageFileName;
public ImageRequestListener(final T data, final SpiceListItemView spiceListItemView, final int imageIndex, final String imageFileName) {
this.data = data;
this.spiceListItemView = spiceListItemView;
this.thumbImageView = spiceListItemView.getImageView(imageIndex);
this.imageFileName = imageFileName;
}
@Override
public final void onRequestFailure(final SpiceException spiceException) {
Ln.e(SpiceListItemView.class.getName(), "Unable to retrive image", spiceException);
thumbImageView.setImageDrawable(defaultDrawable);
}
@Override
public final void onRequestSuccess(final Bitmap bitmap) {
freshDrawableSet.add(data);
if (this.data.equals(spiceListItemView.getData())) {
loadBitmapAsynchronously(data, thumbImageView, imageFileName);
}
}
}
protected void loadBitmapAsynchronously(final T octo, final ImageView thumbImageView, final String tempThumbnailImageFileName) {
if (thumbImageView.getTag() != null && thumbImageView.getTag().equals(tempThumbnailImageFileName)) {
return;
}
if (cancelPotentialWork(tempThumbnailImageFileName, thumbImageView)) {
final BitmapWorkerTask task = new BitmapWorkerTask(thumbImageView, octo);
task.fileName = tempThumbnailImageFileName;
final AsyncDrawable asyncDrawable = new AsyncDrawable(getContext().getResources(), task);
thumbImageView.setImageDrawable(asyncDrawable);
thumbImageView.setTag(tempThumbnailImageFileName);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
task.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR, tempThumbnailImageFileName);
} else {
task.execute(tempThumbnailImageFileName);
}
}
}
private boolean cancelPotentialWork(final String fileName, final ImageView imageView) {
final BitmapWorkerTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
if (bitmapWorkerTask != null) {
final String bitmapFileName = bitmapWorkerTask.fileName;
if (bitmapFileName == null || !bitmapFileName.equals(fileName)) {
// Cancel previous task
bitmapWorkerTask.cancel(true);
} else {
// The same work is already in progress
return false;
}
}
// No task associated with the ImageView, or an existing task was
// cancelled
return true;
}
protected final BitmapWorkerTask getBitmapWorkerTask(final ImageView imageView) {
if (imageView != null) {
final Drawable drawable = imageView.getDrawable();
if (drawable instanceof BaseSpiceArrayAdapter.AsyncDrawable) {
@SuppressWarnings("unchecked")
final AsyncDrawable asyncDrawable = (AsyncDrawable) drawable;
return asyncDrawable.getBitmapWorkerTask();
}
}
return null;
}
// ----------------------------------
// INNER CLASSES
// ----------------------------------
protected class ThumbnailAsynTask extends AsyncTask {
private T data;
private SpiceListItemView spiceListItemView;
private String tempThumbnailImageFileName = "";
private IBitmapRequest bitmapRequest;
private int imageIndex;
public ThumbnailAsynTask(final IBitmapRequest request) {
this.bitmapRequest = request;
}
@SuppressWarnings("unchecked")
@Override
protected final Boolean doInBackground(final Object... params) {
data = (T) params[0];
spiceListItemView = (SpiceListItemView) params[1];
imageIndex = (Integer) params[2];
if (bitmapRequest != null) {
File tempThumbnailImageFile = bitmapRequest.getCacheFile();
tempThumbnailImageFileName = tempThumbnailImageFile.getAbsolutePath();
Ln.d("Filename : " + tempThumbnailImageFileName);
if (!tempThumbnailImageFile.exists()) {
if (isNetworkFetchingAllowed) {
ImageRequestListener imageRequestListener = new ImageRequestListener(data, spiceListItemView, imageIndex, tempThumbnailImageFileName);
spiceManagerBinary.execute((SpiceRequest) bitmapRequest, "THUMB_IMAGE_" + data.hashCode(), DurationInMillis.ALWAYS_EXPIRED, imageRequestListener);
}
return false;
}
}
return true;
}
@Override
protected final void onPostExecute(final Boolean isImageAvailableInCache) {
if (isImageAvailableInCache) {
loadBitmapAsynchronously(data, spiceListItemView.getImageView(imageIndex), tempThumbnailImageFileName);
} else {
spiceListItemView.getImageView(imageIndex).setImageDrawable(defaultDrawable);
}
}
}
private class BitmapWorkerTask extends AsyncTask {
private final WeakReference imageViewReference;
String fileName = "";
private T data;
public BitmapWorkerTask(final ImageView imageView, final T data) {
// Use a WeakReference to ensure the ImageView can be garbage
// collected
imageViewReference = new WeakReference(imageView);
this.data = data;
}
// Decode image in background.
@Override
protected Drawable doInBackground(final String... params) {
fileName = params[0];
return new BitmapDrawable(getContext().getResources(), BitmapFactory.decodeFile(fileName, null));
}
// Once complete, see if ImageView is still around and set bitmap.
@Override
protected void onPostExecute(Drawable drawable) {
if (isCancelled()) {
drawable = null;
}
if (imageViewReference != null && drawable != null) {
final ImageView imageView = imageViewReference.get();
final BitmapWorkerTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
if (this == bitmapWorkerTask) {
if (freshDrawableSet.remove(data)) {
Drawable[] layers = new Drawable[] {defaultDrawable, drawable};
TransitionDrawable transitionDrawable = new TransitionDrawable(layers);
transitionDrawable.setCrossFadeEnabled(true);
transitionDrawable.startTransition(getContext().getResources().getInteger(android.R.integer.config_longAnimTime));
imageView.setImageDrawable(transitionDrawable);
} else {
imageView.setImageDrawable(drawable);
}
}
}
}
}
private class NetworkFetchingAuthorizationStateChangeAdapter {
private WeakReference> weakReferenceSpiceListItemView;
public NetworkFetchingAuthorizationStateChangeAdapter(final SpiceListItemView spiceListItemView) {
this.weakReferenceSpiceListItemView = new WeakReference>(spiceListItemView);
}
public void onNetworkFetchingAllowedChange(final boolean networkFetchingAllowed) {
SpiceListItemView spiceListItemView = weakReferenceSpiceListItemView.get();
if (spiceListItemView != null && networkFetchingAllowed) {
T data = spiceListItemView.getData();
for (int imageIndex = 0; imageIndex < spiceListItemView.getImageViewCount(); imageIndex++) {
performBitmapRequestAsync(spiceListItemView, data, imageIndex);
}
}
}
public SpiceListItemView getView() {
return weakReferenceSpiceListItemView.get();
}
}
private class AsyncDrawable extends BitmapDrawable {
private final WeakReference bitmapWorkerTaskReference;
public AsyncDrawable(final Resources res, final BitmapWorkerTask bitmapWorkerTask) {
super(res);
bitmapWorkerTaskReference = new WeakReference(bitmapWorkerTask);
}
public BitmapWorkerTask getBitmapWorkerTask() {
return bitmapWorkerTaskReference.get();
}
}
}
