2018-03-20 Android自定义键盘的简单实现

概述

转载:http://blog.csdn.net/tianzhaoai/article/details/64130332
突然发现好多软件都使用了自己定义的软键盘。自己就想着先把这块坑先踩踩把,以后掉坑的时候不至于摔的太惨。言归正传,对于自定义软键盘。需要用到系统提供的两个类:Keyboard和KeyboardView。

Keyboard

设计键盘的布局文件,官方上对Keyboard是这么解释的

Loads an XML description of a keyboard and stores the attributes of the keys. 
A keyboard consists of rows of keys.The layout file for a keyboard contains XML that looks like the following snippet:

也就是说这个Keyboard是一个xml文件,可以用来进行键盘的布局,格式如下:


     
         
         ...
     
     ...
 

下面是Keyboard描述键盘时的一些常用属性介绍

属性 描述
codes 按键对应的输出值,可以为unicode值或则逗号(,)分割的多个值,也可以为一个字 符串。在字符串中通过“\”来转义特殊字符,例如 ‘\n’ 或则 ‘\uxxxx’ 。Codes通常用来定义该键的键码,例如上图中的数字按键1对应的为49;如果提供的是逗号分割的多个值则和普通手机输入键盘一样在多个值之间切换
keyLabel 按键显示的文本内容
keyIcon 按键显示的图标内容,如果指定了该值则在显示的时候显示为图片不显示文本
keyWidth 按键的宽度,可以为精确值或则相对值,对于精确值支持多种单位,例如:像素,英寸 等;相对值为相对于基础取值的百分比,为以% 或则%p 结尾,其中%p表示相对于父容器
keyHeight 按键的高度,取值同keyWidth
horizontalGap 按键前的间隙(水平方向),取值取值同keyWidth
isSticky 按键是否为sticky的。例如Shift大小写切换按键,具有两种状态,按下状态和正常状态,取值为true或则false
isModifier 按键是否为功能键( modifier key ) ,例如 Alt 或则 Shift 。取值为true或则false
keyOutputText 按键输出的文本内容,取值为字符串
isRepeatable 按键是否是可重复的,如果长按该键可以触发重复按键事件则为true,否则为false
keyEdgeFlags 按键的对齐指令,取值为left或则right

KeyboardView

处理绘制,检测按键,触摸动作等

A view that renders a virtual Keyboard. It handles rendering of keys and detecting key presses and touch movements.

在这里渲染虚拟键盘的视图,并且处理按键的触摸和移动等操作。在Activity的布局文件中可以这样定义


下面介绍一些KeyboardView的属性

属性 描述
android:keyBackground 键的背景图
android:keyPreviewLayout 击键盘上的某个键时,短暂弹出的提示布局文件
android:keyPreviewOffset 击键盘上的某个键时,短暂弹出布局的垂直偏移量
android:keyTextColor 按键中的keyLabel的颜色
android:keyTextSize 按键中的keyLabel的大小
android:labelTextSize 如果有图片时,按键中的keyLabel的大小
android:popupLayout 弹出键盘的布局文件
android:verticalCorrection 补偿触摸Y坐标的偏移量,用于偏移校正

基本实现

一、定义键盘的键

自己定义的xml键盘布局位于res–>xml文件目录下


2018-03-20 Android自定义键盘的简单实现_第1张图片
这里写图片描述

键盘上键的细节和它的位置我们指定在一个xml文件中,每一个键都有自己的属性。

  • keyLabel 这个属性是指每个键显示的文本
  • codes 这个属性是指这个键代表的字符的unicode

比如我们自己定义一个数字1,则他的codes属性的值是49,keyLabel属性的值就是1。

如果一个code对应多个key,这个key代表的字符取决于这个key接受到的点击数taps,例如,一个键具有49,50,51编码:

  • 一次点击就是 1
  • 两次点击就是 2
  • 三次点击就是 3

每个键都可以设置自己的属性,这里就不一一赘述了。当然,一般情况下键盘上每行的按键尽量都控制10个或10个以内,要不然影响用户体验,每行都使用进行分行。

一般自己定义的code都为负数,比如-5代表删除,-1代表shift切换等。

数字键盘number.xml



    
        
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
    

英文键盘letter.xml



    
        
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
    

符号键盘symbol.xml



    
        
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
        
        
    
    
        
        
        
        
        
        
        
    

二、处理按键

OnKeyboardActionListener

在KeyboardView类里面有专门处理Keyboard的监听类OnKeyboardActionListener

public class KeyboardView extends View implements View.OnClickListener {

    ......

    /**
     * Listener for virtual keyboard events.
     */
    public interface OnKeyboardActionListener {

        /**
         * 当用户按下一个键时调用。 这是在调用onKey之前。
         * 对于重复的键,此键仅调用一次。
         * @param primaryCode被按下的键的unicode。如果触摸不在有效范围内,值将为零。
         */
        void onPress(int primaryCode);

        /**
         * 当用户释放键时调用。 这是在调用onKey之后。
         * 对于重复的键,此键仅调用一次。
         * @param primaryCode被释放的键的unicode
         */
        void onRelease(int primaryCode);

        /**
         * 发送一个按键到监听器
         * @ param primaryCode这是按下的键
         * @ param keyCodes所有可能的替代键的代码,
         */
        void onKey(int primaryCode, int[] keyCodes);

        /**
         * 向侦听器发送一系列字符。
         * @param text 要显示的字符序列。
         */
        void onText(CharSequence text);

        /**
         * 当用户从右向左快速移动手指时调用。
         */
        void swipeLeft();

        /**
         * 当用户从左向右快速移动手指时调用。
         */
        void swipeRight();

        /**
         * 当用户从上到下快速移动手指时调用。
         */
        void swipeDown();

        /**
         * 当用户快速将手指从下向上移动时调用。
         */
        void swipeUp();
    }

    ......

}

我们自己实现OnKeyboardActionListener接口,即可处理对键盘的操作。主要实现了onKey方法。在这个方法里通过传入的primaryCode进行相应的操作,如

  • 如果code是 KEYCODE_DELETE 使用Editable.delete方法删除光标左边的字符
  • 如果code是 KEYCODE_SHIFT boolean类型的isUpper的值会被改变,并且使用 setShifted() 方法改变键盘的换档状态(shift state),当状态改变时,键盘需要重绘,所以的键的label被更新了,invalidateAllKeys() 方法用来重绘所有的键
  • 对于其他所有的codes,只是简单的将unicode转化为字符并且使用Editable.insert()方法插入到输入框里即可,如果这个code代表了字母表里的一个字母,并且isUpper变量为true,那么还需要将字母转化为大写
  • 若code为负数的话,只需要根据自己的定义,进行相应的处理即可,例如-8代表省略号,-10代表笑脸等。
public class KeyboardUtil {

    ...

    private static final int SYMBOL_CODE = -7;//符号键盘
    private static final int ELLIPSES_CODE = -8;//省略号
    private static final int CHINESE_HORIZONTAL_LINE_CODE = -9;//中文横线
    private static final int SMILING_FACE_CODE = -10;//笑脸
    private static final int LEFT_CODE = -11;//中文横线
    private static final int RIGHT_CODE = -12;//中文横线
    private static final int HEE_CODE = -13;//哈哈
    private static final int AWKWARD_CODE = -14;//尴尬

 OnKeyboardActionListener onKeyboardActionListener = new OnKeyboardActionListener() {
        @Override
        public void swipeUp() {
        }

        @Override
        public void swipeRight() {
        }

        @Override
        public void swipeLeft() {
        }

        @Override
        public void swipeDown() {
        }

        @Override
        public void onText(CharSequence text) {
        }

        @Override
        public void onRelease(int primaryCode) {
        }

        @Override
        public void onPress(int primaryCode) {
        }

        @Override
        public void onKey(int primaryCode, int[] keyCodes) {
            Editable editable = ed.getText();
            int start = ed.getSelectionStart();
            if (primaryCode == Keyboard.KEYCODE_CANCEL) {// 完成
                hideKeyboard();
            } else if (primaryCode == Keyboard.KEYCODE_DELETE) {// 回退
                if (editable != null && editable.length() > 0) {
                    if (start > 0) {
                        editable.delete(start - 1, start);
                    }
                }
            } else if (primaryCode == Keyboard.KEYCODE_SHIFT) {// 大小写切换
                isUpper = !isUpper;
                k1.setShifted(isUpper);
                keyboardView.invalidateAllKeys();
            } else if (primaryCode == SYMBOL_CODE) {// 符号键盘
                if (isSymbol) {
                    isSymbol = false;
                    keyboardView.setKeyboard(k2);
                } else {
                    isSymbol = true;
                    keyboardView.setKeyboard(k3);
                }
            } else if (primaryCode == Keyboard.KEYCODE_MODE_CHANGE) {// 数字键盘切换
                if (isNum) {
                    isNum = false;
                    keyboardView.setKeyboard(k1);
                } else {
                    isNum = true;
                    keyboardView.setKeyboard(k2);
                }
            } else if (primaryCode == LEFT_CODE) { //向左
                if (start > 0) {
                    ed.setSelection(start - 1);
                }
            } else if (primaryCode == RIGHT_CODE) { // 向右
                if (start < ed.length()) {
                    ed.setSelection(start + 1);
                }
            } else if (primaryCode == ELLIPSES_CODE) { //省略号
                editable.insert(start, "...");
            } else if (primaryCode == CHINESE_HORIZONTAL_LINE_CODE) {
                editable.insert(start, "——");
            } else if (primaryCode == SMILING_FACE_CODE) {
                editable.insert(start, "^_^");
            } else if (primaryCode == HEE_CODE) {
                editable.insert(start, "^o^");
            } else if (primaryCode == AWKWARD_CODE) {
                editable.insert(start, ">_<");
            } else {
                String str = Character.toString((char) primaryCode);
                if (isWord(str)) {
                    if (isUpper) {
                        str = str.toUpperCase();
                    } else {
                        str = str.toLowerCase();
                    }
                }
                editable.insert(start, str);

            }
        }
    };

    ...

}

KeyboardUtil

这里自定义了一个键盘的工具类KeyboardUtil

import android.app.Activity;
import android.inputmethodservice.Keyboard;
import android.inputmethodservice.KeyboardView;
import android.inputmethodservice.KeyboardView.OnKeyboardActionListener;
import android.text.Editable;
import android.view.ViewGroup;
import android.widget.EditText;
import android.widget.RelativeLayout;

public class KeyboardUtil {
    private KeyboardView keyboardView;
    private Keyboard k1;// 字母键盘
    private Keyboard k2;// 数字键盘
    private Keyboard k3;// 符号键盘
    private boolean isNum = false;// 是否数据键盘
    private boolean isUpper = false;// 是否大写
    private boolean isSymbol = false;// 是否符号

    private static final int SYMBOL_CODE = -7;//符号键盘
    private static final int ELLIPSES_CODE = -8;//省略号
    private static final int CHINESE_HORIZONTAL_LINE_CODE = -9;//中文横线
    private static final int SMILING_FACE_CODE = -10;//笑脸
    private static final int LEFT_CODE = -11;//中文横线
    private static final int RIGHT_CODE = -12;//中文横线
    private static final int HEE_CODE = -13;//哈哈
    private static final int AWKWARD_CODE = -14;//尴尬

    private ViewGroup rootView;
    private EditText ed;

    private KeyboardUtil(Activity activity, EditText edit) {
        this.ed = edit;
        k1 = new Keyboard(activity, R.xml.letter);
        k2 = new Keyboard(activity, R.xml.number);
        k3 = new Keyboard(activity, R.xml.symbol);

        keyboardView = new KeyboardView(activity, null);
        keyboardView.setKeyboard(k1);
        keyboardView.setEnabled(true);
        keyboardView.setPreviewEnabled(false);
        keyboardView.setOnKeyboardActionListener(onKeyboardActionListener);

        rootView = (ViewGroup) ((ViewGroup) activity.findViewById(android.R.id.content)).getChildAt(0);

    }

    OnKeyboardActionListener onKeyboardActionListener = new OnKeyboardActionListener() {
        @Override
        public void swipeUp() {
        }

        @Override
        public void swipeRight() {
        }

        @Override
        public void swipeLeft() {
        }

        @Override
        public void swipeDown() {
        }

        @Override
        public void onText(CharSequence text) {
        }

        @Override
        public void onRelease(int primaryCode) {
        }

        @Override
        public void onPress(int primaryCode) {
        }

        @Override
        public void onKey(int primaryCode, int[] keyCodes) {
            Editable editable = ed.getText();
            int start = ed.getSelectionStart();
            if (primaryCode == Keyboard.KEYCODE_CANCEL) {// 完成
                hideKeyboard();
            } else if (primaryCode == Keyboard.KEYCODE_DELETE) {// 回退
                if (editable != null && editable.length() > 0) {
                    if (start > 0) {
                        editable.delete(start - 1, start);
                    }
                }
            } else if (primaryCode == Keyboard.KEYCODE_SHIFT) {// 大小写切换
                isUpper = !isUpper;
                k1.setShifted(isUpper);
                keyboardView.invalidateAllKeys();
            } else if (primaryCode == SYMBOL_CODE) {// 符号键盘
                if (isSymbol) {
                    isSymbol = false;
                    keyboardView.setKeyboard(k2);
                } else {
                    isSymbol = true;
                    keyboardView.setKeyboard(k3);
                }
            } else if (primaryCode == Keyboard.KEYCODE_MODE_CHANGE) {// 数字键盘切换
                if (isNum) {
                    isNum = false;
                    keyboardView.setKeyboard(k1);
                } else {
                    isNum = true;
                    keyboardView.setKeyboard(k2);
                }
            } else if (primaryCode == LEFT_CODE) { //向左
                if (start > 0) {
                    ed.setSelection(start - 1);
                }
            } else if (primaryCode == RIGHT_CODE) { // 向右
                if (start < ed.length()) {
                    ed.setSelection(start + 1);
                }
            } else if (primaryCode == ELLIPSES_CODE) { //省略号
                editable.insert(start, "...");
            } else if (primaryCode == CHINESE_HORIZONTAL_LINE_CODE) {
                editable.insert(start, "——");
            } else if (primaryCode == SMILING_FACE_CODE) {
                editable.insert(start, "^_^");
            } else if (primaryCode == HEE_CODE) {
                editable.insert(start, "^o^");
            } else if (primaryCode == AWKWARD_CODE) {
                editable.insert(start, ">_<");
            } else {
                String str = Character.toString((char) primaryCode);
                if (isWord(str)) {
                    if (isUpper) {
                        str = str.toUpperCase();
                    } else {
                        str = str.toLowerCase();
                    }
                }
                editable.insert(start, str);

            }
        }
    };

    private boolean isShow = false;

    public void showKeyboard() {
        if (!isShow) {
            RelativeLayout.LayoutParams layoutParams = new RelativeLayout.LayoutParams(RelativeLayout.LayoutParams.MATCH_PARENT, RelativeLayout.LayoutParams.MATCH_PARENT);
            layoutParams.addRule(RelativeLayout.ALIGN_BOTTOM, RelativeLayout.TRUE);
            rootView.addView(keyboardView, layoutParams);
            isShow = true;
        }
    }

    private void hideKeyboard() {
        if (rootView != null && keyboardView != null && isShow) {
            isShow = false;
            rootView.removeView(keyboardView);
        }
        mInstance = null;
    }

    private boolean isWord(String str) {
        return str.matches("[a-zA-Z]");
    }

    private static KeyboardUtil mInstance;

    public static KeyboardUtil shared(Activity activity, EditText edit) {
        if (mInstance == null) {
            mInstance = new KeyboardUtil(activity, edit);
        }
        mInstance.ed = edit;
        return mInstance;
    }

}

三、MainActivity中的使用

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.text.InputType;
import android.view.View;
import android.widget.EditText;

public class MainActivity extends AppCompatActivity {

    private EditText edit;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        edit = (EditText) this.findViewById(R.id.edit);
        edit.setInputType(InputType.TYPE_NULL);

        edit.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                KeyboardUtil.shared(MainActivity.this,edit).showKeyboard();
            }
        });
    }
}

好了,关于Android的自定义键盘就说到这里,这个只是自定义键盘最简单的使用方式。当然,就算是最简单的方式,想要完整的实现下来也是踩了不少坑的。有时间了在继续踩。这里贴上源码下载

你可能感兴趣的:(2018-03-20 Android自定义键盘的简单实现)