1 /* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.inputmethod.latin; 18 19 import android.text.TextUtils; 20 21 import com.android.inputmethod.event.Event; 22 23 import java.util.ArrayList; 24 25 /** 26 * This class encapsulates data about a word previously composed, but that has been 27 * committed already. This is used for resuming suggestion, and cancel auto-correction. 28 */ 29 public final class LastComposedWord { 30 // COMMIT_TYPE_USER_TYPED_WORD is used when the word committed is the exact typed word, with 31 // no hinting from the IME. It happens when some external event happens (rotating the device, 32 // for example) or when auto-correction is off by settings or editor attributes. 33 public static final int COMMIT_TYPE_USER_TYPED_WORD = 0; 34 // COMMIT_TYPE_MANUAL_PICK is used when the user pressed a field in the suggestion strip. 35 public static final int COMMIT_TYPE_MANUAL_PICK = 1; 36 // COMMIT_TYPE_DECIDED_WORD is used when the IME commits the word it decided was best 37 // for the current user input. It may be different from what the user typed (true auto-correct) 38 // or it may be exactly what the user typed if it's in the dictionary or the IME does not have 39 // enough confidence in any suggestion to auto-correct (auto-correct to typed word). 40 public static final int COMMIT_TYPE_DECIDED_WORD = 2; 41 // COMMIT_TYPE_CANCEL_AUTO_CORRECT is used upon committing back the old word upon cancelling 42 // an auto-correction. 43 public static final int COMMIT_TYPE_CANCEL_AUTO_CORRECT = 3; 44 45 public static final String NOT_A_SEPARATOR = ""; 46 47 public final ArrayList<Event> mEvents; 48 public final String mTypedWord; 49 public final CharSequence mCommittedWord; 50 public final String mSeparatorString; 51 public final PrevWordsInfo mPrevWordsInfo; 52 public final int mCapitalizedMode; 53 public final InputPointers mInputPointers = 54 new InputPointers(Constants.DICTIONARY_MAX_WORD_LENGTH); 55 56 private boolean mActive; 57 58 public static final LastComposedWord NOT_A_COMPOSED_WORD = 59 new LastComposedWord(new ArrayList<Event>(), null, "", "", 60 NOT_A_SEPARATOR, null, WordComposer.CAPS_MODE_OFF); 61 62 // Warning: this is using the passed objects as is and fully expects them to be 63 // immutable. Do not fiddle with their contents after you passed them to this constructor. LastComposedWord(final ArrayList<Event> events, final InputPointers inputPointers, final String typedWord, final CharSequence committedWord, final String separatorString, final PrevWordsInfo prevWordsInfo, final int capitalizedMode)64 public LastComposedWord(final ArrayList<Event> events, 65 final InputPointers inputPointers, final String typedWord, 66 final CharSequence committedWord, final String separatorString, 67 final PrevWordsInfo prevWordsInfo, final int capitalizedMode) { 68 if (inputPointers != null) { 69 mInputPointers.copy(inputPointers); 70 } 71 mTypedWord = typedWord; 72 mEvents = new ArrayList<>(events); 73 mCommittedWord = committedWord; 74 mSeparatorString = separatorString; 75 mActive = true; 76 mPrevWordsInfo = prevWordsInfo; 77 mCapitalizedMode = capitalizedMode; 78 } 79 deactivate()80 public void deactivate() { 81 mActive = false; 82 } 83 canRevertCommit()84 public boolean canRevertCommit() { 85 return mActive && !TextUtils.isEmpty(mCommittedWord) && !didCommitTypedWord(); 86 } 87 didCommitTypedWord()88 private boolean didCommitTypedWord() { 89 return TextUtils.equals(mTypedWord, mCommittedWord); 90 } 91 } 92