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

インプット メソッド エディタ(IME)は、ユーザーがテキストを入力できるユーザー コントロールです。Android には、アプリが画面キーボードや音声入力などの代替入力方法をユーザーに提供できる、拡張性の高いインプット メソッド フレームワークが用意されています。IME をインストールすると、ユーザーはシステム設定から IME を選択し、システム全体で使用できます。一度に有効にできる IME は 1 つのみです。

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

このページでは、次のトピックについて説明します。

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 をセットアップする必要はありません。これは、テキスト フィールドを所有するアプリケーションが行います。

たとえば、Latin IME が Android プラットフォームのテキスト入力用に提供するインターフェースは次のとおりです。

Latin IME でのテキスト入力を示す画像
図 2. Latin IME テキスト入力。

以下は、ラテン IME が Android プラットフォームの数値入力用に提供するインターフェースです。

ラテン語の IME での数値入力を示す画像
図 3. ラテン文字の 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
数値を入力するためのテキスト フィールド。図 3 に示すように、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 などの Uniform Resource Identifier(URI)を入力するための TYPE_CLASS_TEXT のバリアントです。
TYPE_TEXT_FLAG_AUTO_COMPLETE
辞書や検索などの機能からアプリケーションがオートコンプリートするテキストを入力するための TYPE_CLASS_TEXT のバリアント。

これらのバリアントをテストするときは、適切な定数で inputType をマスクします。使用可能なマスク定数のリストについては、InputType のリファレンス ドキュメントをご覧ください。

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

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

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

既存のテキストの編集を処理する場合、BaseInputConnection には次のような便利なメソッドがあります。

getTextBeforeCursor()
現在のカーソル位置の前にあるリクエストされた文字数を含む CharSequence を返します。
getTextAfterCursor()
現在のカーソル位置の後にリクエストされた文字数を含む CharSequence を返します。
deleteSurroundingText()
現在のカーソル位置の前後にある指定した文字数を削除します。
commitText()
CharSequence をテキスト フィールドに commit し、新しいカーソル位置を設定します。

たとえば、次のスニペットは、カーソルの左側にある 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);

commit 前のテキスト作成のサポート

IME がテキストを予測する場合や、グリフや単語を作成するために複数のステップが必要な場合は、ユーザーが単語を commit するまでテキスト フィールドに進行状況を表示してから、部分的な構成を完成したテキストに置き換えることができます。テキストを setComposingText() に渡す際に、テキストにスパンを追加することで、特別な処理を行うことができます。

次のスニペットは、テキスト フィールドに進行状況を表示する方法を示しています。

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);

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

インプット メソッド ウィンドウには明示的なフォーカスはありませんが、最初にハードウェア キーイベントを受け取り、それを使用したり、アプリに転送したりすることができます。たとえば、方向キーを使用して UI 内を移動し、コンポジション中に候補を選択できます。また、戻るキーをトラップして、インプット メソッド ウィンドウからのダイアログをすべて閉じることもできます。

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

自身で処理しないキーについては、super() メソッドを呼び出します。

IME サブタイプを作成する

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

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

モードには、「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:languageTag="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:languageTag="fr-FR"
            android:imeSubtypeMode="keyboard"
            android:imeSubtypeExtraValue="someVariable=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>

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

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

Android システムは、すべての IME がエクスポーズするすべてのサブタイプを管理します。IME サブタイプは、それが属する IME のモードとして扱われます。次の図に示すように、ユーザーは通知バーまたは設定アプリから、利用可能な IME サブタイプのメニューに移動できます。

[言語と入力] のシステム メニューを示す画像
図 4. [言語と入力] システム メニュー

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

ユーザーは、システム設定の [言語と入力] 設定パネルで、サブタイプの使用方法を制御することもできます。

[言語] 選択メニューを示す画像
図 5. [言語] システム メニュー

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

キーボード上の地球形の言語アイコンなど、切り替えキーを提供することで、ユーザーが IME のサブタイプを簡単に切り替えられるようにします。これにより、キーボードのユーザビリティが向上し、ユーザーにとって便利です。この切り替えを有効にする手順は次のとおりです。

  1. インプット メソッドの 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">
    
  2. shouldOfferSwitchingToNextInputMethod() メソッドを呼び出します。
  3. メソッドが true を返した場合は、切り替えキーを表示します。
  4. ユーザーが切り替えキーをタップしたら、switchToNextInputMethod() を呼び出して false を渡します。値が false の場合、所属する IME に関係なく、すべてのサブタイプを均等に扱うようシステムに指示します。true を指定すると、システムが現在の IME のサブタイプを循環させる必要があります。

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

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

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