乐者为王

Do one thing, and do it well.

创建Android自定义键盘

在应用中,为了能够快捷地输入字符,我们有时需要使用特殊的软键盘,就像下图显示的那样。这是如何实现的呢?下面就来做个实例详解。

注意,这篇文章不是教你如何创建输入法,如果你想创建自己的输入法,可以研究文章Creating an Input Method和Android Sample中的SoftKeyboard项目。

在Android中创建软键盘是非常容易的,通过android.inputmethodservice.Keyboard类就可以实现。该类从XML文件中读取软键盘信息,有多少行,每行有多少按键,每个按键代表什么内容等。下面是软键盘的XML代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?xml version="1.0" encoding="utf-8"?>
<Keyboard xmlns:android="http://schemas.android.com/apk/res/android"
    android:keyWidth="25%p"
    android:horizontalGap="0px"
    android:verticalGap="0px"
    android:keyHeight="@dimen/key_height">
    <Row>
        <Key android:codes="49" android:keyLabel="1" />
        <Key android:codes="50" android:keyLabel="2" />
        <Key android:codes="51" android:keyLabel="3" />
        <Key android:codes="57419"
            android:keyEdgeFlags="right"
            android:keyIcon="@drawable/sym_keyboard_left" />
    </Row>
    <Row>
        <Key android:codes="52" android:keyLabel="4" />
        <Key android:codes="53" android:keyLabel="5" />
        <Key android:codes="54" android:keyLabel="6" />
        <Key android:codes="57421"
            android:keyEdgeFlags="right"
            android:keyIcon="@drawable/sym_keyboard_right" />
    </Row>
    <Row>
        <Key android:codes="55" android:keyLabel="7" />
        <Key android:codes="56" android:keyLabel="8" />
        <Key android:codes="57" android:keyLabel="9" />
        <Key android:codes="-5"
            android:keyHeight="@dimen/key_height_large"
            android:keyEdgeFlags="right"
            android:isRepeatable="true"
            android:keyIcon="@drawable/sym_keyboard_delete" />
    </Row>
    <Row>
        <Key android:codes="-3" android:keyIcon="@drawable/sym_keyboard_done" />
        <Key android:codes="48" android:keyLabel="0" />
        <Key android:codes="88" android:keyLabel="X" />
    </Row>
</Keyboard>

在上面的键盘定义中,Row元素说明这是一行按键的定义,Key元素说明这是一个按键的定义。Key元素通过一些属性来定义每个按键,下面是一些常用的属性介绍:

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

然后在main.xml文件末尾加入以下代码:

1
2
3
4
5
6
7
8
9
10
11
12
<RelativeLayout
    android:layout_width="fill_parent"
    android:layout_height="wrap_content">
    <android.inputmethodservice.KeyboardView
        android:id="@+id/keyboard_view"
        android:visibility="gone"
        android:focusable="true"
        android:focusableInTouchMode="true"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:layout_alignParentBottom="true" />
</RelativeLayout>

下面是主要的处理代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
public class MainActivity extends Activity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);

        EditText edit = (EditText)findViewById(R.id.edit);
        edit.setInputType(InputType.TYPE_NULL);
        edit.setOnClickListener(new OnClickListener() {
            @Override
            public void onClick(View v) {
                showKeyboard();
            }
        });

        KeyboardView keyboardView = (KeyboardView)findViewById(R.id.keyboard_view);
        keyboardView.setKeyboard(new Keyboard(this, R.xml.qwerty));
        keyboardView.setEnabled(true);
        keyboardView.setPreviewEnabled(true);
        keyboardView.setOnKeyboardActionListener(new OnKeyboardActionListener() {
            @Override
            public void onKey(int primaryCode, int[] keyCodes) {
                Editable editable = edit.getText();
                int start = edit.getSelectionStart();
                if (primaryCode == Keyboard.KEYCODE_CANCEL) {
                    hideKeyboard();
                } else if (primaryCode == Keyboard.KEYCODE_DELETE) {
                    if (editable != null && editable.length() > 0) {
                        editable.delete(start - 1, start);
                    }
                } else if (primaryCode == 57419) {    // go left
                    if (start > 0) {
                        edit.setSelection(start - 1);
                    }
                } else if (primaryCode == 57421) {    // go right
                    if (start < edit.length()) {
                        edit.setSelection(start + 1);
                    }
                } else {
                    editable.insert(start, Character.toString((char)primaryCode));
                }
            }
        });
    }

    private void showKeyboard() {
        int visibility = keyboardView.getVisibility();
        if (visibility == View.GONE || visibility == View.INVISIBLE) {
            keyboardView.setVisibility(View.VISIBLE);
        }
    }

    private void hideKeyboard() {
        int visibility = keyboardView.getVisibility();
        if (visibility == View.VISIBLE) {
            keyboardView.setVisibility(View.INVISIBLE);
        }
    }
}

至此,一个自定义的软键盘就大功告成了。

Comments