Android Selectable ListView 最佳实践

前言

日常开发中,单选或多选列表是一种常见的需求。当然如果以“安卓 style”的交互理念,那么通常认为列表下长按进入“选择模式”。感觉国内这种理念几乎被忽略,产品经理(或者交互设计师)要求“与 IOS 保持一致”的情况也遍地都是。

在面对这样的需求时,我们绝大多数开发者的解决方案一定是在 Adapter 下保持一个 HashMap<Object, Boolean>,用于保存数据集的选择状态,想的深入的也许会采用 SparseBooleanArray 等等优化的数据结构,或者干脆在 Model 类中加入 selected 的布尔属性,然后通过 OnItemClickListener 设置选中状态再 notifyDataChanged ,如果涉及到单选、多选、不可选模式的切换就更复杂,代码也设计的惨不忍睹。但我这里要介绍的是一种更贴近原生 API 的解决方案。

ListView 的 choiceMode 属性

之所以会想到要寻求更好的解决方案,是因为我发现 ListView 下的 choiceMode 很有意思。它似乎被我们遗忘了,是不是 SDK 本身就已经处理了这种的需求。
choiceMode 的值可以有以下几个,在 ListView 下可以找到:

  • CHOICE_MODE_NONE
  • CHOICE_MODE_SINGLE
  • CHOICE_MODE_MULTIPLE
  • CHOICE_MODE_MULTIPLE_MODAL

除了最后一个,其他的几个值得意思都是显然易见的,MODAL 用于与 ActionBar 响应交互(?待验证)。

可以在 XML 中配置:

android:choiceMode="singleChoice"

也可以代码设置:

listView.setChoiceMode(ListView.CHOICE_MODE_SINGLE);

让开发更简便

我们要做的只要以下几步:

  • item 的根布局采用 CheckableRelativeLayout,顾名思义,考虑到 RelativeLayout 的全能,这里就只放相对布局了,这个类要继承 RelativeLayout,实现 Checkable 接口,代码会在文章最后呈现

  • 调用 ListView#setItemChecked 方法初始化选择的状态

  • 在 Adapter#getView 方法中加入

    final ListView lv = (ListView) parent;
    holder.rootLayout.setChecked(lv.isItemChecked(position));
    
  • 调用 ListView#getCheckedItemPositions 获取被选中的位置,ListView#getCheckedItemIds 获取被选中的数据 id,对于 SparseBooleanArray 的遍历方法如下:

    int position = checkedItems.keyAt(i);
    boolean isChecked = checkedItems.valueAt(i);
    
  • 然后别忘了布局中每个控件设置:

    <Xxx
      ...
      android:focusable="false" />
    

CheckableRelativeLayout 源码

代码来源
https://github.com/marvinlabs/android-tutorials-custom-selectable-listview
侵权即删

import java.util.ArrayList;
import java.util.List;

import android.content.Context;
import android.util.AttributeSet;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Checkable;
import android.widget.RelativeLayout;

/**
 * Extension of a relative layout to provide a checkable behaviour
 * 
 * @author marvinlabs
 */
public class CheckableRelativeLayout extends RelativeLayout implements Checkable {

    /**
     * Interface definition for a callback to be invoked when the checked state of a CheckableRelativeLayout changed.
     */
    public static interface OnCheckedChangeListener {
        public void onCheckedChanged(CheckableRelativeLayout layout, boolean isChecked);
    }

    public CheckableRelativeLayout(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
        initialise(attrs);
    }

    public CheckableRelativeLayout(Context context, AttributeSet attrs) {
        super(context, attrs);
        initialise(attrs);
    }

    public CheckableRelativeLayout(Context context, int checkableId) {
        super(context);
        initialise(null);
    }

    /*
     * @see android.widget.Checkable#isChecked()
     */
    public boolean isChecked() {
        return isChecked;
    }

    /*
     * @see android.widget.Checkable#setChecked(boolean)
     */
    public void setChecked(boolean isChecked) {
        this.isChecked = isChecked;
        for (Checkable c : checkableViews) {
            c.setChecked(isChecked);
        }

        if (onCheckedChangeListener != null) {
            onCheckedChangeListener.onCheckedChanged(this, isChecked);
        }
    }

    /*
     * @see android.widget.Checkable#toggle()
     */
    public void toggle() {
        this.isChecked = !this.isChecked;
        for (Checkable c : checkableViews) {
            c.toggle();
        }
    }

    public void setOnCheckedChangeListener(OnCheckedChangeListener onCheckedChangeListener) {
        this.onCheckedChangeListener = onCheckedChangeListener;
    }

    @Override
    protected void onFinishInflate() {
        super.onFinishInflate();

        final int childCount = this.getChildCount();
        for (int i = 0; i < childCount; ++i) {
            findCheckableChildren(this.getChildAt(i));
        }
    }

    /**
     * Read the custom XML attributes
     */
    private void initialise(AttributeSet attrs) {
        this.isChecked = false;
        this.checkableViews = new ArrayList<Checkable>(5);
    }

    /**
     * Add to our checkable list all the children of the view that implement the interface Checkable
     */
    private void findCheckableChildren(View v) {
        if (v instanceof Checkable) {
            this.checkableViews.add((Checkable) v);
        }

        if (v instanceof ViewGroup) {
            final ViewGroup vg = (ViewGroup) v;
            final int childCount = vg.getChildCount();
            for (int i = 0; i < childCount; ++i) {
                findCheckableChildren(vg.getChildAt(i));
            }
        }
    }

    private boolean isChecked;
    private List<Checkable> checkableViews;
    private OnCheckedChangeListener onCheckedChangeListener;
}

推荐阅读更多精彩内容