1 /*
2  * Copyright (C) 2011 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 android.text.style;
18 
19 import android.os.Parcel;
20 import android.text.ParcelableSpan;
21 import android.text.TextUtils;
22 
23 /**
24  * A SpellCheckSpan is an internal data structure created by the TextView's SpellChecker to
25  * annotate portions of the text that are about to or currently being spell checked. They are
26  * automatically removed once the spell check is completed.
27  *
28  * @hide
29  */
30 public class SpellCheckSpan implements ParcelableSpan {
31 
32     private boolean mSpellCheckInProgress;
33 
SpellCheckSpan()34     public SpellCheckSpan() {
35         mSpellCheckInProgress = false;
36     }
37 
SpellCheckSpan(Parcel src)38     public SpellCheckSpan(Parcel src) {
39         mSpellCheckInProgress = (src.readInt() != 0);
40     }
41 
setSpellCheckInProgress(boolean inProgress)42     public void setSpellCheckInProgress(boolean inProgress) {
43         mSpellCheckInProgress = inProgress;
44     }
45 
isSpellCheckInProgress()46     public boolean isSpellCheckInProgress() {
47         return mSpellCheckInProgress;
48     }
49 
50     @Override
describeContents()51     public int describeContents() {
52         return 0;
53     }
54 
55     @Override
writeToParcel(Parcel dest, int flags)56     public void writeToParcel(Parcel dest, int flags) {
57         writeToParcelInternal(dest, flags);
58     }
59 
60     /** @hide */
writeToParcelInternal(Parcel dest, int flags)61     public void writeToParcelInternal(Parcel dest, int flags) {
62         dest.writeInt(mSpellCheckInProgress ? 1 : 0);
63     }
64 
65     @Override
getSpanTypeId()66     public int getSpanTypeId() {
67         return getSpanTypeIdInternal();
68     }
69 
70     /** @hide */
getSpanTypeIdInternal()71     public int getSpanTypeIdInternal() {
72         return TextUtils.SPELL_CHECK_SPAN;
73     }
74 }
75