Android Open Source - Android-MultiStateListView Multi State List View

• Back to UI ListView/Load  ↑

From Project

Back to project page Android-MultiStateListView.

License

The source code is released under:

MIT License

Java Source Code

package com.jensdriller.libs.multistatelistview;
//w  w w.  j  a v  a 2s  .c  o  m
import android.content.Context;
import android.content.res.TypedArray;
import android.util.AttributeSet;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.FrameLayout;
import android.widget.ListView;

/**
 * A simple {@link ListView} that lets you define three states:
 * <ul>
 *     <li>Loading</li>
 *     <li>Empty</li>
 *     <li>Error</li>
 * </ul>
 *
 * @author Jens Driller <jens@jensdriller.com>
 */
public class MultiStateListView extends ListView {

  //================================================================================
  // Fields
  //================================================================================

  private static final String TAG = MultiStateListView.class.getSimpleName();

  private View mLoadingView;
  private View mEmptyView;
  private View mErrorView;

  private LayoutInflater mLayoutInflater;
  private boolean mInitViews = true;
  private boolean mInvalidateView;

  //================================================================================
  // Constructors
  //================================================================================

  public MultiStateListView(Context context) {
    super(context);
    init(null);
  }

  public MultiStateListView(Context context, AttributeSet attrs) {
    super(context, attrs);
    init(attrs);
  }

  public MultiStateListView(Context context, AttributeSet attrs, int defStyle) {
    super(context, attrs, defStyle);
    init(attrs);
  }

  private void init(AttributeSet attrs) {
    mLayoutInflater = LayoutInflater.from(getContext());

    if (attrs != null) {
      TypedArray a = getContext().obtainStyledAttributes(attrs, R.styleable.MultiStateListView);

      int loadingViewResId = a.getResourceId(R.styleable.MultiStateListView_loadingView, 0);
      if (loadingViewResId > 0) {
        mLoadingView = mLayoutInflater.inflate(loadingViewResId, null);
      }

      int emptyViewResId = a.getResourceId(R.styleable.MultiStateListView_emptyView, 0);
      if (emptyViewResId > 0) {
        mEmptyView = mLayoutInflater.inflate(emptyViewResId, null);
      }

      int errorViewResId = a.getResourceId(R.styleable.MultiStateListView_errorView, 0);
      if (errorViewResId > 0) {
        mErrorView = mLayoutInflater.inflate(errorViewResId, null);
      }

      a.recycle();
    }
  }

  // Private constructor used for Builder pattern
  private MultiStateListView(Builder builder) {
    super(builder.mContext);
    mLoadingView = builder.mLoadingView;
    mEmptyView = builder.mEmptyView;
    mErrorView = builder.mErrorView;
  }

  //================================================================================
  // Builder
  //================================================================================

  public static class Builder {

    private Context mContext;
    private LayoutInflater mLayoutInflater;

    private View mLoadingView;
    private View mEmptyView;
    private View mErrorView;

    public Builder(Context context) {
      if (context == null) {
        throw new IllegalArgumentException("Context must not be null.");
      }
      mContext = context;
      mLayoutInflater = LayoutInflater.from(context);
    }

    public Builder loadingView(View view) {
      if (view == null) {
        throw new IllegalArgumentException("View must not be null.");
      }
      mLoadingView = view;
      return this;
    }

    public Builder loadingView(View view, OnClickListener clickListener) {
      if (view == null) {
        throw new IllegalArgumentException("View must not be null.");
      }
      mLoadingView = view;
      mLoadingView.setOnClickListener(clickListener);
      return this;
    }

    public Builder loadingView(int resId) {
      if (resId <= 0) {
        throw new IllegalArgumentException("View resource id must be greater than 0.");
      }
      mLoadingView = mLayoutInflater.inflate(resId, null);
      return this;
    }

    public Builder emptyView(View view) {
      if (view == null) {
        throw new IllegalArgumentException("View must not be null.");
      }
      mEmptyView = view;
      return this;
    }

    public Builder emptyView(View view, OnClickListener clickListener) {
      if (view == null) {
        throw new IllegalArgumentException("View must not be null.");
      }
      mEmptyView = view;
      mEmptyView.setOnClickListener(clickListener);
      return this;
    }

    public Builder emptyView(int resId) {
      if (resId <= 0) {
        throw new IllegalArgumentException("View resource id must be greater than 0.");
      }
      mEmptyView = mLayoutInflater.inflate(resId, null);
      return this;
    }

    public Builder errorView(View view) {
      if (view == null) {
        throw new IllegalArgumentException("View must not be null.");
      }
      mErrorView = view;
      return this;
    }

    public Builder errorView(View view, OnClickListener clickListener) {
      if (view == null) {
        throw new IllegalArgumentException("View must not be null.");
      }
      mErrorView = view;
      mErrorView.setOnClickListener(clickListener);
      return this;
    }

    public Builder errorView(int resId) {
      if (resId <= 0) {
        throw new IllegalArgumentException("View resource id must be greater than 0.");
      }
      mErrorView = mLayoutInflater.inflate(resId, null);
      return this;
    }

    public MultiStateListView build() {
      return new MultiStateListView(this);
    }
  }

  //================================================================================
  // Getters
  //================================================================================

  public View getLoadingView() {
    return mLoadingView;
  }

  @Override
  public View getEmptyView() {
    return mEmptyView;
  }

  public View getErrorView() {
    return mErrorView;
  }

  //================================================================================
  // Setters
  //================================================================================

  public void setLoadingView(View view) {
    setLoadingView(view, false);
  }

  public void setLoadingView(View view, boolean invalidateView) {
    if (view == null) {
      throw new IllegalArgumentException("View must not be null.");
    }
    mLoadingView = view;
    mInvalidateView = invalidateView;
  }

  public void setLoadingView(int resId) {
    setLoadingView(resId, false);
  }

  public void setLoadingView(int resId, boolean invalidateView) {
    if (resId <= 0) {
      throw new IllegalArgumentException("View resource id must be greater than 0.");
    }
    mLoadingView = mLayoutInflater.inflate(resId, null);
    mInvalidateView = invalidateView;
  }

  public void setLoadingView(View view, OnClickListener clickListener) {
    setLoadingView(view, clickListener, false);
  }

  public void setLoadingView(View view, OnClickListener clickListener, boolean invalidateView) {
    if (view == null) {
      throw new IllegalArgumentException("View must not be null.");
    }
    mLoadingView = view;
    mLoadingView.setOnClickListener(clickListener);
    mInvalidateView = invalidateView;
  }

  public void setLoadingView(int resId, OnClickListener clickListener) {
    setLoadingView(resId, clickListener, false);
  }

  public void setLoadingView(int resId, OnClickListener clickListener, boolean invalidateView) {
    if (resId <= 0) {
      throw new IllegalArgumentException("View resource id must be greater than 0.");
    }
    mLoadingView = mLayoutInflater.inflate(resId, null);
    mLoadingView.setOnClickListener(clickListener);
    mInvalidateView = invalidateView;
  }

  public void setLoadingViewClickListener(OnClickListener clickListener) {
    if (mLoadingView == null) {
      throw new IllegalStateException("Loading view is null. Cannot set click listener.");
    }
    mLoadingView.setOnClickListener(clickListener);
  }

  @Override
  public void setEmptyView(View view) {
    setEmptyView(view, false);
  }

  public void setEmptyView(View view, boolean invalidateView) {
    if (view == null) {
      throw new IllegalArgumentException("View must not be null.");
    }
    mEmptyView = view;
    mInvalidateView = invalidateView;
  }

  public void setEmptyView(int resId) {
    setEmptyView(resId, false);
  }

  public void setEmptyView(int resId, boolean invalidateView) {
    if (resId <= 0) {
      throw new IllegalArgumentException("View resource id must be greater than 0.");
    }
    mEmptyView = mLayoutInflater.inflate(resId, null);
    mInvalidateView = invalidateView;
  }

  public void setEmptyView(View view, OnClickListener clickListener) {
    setEmptyView(view, clickListener, false);
  }

  public void setEmptyView(View view, OnClickListener clickListener, boolean invalidateView) {
    if (view == null) {
      throw new IllegalArgumentException("View must not be null.");
    }
    mEmptyView = view;
    mEmptyView.setOnClickListener(clickListener);
    mInvalidateView = invalidateView;
  }

  public void setEmptyView(int resId, OnClickListener clickListener) {
    setEmptyView(resId, clickListener, false);
  }

  public void setEmptyView(int resId, OnClickListener clickListener, boolean invalidateView) {
    if (resId <= 0) {
      throw new IllegalArgumentException("View resource id must be greater than 0.");
    }
    mEmptyView = mLayoutInflater.inflate(resId, null);
    mEmptyView.setOnClickListener(clickListener);
    mInvalidateView = invalidateView;
  }

  public void setEmptyViewClickListener(OnClickListener clickListener) {
    if (mEmptyView == null) {
      throw new IllegalStateException("Empty view is null. Cannot set click listener.");
    }
    mEmptyView.setOnClickListener(clickListener);
  }

  public void setErrorView(View view) {
    setErrorView(view, false);
  }

  public void setErrorView(View view, boolean invalidateView) {
    if (view == null) {
      throw new IllegalArgumentException("View must not be null.");
    }
    mErrorView = view;
    mInvalidateView = invalidateView;
  }

  public void setErrorView(int resId) {
    setErrorView(resId, false);
  }

  public void setErrorView(int resId, boolean invalidateView) {
    if (resId <= 0) {
      throw new IllegalArgumentException("View resource id must be greater than 0.");
    }
    mErrorView = mLayoutInflater.inflate(resId, null);
    mInvalidateView = invalidateView;
  }

  public void setErrorView(View view, OnClickListener clickListener) {
    setErrorView(view, clickListener, false);
  }

  public void setErrorView(View view, OnClickListener clickListener, boolean invalidateView) {
    if (view == null) {
      throw new IllegalArgumentException("View must not be null.");
    }
    mErrorView = view;
    mErrorView.setOnClickListener(clickListener);
    mInvalidateView = invalidateView;
  }

  public void setErrorView(int resId, OnClickListener clickListener) {
    setErrorView(resId, clickListener, false);
  }

  public void setErrorView(int resId, OnClickListener clickListener, boolean invalidateView) {
    if (resId <= 0) {
      throw new IllegalArgumentException("View resource id must be greater than 0.");
    }
    mErrorView = mLayoutInflater.inflate(resId, null);
    mErrorView.setOnClickListener(clickListener);
    mInvalidateView = invalidateView;
  }

  public void setErrorViewClickListener(OnClickListener clickListener) {
    if (mErrorView == null) {
      throw new IllegalStateException("Error view is null. Cannot set click listener.");
    }
    mErrorView.setOnClickListener(clickListener);
  }

  //================================================================================
  // State Handling
  //================================================================================

  public static enum State {
    LOADING,
    EMPTY,
    ERROR
  }

  public void showLoadingView() {
    showView(State.LOADING);
  }

  public void showEmptyView() {
    showView(State.EMPTY);
  }

  public void showErrorView() {
    showView(State.ERROR);
  }

  public void showView(State state) {
    if (mInitViews || mInvalidateView) {
      initViews();
      mInitViews = mInvalidateView = false;
    }

    boolean showLoadingView = false;
    boolean showEmptyView = false;
    boolean showErrorView = false;

    switch (state) {
      case LOADING:
        showLoadingView = true;
        break;
      case EMPTY:
        showEmptyView = true;
        break;
      case ERROR:
        showErrorView = true;
        break;
    }

    if (mLoadingView != null) {
      mLoadingView.setVisibility(showLoadingView ? View.VISIBLE : View.GONE);
    }

    if (mEmptyView != null) {
      mEmptyView.setVisibility(showEmptyView ? View.VISIBLE : View.GONE);
    }

    if (mErrorView != null) {
      mErrorView.setVisibility(showErrorView ? View.VISIBLE : View.GONE);
    }
  }

  private void initViews() {
    ViewGroup parent = (ViewGroup) getParent();
    if (parent == null) {
      throw new IllegalStateException(getClass().getSimpleName() + " is not attached to parent view.");
    }

    ViewGroup container = getContainerView(parent);
    container.removeAllViews();

    parent.removeView(container);
    parent.addView(container);

    if (mLoadingView != null) {
      container.addView(mLoadingView);
    }

    if (mEmptyView != null) {
      container.addView(mEmptyView);
    }

    if (mErrorView != null) {
      container.addView(mErrorView);
    }

    super.setEmptyView(container);
  }

  private ViewGroup getContainerView(ViewGroup parent) {
    ViewGroup container = findContainerView(parent);
    if (container == null) {
      container = createContainerView();
    }
    return container;
  }

  private ViewGroup findContainerView(ViewGroup parent) {
    return (ViewGroup) parent.findViewWithTag(TAG);
  }

  private ViewGroup createContainerView() {
    LayoutParams lp = new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT);
    FrameLayout container = new FrameLayout(getContext());
    container.setTag(TAG);
    container.setLayoutParams(lp);
    return container;
  }
}

Java Source Code List

• Back to UI ListView/Load  ↑