Back to project page android_widget_adapters.
The source code is released under:
[Apache License](http://www.apache.org/licenses/): Version 2.0, January 2004 =============== ## TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION ## ### 1. Definitions. ### "License" sha...
If you think the Android project android_widget_adapters listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
/* * ================================================================================================= * Copyright (C) 2013 - 2014 Martin Albedinsky [Wolf-ITechnologies] * ================================================================================================= * Licensed under the Apache License, Version 2.0 or later (further "License" only). * ------------------------------------------------------------------------------------------------- * You may use this file only in compliance with the License. More details and copy of this License * you may obtain at//from ww w .java 2s . co m * * http://www.apache.org/licenses/LICENSE-2.0 * * You can redistribute, modify or publish any part of the code written within this file but as it * is described in the License, the software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES or CONDITIONS OF ANY KIND. * * See the License for the specific language governing permissions and limitations under the License. * ================================================================================================= */ package com.wit.android.ui.widget.adapter; import android.content.Context; import android.content.res.Resources; import android.os.Parcel; import android.os.Parcelable; import android.support.annotation.LayoutRes; import android.support.annotation.NonNull; import android.support.annotation.Nullable; import android.support.annotation.StringRes; import android.view.AbsSavedState; import android.view.LayoutInflater; import android.view.View; import android.view.ViewGroup; import com.wit.android.ui.widget.adapter.annotation.ItemView; import com.wit.android.ui.widget.adapter.annotation.ItemViewHolder; import com.wit.android.ui.widget.adapter.annotation.ItemViewHolderFactory; /** * <h3>Class Overview</h3> * todo: description * <h3>Accepted annotations</h3> * <ul> * <li> * {@link com.wit.android.ui.widget.adapter.annotation.ItemView @ItemView} <b>[class - inherited]</b> * <p> * If this annotation is presented, a resource id provided by this annotation will be used to inflate * the desired view in {@link #onCreateView(int, android.view.LayoutInflater, android.view.ViewGroup)}. * </li> * <li> * {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolderFactory @ItemViewHolderFactory} <b>[class - inherited]</b> * <p> * If this annotation is presented, a class provided by this annotation will be used to create instances * of holders for item views. * </li> * <li> * {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolder @ItemViewHolder} <b>[class - inherited]</b> * <p> * If this annotation is presented, a class provided by this annotation will be used to instantiate * an instance of the desired holder in {@link #onCreateViewHolder(int, android.view.View)}. * </li> * </ul> * <h3>State saving</h3> * <pre> * public class MyAdapter extends BaseAdapter<String> { * * // .. * * @Override * protected Parcelable onSaveInstanceState() { * final MyAdapterState state = new MyAdapterState(super.onSaveInstanceState()); * * // .. * // Pass here all data of this adapter which need to be saved to the state. * // .. * * return state; * } * * @Override * protected void onRestoreInstanceState(Parcelable savedState) { * if (!(savedState instanceof MyAdapterState)) { * // Passed savedState is not our state, let super to process it. * super.onRestoreInstanceState(savedState); * return; * } * * final MyAdapterState state = (MyAdapterState) savedState; * // Pass superState to super to process it. * super.onRestoreInstanceState(savedState.getSuperState()); * * // .. * // Set here all data of this adapter which need to be restored from the savedState. * // .. * } * * // .. * * // Implementation of BaseSavedState for this adapter. * static class MyAdapterState extends BaseSavedState { * * // Each implementation of saved state need to have its own CREATOR provided. * public static final Creator<MyAdapterState> CREATOR = new Creator<> { * * @Override * public MyAdapterState createFromParcel(Parcel source) { * return new MyAdapterState(source); * } * * @Override * public MyAdapterState[] newArray(int size) { * return new MyAdapterState[size]; * } * } * * MyAdapterState(Parcel source) { * super(source); * // Restore here state's data. * } * * // Constructor used to chain the state of inheritance hierarchies. * MyAdapterState(Parcelable superState) { * super(superState); * } * * @Override * public void writeToParcel(Parcel dest, int flags) { * super.writeToParcel(dest, flags); * // Save here state's data. * } * } * } * </pre> * * @param <Item> A type of the item presented within a data set of a subclass of this BaseAdapter. * @author Martin Albedinsky * @see com.wit.android.ui.widget.adapter.BaseSpinnerAdapter */ public abstract class BaseAdapter<Item> extends android.widget.BaseAdapter implements StateAdapter, FactoryHolderAdapter { /** * Interface =================================================================================== */ /** * Constants =================================================================================== */ /** * Log TAG. */ // private static final String TAG = "BaseAdapter"; /** * Flag indicating whether the debug output trough log-cat is enabled or not. */ // private static final boolean DEBUG_ENABLED = true; /** * Flag indicating whether the output for user trough log-cat is enabled or not. */ // private static final boolean USER_LOG = true; /** * Flag indicating whether the output for user trough log-cat is enabled or not. */ // private static final boolean USER_LOG = true; /** * Static members ============================================================================== */ /** * Members ===================================================================================== */ /** * Context in which will be this adapter used. */ protected final Context mContext; /** * Layout inflater used to inflate new views for this adapter. */ protected final LayoutInflater mLayoutInflater; /** * Application resources. */ protected final Resources mResources; /** * Item view type for the current {@link #getView(int, android.view.View, android.view.ViewGroup)} * iteration. */ private int mCurrentViewType; /** * Resource id of the view which should be inflated as item view. */ private int mViewRes = -1; /** * Class to be used to instantiate an instance of holder for item view. */ private Class<? extends ViewHolder> mClassOfHolder; /** * Factory responsible for instantiation of item view holders for this adapter. */ private ViewHolderFactory mHolderFactory; /** * Registered OnDataSetListener callback. */ private OnDataSetListener mDataSetListener; /** * Registered OnDataSetActionListener callback. */ private OnDataSetActionListener mDataSetActionListener; /** * Constructors ================================================================================ */ /** * Creates a new instance of BaseAdapter within the given <var>context</var>. * <p> * If {@link com.wit.android.ui.widget.adapter.annotation.ItemView @ItemView}, * {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolderFactory @ItemViewHolderFactory} * {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolder @ItemViewHolder} * annotations are presented above subclass of this BaseAdapter, they will be processed here. * * @param context Context in which will be this adapter used. * @throws NullPointerException If the given context is {@code null}. */ public BaseAdapter(@NonNull Context context) { this.processAnnotations(((Object) this).getClass()); // Set up. this.mContext = context; this.mLayoutInflater = (LayoutInflater) context.getSystemService(Context.LAYOUT_INFLATER_SERVICE); this.mResources = context.getResources(); } /** * Methods ===================================================================================== */ /** * Public -------------------------------------------------------------------------------------- */ /** */ @NonNull @Override public Parcelable dispatchSaveInstanceState() { return onSaveInstanceState(); } /** */ @Override public void dispatchRestoreInstanceState(@NonNull Parcelable savedState) { onRestoreInstanceState(savedState); } /** * This will also notify the current {@link OnDataSetListener} callback if it is presented. */ @Override public void notifyDataSetChanged() { super.notifyDataSetChanged(); notifyDataSetChangedInner(); } /** * This will also notify the current {@link OnDataSetActionListener} callback if it is presented. */ @Override public void notifyDataSetInvalidated() { super.notifyDataSetInvalidated(); notifyDataSetInvalidatedInner(); } /** * Performs optimized algorithm for this method using the <b>Holder</b> pattern. * * @throws NullPointerException If {@link #onCreateView(int, android.view.LayoutInflater, android.view.ViewGroup)} * returns {@code null} for the specified <var>position</var>. */ @Override public View getView(int position, @Nullable View convertView, @NonNull ViewGroup parent) { Object viewHolder; // Obtain current item view type. this.mCurrentViewType = getItemViewType(position); if (convertView == null) { // Dispatch to create new view. convertView = onCreateView(position, mLayoutInflater, parent); // Resolve holder for the newly created view. final Object holder = onCreateViewHolder(position, convertView); if (holder != null) { convertView.setTag(viewHolder = holder); } else { viewHolder = convertView; } } else { final Object holder = convertView.getTag(); viewHolder = holder != null ? holder : convertView; } // Dispatch to bind view with data. onBindView(position, viewHolder); return convertView; } /** * Getters + Setters --------------------------------------------------------------------------- */ /** * Returns the context with which was this adapter created. * * @return Same context as passed during initialization. */ @NonNull public Context getContext() { return mContext; } /** * Returns layout inflater instance provided by the context passed during initialization of this * adapter. * * @return An instance of LayoutInflater. */ @NonNull public LayoutInflater getLayoutInflater() { return mLayoutInflater; } /** * Returns an application's resources provided by the context passed during initialization of * this adapter. * * @return An application's resources. */ @NonNull public Resources getResources() { return mResources; } /** * Wrapped {@link android.content.res.Resources#getString(int)} for the current resources. */ @NonNull public String getString(@StringRes int resId) { return (mResources != null) ? mResources.getString(resId) : ""; } /** * Wrapped {@link android.content.res.Resources#getString(int, Object...)} for the current resources. */ @NonNull public String getString(@StringRes int resId, @Nullable Object... args) { return (mResources != null) ? mResources.getString(resId, args) : ""; } /** * Wrapped {@link android.content.res.Resources#getText(int)} for the current resources. */ @NonNull public CharSequence getText(@StringRes int resId) { return (mResources != null) ? mResources.getText(resId) : ""; } /** * Wrapped {@link android.content.res.Resources#getText(int, CharSequence)} for the current resources. */ @NonNull public CharSequence getText(@StringRes int resId, @NonNull CharSequence def) { return (mResources != null) ? mResources.getText(resId, def) : ""; } /** */ @Nullable @Override public abstract Item getItem(int position); /** * @return By default, the given position as id. */ @Override public long getItemId(int position) { return position; } /** */ @Override public final int getCurrentViewType() { return mCurrentViewType; } /** * Registers a callback to be invoked when the data set of this adapter has been changed or invalidated. * * @param listener Listener callback. */ public void setOnDataSetListener(@NonNull OnDataSetListener listener) { this.mDataSetListener = listener; } /** * Removes the current OnDataSetListener callback. */ public void removeOnDataSetListener() { this.mDataSetListener = null; } /** * Registers a callback to be invoked when there was a specific action performed above the * current data set of this adapter. * * @param listener Listener callback. */ public void setOnDataSetActionListener(@NonNull OnDataSetActionListener listener) { this.mDataSetActionListener = listener; } /** * Removes the current OnDataSetActionListener callback. */ public void removeOnDataSetActionListener() { this.mDataSetActionListener = null; } /** */ @Override public int getAdapterId() { return 0; } /** * Protected ----------------------------------------------------------------------------------- */ /** * Same as {@link #getCurrentViewType()}. */ protected final int currentViewType() { return mCurrentViewType; } /** * Inflates a new view hierarchy from the given xml resource. * * @param resource Resource id of a view to inflate. * @param parent A parent view, to resolve correct layout params for the newly creating view. * @return The root view of the inflated view hierarchy. * @see android.view.LayoutInflater#inflate(int, android.view.ViewGroup) */ @NonNull protected final View inflate(@LayoutRes int resource, @NonNull ViewGroup parent) { return mLayoutInflater.inflate(resource, parent, false); } /** * Called to notify, that the given <var>action</var> was performed for the specified <var>position</var>. * <p> * If {@link #onDataSetActionSelected(int, int, Object)} will not process this call, the current * {@link OnDataSetActionListener} will be notified if it is presented. * * @param action Action to be dispatched. * @param position The position for which was the given action performed. * @param data Additional data for the selected action to be dispatched to the listener. */ protected void notifyDataSetActionSelected(int action, int position, @Nullable Object data) { if (!onDataSetActionSelected(action, position, data)) { notifyDataSetActionSelectedInner(action, position, data); } } /** * Invoked immediately after {@link #notifyDataSetActionSelected(int, int, Object)} was called. * * @return {@code True} to indicate that this event was processed here, otherwise the current * {@link OnDataSetActionListener} will be notified about this event if it is presented. */ protected boolean onDataSetActionSelected(int action, int position, @Nullable Object data) { return false; } /** * Invoked to create a view for an item from the current data set at the specified position. * <p> * This is invoked only if <var>convertView</var> for the specified <var>position</var> in * {@link #getView(int, android.view.View, android.view.ViewGroup)} was {@code null}. * <p> * <b>Note</b>, that if {@link com.wit.android.ui.widget.adapter.annotation.ItemView @ItemView} * annotation is presented, a resource id provided by this annotation will be used to inflate the * requested view, otherwise implementation of this method is <b>required</b> or exception will * be thrown. * * @param position Position of the item from the current data set for which should be a new view * created. * @param inflater Layout inflater which can be used to inflate the requested view. * @param parent A parent view, to resolve correct layout params for the newly creating view. * @return New instance of the requested view. * @throws MissingUiAnnotationException If there is no @ItemView annotation presented. * @see #inflate(int, android.view.ViewGroup) */ @NonNull protected View onCreateView(int position, @NonNull LayoutInflater inflater, @NonNull ViewGroup parent) { if (mViewRes >= 0) { return inflater.inflate(mViewRes, parent, false); } throw new MissingUiAnnotationException( "Can not to create view for position(" + position + ") without resource id. " + "No @ItemView annotation presented." ); } /** * Invoked to create a view holder for a view of an item from the current data set at the * specified position. * <p> * This is invoked only if <var>convertView</var> for the specified <var>position</var> in * {@link #getView(int, android.view.View, android.view.ViewGroup)} was {@code null}, so as * view also holder need to be created. * <p> * If {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolderFactory @ItemViewHolderFactory} * annotation is presented, factory instantiated from the class provided by this annotation will * be used to create the requested view holder, otherwise * {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolder @ItemViewHolder} * annotation will be processed as described below. * <p> * If {@link com.wit.android.ui.widget.adapter.annotation.ItemViewHolder @ItemViewHolder} * annotation is presented, a class provided by this annotation will be used to instantiate the * requested view holder, otherwise {@code null} holder will be returned so the view created * by {@link #onCreateView(int, android.view.LayoutInflater, android.view.ViewGroup)} for the * specified position will be passed as holder to {@link #onBindView(int, Object)}. * * @param position Position of the item from the current data set for which should be a new view * holder created. * @param itemView An instance of the same view as obtained from * {@link #onCreateView(int, android.view.LayoutInflater, android.view.ViewGroup)} * for the specified position. * @return New instance of the requested view holder. * @throws IllegalStateException If the class provided by @ItemViewHolder annotation can not * be accessed or does not have an empty public constructor. */ @Nullable protected Object onCreateViewHolder(int position, @NonNull View itemView) { if (mHolderFactory != null) { final ViewHolder holder = mHolderFactory.createHolder(this, position, itemView); if (holder != null) { holder.create(position, itemView); return holder; } } if (mClassOfHolder != null) { ViewHolder holder; try { holder = mClassOfHolder.newInstance(); } catch (InstantiationException | IllegalAccessException e) { throw new IllegalStateException( "Failed to create view holder from class(" + mClassOfHolder + "). " + "Check if this holder class has public access and empty public constructor." ); } holder.create(position, itemView); return holder; } // Return null holder, so view created by onCreateView(..) will be passed as holder to onBindView(..). return null; } /** * Invoked to set up and populate a view of an item from the current data set at the specified * position. This is invoked whenever {@link #getView(int, android.view.View, android.view.ViewGroup)} * is called. * <p> * <b>Note</b>, that if {@link #onCreateViewHolder(int, android.view.View)} returns {@code null} * for the specified <var>position</var> here passed <var>viewHolder</var> will be the view created * by {@link #onCreateView(int, android.view.LayoutInflater, android.view.ViewGroup)} for the * specified position or just recycled view for such a position. This approach can be used, when * a view hierarchy of the specific list item is represented by one custom view, where such a view * represents a holder for all its child views. * <p> * By default this will try to bind the given <var>viewHolder</var> (if it is instanceof {@link ViewHolder}), * otherwise implementation of this method is <b>required</b> or exception will be thrown. * * @param position Position of the item from the current data set of which view to set up. * @param viewHolder An instance of the same holder as provided by {@link #onCreateViewHolder(int, android.view.View)} * for the specified position or converted view as holder as described above. * @throws IllegalStateException If binding process for the specified position fails. */ protected void onBindView(int position, @NonNull Object viewHolder) { final Item item = getItem(position); if (item == null || !bindViewInner(position, item, viewHolder)) { throw new IllegalStateException( "Failed to bind view at position(" + position + "). " + viewHolder + " is not instance of ViewHolder or item for this position is null." ); } } /** * Invoked immediately after {@link #dispatchSaveInstanceState()} was called, to save the current * state of this adapter. * <p> * If you decide to override this method, do not forget to call {@code super.onSaveInstanceState()} * and pass super state obtained from the super to constructor of your {@link BaseSavedState} * implementation with such a parameter to ensure the state of all classes along the chain is saved. * * @return Return here your implementation of {@link BaseSavedState} if you want to save state of * your adapter, otherwise no implementation of this method is necessary. */ @NonNull protected Parcelable onSaveInstanceState() { return BaseSavedState.EMPTY_STATE; } /** * Called immediately after {@link #dispatchRestoreInstanceState(android.os.Parcelable)} was called, * to restore a previous state, (saved in {@link #onSaveInstanceState()}), of this adapter. * * @param savedState Before saved state of this adapter. */ protected void onRestoreInstanceState(@NonNull Parcelable savedState) { } /** * Called to dispatch data set change to the current OnDataSetListener callback. */ @SuppressWarnings("unchecked") void notifyDataSetChangedInner() { if (mDataSetListener != null) { mDataSetListener.onDataSetChanged(this); } } /** * Called to dispatch data set invalidation to the current OnDataSetListener callback. */ @SuppressWarnings("unchecked") void notifyDataSetInvalidatedInner() { if (mDataSetListener != null) { mDataSetListener.onDataSetInvalidated(this); } } /** * Inner implementation of {@link #notifyDataSetActionSelected(int, int, Object)} to hide such an * implementation. */ @SuppressWarnings("unchecked") void notifyDataSetActionSelectedInner(int action, int position, Object data) { if (mDataSetActionListener != null) { mDataSetActionListener.onDataSetActionSelected(this, action, position, getItemId(position), data); } } /** * Inner implementation of {@link #onBindView(int, Object)} to hide such an implementation. */ @SuppressWarnings("unchecked") boolean bindViewInner(int position, Item item, Object viewHolder) { if (viewHolder instanceof ViewHolder) { ((ViewHolder<Item, BaseAdapter<Item>>) viewHolder).bind(position, item, this); return true; } return false; } /** * Private ------------------------------------------------------------------------------------- */ /** * Called to process all class annotations of this <var>classOfAdapter</var>. * * @param classOfAdapter The class of this adapter of which annotations to process. */ private void processAnnotations(Class<?> classOfAdapter) { // Obtain item view. final ItemView itemView = AdapterAnnotations.obtainAnnotationFrom( classOfAdapter, ItemView.class, BaseAdapter.class ); if (itemView != null) { this.mViewRes = itemView.value(); } // Obtain item view holder factory. final ItemViewHolderFactory holderFactory = AdapterAnnotations.obtainAnnotationFrom( classOfAdapter, ItemViewHolderFactory.class, BaseAdapter.class ); if (holderFactory != null) { try { this.mHolderFactory = holderFactory.value().newInstance(); } catch (InstantiationException | IllegalAccessException e) { throw new IllegalStateException( "Failed to create view holder factory from class(" + holderFactory.value() + "). " + "Check if this factory class has public access and empty public constructor." ); } } // Obtain item view holder. final ItemViewHolder itemViewHolder = AdapterAnnotations.obtainAnnotationFrom( classOfAdapter, ItemViewHolder.class, BaseAdapter.class ); if (itemViewHolder != null) { this.mClassOfHolder = itemViewHolder.value(); } } /** * Inner classes =============================================================================== */ /** * <h3>Class Overview</h3> * A {@link android.view.AbsSavedState} implementation that should be used by inheritance hierarchies of {@link BaseAdapter} * to ensure the state of all classes along the chain is saved. * * @author Martin Albedinsky */ public static class BaseSavedState extends AbsSavedState { /** * Members ================================================================================= */ /** * Creator used to create an instance or array of instances of BaseSavedState from {@link android.os.Parcel}. */ public static final Creator<BaseSavedState> CREATOR = new Creator<BaseSavedState>() { /** */ @Override public BaseSavedState createFromParcel(Parcel source) { return new BaseSavedState(source); } /** */ @Override public BaseSavedState[] newArray(int size) { return new BaseSavedState[size]; } }; /** * Constructors ============================================================================ */ /** * Creates a new instance BaseSavedState with the given <var>superState</var> to allow * chaining of saved states in {@link #onSaveInstanceState()} and also in * {@link #onRestoreInstanceState(android.os.Parcelable)}. * * @param superState A super state obtained from {@code super.onSaveInstanceState()} * within {@code onSaveInstanceState()} of a specific {@link BaseAdapter} * implementation. */ protected BaseSavedState(@Nullable Parcelable superState) { super(superState); } /** * Called form {@link #CREATOR} to create an instance of BaseSavedState form the given parcel * <var>source</var>. * * @param source Parcel with data for a new instance. */ protected BaseSavedState(@NonNull Parcel source) { super(source); } } }