自定义控件--快速检索

一.应用场景:联系人，好友列表，商品等列表的快速定位和搜索
二.实现逻辑:
a.右边是自定义QuickIndexBar,它能获取触摸它的时候当前所触摸到的字母;
 绘制文本x坐标: width/2;
 绘制文本y坐标: 格子高度的一半 + 文本高度的一半 + position*格子高度
 计算触摸点对应的字母:根据触摸点的y坐标除以cellHeight,得到的值就是字母对应的索引;
 
b.左边是listview，它根据当前触摸的字母，去自己列表找首字母和触摸字母相同的那个
item，然后让item放置到屏幕顶端(setSelection(position));

c.需要用到获取汉字的拼音,借助类库pinyin4j.jar实现;

  

三.实现

    1.目录结构

2.java代码

2.1 MyAdapter.java

package com.weizh.quickindexbar.adapter;

import android.content.Context;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.ListAdapter;
import android.widget.TextView;

import com.weizh.quickindexbar.R;
import com.weizh.quickindexbar.domain.Friend;

import java.util.ArrayList;

/**
 * Created by weizh_000 on 2016/8/23.
 */
public class MyAdapter extends BaseAdapter {


    private ArrayList<Friend> list;
    private Context context;

    public MyAdapter(ArrayList<Friend> list, Context context) {
        this.list = list;
        this.context = context;
    }

    @Override
    public int getCount() {
        return list.size();
    }

    @Override
    public Object getItem(int i) {
        return null;
    }

    @Override
    public long getItemId(int i) {
        return 0;
    }

    @Override
    public View getView(int position, View convertView, ViewGroup viewGroup) {
        ViewHolder holder = null;
        if (convertView == null) {
            convertView = View.inflate(context, R.layout.list_item, null);
            holder = new ViewHolder();
            holder.tvFirstLetter = (TextView) convertView.findViewById(R.id.tv_firstLetter);
            holder.tvName = (TextView) convertView.findViewById(R.id.tv_name);
            convertView.setTag(holder);
        } else {
            holder = (ViewHolder) convertView.getTag();
        }

        String letter = list.get(position).getPinyin().charAt(0) + "";
        if (position > 0) {
            String lastLetter = list.get(position - 1).getPinyin().charAt(0) + "";
            if (letter.equals(lastLetter)) {
                //需要隐藏当前的字母
                holder.tvFirstLetter.setVisibility(View.GONE);
            }else {
                //需要显示当前的字母
                holder.tvFirstLetter.setVisibility(View.VISIBLE);
                holder.tvFirstLetter.setText(letter);
            }
        } else {
            //第一个条目
            holder.tvFirstLetter.setVisibility(View.VISIBLE);
            holder.tvFirstLetter.setText(letter);
        }
        holder.tvName.setText(list.get(position).getName());
        return convertView;
    }

    class ViewHolder {
        private TextView tvFirstLetter;
        private TextView tvName;
    }
}

2.2 Friend.java

package com.weizh.quickindexbar.domain;

import com.weizh.quickindexbar.util.PinyinUtil;

/**
 * Created by weizh_000 on 2016/8/23.
 */

public class Friend implements Comparable<Friend>{

    private String name;

    private String pinyin;

    public Friend(String name) {
        this.name = name;
        //设置名字对应的拼音
        setPinyin(PinyinUtil.getPinyin(getName()));
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPinyin() {
        return pinyin;
    }

    public void setPinyin(String pinyin) {
        this.pinyin = pinyin;
    }

    @Override
    public int compareTo(Friend another) {
        String pinyin = getPinyin();
        String anotherPinyin = another.getPinyin();
        return pinyin.compareTo(anotherPinyin);
    }
}

2.3 PinyinUtil.java

package com.weizh.quickindexbar.util;

import android.text.TextUtils;

import net.sourceforge.pinyin4j.PinyinHelper;
import net.sourceforge.pinyin4j.format.HanyuPinyinCaseType;
import net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat;
import net.sourceforge.pinyin4j.format.HanyuPinyinToneType;
import net.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination;

/**
 * Created by weizh_000 on 2016/8/23.
 */

public class PinyinUtil {
    public static String getPinyin(String chinese) {
        if (TextUtils.isEmpty(chinese)) return null;

        //1.由于只能对单个汉字进行转换，所以将汉字逐个拆开放入数组，然后对每个汉字进行转换
        char[] charArray = chinese.toCharArray();
        StringBuffer pinyin = new StringBuffer();

        HanyuPinyinOutputFormat format = new HanyuPinyinOutputFormat();
        format.setCaseType(HanyuPinyinCaseType.UPPERCASE);
        format.setToneType(HanyuPinyinToneType.WITHOUT_TONE);

        for (char c : charArray) {
            //2.过滤掉空格
            if (Character.isWhitespace(c)) continue;
            //3.判断是否是汉字
            //汉字是2个字节，每个字节范围-128~127，所以每个汉字肯定大于127
            if (c > 127) {
                //可能是汉字
                String[] strings = new String[0];
                try {
                    strings = PinyinHelper.toHanyuPinyinStringArray(c, format);
                } catch (BadHanyuPinyinOutputFormatCombination badHanyuPinyinOutputFormatCombination) {
                    badHanyuPinyinOutputFormatCombination.printStackTrace();
                    //不是汉字，不处理
                }
                pinyin.append(strings[0]);
            } else {
                //不是汉字，则是键盘上的某个字符
                pinyin.append(c);//直接加到拼音字符串
            }
        }
        return pinyin.toString();
    }
}

2.4 QuickIndexBar.java

package com.weizh.quickindexbar.widget;

import android.content.Context;
import android.graphics.Canvas;
import android.graphics.Color;
import android.graphics.Paint;
import android.graphics.Rect;
import android.util.AttributeSet;
import android.view.MotionEvent;
import android.widget.FrameLayout;


/**
 * Created by weizh_000 on 2016/8/23.
 */

public class QuickIndexBar extends FrameLayout {
    private Paint paint;
    private String[] indexArr = {"A", "B", "C", "D", "E", "F", "G", "H",
            "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U",
            "V", "W", "X", "Y", "Z"};
    private float cellHeight;
    private OnTouchLetterListener touchLetterListener;

    public QuickIndexBar(Context context) {
        super(context);
        init();
    }

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

    public QuickIndexBar(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init();
    }

    private void init() {
        paint = new Paint(Paint.ANTI_ALIAS_FLAG);//设置抗锯齿
        paint.setColor(Color.WHITE);
        paint.setTextSize(32);
        paint.setTextAlign(Paint.Align.CENTER);//文字居中显示
    }

    @Override
    protected void onSizeChanged(int w, int h, int oldw, int oldh) {
        super.onSizeChanged(w, h, oldw, oldh);
        cellHeight = getMeasuredHeight() * 1f / indexArr.length;//获取每个格子的高度
    }

    @Override
    protected void onDraw(Canvas canvas) {
        float x = getMeasuredWidth() / 2;//让文字水平居中
        float y = 0;
        for (int i = 0; i < indexArr.length; i++) {
            y = cellHeight / 2 + getTextHeight(indexArr[i]) / 2 + i * cellHeight;//设置文字的位置y大小
            paint.setColor(lastIndex==i?Color.BLACK:Color.WHITE);//重绘时，改变画笔颜色，让被按下的字母变成黑色，其他字母白色
            canvas.drawText(indexArr[i], x, y, paint);
        }
    }

    //获取文本高度
    private float getTextHeight(String s) {
        Rect bounds = new Rect();
        paint.getTextBounds(s, 0, 1, bounds);
        return bounds.height();
    }

    private int lastIndex = -1;

    @Override
    public boolean onTouchEvent(MotionEvent event) {
        switch (event.getAction()) {
            case MotionEvent.ACTION_DOWN:
            case MotionEvent.ACTION_MOVE:
                float y = event.getY();
                int index = (int) (y / cellHeight);//获取当前所触摸的字母索引
                if (index != lastIndex) {
                    if(index<indexArr.length)//容错处理
                    touchLetterListener.onTouch(indexArr[index]);
                }
                lastIndex = index;
                break;
            case MotionEvent.ACTION_UP:
                //重置上一个字母索引
                lastIndex = -1;
                break;
        }
        invalidate();//引起重绘
        return true;//消费掉事件
    }

    public void setOnTouchLetterListener(OnTouchLetterListener touchLetterListener) {

        this.touchLetterListener = touchLetterListener;
    }

    public interface OnTouchLetterListener {

        void onTouch(String letter);
    }
}

2.5 MainActivity.java

    

package com.weizh.quickindexbar;

import android.os.Bundle;
import android.os.Handler;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.ListView;
import android.widget.TextView;

import com.weizh.quickindexbar.adapter.MyAdapter;
import com.weizh.quickindexbar.domain.Friend;
import com.weizh.quickindexbar.widget.QuickIndexBar;

import java.util.ArrayList;
import java.util.Collections;

import static com.weizh.quickindexbar.R.id.tv_currentLetter;

public class MainActivity extends AppCompatActivity {

    private QuickIndexBar quickIndexBar;
    private ListView lvListView;
    private ArrayList<Friend> list = new ArrayList<Friend>();
    private TextView tvCurrentLetter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initView();
        initData();
    }

    private void initData() {
        quickIndexBar.setOnTouchLetterListener(new QuickIndexBar.OnTouchLetterListener() {
            @Override
            public void onTouch(String letter) {
                //根据当前所选中的字母，去friend集合中找首字母
                for (int i = 0; i < list.size(); i++) {
                    String firstLetter = list.get(i).getPinyin().charAt(0) + "";
                    if (letter.equals(firstLetter)) {
                        lvListView.setSelection(i);
                        break;
                    }
                }
                showCurrentLetter(letter);
            }
        });
        fillFriend();//填充数据
        if (!list.isEmpty()) Collections.sort(list); //对数据进行排序
        lvListView.setAdapter(new MyAdapter(list, getApplicationContext()));

//        System.out.println(PinyinUtil.getPinyin("#黑马"));
//        System.out.println(PinyinUtil.getPinyin(":-)黑 马"));
//        System.out.println(PinyinUtil.getPinyin("a黑 马"));
    }

    private Handler handler = new Handler();

    //显示当前被选中的字母
    private void showCurrentLetter(String letter) {
        tvCurrentLetter.setText(letter);
        tvCurrentLetter.setVisibility(View.VISIBLE);

        //先移除之前的任务
        handler.removeCallbacksAndMessages(null);
        //延时隐藏currentLetter
        handler.postDelayed(new Runnable() {
            @Override
            public void run() {
                tvCurrentLetter.setVisibility(View.GONE);
            }
        }, 1500);
    }

    private void initView() {
        quickIndexBar = (QuickIndexBar) findViewById(R.id.quickIndexBar);
        lvListView = (ListView) findViewById(R.id.lv_listView);
        tvCurrentLetter = (TextView) findViewById(tv_currentLetter);
    }

    private void fillFriend() {
        // 虚拟数据
        list.add(new Friend("李伟"));
        list.add(new Friend("张三"));
        list.add(new Friend("阿三"));
        list.add(new Friend("阿四"));
        list.add(new Friend("段誉"));
        list.add(new Friend("段正淳"));
        list.add(new Friend("张三丰"));
        list.add(new Friend("陈坤"));
        list.add(new Friend("林俊杰1"));
        list.add(new Friend("陈坤2"));
        list.add(new Friend("王二a"));
        list.add(new Friend("林俊杰a"));
        list.add(new Friend("张四"));
        list.add(new Friend("林俊杰"));
        list.add(new Friend("王二"));
        list.add(new Friend("王二b"));
        list.add(new Friend("赵四"));
        list.add(new Friend("杨坤"));
        list.add(new Friend("赵子龙"));
        list.add(new Friend("杨坤1"));
        list.add(new Friend("李伟1"));
        list.add(new Friend("宋江"));
        list.add(new Friend("宋江1"));
        list.add(new Friend("李伟3"));

    }
}

三、运行效果图：

四、 源码地址：https://github.com/Jszgw/QuickIndexBar