public class EditorInfo extends Object implements InputType, Parcelable
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
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() . |
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.
|
static Parcelable.Creator<EditorInfo> |
CREATOR
Used to make this class parcelable.
|
Bundle |
extras
Any extra data to supply to the input method.
|
int |
fieldId
Identifier for the editor's field.
|
String |
fieldName
Additional name for the editor's field.
|
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.
|
static int |
IME_ACTION_DONE
Bits of
IME_MASK_ACTION : the action key performs a "done"
operation, typically meaning the IME will be closed. |
static 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. |
static 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. |
static int |
IME_ACTION_NONE
Bits of
IME_MASK_ACTION : there is no available action. |
static int |
IME_ACTION_PREVIOUS
Bits of
IME_MASK_ACTION : Like IME_ACTION_NEXT , but
for moving to the previous field. |
static 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
the have typed (in whatever context is appropriate). |
static int |
IME_ACTION_SEND
Bits of
IME_MASK_ACTION : the action key performs a "send"
operation, delivering the text to its target. |
static 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. |
static int |
IME_FLAG_FORCE_ASCII
Flag of
imeOptions : used to request that the IME is capable of
inputting ASCII characters. |
static int |
IME_FLAG_NAVIGATE_NEXT
Flag of
imeOptions : used to specify that there is something
interesting that a forward navigation can focus on. |
static 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. |
static int |
IME_FLAG_NO_ACCESSORY_ACTION
Flag of
imeOptions : used in conjunction with
IME_MASK_ACTION , this indicates that the action should not
be available as an accessory button when the input method is full-screen. |
static int |
IME_FLAG_NO_ENTER_ACTION
Flag of
imeOptions : used in conjunction with
IME_MASK_ACTION , this indicates that the action should not
be available in-line as a replacement for "enter" key. |
static int |
IME_FLAG_NO_EXTRACT_UI
Flag of
imeOptions : used to specify that the IME does not need
to show its extracted text UI. |
static int |
IME_FLAG_NO_FULLSCREEN
Flag of
imeOptions : used to request that the IME never go
into fullscreen mode. |
static int |
IME_MASK_ACTION
Set of bits in
imeOptions that provide alternative actions
associated with the "enter" key. |
static int |
IME_NULL
Generic unspecified type for
imeOptions . |
int |
imeOptions
Extended type information for the editor, to help the IME better
integrate with it.
|
int |
initialCapsMode
The capitalization mode of the first character being edited in the
text.
|
int |
initialSelEnd
The text offset of the end of the selection at the time editing
began; -1 if not known.
|
int |
initialSelStart
The text offset of the start of the selection at the time editing
began; -1 if not known.
|
int |
inputType
The content type of the text box, whose bits are defined by
InputType . |
CharSequence |
label
A label to show to the user describing the text they are writing.
|
String |
packageName
Name of the package that owns this editor.
|
String |
privateImeOptions
A string supplying additional information options that are
private to a particular IME implementation.
|
TYPE_CLASS_DATETIME, TYPE_CLASS_NUMBER, TYPE_CLASS_PHONE, TYPE_CLASS_TEXT, TYPE_DATETIME_VARIATION_DATE, TYPE_DATETIME_VARIATION_NORMAL, TYPE_DATETIME_VARIATION_TIME, TYPE_MASK_CLASS, TYPE_MASK_FLAGS, TYPE_MASK_VARIATION, TYPE_NULL, TYPE_NUMBER_FLAG_DECIMAL, TYPE_NUMBER_FLAG_SIGNED, TYPE_NUMBER_VARIATION_NORMAL, TYPE_NUMBER_VARIATION_PASSWORD, TYPE_TEXT_FLAG_AUTO_COMPLETE, TYPE_TEXT_FLAG_AUTO_CORRECT, TYPE_TEXT_FLAG_CAP_CHARACTERS, TYPE_TEXT_FLAG_CAP_SENTENCES, TYPE_TEXT_FLAG_CAP_WORDS, TYPE_TEXT_FLAG_IME_MULTI_LINE, TYPE_TEXT_FLAG_MULTI_LINE, TYPE_TEXT_FLAG_NO_SUGGESTIONS, TYPE_TEXT_VARIATION_EMAIL_ADDRESS, TYPE_TEXT_VARIATION_EMAIL_SUBJECT, TYPE_TEXT_VARIATION_FILTER, TYPE_TEXT_VARIATION_LONG_MESSAGE, TYPE_TEXT_VARIATION_NORMAL, TYPE_TEXT_VARIATION_PASSWORD, TYPE_TEXT_VARIATION_PERSON_NAME, TYPE_TEXT_VARIATION_PHONETIC, TYPE_TEXT_VARIATION_POSTAL_ADDRESS, TYPE_TEXT_VARIATION_SHORT_MESSAGE, TYPE_TEXT_VARIATION_URI, TYPE_TEXT_VARIATION_VISIBLE_PASSWORD, TYPE_TEXT_VARIATION_WEB_EDIT_TEXT, TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS, TYPE_TEXT_VARIATION_WEB_PASSWORD
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
Constructor and Description |
---|
EditorInfo() |
Modifier and Type | Method and Description |
---|---|
int |
describeContents()
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
|
void |
dump(Printer pw,
String prefix)
Write debug output of this object.
|
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
Parcel . |
public int inputType
InputType
.public static final int IME_MASK_ACTION
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_UNSPECIFIED
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_NONE
IME_MASK_ACTION
: there is no available action.public static final int IME_ACTION_GO
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_SEARCH
IME_MASK_ACTION
: the action key performs a "search"
operation, taking the user to the results of searching for the text
the have typed (in whatever context is appropriate).public static final int IME_ACTION_SEND
IME_MASK_ACTION
: the action key performs a "send"
operation, delivering the text to its target. This is typically used
when composing a message.public static final int IME_ACTION_NEXT
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_DONE
IME_MASK_ACTION
: the action key performs a "done"
operation, typically meaning the IME will be closed.public static final int IME_ACTION_PREVIOUS
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
.public static final int IME_FLAG_NO_FULLSCREEN
imeOptions
: used to request that the IME never go
into fullscreen mode. Applications need to be aware that the flag is not
a guarantee, and not all IMEs will respect it.public static final int IME_FLAG_NAVIGATE_PREVIOUS
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)
.public static final int IME_FLAG_NAVIGATE_NEXT
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)
.public static final int IME_FLAG_NO_EXTRACT_UI
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. Though there will likely be limited
access to the application available from the user, it can make the
experience of a (mostly) fullscreen IME less jarring. Note that when
this flag is specified the IME may not be set up to be able
to display text, so it should only be used in situations where this is
not needed.public static final int IME_FLAG_NO_ACCESSORY_ACTION
imeOptions
: used in conjunction with
IME_MASK_ACTION
, this indicates that the action should not
be available as an accessory button 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 showing text being edited is more important than the
action you have supplied.public static final int IME_FLAG_NO_ENTER_ACTION
imeOptions
: used in conjunction with
IME_MASK_ACTION
, this indicates that the action should not
be available in-line as a replacement for "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.public static final int IME_FLAG_FORCE_ASCII
imeOptions
: used to request that the IME 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
used for, typically, account ID or password input. It is expected that IMEs
normally are able to input ASCII even without being told so (such IMEs
already respect this flag in a sense), but there could be some cases they
aren't when, for instance, only non-ASCII input languagaes like Arabic,
Greek, Hebrew, Russian are enabled in the IME. Applications need to be
aware that the flag is not a guarantee, and not all IMEs will respect it.
However, it is strongly recommended for IME authors to respect this flag
especially when their IME could end up with a state that has only non-ASCII
input languages enabled.public static final int IME_NULL
imeOptions
.public int imeOptions
public String privateImeOptions
"com.example.myapp.SpecialMode=3"
. This field is can be
filled in from the android.R.attr#privateImeOptions
attribute of a TextView.public CharSequence actionLabel
public int actionId
actionLabel
has been given, this is the id for that command
when the user presses its button that is delivered back with
InputConnection.performEditorAction()
.public int initialSelStart
public int initialSelEnd
public int initialCapsMode
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.public CharSequence hintText
public CharSequence label
public String packageName
public int fieldId
View.getId()
on the View that
is being edited.public String fieldName
public Bundle extras
android.R.attr#editorExtras
attribute of a TextView.public static final Parcelable.Creator<EditorInfo> CREATOR
public final void makeCompatible(int targetSdkVersion)
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.
targetSdkVersion
- The API version number that the compatible
application was developed against.public void writeToParcel(Parcel dest, int flags)
Parcel
.writeToParcel
in interface Parcelable
dest
- The Parcel
to be written.flags
- The flags used for parceling.public int describeContents()
Parcelable
describeContents
in interface Parcelable