תאימות לאמוג'י

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() {...})

הוספת פונקציות event listener לאתחול

המחלקות EmojiCompat ו-EmojiCompat מספקות את השיטות registerInitCallback() ו-unregisterInitCallback() לרישום של קריאה חוזרת לאתחול. כדי להשתמש בשיטות האלה, צריך ליצור מופע של מחלקת EmojiCompat.InitCallback. קוראים לשיטות האלה ומעבירים את המופע של המחלקה EmojiCompat.InitCallback. כשאתחול ספריית התמיכה של EmojiCompat מצליח, המחלקה EmojiCompat קוראת לשיטה onInitialized(). אם לא ניתן לאתחל את הספרייה, הקלאס EmojiCompat קורא ל-method‏ onFailed().

כדי לבדוק את מצב האתחול בכל שלב, קוראים לשיטה getLoadState(). הפונקציה מחזירה אחד מהערכים הבאים: LOAD_STATE_LOADING, LOAD_STATE_SUCCEEDED, או LOAD_STATE_FAILED.

שימוש ב-EmojiCompat עם ווידג'טים של AppCompat

אם אתם משתמשים ב-AppCompat widgets, אתם יכולים להשתמש בווידג'טים של EmojiCompat שמתבססים על AppCompat widgets.

1. מוסיפים את ספריית התמיכה לקטע dependencies (תלויות).

   מגניב

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

   Kotlin

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

   מגניב

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

2. משתמשים בווידג'טים EmojiCompat AppCompat Widget בפריסות של קובצי XML.

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

הגדרת גופנים בחבילה

ספריית התמיכה EmojiCompat זמינה גם בגרסת גופן מאוגדת. החבילה הזו כוללת את הגופן עם המטא-נתונים המוטמעים. החבילה כוללת גם BundledEmojiCompatConfig שמשתמש ב-AssetManager כדי לטעון את המטא-נתונים ואת הגופנים.

הערה: גודל הגופן הוא כמה מגה-בייט.

הוספת תלות בספריית תמיכה

כדי להשתמש בספריית התמיכה EmojiCompat עם הגדרת גופנים בחבילה, חייבים לשנות את יחסי התלות של נתיב המחלקה בפרויקט האפליקציה בסביבת הפיתוח.

כדי להוסיף ספריית תמיכה לפרויקט האפליקציה:

1. פותחים את קובץ build.gradle של האפליקציה.
2. מוסיפים את ספריית התמיכה לקטע dependencies.

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

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

שימוש בגופנים בחבילה להגדרת EmojiCompat

כדי להשתמש בגופנים בחבילה להגדרת EmojiCompat, פועלים לפי השלבים הבאים:

1. משתמשים ב-BundledEmojiCompatConfig כדי ליצור מופע של EmojiCompat ומספקים מופע של Context.
2. מבצעים קריאה ל-method‏ init() כדי לאתחל את EmojiCompat ומעבירים את המופע של BundledEmojiCompatConfig.

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 ללא ווידג'טים

‫EmojiCompat משתמש ב-EmojiSpan כדי לעבד תמונות בצורה נכונה. לכן, היא צריכה להמיר כל CharSequence נתון למופעים של Spanned עם EmojiSpans. המחלקות EmojiCompat מספקות שיטה להמרה של CharSequences למופעים של Spanned עם EmojiSpans. באמצעות השיטה הזו, אפשר לעבד את המופעים המעובדים ולשמור אותם במטמון במקום את המחרוזת הגולמית, וכך לשפר את הביצועים של האפליקציה.

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

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

שימוש ב-EmojiCompat עבור IME

באמצעות ספריית התמיכה EmojiCompat, המקלדות יכולות להציג את האמוג'י שהאפליקציה תומכת בהם. ממשקי IME יכולים להשתמש בשיטה hasEmojiGlyph() כדי לבדוק אם EmojiCompat יכול להציג אמוג'י. השיטה הזו מקבלת CharSequence של אמוג'י ומחזירה true אם EmojiCompat יכול לזהות את האמוג'י ולהציג אותו.

המקלדת יכולה גם לבדוק את הגרסה של ספריית התמיכה של EmojiCompat שהאפליקציה תומכת בה, כדי לקבוע אילו אמוג'י יוצגו בלוח. כדי לבדוק את הגרסה, אם היא זמינה, המקלדת צריכה לבדוק אם המקשים הבאים קיימים בחבילה EditorInfo.extras:

• EDITOR_INFO_METAVERSION_KEY

אם המפתח קיים בחבילה, הערך מייצג את גרסת המטא-נתונים של האימוג'י שבה נעשה שימוש באפליקציה. אם המפתח הזה לא קיים, האפליקציה לא משתמשת ב-EmojiCompat.

• EDITOR_INFO_REPLACE_ALL_KEY

אם המפתח קיים והערך שלו הוא true, זה מציין שהאפליקציה קראה לשיטה SetReplaceAll(). מידע נוסף על הגדרת EmojiCompat זמין בקטע אפשרויות הגדרה.

אחרי קבלת המפתחות בחבילה EditorInfo.extras, המקלדת יכולה להשתמש ב-method‏ hasEmojiGlyph(), כאשר metadataVersion הוא הערך של EDITOR_INFO_METAVERSION_KEY, כדי לבדוק אם האפליקציה יכולה להציג אמוג'י ספציפי.

שימוש ב-EmojiCompat עם ווידג'טים בהתאמה אישית

תמיד אפשר להשתמש בשיטה process() כדי לבצע עיבוד מקדים של CharSequence באפליקציה ולהוסיף אותו לכל ווידג'ט שיכול לעבד מופעים של Spanned, לדוגמה, TextView. בנוסף, ספריית EmojiCompat מספקת את מחלקות העזר לווידג'טים הבאות, כדי שתוכלו להוסיף תמיכה בסמלי אמוג'י לווידג'טים בהתאמה אישית במינימום מאמץ.

• EmojiTextViewHelper
• EmojiEditTextHelper

Sample 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() {
       ...
   }
}

דוגמה ל-EditText

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() {
       ...
   }
}

שאלות נפוצות

• איך מתחילים את ההורדה של הגופן?

גופני האימוג'י יורדים בפעם הראשונה שמבקשים אותם, אם הם לא קיימים במכשיר. התזמון של ההורדה שקוף לאפליקציה.

• כמה זמן נמשך תהליך האתחול?

אחרי שהגופן יורד, לוקח בערך 150 אלפיות השנייה עד ש-EmojiCompat מאותחל.

• כמה זיכרון משתמשת ספריית התמיכה EmojiCompat?

בשלב הזה, מבנה הנתונים של האימוג'י נטען בזיכרון של האפליקציה ומשתמש בכ-200KB.

• האם אפשר להשתמש ב-EmojiCompat עבור TextView בהתאמה אישית?

כן. ‫EmojiCompat מספקת מחלקות עזר לווידג'טים בהתאמה אישית. אפשר גם לבצע עיבוד מקדים למחרוזת נתונה ולהמיר אותה ל-Spanned. מידע נוסף על מחלקות העזר של הווידג'טים זמין בקטע שימוש ב-EmojiCompat עם ווידג'טים בהתאמה אישית.

• מה קורה אם מוסיפים ווידג'טים בקובצי XML של פריסות במכשירים שפועלת בהם מערכת Android מגרסה 4.4 (API ברמה 19) ומטה?

אפשר לכלול את ספריית התמיכה EmojiCompat או את הווידג'טים שלה באפליקציות שתומכות במכשירים עם Android 4.4 (רמת API‏ 19) או גרסאות קודמות. עם זאת, אם במכשיר פועלת גרסת Android שקודמת לרמת API‏ 19,‏ EmojiCompat הווידג'טים שלו יהיו במצב 'ללא פעולה'. המשמעות היא ש-EmojiTextView מתנהג בדיוק כמו TextView רגיל. ‫EmojiCompat; הוא עובר באופן מיידי למצב LOAD_STATE_SUCCEEDED כשמתקשרים לשיטה init().

מקורות מידע נוספים

למידע נוסף על השימוש בספרייה EmojiCompat אפשר לצפות בסרטון EmojiCompat.