| /* |
| * Copyright (C) 2006 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.text.style; |
| |
| import android.annotation.ColorInt; |
| import android.annotation.NonNull; |
| import android.os.Parcel; |
| import android.text.ParcelableSpan; |
| import android.text.TextPaint; |
| import android.text.TextUtils; |
| |
| /** |
| * Changes the background color of the text to which the span is attached. |
| * <p> |
| * For example, to set a green background color for a text you would create a {@link |
| * android.text.SpannableStringBuilder} based on the text and set the span. |
| * <pre>{@code |
| * SpannableString string = new SpannableString("Text with a background color span"); |
| *string.setSpan(new BackgroundColorSpan(color), 12, 28, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE); |
| * }</pre> |
| * <img src="{@docRoot}reference/android/images/text/style/backgroundcolorspan.png" /> |
| * <figcaption>Set a background color for the text.</figcaption> |
| */ |
| public class BackgroundColorSpan extends CharacterStyle |
| implements UpdateAppearance, ParcelableSpan { |
| |
| private final int mColor; |
| |
| /** |
| * Creates a {@link BackgroundColorSpan} from a color integer. |
| * <p> |
| * |
| * @param color color integer that defines the background color |
| * @see android.content.res.Resources#getColor(int, Resources.Theme) |
| */ |
| public BackgroundColorSpan(@ColorInt int color) { |
| mColor = color; |
| } |
| |
| /** |
| * Creates a {@link BackgroundColorSpan} from a parcel. |
| */ |
| public BackgroundColorSpan(@NonNull Parcel src) { |
| mColor = src.readInt(); |
| } |
| |
| public int getSpanTypeId() { |
| return getSpanTypeIdInternal(); |
| } |
| |
| /** @hide */ |
| public int getSpanTypeIdInternal() { |
| return TextUtils.BACKGROUND_COLOR_SPAN; |
| } |
| |
| public int describeContents() { |
| return 0; |
| } |
| |
| /** |
| * Flatten this object into a Parcel. |
| * |
| * @param dest The Parcel in which the object should be written. |
| * @param flags Additional flags about how the object should be written. |
| */ |
| public void writeToParcel(@NonNull Parcel dest, int flags) { |
| writeToParcelInternal(dest, flags); |
| } |
| |
| /** @hide */ |
| public void writeToParcelInternal(@NonNull Parcel dest, int flags) { |
| dest.writeInt(mColor); |
| } |
| |
| /** |
| * @return the background color of this span. |
| * @see BackgroundColorSpan#BackgroundColorSpan(int) |
| */ |
| @ColorInt |
| public int getBackgroundColor() { |
| return mColor; |
| } |
| |
| /** |
| * Updates the background color of the TextPaint. |
| */ |
| @Override |
| public void updateDrawState(@NonNull TextPaint textPaint) { |
| textPaint.bgColor = mColor; |
| } |
| } |