# EmojiTextViewHelper

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  
belongs to Maven artifact com.android.support:support-emoji:28.0.0-alpha1  
Summary:[Ctors](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#pubctors)\|[Methods](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#)  

# EmojiTextViewHelper

| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).

`
public

final

class
EmojiTextViewHelper
`  
`

extends Object


``


`

|---|-------------------------------------------------------|
| java.lang.Object                                         ||
| ↳ | android.support.text.emoji.widget.EmojiTextViewHelper |

<br />

*** ** * ** ***

Utility class to enhance custom TextView widgets with[EmojiCompat](https://developer.android.com/reference/android/support/text/emoji/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;
     }
 }
 
```

<br />

## Summary

|                                                                                                                                   ### Public constructors                                                                                                                                    ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[EmojiTextViewHelper](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#EmojiTextViewHelper(android.widget.TextView))`(`[TextView](https://developer.android.com/reference/android/widget/TextView.html)` textView) ` Default constructor. |

|                                                                                                                                                                                                                                                                ### Public methods                                                                                                                                                                                                                                                                ||
|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[InputFilter[]](https://developer.android.com/reference/android/text/InputFilter.html)                        | ` `[getFilters](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#getFilters(android.text.InputFilter[]))`(`[InputFilter[]](https://developer.android.com/reference/android/text/InputFilter.html)` filters) ` Appends EmojiCompat InputFilters to the widget InputFilters.                                                                                                        |
| ` void`                                                                                                          | ` `[setAllCaps](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#setAllCaps(boolean))`(boolean allCaps) ` Call when allCaps is set on TextView.                                                                                                                                                                                                                                   |
| ` void`                                                                                                          | ` `[updateTransformationMethod](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#updateTransformationMethod())`() ` Updates widget's TransformationMethod so that the transformed text can be processed.                                                                                                                                                                          |
| ` `[TransformationMethod](https://developer.android.com/reference/android/text/method/TransformationMethod.html) | ` `[wrapTransformationMethod](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#wrapTransformationMethod(android.text.method.TransformationMethod))`(`[TransformationMethod](https://developer.android.com/reference/android/text/method/TransformationMethod.html)` transformationMethod) ` Returns transformation method that can update the transformed text to display emojis. |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object`         | ` clone() `                   | | ` boolean`        | ` equals(Object arg0) `       | | ` void`           | ` finalize() `                | | ` final Class<?>` | ` getClass() `                | | ` int`            | ` hashCode() `                | | ` final void`     | ` notify() `                  | | ` final void`     | ` notifyAll() `               | | ` String`         | ` toString() `                | | ` final void`     | ` wait(long arg0, int arg1) ` | | ` final void`     | ` wait(long arg0) `           | | ` final void`     | ` wait() `                    | ||

## Public constructors

### EmojiTextViewHelper

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
EmojiTextViewHelper (TextView textView)
```

Default constructor.

<br />

|                    Parameters                    ||
|------------|--------------------------------------|
| `textView` | `TextView`: TextView instance <br /> |

## Public methods

### getFilters

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
InputFilter[] getFilters (InputFilter[] filters)
```

Appends EmojiCompat InputFilters to the widget InputFilters. Should be called by[setFilters(InputFilter[])](https://developer.android.com/reference/android/widget/TextView.html#setFilters(android.text.InputFilter[]))to update the InputFilters. When used on devices running API 18 or below, this method returns`filters`that is given as a parameter.

<br />

|                                                                                              Parameters                                                                                              ||
|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `filters` | `InputFilter`: InputFilter array passed to[setFilters(InputFilter[])](https://developer.android.com/reference/android/widget/TextView.html#setFilters(android.text.InputFilter[])) <br /> |

|                                                                                         Returns                                                                                          ||
|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
| [InputFilter[]](https://developer.android.com/reference/android/text/InputFilter.html) | same copy if the array already contains EmojiCompat InputFilter. A new array copy if not. <br /> |

### setAllCaps

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setAllCaps (boolean allCaps)
```

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

<br />

|                                                                               Parameters                                                                                ||
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `allCaps` | `boolean`: allCaps parameter passed to[setAllCaps(boolean)](https://developer.android.com/reference/android/widget/TextView.html#setAllCaps(boolean)) <br /> |

### updateTransformationMethod

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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.

<br />

**See also:**

- [wrapTransformationMethod(TransformationMethod)](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper#wrapTransformationMethod(android.text.method.TransformationMethod))  

### wrapTransformationMethod

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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.

<br />

|                                  Parameters                                   ||
|------------------------|-------------------------------------------------------|
| `transformationMethod` | `TransformationMethod`: instance to be wrapped <br /> |

|                                                        Returns                                                        ||
|---------------------------------------------------------------------------------------------------------------|--------|
| [TransformationMethod](https://developer.android.com/reference/android/text/method/TransformationMethod.html) | <br /> |

-

  ## Classes

  - [EmojiAppCompatButton](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiAppCompatButton)
  - [EmojiAppCompatEditText](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiAppCompatEditText)
  - [EmojiAppCompatTextView](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiAppCompatTextView)
  - [EmojiButton](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiButton)
  - [EmojiEditText](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiEditText)
  - [EmojiEditTextHelper](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiEditTextHelper)
  - [EmojiExtractTextLayout](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiExtractTextLayout)
  - [EmojiTextView](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextView)
  - [EmojiTextViewHelper](https://developer.android.com/reference/android/support/text/emoji/widget/EmojiTextViewHelper)