public final class CompletionInfo
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | android.view.inputmethod.CompletionInfo |
关于编辑者向输入法报告的单个文本完成的信息。
该类封装了由应用程序提供的完成，该应用程序要由IME将其呈现给用户。 例如，应用程序通常直接在滚动列表中显示完成（UI开发人员通常会使用或扩展来实现此功能）。 但是，在某些情况下，编辑器可能不可见，例如在IME已接管整个屏幕的提取模式下。 在这种情况下，编辑可以选择将其完成内容发送给IME以供显示。
大多数想要完成IME的应用程序应该使用AutoCompleteTextView因为这个类使这个过程变得简单。 在这种情况下，应用程序不必直接处理这个类。
实现自己的编辑器并希望直接控制它的应用程序将创建一个CompletionInfo对象数组，并使用displayCompletions(View, CompletionInfo[])将其发送到IME。 IME会提供他们认为合适的完成，并通过commitCompletion(CompletionInfo)回复编辑。 应用程序可以通过覆盖onCommitCompletion(CompletionInfo)来获取提交事件。
也可以看看：
Inherited constants |
|---|
 From interface android.os.Parcelable
|
Fields |
|
|---|---|
public static final Creator<CompletionInfo> |
CREATOR 用于使这个类可以分类。 |
Public constructors |
|
|---|---|
CompletionInfo(long id, int index, CharSequence text) 用文本创建一个简单的完成，没有标签。 |
|
CompletionInfo(long id, int index, CharSequence text, CharSequence label) 使用文本和标签创建一个完整的完成。 |
|
Public methods |
|
|---|---|
int |
describeContents() 描述此Parcelable实例的封送表示中包含的特殊对象的种类。 |
long |
getId() 返回此完成的抽象标识符，通常对应于原始适配器中与其关联的标识。 |
CharSequence |
getLabel() 返回完成的用户可见标签;如果应显示纯文本，则返回null。 |
int |
getPosition() 返回此完成的原始位置，通常对应于其在原始适配器中的位置。 |
CharSequence |
getText() 返回与此完成相关的实际文本。 |
String |
toString() 返回对象的字符串表示形式。 |
void |
writeToParcel(Parcel dest, int flags) 用于将此对象打包成 |
Inherited methods |
|
|---|---|
From class java.lang.Object
|
|
From interface android.os.Parcelable
|
|
Android开发手册
CompletionInfo (long id,
int index,
CharSequence text)
用文本创建一个简单的完成，没有标签。
| Parameters | |
|---|---|
id |
long: An id that get passed as is (to the editor's discretion) |
index |
int: An index that get passed as is. Typically this is the index in the list of completions inside the editor. |
text |
CharSequence: The text that should be inserted into the editor when this completion is chosen. |
CompletionInfo (long id,
int index,
CharSequence text,
CharSequence label)
使用文本和标签创建一个完整的完成。 文本是插入到编辑器中的内容，而标签是IME应显示的内容。 如果它们相同，则使用不带`label'参数的构造函数的版本。
| Parameters | |
|---|---|
id |
long: An id that get passed as is (to the editor's discretion) |
index |
int: An index that get passed as is. Typically this is the index in the list of completions inside the editor. |
text |
CharSequence: The text that should be inserted into the editor when this completion is chosen. |
label |
CharSequence: The text that the IME should be showing among the completions list. |
int describeContents ()
描述此Parcelable实例的封送表示中包含的特殊对象的种类。 例如，如果对象将在writeToParcel(Parcel, int)的输出中包含writeToParcel(Parcel, int) ，则此方法的返回值必须包含CONTENTS_FILE_DESCRIPTOR位。
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
CharSequence getLabel ()
返回完成的用户可见标签;如果应显示纯文本，则返回null。 如果非null，则这将是用户认为是完成选项而不是实际文本的内容。
| Returns | |
|---|---|
CharSequence |
|
CharSequence getText ()
返回与此完成相关的实际文本。 这是如果用户选择它将被插入到编辑器中的真实文本。
| Returns | |
|---|---|
CharSequence |
|
String toString ()
返回对象的字符串表示形式。 通常， toString方法返回一个“文本表示”该对象的字符串。 结果应该是一个简洁但内容丰富的表述，对于一个人来说很容易阅读。 建议所有子类重写此方法。
类Object的toString方法返回一个字符串，其中包含对象为实例的类的名称，符号字符“ @ ”以及对象的哈希代码的无符号十六进制表示形式。 换句话说，这个方法返回一个字符串，其值等于：
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
void writeToParcel (Parcel dest, int flags)
用于将此对象打包成 Parcel 。
| Parameters | |
|---|---|
dest |
Parcel: The Parcel to be written. |
flags |
int: The flags used for parceling. |