Emoji-Kompatibilität

val config = FontRequestEmojiCompatConfig(...)
        .setReplaceAll(true)
        .setEmojiSpanIndicatorEnabled(true)
        .setEmojiSpanIndicatorColor(Color.GREEN)
        .registerInitCallback(object: EmojiCompat.InitCallback() {
            ...
        })

EmojiCompat.Config config = new FontRequestEmojiCompatConfig(...)
       .setReplaceAll(true)
       .setEmojiSpanIndicatorEnabled(true)
       .setEmojiSpanIndicatorColor(Color.GREEN)
       .registerInitCallback(new InitCallback() {...})

Initialisierungs-Listener hinzufügen

Die Klassen EmojiCompat und EmojiCompat stellen die Methoden registerInitCallback() und unregisterInitCallback() bereit, um einen Initialisierungs-Callback zu registrieren. Erstellen Sie eine Instanz der Klasse EmojiCompat.InitCallback, um diese Methoden zu verwenden. Rufen Sie diese Methoden auf und übergeben Sie die Instanz der EmojiCompat.InitCallback-Klasse. Wenn die Initialisierung der EmojiCompat-Supportbibliothek erfolgreich ist, ruft die Klasse EmojiCompat die Methode onInitialized() auf. Wenn die Bibliothek nicht initialisiert werden kann, ruft die Klasse EmojiCompat die Methode onFailed() auf.

Mit der Methode getLoadState() lässt sich jederzeit der Initialisierungsstatus prüfen. Sie gibt einen der folgenden Werte zurück: LOAD_STATE_LOADING, LOAD_STATE_SUCCEEDED oder LOAD_STATE_FAILED.

EmojiCompat mit AppCompat-Widgets verwenden

Wenn Sie AppCompat widgets verwenden, können Sie EmojiCompat-Widgets verwenden, die von AppCompat widgets aus erweitert werden.

1. Fügen Sie die Supportbibliothek zum Abschnitt „Abhängigkeiten“ hinzu.

   Groovig

   dependencies {
       ...
       implementation "androidx.emoji:emoji-bundled:$version"
   }
   

   Kotlin

         dependencies {
             implementation("androidx.emoji:emoji-appcompat:$version")
         }
         

   Groovig

         dependencies {
             implementation "androidx.emoji:emoji-appcompat:$version"
         }
         

2. Verwenden Sie EmojiCompat-AppCompat Widget-Widgets in Layout-XMLs.

<android.support.text.emoji.widget.EmojiAppCompatTextView
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

<android.support.text.emoji.widget.EmojiAppCompatEditText
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

<android.support.text.emoji.widget.EmojiAppCompatButton
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"/>

Konfiguration gebündelter Schriftarten

Die EmojiCompat-Supportbibliothek ist auch in einer gebündelten Schriftartversion verfügbar. Dieses Paket enthält die Schriftart mit den eingebetteten Metadaten. Das Paket enthält auch ein BundledEmojiCompatConfig, das AssetManager verwendet, um die Metadaten und Schriftarten zu laden.

Hinweis:Die Schriftgröße wird in mehreren Megabyte angegeben.

Abhängigkeit von Supportbibliotheken hinzufügen

Damit Sie die EmojiCompat-Supportbibliothek mit der Konfiguration gebündelter Schriftarten verwenden können, müssen Sie die Klassenpfadabhängigkeiten des App-Projekts in Ihrer Entwicklungsumgebung ändern.

So fügen Sie Ihrem Anwendungsprojekt eine Supportbibliothek hinzu:

1. Öffnen Sie die Datei build.gradle Ihrer Anwendung.
2. Fügen Sie die Supportbibliothek zum Abschnitt dependencies hinzu.

dependencies {
    ...
    implementation "androidx.emoji:emoji:28.0.0"
}

dependencies {
    ...
    implementation("androidx.emoji:emoji:28.0.0")
}

Gebündelte Schriftarten zum Konfigurieren von EmojiCompat verwenden

Führe die folgenden Schritte aus, um EmojiCompat mit gebündelten Schriftarten zu konfigurieren:

1. Verwenden Sie BundledEmojiCompatConfig, um eine Instanz von EmojiCompat zu erstellen und eine Instanz von Context bereitzustellen.
2. Rufen Sie die Methode init() auf, um EmojiCompat zu initialisieren und die Instanz von BundledEmojiCompatConfig zu übergeben.

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
        val config = BundledEmojiCompatConfig(this)
        EmojiCompat.init(config)
    }
}

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        EmojiCompat.Config config = new BundledEmojiCompatConfig(this);
        EmojiCompat.init(config);
        ...
    }
}

EmojiCompat ohne Widgets verwenden

EmojiCompat verwendet EmojiSpan, um korrekte Bilder zu rendern. Daher muss jede CharSequence in Spanned-Instanzen mit EmojiSpans konvertiert werden. Die Klasse EmojiCompat bietet eine Methode zum Konvertieren von CharSequences in Spanned-Instanzen mit EmojiSpans. Mit dieser Methode können Sie die verarbeiteten Instanzen anstelle des Rohstrings verarbeiten und im Cache speichern, was die Leistung Ihrer Anwendung verbessert.

val processed = EmojiCompat.get().process("neutral face \uD83D\uDE10")

CharSequence processed = EmojiCompat.get().process("neutral face \uD83D\uDE10");

EmojiCompat für IMEs verwenden

Mithilfe der EmojiCompat-Supportbibliothek können Tastaturen die Emojis rendern, die von der Anwendung unterstützt werden, mit der sie interagieren. IMEs können mit der Methode hasEmojiGlyph() prüfen, ob EmojiCompat Emojis rendern kann. Diese Methode verwendet die CharSequence eines Emojis und gibt true zurück, wenn EmojiCompat das Emoji erkennen und rendern kann.

Die Tastatur kann auch die von der App unterstützte Version der EmojiCompat-Supportbibliothek prüfen, um festzustellen, welche Emojis in der Palette gerendert werden sollen. Zum Prüfen der Version (falls verfügbar) muss die Tastatur prüfen, ob die folgenden Tasten im EditorInfo.extras-Bundle vorhanden sind:

• EDITOR_INFO_METAVERSION_KEY

Wenn der Schlüssel im Bundle vorhanden ist, stellt der Wert die Version der Emoji-Metadaten dar, die von der Anwendung verwendet werden. Wenn dieser Schlüssel nicht vorhanden ist, verwendet die Anwendung EmojiCompat nicht.

• EDITOR_INFO_REPLACE_ALL_KEY

Wenn der Schlüssel vorhanden und auf true gesetzt ist, bedeutet das, dass die Anwendung die Methode SetReplaceAll() aufgerufen hat. Weitere Informationen zur EmojiCompat-Konfiguration finden Sie im Abschnitt Konfigurationsoptionen.

Nachdem die Schlüssel im EditorInfo.extras-Bundle empfangen wurden, kann die Tastatur mit der Methode hasEmojiGlyph() prüfen, ob die App ein bestimmtes Emoji rendern kann. Dabei ist metadataVersion der Wert für EDITOR_INFO_METAVERSION_KEY.

EmojiCompat mit benutzerdefinierten Widgets verwenden

Sie können jederzeit die Methode process() verwenden, um das CharSequence in Ihrer Anwendung vorzuverarbeiten und es jedem Widget hinzuzufügen, das Spanned-Instanzen rendern kann, z. B. TextView. Darüber hinaus bietet EmojiCompat die folgenden Widget-Hilfsklassen, mit denen Sie Ihre benutzerdefinierten Widgets mit minimalem Aufwand mit Emoji-Unterstützung anreichern können.

• EmojiTextViewHelper
• EmojiEditTextHelper

Beispiel für TextView

Kotlin

class MyTextView(context: Context) : AppCompatTextView(context) {

    private val emojiTextViewHelper: EmojiTextViewHelper by lazy(LazyThreadSafetyMode.NONE) {
        EmojiTextViewHelper(this).apply {
            updateTransformationMethod()
        }
    }

    override fun setFilters(filters: Array<InputFilter>) {
        super.setFilters(emojiTextViewHelper.getFilters(filters))
    }

    override fun setAllCaps(allCaps: Boolean) {
        super.setAllCaps(allCaps)
        emojiTextViewHelper.setAllCaps(allCaps)
    }
}

Java

public class MyTextView extends AppCompatTextView {
   ...
   public MyTextView(Context context) {
       super(context);
       init();
   }
   ...
   private void init() {
       getEmojiTextViewHelper().updateTransformationMethod();
   }

   @Override
   public void setFilters(InputFilter[] filters) {
       super.setFilters(getEmojiTextViewHelper().getFilters(filters));
   }

   @Override
   public void setAllCaps(boolean allCaps) {
       super.setAllCaps(allCaps);
       getEmojiTextViewHelper().setAllCaps(allCaps);
   }

   private EmojiTextViewHelper getEmojiTextViewHelper() {
       ...
   }
}

Beispiel für Bearbeitungstext

Kotlin

class MyEditText(context: Context) : AppCompatEditText(context) {

    private val emojiEditTextHelper: EmojiEditTextHelper by lazy(LazyThreadSafetyMode.NONE) {
        EmojiEditTextHelper(this).also {
            super.setKeyListener(it.getKeyListener(keyListener))
        }
    }

    override fun setKeyListener(input: KeyListener?) {
        input?.also {
            super.setKeyListener(emojiEditTextHelper.getKeyListener(it))
        }
    }

    override fun onCreateInputConnection(outAttrs: EditorInfo): InputConnection {
        val inputConnection: InputConnection = super.onCreateInputConnection(outAttrs)
        return emojiEditTextHelper.onCreateInputConnection(
                inputConnection,
                outAttrs
        ) as InputConnection
    }
}

Java

public class MyEditText extends AppCompatEditText {
   ...
   public MyEditText(Context context) {
       super(context);
       init();
   }
   ...
   private void init() {
       super.setKeyListener(getEmojiEditTextHelper().getKeyListener(getKeyListener()));
   }

   @Override
   public void setKeyListener(android.text.method.KeyListener keyListener) {
       super.setKeyListener(getEmojiEditTextHelper().getKeyListener(keyListener));
   }

   @Override
   public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
       InputConnection inputConnection = super.onCreateInputConnection(outAttrs);
       return getEmojiEditTextHelper().onCreateInputConnection(inputConnection, outAttrs);
   }

   private EmojiEditTextHelper getEmojiEditTextHelper() {
       ...
   }
}

Häufig gestellte Fragen

• Wie starte ich den Download von Schriftarten?

Die Emoji-Schriftarten werden auf die erste Anfrage heruntergeladen, wenn sie nicht auf dem Gerät vorhanden sind. Die Downloadplanung ist für die App transparent.

• Wie lange dauert die Initialisierung?

Nachdem die Schriftart heruntergeladen wurde, dauert es etwa 150 Millisekunden, EmojiCompat zu initialisieren.

• Wie viel Speicher verwendet die EmojiCompat-Bibliothek?

Derzeit ist die Datenstruktur, mit der das Emoji gefunden wird, in den Arbeitsspeicher der Anwendung geladen und belegt ca. 200 KB.

• Kann ich EmojiCompat für eine benutzerdefinierte TextView verwenden?

Ja. EmojiCompat bietet Hilfsklassen für benutzerdefinierte Widgets. Es ist auch möglich, einen bestimmten String vorzuverarbeiten und in Spanned zu konvertieren. Weitere Informationen zu Widget-Hilfsklassen finden Sie im Abschnitt EmojiCompat mit benutzerdefinierten Widgets verwenden.

• Was passiert, wenn ich Widgets in Layout-XMLs auf Geräten mit Android 4.4 (API-Level 19) oder niedriger hinzufüge?

Du kannst die EmojiCompat-Supportbibliothek oder deren Widgets in deine Apps einbinden, die Geräte mit Android 4.4 (API-Level 19) oder niedriger unterstützen. Wird auf einem Gerät jedoch eine Android-Version vor API-Level 19 ausgeführt, befinden sich EmojiCompat und die zugehörigen Widgets im Zustand „Kein Vorgang“. Das bedeutet, dass sich EmojiTextView genau wie eine reguläre TextView verhält. EmojiCompat-Instanz. Sie wechselt sofort in den Status LOAD_STATE_SUCCEEDED, wenn Sie die Methode init() aufrufen.

Weitere Informationen

Wenn Sie weitere Informationen zur Verwendung der EmojiCompat-Bibliothek erhalten möchten, sehen Sie sich EmojiCompat an.