public final class

CorrectionInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.view.inputmethod.CorrectionInfo

Class Overview

Information about a single text correction that an editor has reported to an input method.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<CorrectionInfo> CREATOR Used to make this class parcelable.
Public Constructors
CorrectionInfo(int offset, CharSequence oldText, CharSequence newText)
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
CharSequence getNewText()
Return the new text that corrects what was typed by the user.
int getOffset()
Return the offset position of this correction in the text.
CharSequence getOldText()
Return the text that has actually been typed by the user, and which has been corrected.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Used to package this object into a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<CorrectionInfo> CREATOR

Since: API Level 11

Used to make this class parcelable.

Public Constructors

public CorrectionInfo (int offset, CharSequence oldText, CharSequence newText)

Since: API Level 11

Parameters
offset The offset in the edited text where the old and new text start.
oldText The old text that has been replaced.
newText The replacement text.

Public Methods

public int describeContents ()

Since: API Level 11

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public CharSequence getNewText ()

Since: API Level 11

Return the new text that corrects what was typed by the user.

public int getOffset ()

Since: API Level 11

Return the offset position of this correction in the text. Both the getOldText() and getNewText() start at this offset.

public CharSequence getOldText ()

Since: API Level 11

Return the text that has actually been typed by the user, and which has been corrected.

public String toString ()

Since: API Level 11

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Since: API Level 11

Used to package this object into a Parcel.

Parameters
dest The Parcel to be written.
flags The flags used for parceling.