19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007-2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); you may not 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * use this file except in compliance with the License. You may obtain a copy of 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * License for the specific language governing permissions and limitations under 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.view.inputmethod; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Parcel; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Parcelable; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.text.TextUtils; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Information about a single text completion that an editor has reported to 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * an input method. 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic final class CompletionInfo implements Parcelable { 28cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne private final long mId; 29cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne private final int mPosition; 30cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne private final CharSequence mText; 31cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne private final CharSequence mLabel; 32cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a simple completion with just text, no label. 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CompletionInfo(long id, int index, CharSequence text) { 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mId = id; 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPosition = index; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mText = text; 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLabel = null; 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a full completion with both text and label. 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CompletionInfo(long id, int index, CharSequence text, CharSequence label) { 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mId = id; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPosition = index; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mText = text; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLabel = label; 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 53cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne private CompletionInfo(Parcel source) { 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mId = source.readLong(); 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPosition = source.readInt(); 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mText = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(source); 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLabel = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(source); 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the abstract identifier for this completion, typically 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * corresponding to the id associated with it in the original adapter. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public long getId() { 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mId; 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the original position of this completion, typically 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * corresponding to its position in the original adapter. 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getPosition() { 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPosition; 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the actual text associated with this completion. This is the 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * real text that will be inserted into the editor if the user selects it. 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getText() { 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mText; 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the user-visible label for the completion, or null if the plain 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * text should be shown. If non-null, this will be what the user sees as 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the completion option instead of the actual text. 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getLabel() { 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLabel; 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return "CompletionInfo{#" + mPosition + " \"" + mText 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "\" id=" + mId + " label=" + mLabel + "}"; 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Used to package this object into a {@link Parcel}. 101cf9cf2f40efc4ccf3f73e6fdb07725d9c00c4f91Gilles Debunne * 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param dest The {@link Parcel} to be written. 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags The flags used for parceling. 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void writeToParcel(Parcel dest, int flags) { 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeLong(mId); 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dest.writeInt(mPosition); 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project TextUtils.writeToParcel(mText, dest, flags); 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project TextUtils.writeToParcel(mLabel, dest, flags); 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Used to make this class parcelable. 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Parcelable.Creator<CompletionInfo> CREATOR 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project = new Parcelable.Creator<CompletionInfo>() { 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CompletionInfo createFromParcel(Parcel source) { 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new CompletionInfo(source); 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CompletionInfo[] newArray(int size) { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new CompletionInfo[size]; 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }; 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int describeContents() { 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return 0; 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 130