Créer un mode de saisie

Un éditeur de mode de saisie (IME) est une commande qui permet aux utilisateurs de saisir du texte. Android fournit un framework de mode de saisie extensible qui permet aux applications de proposer aux utilisateurs d'autres modes de saisie, tels que des claviers à l'écran ou la saisie vocale. Après avoir installé les IME, l'utilisateur peut en sélectionner un dans les paramètres système et l'utiliser sur l'ensemble du système. Vous ne pouvez activer qu'un seul IME à la fois.

Pour ajouter un IME au système Android, créez une application Android contenant une classe qui étend InputMethodService. En outre, vous créez généralement une activité de type "paramètres" qui transmet les options au service IME. Vous pouvez également définir une interface utilisateur de paramètres qui s'affiche dans les paramètres système.

Cette page traite des sujets suivants:

• Cycle de vie des IME
• Déclarer les composants IME dans le fichier manifeste de l'application
• API IME
• Concevoir une interface utilisateur IME
• Envoyer du texte à une application à partir d'un IME
• Utiliser des sous-types d'IME
• Autres points à prendre en compte concernant les IME

Si vous n'avez pas encore utilisé d'IME, commencez par lire l'article d'introduction Modes de saisie à l'écran.

Remarque:À partir d'Android 11, la plate-forme permet aux IME d'afficher des suggestions de saisie automatique intégrées au lieu d'utiliser un menu déroulant. Pour en savoir plus sur la compatibilité des services de saisie automatique avec cette fonctionnalité, consultez Intégrer la saisie automatique à votre IME.

Cycle de vie des IME

Le schéma suivant décrit le cycle de vie d'un IME:

Figure 1 : Cycle de vie d'un IME

Les sections suivantes décrivent comment implémenter l'interface utilisateur et le code associés à un IME qui suit ce cycle de vie.

Déclarer les composants IME dans le fichier manifeste

Dans le système Android, un IME est une application Android qui contient un service IME spécial. Le fichier manifeste de l'application doit déclarer le service, demander les autorisations nécessaires, fournir un filtre d'intent correspondant à l'action action.view.InputMethod et fournir des métadonnées qui définissent les caractéristiques de l'IME. En outre, pour fournir une interface de paramètres qui permet à l'utilisateur de modifier le comportement de l'IME, vous pouvez définir une activité de "paramètres" pouvant être lancée à partir des paramètres système.

L'extrait de code suivant déclare un service IME. Il demande l'autorisation BIND_INPUT_METHOD pour permettre au service de connecter l'IME au système, configure un filtre d'intent correspondant à l'action android.view.InputMethod et définit des métadonnées pour l'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>

L'extrait de code suivant déclare l'activité de paramétrage de l'IME. Il dispose d'un filtre d'intent pour ACTION_MAIN qui indique que cette activité est le point d'entrée principal de l'application IME:

<!-- 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>

Vous pouvez également fournir l'accès aux paramètres de l'IME directement depuis son interface utilisateur.

L'API du mode de saisie

Les classes spécifiques aux IME se trouvent dans les packages android.inputmethodservice et android.view.inputmethod. La classe KeyEvent est importante pour gérer les caractères du clavier.

La partie centrale d'un IME est un composant de service, une classe qui étend InputMethodService. En plus de mettre en œuvre le cycle de vie normal du service, cette classe comporte des rappels permettant de fournir l'UI de votre IME, de gérer les entrées utilisateur et d'envoyer du texte au champ sélectionné. Par défaut, la classe InputMethodService fournit la majeure partie de l'implémentation permettant de gérer l'état et la visibilité de l'IME, et de communiquer avec le champ de saisie actuel.

Les classes suivantes sont également importantes:

BaseInputConnection

Définit le canal de communication entre une InputMethod et l'application qui reçoit son entrée. Elle permet de lire le texte autour du curseur, de valider le texte dans la zone de texte et d'envoyer des événements clés bruts à l'application. Les applications doivent étendre cette classe au lieu d'implémenter l'interface de base InputConnection.

KeyboardView

Extension de View qui affiche un clavier et répond aux événements d'entrée utilisateur. La disposition du clavier est spécifiée par une instance de Keyboard, que vous pouvez définir dans un fichier XML.

Concevoir l'interface utilisateur du mode de saisie

Un IME se compose de deux éléments visuels principaux: la vue input et la vue candidates. Il vous suffit d'implémenter les éléments pertinents pour le mode de saisie que vous concevez.

Vue de la saisie

La vue d'entrée est l'interface utilisateur dans laquelle l'utilisateur saisit du texte sous forme de clics sur des touches, d'écriture manuscrite ou de gestes. Lorsque l'IME est affiché pour la première fois, le système appelle le rappel onCreateInputView(). Dans votre implémentation de cette méthode, créez la mise en page que vous souhaitez afficher dans la fenêtre IME et renvoyez-la au système. L'extrait de code suivant montre un exemple d'implémentation de la méthode 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;
}

Dans cet exemple, MyKeyboardView est une instance d'une implémentation personnalisée de KeyboardView qui affiche un Keyboard.

Vue des candidats

La vue des candidats est l'interface utilisateur dans laquelle l'IME affiche les corrections ou suggestions de mots potentielles que l'utilisateur peut sélectionner. Dans le cycle de vie de l'IME, le système appelle onCreateCandidatesView() lorsqu'il est prêt à afficher la vue des candidats. Dans l'implémentation de cette méthode, renvoyez une mise en page qui affiche des suggestions de mots ou renvoyez la valeur "null" si vous ne souhaitez rien afficher. Une réponse nulle est le comportement par défaut. Vous n'avez donc pas à l'implémenter si vous ne fournissez pas de suggestions.

Considérations relatives à la conception de l'interface utilisateur

Cette section décrit quelques considérations de conception d'interface utilisateur pour les IME.

Gérer plusieurs tailles d'écran

L'UI de votre IME doit pouvoir s'adapter à différentes tailles d'écran et gérer les orientations paysage et portrait. En mode IME qui n'est pas en plein écran, laissez suffisamment d'espace à l'application pour afficher le champ de texte et tout contexte associé, de sorte que l'IME ne soit pas occupé par plus de la moitié de l'écran. En mode IME en plein écran, ce n'est pas un problème.

Gérer différents types d'entrées

Les champs de texte Android vous permettent de définir un type de saisie spécifique, tel que du texte libre, des nombres, des URL, des adresses e-mail et des chaînes de recherche. Lorsque vous implémentez un nouvel IME, détectez le type d'entrée de chaque champ et fournissez l'interface appropriée. Toutefois, vous n'avez pas besoin de configurer votre IME pour vérifier si l'utilisateur saisit du texte valide pour le type d'entrée. Cela relève de la responsabilité de l'application propriétaire du champ de texte.

Par exemple, voici l'interface fournie par l'IME latin pour la saisie de texte de la plate-forme Android:

Figure 2 : Saisie de texte IME latin.

Voici l'interface fournie par l'IME latin pour la saisie numérique de la plate-forme Android:

Figure 3 : Saisie numérique IME latino.

Lorsqu'un champ de saisie est sélectionné et que l'IME démarre, le système appelle onStartInputView(), en transmettant un objet EditorInfo contenant des détails sur le type d'entrée et d'autres attributs du champ de texte. Dans cet objet, le champ inputType contient le type d'entrée du champ de texte.

Le champ inputType est un int contenant des formats de bits pour divers paramètres de type d'entrée. Pour tester le type d'entrée du champ de texte, masquez-le avec la constante TYPE_MASK_CLASS, comme ceci:

Kotlin

inputType and InputType.TYPE_MASK_CLASS

Java

inputType & InputType.TYPE_MASK_CLASS

Le modèle de bits du type d'entrée peut avoir l'une des valeurs suivantes:

TYPE_CLASS_NUMBER

Champ de texte permettant de saisir des chiffres. Comme le montre la figure 3, l'IME latin affiche un pavé numérique pour les champs de ce type.

TYPE_CLASS_DATETIME

Champ de texte permettant de saisir une date et une heure.

TYPE_CLASS_PHONE

Champ de texte permettant de saisir des numéros de téléphone.

TYPE_CLASS_TEXT

Champ de texte permettant de saisir des caractères acceptés.

Ces constantes sont décrites plus en détail dans la documentation de référence de InputType.

Le champ inputType peut contenir d'autres bits indiquant une variante du type de champ de texte, par exemple:

TYPE_TEXT_VARIATION_PASSWORD

Variante de TYPE_CLASS_TEXT pour la saisie de mots de passe. La méthode de saisie affiche des tirets au lieu du texte réel.

TYPE_TEXT_VARIATION_URI

Variante de TYPE_CLASS_TEXT permettant de saisir des URL Web et d'autres URI (Uniform Resource Identifiers).

TYPE_TEXT_FLAG_AUTO_COMPLETE

Variante de TYPE_CLASS_TEXT permettant de saisir du texte saisi automatiquement par l'application à partir d'un dictionnaire, d'une recherche ou d'une autre fonctionnalité.

Masquez inputType avec la constante appropriée lorsque vous testez ces variantes. Les constantes de masque disponibles sont répertoriées dans la documentation de référence pour InputType.

Attention:Dans votre propre IME, gérez correctement le texte lorsque vous l'envoyez à un champ de mot de passe. Masquez le mot de passe dans votre interface utilisateur, à la fois dans la vue de saisie et dans la vue des candidats. Ne stockez pas de mots de passe sur un appareil. Pour en savoir plus, consultez les conseils de sécurité.

Envoyer un SMS à l'application

Lorsque l'utilisateur saisit du texte avec votre IME, vous pouvez envoyer du texte à l'application en envoyant des événements clés individuels ou en modifiant le texte autour du curseur dans le champ de texte de l'application. Dans les deux cas, utilisez une instance de InputConnection pour diffuser le texte. Pour obtenir cette instance, appelez InputMethodService.getCurrentInputConnection().

Modifier le texte autour du curseur

Lorsque vous gérez la modification d'un texte existant, voici quelques méthodes utiles dans BaseInputConnection:

getTextBeforeCursor()

Renvoie un CharSequence contenant le nombre de caractères demandés avant la position actuelle du curseur.

getTextAfterCursor()

Renvoie un CharSequence contenant le nombre de caractères demandés suivant la position actuelle du curseur.

deleteSurroundingText()

Supprime le nombre de caractères spécifié avant et après la position actuelle du curseur.

commitText()

Valide un CharSequence dans le champ de texte et définit une nouvelle position du curseur.

Par exemple, l'extrait de code suivant montre comment remplacer les quatre caractères situés à gauche du curseur par le texte "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);

Prise en charge de la rédaction de texte avant de valider

Si votre IME prédit du texte ou nécessite plusieurs étapes pour composer un glyphe ou un mot, vous pouvez afficher la progression dans le champ de texte jusqu'à ce que l'utilisateur valide le mot. Vous pouvez ensuite remplacer la composition partielle par le texte terminé. Vous pouvez appliquer un traitement spécial au texte en y ajoutant un span lorsque vous le transmettez à setComposingText().

L'extrait de code suivant montre comment afficher la progression dans un champ de texte:

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

Intercepter les événements clés matériels

Même si la fenêtre de mode de saisie n'a pas de ciblage explicite, elle reçoit d'abord les événements de clé matérielle et peut les consommer ou les transférer à l'application. Par exemple, vous pouvez utiliser les touches directionnelles pour naviguer dans votre interface utilisateur lors de la sélection de candidats lors de la composition. Vous pouvez également piéger la touche Retour pour fermer toutes les boîtes de dialogue provenant de la fenêtre de mode de saisie.

Pour intercepter les clés matérielles, remplacez onKeyDown() et onKeyUp().

Appelez la méthode super() pour les clés que vous ne souhaitez pas gérer vous-même.

Créer un sous-type IME

Les sous-types permettent à l'IME d'exposer plusieurs modes de saisie et langues pris en charge par un IME. Un sous-type peut représenter les éléments suivants:

• Des paramètres régionaux, tels que en_US ou fr_FR
• Un mode de saisie (voix, clavier ou écriture manuscrite, par exemple)
• Autres styles de saisie, formulaires ou propriétés spécifiques à l'IME, comme les dispositions de clavier à 10 touches ou QWERTY

Le mode peut être défini sur n'importe quel texte, par exemple "clavier" ou "voix". Un sous-type peut également exposer une combinaison de ces éléments.

Les informations de sous-type sont utilisées pour une boîte de dialogue de commutation IME disponible dans la barre de notification et pour les paramètres IME. Ces informations permettent également au framework d'afficher directement un sous-type spécifique d'un IME. Lorsque vous créez un IME, utilisez la fonction de sous-type, car elle aide l'utilisateur à identifier les différents modes et langues d'IME et à passer de l'un à l'autre.

Elle définit les sous-types dans l'un des fichiers de ressources XML de la méthode d'entrée, à l'aide de l'élément <subtype>. L'extrait de code suivant définit un IME avec deux sous-types: un sous-type de clavier pour les paramètres régionaux en anglais américain et un autre sous-type de clavier pour les paramètres régionaux français pour la France:

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

Pour vous assurer que vos sous-types sont correctement libellés dans l'interface utilisateur, utilisez "%s" pour obtenir un libellé de sous-type identique au libellé des paramètres régionaux du sous-type. C'est ce qu'illustrent les deux extraits de code suivants. Le premier extrait montre une partie du fichier XML de la méthode de saisie:

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

L'extrait suivant fait partie du fichier strings.xml de l'IME. La ressource de chaîne label_subtype_generic, utilisée par la définition de l'interface utilisateur de la méthode de saisie pour définir l'étiquette du sous-type, est définie comme suit:

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

Ce paramètre fait en sorte que le nom à afficher du sous-type corresponde au paramètre régional. Par exemple, dans tous les paramètres régionaux anglais, le nom à afficher est "Anglais (États-Unis)".

Choisissez des sous-types d'IME dans la barre de notification

Le système Android gère tous les sous-types exposés par tous les IME. Les sous-types d'IME sont traités comme des modes de l'IME auquel ils appartiennent. L'utilisateur peut naviguer depuis la barre de notification ou l'application Paramètres vers un menu des sous-types d'IME disponibles, comme illustré dans la figure suivante:

Figure 4 : Menu système Langues et saisie.

Choisissez des sous-types d'IME dans les Paramètres système

L'utilisateur peut également contrôler l'utilisation des sous-types dans le panneau des paramètres Langue et saisie dans les paramètres système:

Figure 5 : Menu système Langues

Passer d'un sous-type d'IME à un autre

Vous pouvez permettre aux utilisateurs de basculer facilement entre les sous-types d'IME en fournissant une touche de basculement, telle que l'icône de langue en forme de globe sur le clavier. Cela améliore la facilité d'utilisation du clavier et est pratique pour l'utilisateur. Pour activer ce basculement, procédez comme suit:

1. Déclarez supportsSwitchingToNextInputMethod = "true" dans les fichiers de ressources XML de la méthode d'entrée. Votre déclaration doit ressembler à l'extrait de code suivant :

   <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. Appelez la méthode shouldOfferSwitchingToNextInputMethod().
3. Si la méthode renvoie la valeur "true", affichez une clé de basculement.
4. Lorsque l'utilisateur appuie sur la touche de basculement, appelez switchToNextInputMethod() en transmettant la valeur "false". La valeur "false" indique au système de traiter tous les sous-types de manière égale, quel que soit l'IME auquel ils appartiennent. Si vous spécifiez "true", le système doit faire défiler les sous-types de l'IME actuel.

Considérations générales liées aux IME

Voici d'autres éléments à prendre en compte lorsque vous implémentez votre IME:

• Permettez aux utilisateurs de définir des options directement à partir de l'interface utilisateur de l'IME.
• Permettez aux utilisateurs de basculer vers un autre IME directement depuis l'interface utilisateur du mode de saisie, car plusieurs IME peuvent être installés sur l'appareil.
• Affichez rapidement l'interface utilisateur de l'IME. Préchargez ou chargez à la demande toutes les ressources volumineuses afin que les utilisateurs voient l'IME dès qu'ils appuient sur un champ de texte. Mettez en cache les ressources et les vues pour les appels suivants de la méthode de saisie.
• Une fois la fenêtre de mode de saisie masquée, libérez les grandes allocations de mémoire immédiatement afin que les applications disposent de suffisamment de mémoire pour s'exécuter. Utilisez un message retardé pour libérer des ressources si l'IME est masqué pendant quelques secondes.
• Assurez-vous que les utilisateurs peuvent saisir autant de caractères que possible en fonction de la langue ou des paramètres régionaux associés à l'IME. Les utilisateurs peuvent utiliser des signes de ponctuation dans les mots de passe ou les noms d'utilisateur. Par conséquent, votre IME doit fournir de nombreux caractères différents pour permettre aux utilisateurs de saisir un mot de passe et d'accéder à l'appareil.