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
17package android.text.style;
18
19import android.os.Parcel;
20import android.text.ParcelableSpan;
21import 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 */
30public class SpellCheckSpan implements ParcelableSpan {
31
32    private boolean mSpellCheckInProgress;
33
34    public SpellCheckSpan() {
35        mSpellCheckInProgress = false;
36    }
37
38    public SpellCheckSpan(Parcel src) {
39        mSpellCheckInProgress = (src.readInt() != 0);
40    }
41
42    public void setSpellCheckInProgress(boolean inProgress) {
43        mSpellCheckInProgress = inProgress;
44    }
45
46    public boolean isSpellCheckInProgress() {
47        return mSpellCheckInProgress;
48    }
49
50    @Override
51    public int describeContents() {
52        return 0;
53    }
54
55    @Override
56    public void writeToParcel(Parcel dest, int flags) {
57        dest.writeInt(mSpellCheckInProgress ? 1 : 0);
58    }
59
60    @Override
61    public int getSpanTypeId() {
62        return TextUtils.SPELL_CHECK_SPAN;
63    }
64}
65