LastComposedWord.java revision f8accd8839d291f10b218e64aa6b8eb154c92c4c 
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
17package com.android.inputmethod.latin;
18
19import android.text.TextUtils;
20
21import com.android.inputmethod.event.Event;
22
23import 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 */
29public 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 int[] mPrimaryKeyCodes;
48    public final ArrayList<Event> mEvents;
49    public final String mTypedWord;
50    public final CharSequence mCommittedWord;
51    public final String mSeparatorString;
52    public final String mPrevWord;
53    public final int mCapitalizedMode;
54    public final InputPointers mInputPointers =
55            new InputPointers(Constants.DICTIONARY_MAX_WORD_LENGTH);
56
57    private boolean mActive;
58
59    public static final LastComposedWord NOT_A_COMPOSED_WORD =
60            new LastComposedWord(null, new ArrayList<Event>(), null, "", "",
61            NOT_A_SEPARATOR, null, WordComposer.CAPS_MODE_OFF);
62
63    // Warning: this is using the passed objects as is and fully expects them to be
64    // immutable. Do not fiddle with their contents after you passed them to this constructor.
65    public LastComposedWord(final int[] primaryKeyCodes, final ArrayList<Event> events,
66            final InputPointers inputPointers, final String typedWord,
67            final CharSequence committedWord, final String separatorString,
68            final String prevWord, final int capitalizedMode) {
69        mPrimaryKeyCodes = primaryKeyCodes;
70        if (inputPointers != null) {
71            mInputPointers.copy(inputPointers);
72        }
73        mTypedWord = typedWord;
74        mEvents = new ArrayList<Event>(events);
75        mCommittedWord = committedWord;
76        mSeparatorString = separatorString;
77        mActive = true;
78        mPrevWord = prevWord;
79        mCapitalizedMode = capitalizedMode;
80    }
81
82    public void deactivate() {
83        mActive = false;
84    }
85
86    public boolean canRevertCommit() {
87        return mActive && !TextUtils.isEmpty(mCommittedWord) && !didCommitTypedWord();
88    }
89
90    private boolean didCommitTypedWord() {
91        return TextUtils.equals(mTypedWord, mCommittedWord);
92    }
93}
94