1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package android.view.textservice;
import android.os.Parcel;
import android.os.Parcelable;
import com.android.internal.util.ArrayUtils;
/**
* This class contains a metadata of suggestions from the text service
*/
public final class SuggestionsInfo implements Parcelable {
private static final String[] EMPTY = ArrayUtils.emptyArray(String.class);
/**
* Flag of the attributes of the suggestions that can be obtained by
* {@link #getSuggestionsAttributes}: this tells that the requested word was found
* in the dictionary in the text service.
*/
public static final int RESULT_ATTR_IN_THE_DICTIONARY = 0x0001;
/**
* Flag of the attributes of the suggestions that can be obtained by
* {@link #getSuggestionsAttributes}: this tells that the text service thinks the requested
* word looks like a typo.
*/
public static final int RESULT_ATTR_LOOKS_LIKE_TYPO = 0x0002;
/**
* Flag of the attributes of the suggestions that can be obtained by
* {@link #getSuggestionsAttributes}: this tells that the text service thinks
* the result suggestions include highly recommended ones.
*/
public static final int RESULT_ATTR_HAS_RECOMMENDED_SUGGESTIONS = 0x0004;
private final int mSuggestionsAttributes;
private final String[] mSuggestions;
private final boolean mSuggestionsAvailable;
private int mCookie;
private int mSequence;
/**
* Constructor.
* @param suggestionsAttributes from the text service
* @param suggestions from the text service
*/
public SuggestionsInfo(int suggestionsAttributes, String[] suggestions) {
this(suggestionsAttributes, suggestions, 0, 0);
}
/**
* Constructor.
* @param suggestionsAttributes from the text service
* @param suggestions from the text service
* @param cookie the cookie of the input TextInfo
* @param sequence the cookie of the input TextInfo
*/
public SuggestionsInfo(
int suggestionsAttributes, String[] suggestions, int cookie, int sequence) {
if (suggestions == null) {
mSuggestions = EMPTY;
mSuggestionsAvailable = false;
} else {
mSuggestions = suggestions;
mSuggestionsAvailable = true;
}
mSuggestionsAttributes = suggestionsAttributes;
mCookie = cookie;
mSequence = sequence;
}
public SuggestionsInfo(Parcel source) {
mSuggestionsAttributes = source.readInt();
mSuggestions = source.readStringArray();
mCookie = source.readInt();
mSequence = source.readInt();
mSuggestionsAvailable = source.readInt() == 1;
}
/**
* Used to package this object into a {@link Parcel}.
*
* @param dest The {@link Parcel} to be written.
* @param flags The flags used for parceling.
*/
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(mSuggestionsAttributes);
dest.writeStringArray(mSuggestions);
dest.writeInt(mCookie);
dest.writeInt(mSequence);
dest.writeInt(mSuggestionsAvailable ? 1 : 0);
}
/**
* Set the cookie and the sequence of SuggestionsInfo which are set to TextInfo from a client
* application
* @param cookie the cookie of an input TextInfo
* @param sequence the cookie of an input TextInfo
*/
public void setCookieAndSequence(int cookie, int sequence) {
mCookie = cookie;
mSequence = sequence;
}
/**
* @return the cookie which may be set by a client application
*/
public int getCookie() {
return mCookie;
}
/**
* @return the sequence which may be set by a client application
*/
public int getSequence() {
return mSequence;
}
/**
* @return the attributes of suggestions. This includes whether the spell checker has the word
* in its dictionary or not and whether the spell checker has confident suggestions for the
* word or not.
*/
public int getSuggestionsAttributes() {
return mSuggestionsAttributes;
}
/**
* @return the count of the suggestions. If there's no suggestions at all, this method returns
* -1. Even if this method returns 0, it doesn't necessarily mean that there are no suggestions
* for the requested word. For instance, the caller could have been asked to limit the maximum
* number of suggestions returned.
*/
public int getSuggestionsCount() {
if (!mSuggestionsAvailable) {
return -1;
}
return mSuggestions.length;
}
/**
* @param i the id of suggestions
* @return the suggestion at the specified id
*/
public String getSuggestionAt(int i) {
return mSuggestions[i];
}
/**
* Used to make this class parcelable.
*/
public static final @android.annotation.NonNull Parcelable.Creator<SuggestionsInfo> CREATOR
= new Parcelable.Creator<SuggestionsInfo>() {
@Override
public SuggestionsInfo createFromParcel(Parcel source) {
return new SuggestionsInfo(source);
}
@Override
public SuggestionsInfo[] newArray(int size) {
return new SuggestionsInfo[size];
}
};
/**
* Used to make this class parcelable.
*/
@Override
public int describeContents() {
return 0;
}
}
|
