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.TextPaint;
22import android.text.TextUtils;
23
24/**
25 * A SuggestionRangeSpan is used to show which part of an EditText is affected by a suggestion
26 * popup window.
27 *
28 * @hide
29 */
30public class SuggestionRangeSpan extends CharacterStyle implements ParcelableSpan {
31    private int mBackgroundColor;
32
33    public SuggestionRangeSpan() {
34        // 0 is a fully transparent black. Has to be set using #setBackgroundColor
35        mBackgroundColor = 0;
36    }
37
38    public SuggestionRangeSpan(Parcel src) {
39        mBackgroundColor = src.readInt();
40    }
41
42    @Override
43    public int describeContents() {
44        return 0;
45    }
46
47    @Override
48    public void writeToParcel(Parcel dest, int flags) {
49        writeToParcelInternal(dest, flags);
50    }
51
52    /** @hide */
53    public void writeToParcelInternal(Parcel dest, int flags) {
54        dest.writeInt(mBackgroundColor);
55    }
56
57    @Override
58    public int getSpanTypeId() {
59        return getSpanTypeIdInternal();
60    }
61
62    /** @hide */
63    public int getSpanTypeIdInternal() {
64        return TextUtils.SUGGESTION_RANGE_SPAN;
65    }
66
67    public void setBackgroundColor(int backgroundColor) {
68        mBackgroundColor = backgroundColor;
69    }
70
71    @Override
72    public void updateDrawState(TextPaint tp) {
73        tp.bgColor = mBackgroundColor;
74    }
75}
76