| Fields Summary |
|---|
| public int | inputTypeThe content type of the text box, whose bits are defined by
{@link InputType}. |
| public static final int | IME_MASK_ACTIONSet of bits in {@link #imeOptions} that provide alternative actions
associated with the "enter" key. This both helps the IME provide
better feedback about what the enter key will do, and also allows it
to provide alternative mechanisms for providing that command. |
| public static final int | IME_ACTION_UNSPECIFIEDBits of {@link #IME_MASK_ACTION}: no specific action has been
associated with this editor, let the editor come up with its own if
it can. |
| public static final int | IME_ACTION_NONEBits of {@link #IME_MASK_ACTION}: there is no available action. |
| public static final int | IME_ACTION_GOBits of {@link #IME_MASK_ACTION}: the action key performs a "go"
operation to take the user to the target of the text they typed.
Typically used, for example, when entering a URL. |
| public static final int | IME_ACTION_SEARCHBits of {@link #IME_MASK_ACTION}: the action key performs a "search"
operation, taking the user to the results of searching for the text
they have typed (in whatever context is appropriate). |
| public static final int | IME_ACTION_SENDBits of {@link #IME_MASK_ACTION}: the action key performs a "send"
operation, delivering the text to its target. This is typically used
when composing a message in IM or SMS where sending is immediate. |
| public static final int | IME_ACTION_NEXTBits of {@link #IME_MASK_ACTION}: the action key performs a "next"
operation, taking the user to the next field that will accept text. |
| public static final int | IME_ACTION_DONEBits of {@link #IME_MASK_ACTION}: the action key performs a "done"
operation, typically meaning there is nothing more to input and the
IME will be closed. |
| public static final int | IME_ACTION_PREVIOUSBits of {@link #IME_MASK_ACTION}: like {@link #IME_ACTION_NEXT}, but
for moving to the previous field. This will normally not be used to
specify an action (since it precludes {@link #IME_ACTION_NEXT}), but
can be returned to the app if it sets {@link #IME_FLAG_NAVIGATE_PREVIOUS}. |
| public static final int | IME_FLAG_NO_FULLSCREENFlag of {@link #imeOptions}: used to request that the IME never go
into fullscreen mode.
By default, IMEs may go into full screen mode when they think
it's appropriate, for example on small screens in landscape
orientation where displaying a software keyboard may occlude
such a large portion of the screen that the remaining part is
too small to meaningfully display the application UI.
If this flag is set, compliant IMEs will never go into full screen mode,
and always leave some space to display the application UI.
Applications need to be aware that the flag is not a guarantee, and
some IMEs may ignore it. |
| public static final int | IME_FLAG_NAVIGATE_PREVIOUSFlag of {@link #imeOptions}: like {@link #IME_FLAG_NAVIGATE_NEXT}, but
specifies there is something interesting that a backward navigation
can focus on. If the user selects the IME's facility to backward
navigate, this will show up in the application as an {@link #IME_ACTION_PREVIOUS}
at {@link InputConnection#performEditorAction(int)
InputConnection.performEditorAction(int)}. |
| public static final int | IME_FLAG_NAVIGATE_NEXTFlag of {@link #imeOptions}: used to specify that there is something
interesting that a forward navigation can focus on. This is like using
{@link #IME_ACTION_NEXT}, except allows the IME to be multiline (with
an enter key) as well as provide forward navigation. Note that some
IMEs may not be able to do this, especially when running on a small
screen where there is little space. In that case it does not need to
present a UI for this option. Like {@link #IME_ACTION_NEXT}, if the
user selects the IME's facility to forward navigate, this will show up
in the application at {@link InputConnection#performEditorAction(int)
InputConnection.performEditorAction(int)}. |
| public static final int | IME_FLAG_NO_EXTRACT_UIFlag of {@link #imeOptions}: used to specify that the IME does not need
to show its extracted text UI. For input methods that may be fullscreen,
often when in landscape mode, this allows them to be smaller and let part
of the application be shown behind, through transparent UI parts in the
fullscreen IME. The part of the UI visible to the user may not be responsive
to touch because the IME will receive touch events, which may confuse the
user; use {@link #IME_FLAG_NO_FULLSCREEN} instead for a better experience.
Using this flag is discouraged and it may become deprecated in the future.
Its meaning is unclear in some situations and it may not work appropriately
on older versions of the platform. |
| public static final int | IME_FLAG_NO_ACCESSORY_ACTIONFlag of {@link #imeOptions}: used in conjunction with one of the actions
masked by {@link #IME_MASK_ACTION}, this indicates that the action
should not be available as an accessory button on the right of the extracted
text when the input method is full-screen. Note that by setting this flag,
there can be cases where the action is simply never available to the
user. Setting this generally means that you think that in fullscreen mode,
where there is little space to show the text, it's not worth taking some
screen real estate to display the action and it should be used instead
to show more text. |
| public static final int | IME_FLAG_NO_ENTER_ACTIONFlag of {@link #imeOptions}: used in conjunction with one of the actions
masked by {@link #IME_MASK_ACTION}. If this flag is not set, IMEs will
normally replace the "enter" key with the action supplied. This flag
indicates that the action should not be available in-line as a replacement
for the "enter" key. Typically this is because the action has such a
significant impact or is not recoverable enough that accidentally hitting
it should be avoided, such as sending a message. Note that
{@link android.widget.TextView} will automatically set this flag for you
on multi-line text views. |
| public static final int | IME_FLAG_FORCE_ASCIIFlag of {@link #imeOptions}: used to request an IME that is capable of
inputting ASCII characters. The intention of this flag is to ensure that
the user can type Roman alphabet characters in a {@link android.widget.TextView}.
It is typically used for an account ID or password input. A lot of the time,
IMEs are already able to input ASCII even without being told so (such IMEs
already respect this flag in a sense), but there are cases when this is not
the default. For instance, users of languages using a different script like
Arabic, Greek, Hebrew or Russian typically have a keyboard that can't
input ASCII characters by default. Applications need to be
aware that the flag is not a guarantee, and some IMEs may not respect it.
However, it is strongly recommended for IME authors to respect this flag
especially when their IME could end up with a state where only languages
using non-ASCII are enabled. |
| public static final int | IME_NULLGeneric unspecified type for {@link #imeOptions}. |
| public int | imeOptionsExtended type information for the editor, to help the IME better
integrate with it. |
| public String | privateImeOptionsA string supplying additional information options that are
private to a particular IME implementation. The string must be
scoped to a package owned by the implementation, to ensure there are
no conflicts between implementations, but other than that you can put
whatever you want in it to communicate with the IME. For example,
you could have a string that supplies an argument like
"com.example.myapp.SpecialMode=3". This field is can be
filled in from the {@link android.R.attr#privateImeOptions}
attribute of a TextView. |
| public CharSequence | actionLabelIn some cases an IME may be able to display an arbitrary label for
a command the user can perform, which you can specify here. This is
typically used as the label for the action to use in-line as a replacement
for the "enter" key (see {@link #actionId}). Remember the key where
this will be displayed is typically very small, and there are significant
localization challenges to make this fit in all supported languages. Also
you can not count absolutely on this being used, as some IMEs may
ignore this. |
| public int | actionIdIf {@link #actionLabel} has been given, this is the id for that command
when the user presses its button that is delivered back with
{@link InputConnection#performEditorAction(int)
InputConnection.performEditorAction()}. |
| public int | initialSelStartThe text offset of the start of the selection at the time editing
begins; -1 if not known. Keep in mind that, without knowing the cursor
position, many IMEs will not be able to offer their full feature set and
may even behave in unpredictable ways: pass the actual cursor position
here if possible at all.
Also, this needs to be the cursor position right now,
not at some point in the past, even if input is starting in the same text field
as before. When the app is filling this object, input is about to start by
definition, and this value will override any value the app may have passed to
{@link InputMethodManager#updateSelection(android.view.View, int, int, int, int)}
before. |
| public int | initialSelEnd The text offset of the end of the selection at the time editing
begins; -1 if not known. Keep in mind that, without knowing the cursor
position, many IMEs will not be able to offer their full feature set and
may behave in unpredictable ways: pass the actual cursor position
here if possible at all.
Also, this needs to be the cursor position right now,
not at some point in the past, even if input is starting in the same text field
as before. When the app is filling this object, input is about to start by
definition, and this value will override any value the app may have passed to
{@link InputMethodManager#updateSelection(android.view.View, int, int, int, int)}
before. |
| public int | initialCapsModeThe capitalization mode of the first character being edited in the
text. Values may be any combination of
{@link TextUtils#CAP_MODE_CHARACTERS TextUtils.CAP_MODE_CHARACTERS},
{@link TextUtils#CAP_MODE_WORDS TextUtils.CAP_MODE_WORDS}, and
{@link TextUtils#CAP_MODE_SENTENCES TextUtils.CAP_MODE_SENTENCES}, though
you should generally just take a non-zero value to mean "start out in
caps mode". |
| public CharSequence | hintTextThe "hint" text of the text view, typically shown in-line when the
text is empty to tell the user what to enter. |
| public CharSequence | labelA label to show to the user describing the text they are writing. |
| public String | packageNameName of the package that owns this editor. |
| public int | fieldIdIdentifier for the editor's field. This is optional, and may be
0. By default it is filled in with the result of
{@link android.view.View#getId() View.getId()} on the View that
is being edited. |
| public String | fieldNameAdditional name for the editor's field. This can supply additional
name information for the field. By default it is null. The actual
contents have no meaning. |
| public android.os.Bundle | extrasAny extra data to supply to the input method. This is for extended
communication with specific input methods; the name fields in the
bundle should be scoped (such as "com.mydomain.im.SOME_FIELD") so
that they don't conflict with others. This field can be
filled in from the {@link android.R.attr#editorExtras}
attribute of a TextView. |
| public static final Parcelable.Creator | CREATORUsed to make this class parcelable. |
