EmojiEditTextHelper

public final class EmojiEditTextHelper

Utility class to enhance custom EditText widgets with EmojiCompat. 

public class MyEmojiEditText extends EditText {
     public MyEmojiEditText(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() {
         if (mEmojiEditTextHelper == null) {
             mEmojiEditTextHelper = new EmojiEditTextHelper(this);
         }
         return mEmojiEditTextHelper;
     }
}

Summary

Public constructors

Default constructor.

Public methods
@NonNull KeyListener

Attaches EmojiCompat KeyListener to the widget.
int

Returns the maximum number of EmojiSpans to be added to a CharSequence.
@Nullable InputConnection
onCreateInputConnection(
    @Nullable InputConnection inputConnection,
    @NonNull EditorInfo outAttrs
)

Updates the InputConnection with emoji support.
void
setMaxEmojiCount(@IntRange(from = 0) int maxEmojiCount)

Set the maximum number of EmojiSpans to be added to a CharSequence.

Public constructors

EmojiEditTextHelper

Added in 1.0.0
public EmojiEditTextHelper(@NonNull EditText editText)

Default constructor.

Parameters
@NonNull EditText editText

EditText instance

Public methods

getKeyListener

Added in 1.0.0
public @NonNull KeyListener getKeyListener(@NonNull KeyListener keyListener)

Attaches EmojiCompat KeyListener to the widget. Should be called from setKeyListener. Existing keyListener is wrapped into EmojiCompat KeyListener. When used on devices running API 18 or below, this method returns keyListener that is given as a parameter.

Parameters
@NonNull KeyListener keyListener

KeyListener passed into setKeyListener
Returns
@NonNull KeyListener

a new KeyListener instance that wraps keyListener.

getMaxEmojiCount

Added in 1.0.0
public int getMaxEmojiCount()

Returns the maximum number of EmojiSpans to be added to a CharSequence.

See also
setMaxEmojiCount
process

onCreateInputConnection

Added in 1.0.0
public @Nullable InputConnection onCreateInputConnection(
    @Nullable InputConnection inputConnection,
    @NonNull EditorInfo outAttrs
)

Updates the InputConnection with emoji support. Should be called from onCreateInputConnection. When used on devices running API 18 or below, this method returns inputConnection that is given as a parameter. If inputConnection is null, returns null.

Parameters
@Nullable InputConnection inputConnection

InputConnection instance created by TextView
@NonNull EditorInfo outAttrs

EditorInfo passed into onCreateInputConnection
Returns
@Nullable InputConnection

a new InputConnection instance that wraps inputConnection

setMaxEmojiCount

Added in 1.0.0
public void setMaxEmojiCount(@IntRange(from = 0) int maxEmojiCount)

Set the maximum number of EmojiSpans to be added to a CharSequence. The number of spans in a CharSequence affects the performance of the EditText insert/delete operations. Insert/delete operations slow down as the number of spans increases.

Parameters
@IntRange(from = 0) int maxEmojiCount

maximum number of EmojiSpans to be added to a single CharSequence, should be equal or greater than 0
See also
process