インプットメソッドを作成する

インプットメソッドエディタ（IME）は、ユーザーがテキストを入力できるようにするユーザーコントロールです。Android は、拡張可能なインプットメソッドフレームワークを備えています。これにより、画面キーボードや音声入力など、代替インプットメソッドをユーザーに提供するアプリを作成できます。ユーザーは、目的の IME をインストールした後、使用する IME をシステム設定から選択することで、その IME をシステムレベルで使用できます。一度に有効にできる IME は 1 つだけです。

IME を Android システムに追加するには、InputMethodService を拡張するクラスを含む Android アプリを作成します。また、通常は、オプションを IME サービスに渡す「設定」アクティビティを作成します。設定 UI を定義して、システム設定の一部として表示することもできます。

このガイドでは、以下の内容について説明します。

IME のライフサイクル
アプリマニフェスト内で IME コンポーネントを宣言する
IME API
IME UI を設計する
IME からアプリにテキストを送信する
IME サブタイプを作成する

これまでに IME の開発を行ったことがない場合は、まず、オンスクリーンインプットメソッドの紹介記事をご覧ください。

IME のライフサイクル

IME のライフサイクルを以下の図に示します。

図 1. IME のライフサイクル

以下のセクションでは、このライフサイクルに沿って、IME に関連付けられる UI とコードを実装する方法について説明します。

マニフェスト内で IME コンポーネントを宣言する

Android システムにおける IME は、特別な IME サービスを含む Android アプリです。アプリのマニフェストファイルは、サービスを宣言し、必要な権限をリクエストして、action.view.InputMethod アクションに合致するインテントフィルタと、IME の特性を定義するメタデータを提供する必要があります。また、システム設定から起動できる「設定」アクティビティを定義することで、ユーザーが IME の動作を変更できる設定インターフェースを提供できます。

IME サービスを宣言するスニペットを以下に示します。このスニペットは、サービスが IME をシステムに接続できるようにする BIND_INPUT_METHOD 権限をリクエストして、android.view.InputMethod アクションに合致するインテントフィルタを設定し、IME のメタデータを定義します。

<!-- Declares the input method service -->
<service android:name="FastInputIME"
    android:label="@string/fast_input_label"
    android:permission="android.permission.BIND_INPUT_METHOD">
    <intent-filter>
        <action android:name="android.view.InputMethod" />
    </intent-filter>
    <meta-data android:name="android.view.im"
               android:resource="@xml/method" />
</service>

IME 用の設定アクティビティを宣言するスニペットを以下に示します。このスニペットには、対象アクティビティが IME アプリのメインエントリポイントであることを示す ACTION_MAIN のインテントフィルタがあります。

<!-- Optional: an activity for controlling the IME settings -->
<activity android:name="FastInputIMESettings"
    android:label="@string/fast_input_settings">
    <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
    </intent-filter>
</activity>

また、直接 UI から IME の設定にアクセスできるようにすることも可能です。

インプットメソッド API

IME に固有のクラスは、android.inputmethodservice パッケージと android.view.inputmethod パッケージに含まれています。キーボード文字を処理するうえでは、KeyEvent クラスが重要です。

IME の中心部分は、サービスコンポーネントです。これは、InputMethodService を拡張するクラスです。このクラスは、通常のサービスライフサイクルを実装する機能に加えて、IME の UI を提供し、ユーザー入力を処理し、現在フォーカスがあるフィールドにテキストを配信するためのコールバックを備えています。デフォルトでは、IME の状態と表示設定を管理して現在の入力フィールドと通信するための実装のほとんどの部分は、InputMethodService クラスによって提供されます。

以下のクラスも重要です。

BaseInputConnection: InputMethod からその入力を受信するアプリへの通信チャネルを定義します。このクラスを使用すると、カーソルの周囲のテキストを読み取り、テキストボックスにテキストをコミットし、未加工のキーイベントをアプリに送信できます。アプリは、InputConnection ベースインターフェースを実装するのではなく、このクラスを拡張する必要があります。
KeyboardView: キーボードをレンダリングし、ユーザー入力イベントに応答する View の拡張です。キーボードレイアウトは、XML ファイルで定義可能な Keyboard のインスタンスによって指定します。

インプットメソッド UI を設計する

IME には、入力ビューと候補ビューという 2 つの主要な視覚要素があります。実装する必要があるのは、設計するインプットメソッドに関係する要素だけです。

入力ビュー

入力ビューは、キークリック、手書き、ジェスチャーなどを介してユーザーがテキストを入力する UI です。IME が初めて表示されたとき、システムは onCreateInputView() コールバックを呼び出します。このメソッドの実装で、IME ウィンドウ内に表示するレイアウトを作成し、システムにレイアウトを返します。onCreateInputView() メソッドを実装する例を以下のスニペットに示します。

Kotlin

override fun onCreateInputView(): View {
    return layoutInflater.inflate(R.layout.input, null).apply {
        if (this is MyKeyboardView) {
            setOnKeyboardActionListener(this@MyInputMethod)
            keyboard = latinKeyboard
        }
    }
}

Java

@Override
public View onCreateInputView() {
    MyKeyboardView inputView =
        (MyKeyboardView) getLayoutInflater().inflate(R.layout.input, null);

    inputView.setOnKeyboardActionListener(this);
    inputView.setKeyboard(latinKeyboard);

    return inputView;
}

この例の MyKeyboardView は、Keyboard をレンダリングする KeyboardView のカスタム実装のインスタンスです。

候補ビュー

候補ビューは、ユーザーが選択できる単語の修正候補または入力提案を IME が表示する UI です。IME ライフサイクルの中で、候補ビューを表示する準備が整うと、システムは onCreateCandidatesView() を呼び出します。このメソッドの実装で、単語の候補を表示する場合はレイアウトを返し、何も表示しない場合は null を返します。デフォルトの動作は null 応答であるため、候補を提示しないのであれば、このメソッドを実装する必要はありません。

UI 設計に関する考慮事項

このセクションでは、IME の UI 設計に関する考慮事項について説明します。

さまざまな画面サイズを処理する

IME の UI は、さまざまな画面サイズに合わせて拡大縮小できる必要があります。また、横向きと縦向きの両方を処理できる必要があります。非フルスクリーン IME モードでは、テキストフィールドおよび関連コンテキストをアプリが表示するのに十分なスペースを残し、IME が占有する領域を画面の半分以下にします。フルスクリーン IME モードの場合、この点は問題になりません。

さまざまな入力タイプを処理する

Android テキストフィールドでは、自由形式テキスト、数字、URL、メールアドレス、検索文字列など、さまざまな入力タイプを個々に設定できます。新しい IME を実装する場合、各フィールドの入力タイプを検出して、その入力タイプに適したインターフェースを提供する必要があります。ただし、IME を設定することにより、ユーザーが入力タイプに対して有効なテキストを入力したかどうかをチェックする必要はありません。そうしたチェックを行うのは、テキストフィールドを所有するアプリの役割です。

たとえば、次のスクリーンショットは、Android プラットフォームに組み込まれている Latin IME が、テキスト入力および電話番号入力用に提供するインターフェースを示しています。

図 2. Latin IME の入力タイプ

入力フィールドがフォーカスを受け取って IME が起動されると、システムは onStartInputView() を呼び出し、入力タイプと各種のテキストフィールド属性に関する詳細情報を格納した EditorInfo オブジェクトを渡します。このオブジェクトの inputType フィールドに、テキストフィールドの入力タイプが格納されています。

inputType フィールドは、さまざまな入力タイプ設定のビットパターンを格納する int です。テキストフィールドの入力タイプをテストするには、次のように TYPE_MASK_CLASS 定数でマスキングします。

Kotlin

inputType and InputType.TYPE_MASK_CLASS

Java

inputType & InputType.TYPE_MASK_CLASS

入力タイプのビットパターンには、次のような値を指定できます。

TYPE_CLASS_NUMBER: 数値を入力するためのテキストフィールド。上記のスクリーンショットに示されているように、Latin IME は、このタイプのフィールドに対してテンキーを表示します。
TYPE_CLASS_DATETIME: 日時を入力するためのテキストフィールド。
TYPE_CLASS_PHONE: 電話番号を入力するためのテキストフィールド。
TYPE_CLASS_TEXT: サポートされているすべての文字を入力するためのテキストフィールド。

各定数の詳細については、InputType のリファレンスドキュメントをご覧ください。

inputType フィールドには、以下のようなテキストフィールドタイプのバリアントを示す別のビットを含めることができます。

TYPE_TEXT_VARIATION_PASSWORD: パスワードを入力するための TYPE_CLASS_TEXT のバリアント。インプットメソッドは、実際のテキストの代わりに装飾記号を表示します。
TYPE_TEXT_VARIATION_URI: ウェブ URL と各種の URI（Uniform Resource Identifier）を入力するための TYPE_CLASS_TEXT のバリアント。
TYPE_TEXT_FLAG_AUTO_COMPLETE: 辞書や検索などの機能に基づいてアプリが「オートコンプリート」するテキストを入力するための TYPE_CLASS_TEXT のバリアント。

このようなバリアントをテストする際は、必ず適切な定数を使用して inputType をマスキングするようにしてください。利用可能なマスク定数のリストについては、InputType のリファレンスドキュメントをご覧ください。

注: 独自の IME でパスワードフィールドにテキストを送信する場合は、必ずテキストを適切に処理してください。UI 内の入力ビューと候補ビューの両方で、パスワードを非表示にします。また、パスワードをデバイスに保存しないでください。詳細については、セキュリティの設計ガイドをご覧ください。

テキストをアプリに送信する

ユーザーが IME を使用してテキストを入力した場合、個々のキーイベントを送信するか、アプリのテキストフィールド内でカーソルの周囲のテキストを編集することにより、アプリにテキストを送信できます。どちらの場合も、InputConnection のインスタンスを使用してテキストを送信します。このインスタンスを取得するには、InputMethodService.getCurrentInputConnection() を呼び出します。

カーソルの周囲のテキストを編集する

テキストフィールド内の既存テキストの編集を処理する場合、BaseInputConnection にある以下のメソッドが役に立ちます。

getTextBeforeCursor(): 現在のカーソル位置の前にある、指定された数の文字を格納する CharSequence を返します。
getTextAfterCursor(): 現在のカーソル位置の後ろにある、指定された数の文字を格納する CharSequence を返します。
deleteSurroundingText(): 現在のカーソル位置の前後にある、指定された数の文字を削除します。
commitText(): テキストフィールドに CharSequence をコミットして、新しいカーソル位置を設定します。

たとえば、次のスニペットは、カーソルの左側にある 4 文字を「Hello!」というテキストに置き換える方法を示しています。

Kotlin

currentInputConnection.also { ic: InputConnection ->
    ic.deleteSurroundingText(4, 0)
    ic.commitText("Hello", 1)
    ic.commitText("!", 1)
}

Java

InputConnection ic = getCurrentInputConnection();
ic.deleteSurroundingText(4, 0);
ic.commitText("Hello", 1);
ic.commitText("!", 1);

コミット前にテキストを構成する

IME がテキスト予測を行う場合、または記号や単語を構成するのに複数のステップを必要とする場合は、ユーザーが単語をコミットするまでテキストフィールドに途中経過を表示し、コミット後に、部分的な構成テキストを完全なテキストに置き換えることができます。また、setComposingText() にテキストを渡す際に「span」を追加して、テキストに特別な処理を施すことができます。

テキストフィールドに途中経過を表示するスニペットを以下に示します。

Kotlin

currentInputConnection.also { ic: InputConnection ->
    ic.setComposingText("Composi", 1)
    ic.setComposingText("Composin", 1)
    ic.commitText("Composing ", 1)
}

Java

InputConnection ic = getCurrentInputConnection();
ic.setComposingText("Composi", 1);
ic.setComposingText("Composin", 1);
ic.commitText("Composing ", 1);

次のスクリーンショットは、途中経過がユーザーにどのように表示されるかを示しています。

図 3. コミット前にテキストを構成する

ハードウェアキーイベントをインターセプトする

インプットメソッドウィンドウは明示的なフォーカスを持ちませんが、ハードウェアキーイベントを最初に受け取ったとき、それを使用するかアプリに転送するかを選択できます。たとえば、入力中に候補を選択できるように、方向キーを使用して UI 内を移動できるように設定できます。また、戻るキーをトラップして、インプットメソッドウィンドウから発生したポップアップを閉じることもできます。

ハードウェアキーをインターセプトするには、onKeyDown() と onKeyUp() をオーバーライドします。

自分自身で処理しないキーについては、必ず super() メソッドを呼び出してください。

IME サブタイプを作成する

サブタイプを使用すると、IME は、IME がサポートする複数の入力モードと言語をエクスポーズできます。サブタイプは、以下を表現することができます。

en_US や fr_FR などのロケール。
音声、キーボード、手書きなどの入力モード。
テンキーや QWERTY キーボードレイアウトなど、IME に固有のその他の入力スタイル、フォーム、プロパティ。

基本的に、モードには任意のテキスト（「keyboard」、「voice」など）を使用できます。また、サブタイプはこれらのさまざまな組み合わせもエクスポーズできます。

サブタイプ情報は、通知バーから利用できる IME 切り替えダイアログのほか、IME 設定でも使用されます。また、この情報により、フレームワークは IME の特定のサブタイプを直接表示できます。IME を作成するときは、サブタイプ機能を使用してください。サブタイプは、ユーザーがさまざまな IME の言語とモードを識別して切り替える際に役立ちます。

サブタイプを定義する際は、インプットメソッドのいずれかの XML リソースファイルで <subtype> 要素を使用します。次のスニペットでは、2 つのサブタイプ（「米国の英語」ロケールのキーボードサブタイプと、「フランスのフランス語」ロケールのキーボードサブタイプ）を持つ IME を定義しています。

<input-method xmlns:android="http://schemas.android.com/apk/res/android"
        android:settingsActivity="com.example.softkeyboard.Settings"
        android:icon="@drawable/ime_icon">
    <subtype android:name="@string/display_name_english_keyboard_ime"
            android:icon="@drawable/subtype_icon_english_keyboard_ime"
            android:imeSubtypeLanguage="en_US"
            android:imeSubtypeMode="keyboard"
            android:imeSubtypeExtraValue="somePrivateOption=true" />
    <subtype android:name="@string/display_name_french_keyboard_ime"
            android:icon="@drawable/subtype_icon_french_keyboard_ime"
            android:imeSubtypeLanguage="fr_FR"
            android:imeSubtypeMode="keyboard"
            android:imeSubtypeExtraValue="foobar=30,someInternalOption=false" />
    <subtype android:name="@string/display_name_german_keyboard_ime" ... />
</input-method>

サブタイプが UI 内で正しくラベル付けされるようにするには、%s を使用して、サブタイプのロケールラベルと同じサブタイプラベルを取得します。これは、以下の 2 つのスニペットで示されています。最初のスニペットは、インプットメソッドの XML ファイルの一部を示しています。

<subtype
    android:label="@string/label_subtype_generic"
    android:imeSubtypeLocale="en_US"
    android:icon="@drawable/icon_en_us"
    android:imeSubtypeMode="keyboard" />

次のスニペットは、IME の strings.xml ファイルの一部を示しています。サブタイプのラベルを設定する際にインプットメソッド UI 定義が使用する label_subtype_generic 文字列リソースは、次のように定義されています。

<string name="label_subtype_generic">%s</string>

この設定により、サブタイプの表示名とロケール設定が一致します。たとえば、「米国の英語」ロケールの場合、表示名は「英語（米国）」になります。

通知バーから IME サブタイプを選択する

Android システムは、すべての IME がエクスポーズするすべてのサブタイプを管理します。IME サブタイプは、それが属する IME のモードとして扱われます。通知バーで、現在設定されている IME の利用可能なサブタイプを選択できます。次のスクリーンショットをご覧ください。

図 4. 通知バーから IME サブタイプを選択する

図 5. システム設定でサブタイプを設定する

システム設定から IME サブタイプを選択する

ユーザーは、システム設定領域の「言語と入力」設定パネルで、サブタイプの使用方法を指定できます。

図 6. IME の言語を選択する

IME サブタイプを切り替える

地球の形をした言語アイコンなどの切り替えキーをキーボードの一部として提供すると、複数の IME サブタイプをユーザーが簡単に切り替えられるようにすることができます。これにより、キーボードの操作性が大幅に向上し、ユーザーの不満を取り除くことができます。このような切り替え機能を有効にする手順は次のとおりです。

インプットメソッドの XML リソースファイル内で、supportsSwitchingToNextInputMethod = "true" を宣言します。この宣言は、次のスニペットのようになります。

<input-method xmlns:android="http://schemas.android.com/apk/res/android"
        android:settingsActivity="com.example.softkeyboard.Settings"
        android:icon="@drawable/ime_icon"
        android:supportsSwitchingToNextInputMethod="true">

shouldOfferSwitchingToNextInputMethod() メソッドを呼び出します。
メソッドが true を返した場合は、切り替えキーを表示します。
ユーザーが切り替えキーをタップしたら、switchToNextInputMethod() を呼び出して、2 番目のパラメータに false を渡します。値が false の場合、サブタイプがどの IME に属しているかにかかわらず、すべてのサブタイプを平等に扱うようシステムに指示します。true が指定された場合は、現在の IME 内でサブタイプを循環させる必要があります。

注: Android 5.0（API レベル 21）より前のバージョンの場合、switchToNextInputMethod() は supportsSwitchingToNextInputMethod 属性を認識しません。ユーザーが切り替えキーを使用せずに IME を切り替えると、その IME から抜け出せず、別の IME に簡単に切り替えられなくなる場合があります。

IME に関する一般的な考慮事項

IME を実装する際は、以下の点も考慮してください。

IME の UI から直接オプションを設定する方法をユーザーに提供します。
デバイスに複数の IME がインストールされている可能性があるので、直接インプットメソッド UI から別の IME に切り替える方法をユーザーに提供します。
IME の UI をすばやく表示します。ユーザーがテキストフィールドをタップしたらすぐに IME が表示されるように、大きなリソースはプリロードするか、オンデマンドで読み込みます。その後のインプットメソッドの呼び出しに備えて、リソースとビューをキャッシュに保存します。
逆に、インプットメソッドウィンドウが非表示になったら、大きなメモリ割り当てをすぐに解放する必要があります。これにより、アプリを実行するために十分なメモリを確保できます。IME が数秒間、非表示状態になった場合は、遅延メッセージを使用してリソースを解放することをおすすめします。
IME に関連付けられている言語またはロケールで、ユーザーが可能な限り多くの文字を入力できるようにします。ユーザーは、パスワードまたはユーザー名で句読文字を使用する可能性があります。ユーザーがパスワードを入力してデバイスにアクセスできるように、IME は多様な文字を提供する必要があります。

インプット メソッドを作成する

IME のライフサイクル

マニフェスト内で IME コンポーネントを宣言する

インプット メソッド API

インプット メソッド UI を設計する

入力ビュー

Kotlin

Java

候補ビュー

UI 設計に関する考慮事項

さまざまな画面サイズを処理する

さまざまな入力タイプを処理する

Kotlin

Java

テキストをアプリに送信する

カーソルの周囲のテキストを編集する

Kotlin

Java

コミット前にテキストを構成する

Kotlin

Java

ハードウェア キーイベントをインターセプトする

IME サブタイプを作成する

通知バーから IME サブタイプを選択する

システム設定から IME サブタイプを選択する

IME サブタイプを切り替える

IME に関する一般的な考慮事項

インプットメソッドを作成する

インプットメソッド API

インプットメソッド UI を設計する

ハードウェアキーイベントをインターセプトする