EditorInfo
public
class
EditorInfo
extends Object
implements
InputType,
Parcelable
java.lang.Object | |
↳ | android.view.inputmethod.EditorInfo |
An EditorInfo describes several attributes of a text editing object that an input method is communicating with (typically an EditText), most importantly the type of text content it contains and the current cursor position.
Summary
Constants | |
---|---|
int |
IME_ACTION_DONE
Bits of |
int |
IME_ACTION_GO
Bits of |
int |
IME_ACTION_NEXT
Bits of |
int |
IME_ACTION_NONE
Bits of |
int |
IME_ACTION_PREVIOUS
Bits of |
int |
IME_ACTION_SEARCH
Bits of |
int |
IME_ACTION_SEND
Bits of |
int |
IME_ACTION_UNSPECIFIED
Bits of |
int |
IME_FLAG_FORCE_ASCII
Flag of |
int |
IME_FLAG_NAVIGATE_NEXT
Flag of |
int |
IME_FLAG_NAVIGATE_PREVIOUS
Flag of |
int |
IME_FLAG_NO_ACCESSORY_ACTION
Flag of |
int |
IME_FLAG_NO_ENTER_ACTION
Flag of |
int |
IME_FLAG_NO_EXTRACT_UI
Flag of |
int |
IME_FLAG_NO_FULLSCREEN
Flag of |
int |
IME_FLAG_NO_PERSONALIZED_LEARNING
Flag of |
int |
IME_MASK_ACTION
Set of bits in |
int |
IME_NULL
Generic unspecified type for |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<EditorInfo> |
CREATOR
Used to make this class parcelable. |
public
int |
actionId
If |
public
CharSequence |
actionLabel
In some cases an IME may be able to display an arbitrary label for a command the user can perform, which you can specify here. |
public
String[] |
contentMimeTypes
List of acceptable MIME types for
|
public
Bundle |
extras
Any extra data to supply to the input method. |
public
int |
fieldId
Identifier for the editor's field. |
public
String |
fieldName
Additional name for the editor's field. |
public
LocaleList |
hintLocales
List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. |
public
CharSequence |
hintText
The "hint" text of the text view, typically shown in-line when the text is empty to tell the user what to enter. |
public
int |
imeOptions
Extended type information for the editor, to help the IME better integrate with it. |
public
int |
initialCapsMode
The capitalization mode of the first character being edited in the text. |
public
int |
initialSelEnd
The text offset of the end of the selection at the time editing begins; -1 if not known. |
public
int |
initialSelStart
The text offset of the start of the selection at the time editing begins; -1 if not known. |
public
int |
inputType
The content type of the text box, whose bits are defined by
|
public
CharSequence |
label
A label to show to the user describing the text they are writing. |
public
String |
packageName
Name of the package that owns this editor. |
public
String |
privateImeOptions
A string supplying additional information options that are private to a particular IME implementation. |
Public constructors | |
---|---|
EditorInfo()
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
void
|
dump(Printer pw, String prefix)
Write debug output of this object. |
final
void
|
makeCompatible(int targetSdkVersion)
Ensure that the data in this EditorInfo is compatible with an application that was developed against the given target API version. |
void
|
writeToParcel(Parcel dest, int flags)
Used to package this object into a |
Inherited methods | |
---|---|
Constants
IME_ACTION_DONE
public static final int IME_ACTION_DONE
Bits of IME_MASK_ACTION
: the action key performs a "done"
operation, typically meaning there is nothing more to input and the
IME will be closed.
Constant Value: 6 (0x00000006)
IME_ACTION_GO
public static final int IME_ACTION_GO
Bits of 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.
Constant Value: 2 (0x00000002)
IME_ACTION_NEXT
public static final int IME_ACTION_NEXT
Bits of IME_MASK_ACTION
: the action key performs a "next"
operation, taking the user to the next field that will accept text.
Constant Value: 5 (0x00000005)
IME_ACTION_NONE
public static final int IME_ACTION_NONE
Bits of IME_MASK_ACTION
: there is no available action.
Constant Value: 1 (0x00000001)
IME_ACTION_PREVIOUS
public static final int IME_ACTION_PREVIOUS
Bits of IME_MASK_ACTION
: like IME_ACTION_NEXT
, but
for moving to the previous field. This will normally not be used to
specify an action (since it precludes IME_ACTION_NEXT
), but
can be returned to the app if it sets IME_FLAG_NAVIGATE_PREVIOUS
.
Constant Value: 7 (0x00000007)
IME_ACTION_SEARCH
public static final int IME_ACTION_SEARCH
Bits of 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).
Constant Value: 3 (0x00000003)
IME_ACTION_SEND
public static final int IME_ACTION_SEND
Bits of 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.
Constant Value: 4 (0x00000004)
IME_ACTION_UNSPECIFIED
public static final int IME_ACTION_UNSPECIFIED
Bits of IME_MASK_ACTION
: no specific action has been
associated with this editor, let the editor come up with its own if
it can.
Constant Value: 0 (0x00000000)
IME_FLAG_FORCE_ASCII
public static final int IME_FLAG_FORCE_ASCII
Flag of 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 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.
Constant Value: -2147483648 (0x80000000)
IME_FLAG_NAVIGATE_NEXT
public static final int IME_FLAG_NAVIGATE_NEXT
Flag of imeOptions
: used to specify that there is something
interesting that a forward navigation can focus on. This is like using
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 IME_ACTION_NEXT
, if the
user selects the IME's facility to forward navigate, this will show up
in the application at InputConnection.performEditorAction(int)
.
Constant Value: 134217728 (0x08000000)
IME_FLAG_NAVIGATE_PREVIOUS
public static final int IME_FLAG_NAVIGATE_PREVIOUS
Flag of imeOptions
: like 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 IME_ACTION_PREVIOUS
at InputConnection.performEditorAction(int)
.
Constant Value: 67108864 (0x04000000)
IME_FLAG_NO_ACCESSORY_ACTION
public static final int IME_FLAG_NO_ACCESSORY_ACTION
Flag of imeOptions
: used in conjunction with one of the actions
masked by 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.
Constant Value: 536870912 (0x20000000)
IME_FLAG_NO_ENTER_ACTION
public static final int IME_FLAG_NO_ENTER_ACTION
Flag of imeOptions
: used in conjunction with one of the actions
masked by 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
TextView
will automatically set this flag for you
on multi-line text views.
Constant Value: 1073741824 (0x40000000)
IME_FLAG_NO_EXTRACT_UI
public static final int IME_FLAG_NO_EXTRACT_UI
Flag of 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 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.
Constant Value: 268435456 (0x10000000)
IME_FLAG_NO_FULLSCREEN
public static final int IME_FLAG_NO_FULLSCREEN
Flag of 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.
Constant Value: 33554432 (0x02000000)
IME_FLAG_NO_PERSONALIZED_LEARNING
public static final int IME_FLAG_NO_PERSONALIZED_LEARNING
Flag of imeOptions
: used to request that the IME should not update any personalized
data such as typing history and personalized language model based on what the user typed on
this text editing object. Typical use cases are:
- When the application is in a special mode, where user's activities are expected to be not recorded in the application's history. Some web browsers and chat applications may have this kind of modes.
- When storing typing history does not make much sense. Specifying this flag in typing games may help to avoid typing history from being filled up with words that the user is less likely to type in their daily life. Another example is that when the application already knows that the expected input is not a valid word (e.g. a promotion code that is not a valid word in any natural language).
Applications need to be aware that the flag is not a guarantee, and some IMEs may not respect it.
Constant Value: 16777216 (0x01000000)
IME_MASK_ACTION
public static final int IME_MASK_ACTION
Set of bits in 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.
Constant Value: 255 (0x000000ff)
IME_NULL
public static final int IME_NULL
Generic unspecified type for imeOptions
.
Constant Value: 0 (0x00000000)
Fields
CREATOR
public static final Creator<EditorInfo> CREATOR
Used to make this class parcelable.
actionId
public int actionId
If actionLabel
has been given, this is the id for that command
when the user presses its button that is delivered back with
InputConnection.performEditorAction()
.
actionLabel
public CharSequence actionLabel
In 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 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.
contentMimeTypes
public String[] contentMimeTypes
List of acceptable MIME types for
InputConnection.commitContent(InputContentInfo, int, Bundle)
.
null
or an empty array means that
InputConnection.commitContent(InputContentInfo, int, Bundle)
is not supported in this
editor.
extras
public Bundle extras
Any 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 R.attr.editorExtras
attribute of a TextView.
fieldId
public int fieldId
Identifier for the editor's field. This is optional, and may be
0. By default it is filled in with the result of
View.getId()
on the View that
is being edited.
fieldName
public String fieldName
Additional 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.
hintLocales
public LocaleList hintLocales
List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. This special "hint" can be used mainly for, but not limited to, multilingual users who want IMEs to switch language context automatically.
null
means that no special language "hint" is needed.
Editor authors: Specify this only when you are confident that the user
will switch to certain languages in this context no matter what input method subtype is
currently selected. Otherwise, keep this null
. Explicit user actions and/or
preferences would be good signals to specify this special "hint", For example, a chat
application may be able to put the last used language at the top of hintLocales
based on whom the user is going to talk, by remembering what language is used in the last
conversation. Do not specify TextView.getTextLocales()
only because
it is used for text rendering.
hintText
public CharSequence hintText
The "hint" text of the text view, typically shown in-line when the text is empty to tell the user what to enter.
imeOptions
public int imeOptions
Extended type information for the editor, to help the IME better integrate with it.
initialCapsMode
public int initialCapsMode
The capitalization mode of the first character being edited in the
text. Values may be any combination of
TextUtils.CAP_MODE_CHARACTERS
,
TextUtils.CAP_MODE_WORDS
, and
TextUtils.CAP_MODE_SENTENCES
, though
you should generally just take a non-zero value to mean "start out in
caps mode".
initialSelEnd
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
InputMethodManager.updateSelection(android.view.View, int, int, int, int)
before.
initialSelStart
public int initialSelStart
The 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
InputMethodManager.updateSelection(android.view.View, int, int, int, int)
before.
inputType
public int inputType
The content type of the text box, whose bits are defined by
InputType
.
label
public CharSequence label
A label to show to the user describing the text they are writing.
packageName
public String packageName
Name of the package that owns this editor.
IME authors: In API level 22
Build.VERSION_CODES.LOLLIPOP_MR1
and prior, do not trust this package
name. The system had not verified the consistency between the package name here and
application's uid. Consider to use InputBinding.getUid()
, which is trustworthy.
Starting from Build.VERSION_CODES.M
, the system verifies the consistency
between this package name and application uid before EditorInfo
is passed to the
input method.
Editor authors: Starting from Build.VERSION_CODES.M
,
the application is no longer
able to establish input connections if the package name provided here is inconsistent with
application's uid.
privateImeOptions
public String privateImeOptions
A 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 R.attr.privateImeOptions
attribute of a TextView.
Public constructors
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
dump
public void dump (Printer pw, String prefix)
Write debug output of this object.
Parameters | |
---|---|
pw |
Printer |
prefix |
String |
makeCompatible
public final void makeCompatible (int targetSdkVersion)
Ensure that the data in this EditorInfo is compatible with an application
that was developed against the given target API version. This can
impact the following input types:
InputType.TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS
,
InputType.TYPE_TEXT_VARIATION_WEB_PASSWORD
,
InputType.TYPE_NUMBER_VARIATION_NORMAL
,
InputType.TYPE_NUMBER_VARIATION_PASSWORD
.
This is called by the framework for input method implementations; you should not generally need to call it yourself.
Parameters | |
---|---|
targetSdkVersion |
int : The API version number that the compatible
application was developed against.
|
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Used to package this object into a Parcel
.
Parameters | |
---|---|
dest |
Parcel : The Parcel to be written. |
flags |
int : The flags used for parceling.
|
Interfaces
Classes