belongs to Maven artifact androidx.emoji:emoji:1.0.0-alpha1

EmojiTextViewHelper

public final class EmojiTextViewHelper
extends Object

java.lang.Object
   ↳ androidx.emoji.widget.EmojiTextViewHelper


Utility class to enhance custom TextView widgets with EmojiCompat.

 public class MyEmojiTextView extends TextView {
     public MyEmojiTextView(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() {
         if (mEmojiTextViewHelper == null) {
             mEmojiTextViewHelper = new EmojiTextViewHelper(this);
         }
         return mEmojiTextViewHelper;
     }
 }
 

Summary

Public constructors

EmojiTextViewHelper(TextView textView)

Default constructor.

Public methods

InputFilter[] getFilters(InputFilter[] filters)

Appends EmojiCompat InputFilters to the widget InputFilters.

void setAllCaps(boolean allCaps)

Call when allCaps is set on TextView.

void updateTransformationMethod()

Updates widget's TransformationMethod so that the transformed text can be processed.

TransformationMethod wrapTransformationMethod(TransformationMethod transformationMethod)

Returns transformation method that can update the transformed text to display emojis.

Inherited methods

Public constructors

EmojiTextViewHelper

EmojiTextViewHelper (TextView textView)

Default constructor.

Parameters
textView TextView: TextView instance

Public methods

getFilters

InputFilter[] getFilters (InputFilter[] filters)

Appends EmojiCompat InputFilters to the widget InputFilters. Should be called by TextView.setFilters(InputFilter[]) to update the InputFilters. When used on devices running API 18 or below, this method returns filters that is given as a parameter.

Parameters
filters InputFilter: InputFilter array passed to TextView.setFilters(InputFilter[])

Returns
InputFilter[] same copy if the array already contains EmojiCompat InputFilter. A new array copy if not.

setAllCaps

void setAllCaps (boolean allCaps)

Call when allCaps is set on TextView. When used on devices running API 18 or below, this method does nothing.

Parameters
allCaps boolean: allCaps parameter passed to TextView.setAllCaps(boolean)

updateTransformationMethod

void updateTransformationMethod ()

Updates widget's TransformationMethod so that the transformed text can be processed. Should be called in the widget constructor. When used on devices running API 18 or below, this method does nothing.

wrapTransformationMethod

TransformationMethod wrapTransformationMethod (TransformationMethod transformationMethod)

Returns transformation method that can update the transformed text to display emojis. When used on devices running API 18 or below, this method returns transformationMethod that is given as a parameter.

Parameters
transformationMethod TransformationMethod: instance to be wrapped

Returns
TransformationMethod