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 offre une framework de méthode d'entrée extensible qui permet aux applications de fournir aux utilisateurs d'autres méthodes de saisie, comme les claviers à l'écran ou la saisie vocale. Après avoir installé les IME, l'utilisateur peut en sélectionner un parmi les paramètres du système et l’utiliser dans 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 De plus, vous créez généralement un "paramètre" activité qui transmet les options au service IME. Toi peut également définir une UI de paramètres qui s'affichera 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 travaillé avec les IME, lisez l'article introductif. Modes de saisie à l'écran en premier.

Cycle de vie des IME

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

Les sections suivantes décrivent comment implémenter l'interface utilisateur et le code associé à 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. La le fichier manifeste de l'application doit déclarer le service, demander les autorisations nécessaires, fournir une un filtre d'intent correspondant à l'action action.view.InputMethod et fournissent des métadonnées qui définit les caractéristiques de l'IME. En outre, pour fournir une interface de configuration qui permet au modifier le comportement de l'IME, vous pouvez définir un "paramètre" qui peut être lancée depuis 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 les 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 contient un filtre d'intent ACTION_MAIN que 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 le android.inputmethodservice et android.view.inputmethod packages. La classe KeyEvent est important pour la gestion des caractères du clavier.

La partie centrale d'un IME est le composant de service, une classe qui étend InputMethodService En plus de mettre en œuvre le cycle de vie normal du service, comporte des rappels permettant de fournir l'interface utilisateur de l'IME, de gérer les entrées utilisateur et d'envoyer du texte au qui est ciblé. Par défaut, la classe InputMethodService fournit la plupart des pour gérer l'état et la visibilité de l'IME, et communiquer avec .

Les classes suivantes sont également importantes:

BaseInputConnection

Définit le canal de communication d'un InputMethod à l'application qui reçoit ses entrées. Vous l'utilisez pour lire du texte le curseur, valider le texte dans la zone de texte et 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

Une 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 un 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. Vous ne devez mettre en œuvre que les éléments pertinents méthode de saisie que vous concevez.

Vue de la saisie

La vue de saisie est l'interface utilisateur dans laquelle l'utilisateur saisit du texte sous forme de clics sur des touches, d'écriture manuscrite ou gestes. Lorsque l'IME est affiché pour la première fois, le système appelle la méthode onCreateInputView() . Dans votre implémentation de cette méthode, créez la mise en page que vous souhaitez afficher dans l'IME. et renvoyer la mise en page au système. L'extrait de code suivant montre comment implémenter la méthode onCreateInputView():

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

@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 où l'IME affiche des suggestions ou corrections de mots potentielles que l'utilisateur peut sélectionner. Dans le cycle de vie des IME, le système appelle onCreateCandidatesView() lorsqu'il est prêt à afficher la vue des candidats. Dans votre 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 valeur Null est le comportement par défaut. Vous n'avez donc pas à l'implémenter des 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 à la fois le mode paysage et portrait. En mode IME sans plein écran, laissez suffisamment d'espace pour que l'application puisse le champ de texte et tout contexte associé, de sorte que pas plus de la moitié de l'écran ne soit occupé par l'IME. 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, comme du texte libre, des chiffres, des URL, les adresses e-mail et les chaînes de recherche. Lorsque vous implémentez un nouvel IME, détectez le type d'entrée de chaque et fournissez l'interface appropriée. Cependant, il n'est pas nécessaire de configurer votre IME pour Vérifiez si l'utilisateur saisit du texte valide pour le type d'entrée. C'est la responsabilité qui possède le champ de texte.

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

Et voici l'interface fournie par l'IME latin pour la plate-forme Android entrée numérique:

Lorsqu'un champ de saisie est sélectionné et que l'IME démarre, le système appelle onStartInputView(), en transmettant Objet EditorInfo contenant des détails sur le type d'entrée et d'autres attributs du champ de texte. Dans cet objet, la 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:

inputType and InputType.TYPE_MASK_CLASS

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 illustré dans la figure 3, l'éditeur de mode de saisie latin affiche une 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 InputType

Le champ inputType peut contenir d'autres bits qui indiquent une variante du champ de texte par exemple:

TYPE_TEXT_VARIATION_PASSWORD

Variante de TYPE_CLASS_TEXT pour la saisie de mots de passe. Le mode de saisie s'affiche des barres de couleur au lieu du texte lui-même.

TYPE_TEXT_VARIATION_URI

Variante de TYPE_CLASS_TEXT permettant de saisir des URL Web et d'autres ressources uniformes Identifiants (URI)

TYPE_TEXT_FLAG_AUTO_COMPLETE

Variante de TYPE_CLASS_TEXT permettant de saisir du texte que l'application saisie semi-automatique à partir d'un dictionnaire, d'une recherche ou d'une autre fonction.

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

Envoyer un SMS à l'application

Lorsque l'utilisateur saisit du texte avec votre IME, vous pouvez envoyer du texte à l'application en envoyant des 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, certaines méthodes utiles Les BaseInputConnection sont les suivantes:

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 à la suite 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 à gauche du curseur avec le texte "Hello!" :

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

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 le progression dans le champ de texte jusqu'à ce que l'utilisateur valide le mot. Vous pouvez ensuite remplacer la partie la composition avec le texte terminé. Vous pouvez appliquer un traitement spécial au texte en ajoutant une span lorsque vous la transmettez à setComposingText()

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

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

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 les événements de touche matérielle et peuvent les utiliser ou les transférer à l'application. Par exemple, vous pouvez utiliser les touches directionnelles pour naviguer dans l'interface utilisateur lors de la sélection des candidats lors de la composition. Vous pouvez également piéger la touche Retour pour fermer toutes les boîtes de dialogue provenant du mode de saisie. fenêtre.

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ésentent ce qui suit:

• 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, tels que 10 touches ou QWERTY configurations de clavier

Le mode peut être n'importe quel texte, par exemple "clavier" ou "voix". Un sous-type peut aussi exposer une combinaison de celles-ci.

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 un sous-type spécifique d'un IME. directement. Lorsque vous créez un IME, utilisez l'utilitaire sous-type "feature", car il permet à l'utilisateur d'identifier et basculer entre les différents modes et langages IME.

Elle définit les sous-types dans l'un des fichiers de ressources XML de la méthode d'entrée, à l'aide de la méthode Élément <subtype>. L'extrait de code suivant définit un IME avec deux sous-types : sous-type de clavier pour l'anglais américain et un autre sous-type de clavier pour le français langue 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 étiquetés dans l'interface utilisateur, utilisez "%s" pour obtenir une étiquette de sous-type qui est identique au libellé des paramètres régionaux du sous-type. C'est ce qu'illustrent les deux extraits de code suivants. La 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, qui est utilisé par la définition de l'interface utilisateur du mode de saisie pour définir le du libellé du sous-type, est défini 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 tout 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 IME sont traités comme des modes l'IME auquel ils appartiennent. L'utilisateur peut naviguer de la barre de notification ou de l'application Paramètres vers un des sous-types d'IME disponibles, comme illustré dans la figure suivante:

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

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

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

Vous pouvez permettre aux utilisateurs de passer facilement d'un sous-type d'IME à un autre en fournissant une clé de basculement, telle que le 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éclarer supportsSwitchingToNextInputMethod = "true" dans le fichier XML de la méthode de saisie fichiers de ressources. 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 à quel IME ils appartiennent. Si vous spécifiez "true", le système doit faire défiler les sous-types du sous-type 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.
• permettre aux utilisateurs de basculer vers un autre IME directement à partir de 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 les ressources volumineuses pour que les utilisateurs l'IME dès qu'il appuie sur un champ de texte. Mettez en cache les ressources et les vues pour les de la méthode de saisie.
• Libérez les grandes allocations de mémoire immédiatement après que la fenêtre du mode de saisie est masquée. que les applications disposent d'une mémoire suffisante pour fonctionner. Utiliser un message différé pour libérer des ressources si l'IME est masqué pendant quelques secondes.
• S'assurer que les utilisateurs peuvent saisir autant de caractères que possible pour la langue ou les paramètres régionaux associé à l'IME. Les utilisateurs peuvent utiliser des signes de ponctuation dans les mots de passe ou les noms d'utilisateur. Votre IME doit fournir de nombreux caractères différents pour permettre aux utilisateurs de saisir un mot de passe et d'accéder appareil.