LastComposedWord.java revision 01ab7c8b59a7f12862fbd95fb252e56719f1757f 
1/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5 * use this file except in compliance with the License. You may obtain a copy of
6 * 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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations under
14 * the License.
15 */
16
17package com.android.inputmethod.latin;
18
19import android.text.TextUtils;
20
21/**
22 * This class encapsulates data about a word previously composed, but that has been
23 * committed already. This is used for resuming suggestion, and cancel auto-correction.
24 */
25public class LastComposedWord {
26    // COMMIT_TYPE_USER_TYPED_WORD is used when the word committed is the exact typed word, with
27    // no hinting from the IME. It happens when some external event happens (rotating the device,
28    // for example) or when auto-correction is off by settings or editor attributes.
29    public static final int COMMIT_TYPE_USER_TYPED_WORD = 0;
30    // COMMIT_TYPE_MANUAL_PICK is used when the user pressed a field in the suggestion strip.
31    public static final int COMMIT_TYPE_MANUAL_PICK = 1;
32    // COMMIT_TYPE_DECIDED_WORD is used when the IME commits the word it decided was best
33    // for the current user input. It may be different from what the user typed (true auto-correct)
34    // or it may be exactly what the user typed if it's in the dictionary or the IME does not have
35    // enough confidence in any suggestion to auto-correct (auto-correct to typed word).
36    public static final int COMMIT_TYPE_DECIDED_WORD = 2;
37    // COMMIT_TYPE_CANCEL_AUTO_CORRECT is used upon committing back the old word upon cancelling
38    // an auto-correction.
39    public static final int COMMIT_TYPE_CANCEL_AUTO_CORRECT = 3;
40
41    public static final int NOT_A_SEPARATOR = -1;
42
43    public final int[] mPrimaryKeyCodes;
44    public final int[] mXCoordinates;
45    public final int[] mYCoordinates;
46    public final String mTypedWord;
47    public final String mCommittedWord;
48    public final int mSeparatorCode;
49
50    private boolean mActive;
51
52    public static final LastComposedWord NOT_A_COMPOSED_WORD =
53            new LastComposedWord(null, null, null, "", "", NOT_A_SEPARATOR);
54
55    // Warning: this is using the passed objects as is and fully expects them to be
56    // immutable. Do not fiddle with their contents after you passed them to this constructor.
57    public LastComposedWord(final int[] primaryKeyCodes, final int[] xCoordinates,
58            final int[] yCoordinates, final String typedWord, final String committedWord,
59            final int separatorCode) {
60        mPrimaryKeyCodes = primaryKeyCodes;
61        mXCoordinates = xCoordinates;
62        mYCoordinates = yCoordinates;
63        mTypedWord = typedWord;
64        mCommittedWord = committedWord;
65        mSeparatorCode = separatorCode;
66        mActive = true;
67    }
68
69    public void deactivate() {
70        mActive = false;
71    }
72
73    public boolean canRevertCommit() {
74        return mActive && !TextUtils.isEmpty(mCommittedWord);
75    }
76
77    public boolean didCommitTypedWord() {
78        return TextUtils.equals(mTypedWord, mCommittedWord);
79    }
80
81    public static int getSeparatorLength(final int separatorCode) {
82        return NOT_A_SEPARATOR == separatorCode ? 0 : 1;
83    }
84}
85