FileDocCategorySizeDatePackage
EditorInfo.javaAPI DocAndroid 1.5 API11360Wed May 06 22:41:56 BST 2009android.view.inputmethod

EditorInfo

public class EditorInfo extends Object implements android.text.InputType, android.os.Parcelable
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.

Fields Summary
public int
inputType
The content type of the text box, whose bits are defined by {@link InputType}.
public static final int
IME_MASK_ACTION
Set 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_UNSPECIFIED
Bits 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_NONE
Bits of {@link #IME_MASK_ACTION}: there is no available action.
public static final int
IME_ACTION_GO
Bits 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_SEARCH
Bits of {@link #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
Bits 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.
public static final int
IME_ACTION_NEXT
Bits 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_DONE
Bits of {@link #IME_MASK_ACTION}: the action key performs a "done" operation, typically meaning the IME will be closed.
public static final int
IME_FLAG_NO_EXTRACT_UI
Flag 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. 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
Flag of {@link #imeOptions}: used in conjunction with {@link #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
Flag of {@link #imeOptions}: used in conjunction with {@link #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 {@link android.widget.TextView} will automatically set this flag for you on multi-line text views.
public static final int
IME_NULL
Generic unspecified type for {@link #imeOptions}.
public int
imeOptions
Extended type information for the editor, to help the IME better integrate with it.
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 {@link android.R.attr#privateImeOptions} attribute of a TextView.
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. You can not count on this being used.
public int
actionId
If {@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
initialSelStart
The text offset of the start of the selection at the time editing began; -1 if not known.
public int
initialSelEnd
The text offset of the end of the selection at the time editing began; -1 if not known.
public int
initialCapsMode
The 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
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 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 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 {@link android.view.View#getId() View.getId()} on the View that is being edited.
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.
public android.os.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 is can be filled in from the {@link android.R.attr#editorExtras} attribute of a TextView.
public static final Parcelable.Creator
CREATOR
Used to make this class parcelable.
Constructors Summary
Methods Summary
public intdescribeContents()


       
        return 0;
public voiddump(android.util.Printer pw, java.lang.String prefix)
Write debug output of this object.

    
               
          
        pw.println(prefix + "inputType=0x" + Integer.toHexString(inputType)
                + " imeOptions=0x" + Integer.toHexString(imeOptions)
                + " privateImeOptions=" + privateImeOptions);
        pw.println(prefix + "actionLabel=" + actionLabel
                + " actionId=" + actionId);
        pw.println(prefix + "initialSelStart=" + initialSelStart
                + " initialSelEnd=" + initialSelEnd
                + " initialCapsMode=0x"
                + Integer.toHexString(initialCapsMode));
        pw.println(prefix + "hintText=" + hintText
                + " label=" + label);
        pw.println(prefix + "packageName=" + packageName
                + " fieldId=" + fieldId
                + " fieldName=" + fieldName);
        pw.println(prefix + "extras=" + extras);
public voidwriteToParcel(android.os.Parcel dest, int flags)
Used to package this object into a {@link Parcel}.

param
dest The {@link Parcel} to be written.
param
flags The flags used for parceling.

        dest.writeInt(inputType);
        dest.writeInt(imeOptions);
        dest.writeString(privateImeOptions);
        TextUtils.writeToParcel(actionLabel, dest, flags);
        dest.writeInt(actionId);
        dest.writeInt(initialSelStart);
        dest.writeInt(initialSelEnd);
        dest.writeInt(initialCapsMode);
        TextUtils.writeToParcel(hintText, dest, flags);
        TextUtils.writeToParcel(label, dest, flags);
        dest.writeString(packageName);
        dest.writeInt(fieldId);
        dest.writeString(fieldName);
        dest.writeBundle(extras);