public
final
class
InputMethodInfo
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.view.inputmethod.InputMethodInfo |
This class is used to specify meta information of an input method.
It should be defined in an XML resource file with an <input-method>
element.
For more information, see the guide to
Creating an Input Method.
See also:
XML attributes | |
---|---|
android:isDefault |
Set to true in all of the configurations for which this input method should be considered an option as the default. |
android:settingsActivity |
Component name of an activity that allows the user to modify the settings for this service. |
android:supportsSwitchingToNextInputMethod |
Set to true if this input method supports ways to switch to a next input method (e.g. |
Inherited constants |
---|
From
interface
android.os.Parcelable
|
Fields | |
---|---|
public
static
final
Creator<InputMethodInfo> |
CREATOR
Used to make this class parcelable. |
Public constructors | |
---|---|
InputMethodInfo(Context context, ResolveInfo service)
Constructor. |
|
InputMethodInfo(String packageName, String className, CharSequence label, String settingsActivity)
Temporary API for creating a built-in input method for test. |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
void
|
dump(Printer pw, String prefix)
|
boolean
|
equals(Object o)
Used to test whether the given parameter object is an
|
ComponentName
|
getComponent()
Return the component of the service that implements this input method. |
String
|
getId()
Return a unique ID for this input method. |
int
|
getIsDefaultResourceId()
Return the resource identifier of a resource inside of this input method's .apk that determines whether it should be considered a default input method for the system. |
String
|
getPackageName()
Return the .apk package that implements this input method. |
ServiceInfo
|
getServiceInfo()
Return the raw information about the Service implementing this input method. |
String
|
getServiceName()
Return the class name of the service component that implements this input method. |
String
|
getSettingsActivity()
Return the class name of an activity that provides a settings UI for the input method. |
InputMethodSubtype
|
getSubtypeAt(int index)
Return the Input Method's subtype at the specified index. |
int
|
getSubtypeCount()
Return the count of the subtypes of Input Method. |
int
|
hashCode()
Returns a hash code value for the object. |
Drawable
|
loadIcon(PackageManager pm)
Load the user-displayed icon for this input method. |
CharSequence
|
loadLabel(PackageManager pm)
Load the user-displayed label for this input method. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Used to package this object into a |
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
|
Set to true in all of the configurations for which this input method should be considered an option as the default.
Must be a boolean value, either "true
" or "false
".
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol isDefault
.
Component name of an activity that allows the user to modify the settings for this service.
Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol settingsActivity
.
Set to true if this input method supports ways to switch to a next input method (e.g. a globe key.). When this is true and InputMethodManager#shouldOfferSwitchingToNextInputMethod() returns true, the IME has to offer ways to invoke InputMethodManager#switchToNextInputMethod() accordingly.
Note that the system determines the most appropriate next input method and subtype in order to provide the consistent user experience in switching between IMEs and subtypes.
Must be a boolean value, either "true
" or "false
".
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol supportsSwitchingToNextInputMethod
.
InputMethodInfo (Context context, ResolveInfo service)
Constructor.
Parameters | |
---|---|
context |
Context :
The Context in which we are parsing the input method. |
service |
ResolveInfo :
The ResolveInfo returned from the package manager about
this input method's component.
|
Throws | |
---|---|
XmlPullParserException |
|
IOException |
InputMethodInfo (String packageName, String className, CharSequence label, String settingsActivity)
Temporary API for creating a built-in input method for test.
Parameters | |
---|---|
packageName |
String
|
className |
String
|
label |
CharSequence
|
settingsActivity |
String
|
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. |
boolean equals (Object o)
Used to test whether the given parameter object is an
InputMethodInfo
and its Id is the same to this one.
Parameters | |
---|---|
o |
Object :
the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if the given parameter object is an
InputMethodInfo and its Id is the same to this one.
|
ComponentName getComponent ()
Return the component of the service that implements this input method.
Returns | |
---|---|
ComponentName |
String getId ()
Return a unique ID for this input method. The ID is generated from the package and class name implementing the method.
Returns | |
---|---|
String |
int getIsDefaultResourceId ()
Return the resource identifier of a resource inside of this input method's .apk that determines whether it should be considered a default input method for the system.
Returns | |
---|---|
int |
String getPackageName ()
Return the .apk package that implements this input method.
Returns | |
---|---|
String |
ServiceInfo getServiceInfo ()
Return the raw information about the Service implementing this input method. Do not modify the returned object.
Returns | |
---|---|
ServiceInfo |
String getServiceName ()
Return the class name of the service component that implements this input method.
Returns | |
---|---|
String |
String getSettingsActivity ()
Return the class name of an activity that provides a settings UI for
the input method. You can launch this activity be starting it with
an Intent
whose action is MAIN and with an
explicit ComponentName
composed of getPackageName()
and the class name returned here.
A null will be returned if there is no settings activity associated with the input method.
Returns | |
---|---|
String |
InputMethodSubtype getSubtypeAt (int index)
Return the Input Method's subtype at the specified index.
Parameters | |
---|---|
index |
int :
the index of the subtype to return.
|
Returns | |
---|---|
InputMethodSubtype |
int getSubtypeCount ()
Return the count of the subtypes of Input Method.
Returns | |
---|---|
int |
int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
Drawable loadIcon (PackageManager pm)
Load the user-displayed icon for this input method.
Parameters | |
---|---|
pm |
PackageManager :
Supply a PackageManager used to load the input method's
resources.
|
Returns | |
---|---|
Drawable |
CharSequence loadLabel (PackageManager pm)
Load the user-displayed label for this input method.
Parameters | |
---|---|
pm |
PackageManager :
Supply a PackageManager used to load the input method's
resources.
|
Returns | |
---|---|
CharSequence |
String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
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.
|