/*
* Copyright (C) 2014 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 androidx.appcompat.widget;
import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX;
import android.content.Context;
import android.content.res.ColorStateList;
import android.graphics.PorterDuff;
import android.graphics.drawable.Drawable;
import android.util.AttributeSet;
import android.view.ActionMode;
import android.view.View;
import android.view.inputmethod.EditorInfo;
import android.view.inputmethod.InputConnection;
import android.widget.CheckedTextView;
import android.widget.TextView;
import androidx.annotation.DrawableRes;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RequiresApi;
import androidx.annotation.RestrictTo;
import androidx.appcompat.R;
import androidx.appcompat.content.res.AppCompatResources;
import androidx.core.view.TintableBackgroundView;
import androidx.core.view.ViewCompat;
import androidx.core.widget.TextViewCompat;
import androidx.core.widget.TintableCheckedTextView;
import androidx.core.widget.TintableCompoundDrawablesView;
import androidx.resourceinspection.annotation.AppCompatShadowedAttributes;
/**
* A {@link CheckedTextView} which supports compatible features on older versions of the platform,
* including:
* <ul>
* <li>Allows dynamic tint of its background via the background tint methods in
* {@link androidx.core.view.ViewCompat}.</li>
* <li>Allows setting of the background tint using {@link R.attr#backgroundTint} and
* {@link R.attr#backgroundTintMode}.</li>
* <li>Allows dynamic tint of its check mark via the check mark tint methods in
* {@link androidx.core.widget.CheckedTextViewCompat}.</li>
* <li>Allows setting of the check mark tint using {@link R.attr#checkMarkTint} and
* {@link R.attr#checkMarkTintMode}.</li>
* <li>Allows setting of the font family using {@link android.R.attr#fontFamily}</li>
* </ul>
*
* <p>This will automatically be used when you use {@link CheckedTextView} in your layouts
* and the top-level activity / dialog is provided by
* <a href="{@docRoot}topic/libraries/support-library/packages.html#v7-appcompat">appcompat</a>.
* You should only need to manually use this class when writing custom views.</p>
*/
@AppCompatShadowedAttributes
public class AppCompatCheckedTextView extends CheckedTextView implements TintableCheckedTextView,
TintableBackgroundView, EmojiCompatConfigurationView, TintableCompoundDrawablesView {
private final AppCompatCheckedTextViewHelper mCheckedHelper;
private final AppCompatBackgroundHelper mBackgroundTintHelper;
private final AppCompatTextHelper mTextHelper;
@NonNull
private AppCompatEmojiTextHelper mAppCompatEmojiTextHelper;
public AppCompatCheckedTextView(@NonNull Context context) {
this(context, null);
}
public AppCompatCheckedTextView(@NonNull Context context, @Nullable AttributeSet attrs) {
this(context, attrs, R.attr.checkedTextViewStyle);
}
public AppCompatCheckedTextView(
@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
super(TintContextWrapper.wrap(context), attrs, defStyleAttr);
ThemeUtils.checkAppCompatTheme(this, getContext());
mTextHelper = new AppCompatTextHelper(this);
mTextHelper.loadFromAttributes(attrs, defStyleAttr);
mTextHelper.applyCompoundDrawablesTints();
mBackgroundTintHelper = new AppCompatBackgroundHelper(this);
mBackgroundTintHelper.loadFromAttributes(attrs, defStyleAttr);
mCheckedHelper = new AppCompatCheckedTextViewHelper(this);
mCheckedHelper.loadFromAttributes(attrs, defStyleAttr);
AppCompatEmojiTextHelper emojiTextViewHelper = getEmojiTextViewHelper();
emojiTextViewHelper.loadFromAttributes(attrs, defStyleAttr);
}
@Override
public void setCheckMarkDrawable(@Nullable Drawable d) {
super.setCheckMarkDrawable(d);
if (mCheckedHelper != null) {
mCheckedHelper.onSetCheckMarkDrawable();
}
}
@Override
public void setCheckMarkDrawable(@DrawableRes int resId) {
setCheckMarkDrawable(AppCompatResources.getDrawable(getContext(), resId));
}
/**
* This should be accessed from {@link androidx.core.widget.CheckedTextViewCompat}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Override
public void setSupportCheckMarkTintList(@Nullable ColorStateList tint) {
if (mCheckedHelper != null) {
mCheckedHelper.setSupportCheckMarkTintList(tint);
}
}
/**
* This should be accessed from {@link androidx.core.widget.CheckedTextViewCompat}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Nullable
@Override
public ColorStateList getSupportCheckMarkTintList() {
return mCheckedHelper != null
? mCheckedHelper.getSupportCheckMarkTintList()
: null;
}
/**
* This should be accessed from {@link androidx.core.widget.CheckedTextViewCompat}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Override
public void setSupportCheckMarkTintMode(@Nullable PorterDuff.Mode tintMode) {
if (mCheckedHelper != null) {
mCheckedHelper.setSupportCheckMarkTintMode(tintMode);
}
}
/**
* This should be accessed from {@link androidx.core.widget.CheckedTextViewCompat}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Nullable
@Override
public PorterDuff.Mode getSupportCheckMarkTintMode() {
return mCheckedHelper != null
? mCheckedHelper.getSupportCheckMarkTintMode()
: null;
}
/**
* This should be accessed via
* {@link ViewCompat#setBackgroundTintList(View, ColorStateList)}
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Override
public void setSupportBackgroundTintList(@Nullable ColorStateList tint) {
if (mBackgroundTintHelper != null) {
mBackgroundTintHelper.setSupportBackgroundTintList(tint);
}
}
/**
* This should be accessed via
* {@link androidx.core.view.ViewCompat#getBackgroundTintList(android.view.View)}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Override
@Nullable
public ColorStateList getSupportBackgroundTintList() {
return mBackgroundTintHelper != null
? mBackgroundTintHelper.getSupportBackgroundTintList() : null;
}
/**
* This should be accessed via
* {@link ViewCompat#setBackgroundTintMode(View, PorterDuff.Mode)}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Override
public void setSupportBackgroundTintMode(@Nullable PorterDuff.Mode tintMode) {
if (mBackgroundTintHelper != null) {
mBackgroundTintHelper.setSupportBackgroundTintMode(tintMode);
}
}
/**
* This should be accessed via
* {@link androidx.core.view.ViewCompat#getBackgroundTintMode(android.view.View)}
*
* @hide
*/
@RestrictTo(LIBRARY_GROUP_PREFIX)
@Override
@Nullable
public PorterDuff.Mode getSupportBackgroundTintMode() {
return mBackgroundTintHelper != null
? mBackgroundTintHelper.getSupportBackgroundTintMode() : null;
}
@Override
public void setBackgroundDrawable(@Nullable Drawable background) {
super.setBackgroundDrawable(background);
if (mBackgroundTintHelper != null) {
mBackgroundTintHelper.onSetBackgroundDrawable(background);
}
}
@Override
public void setBackgroundResource(@DrawableRes int resId) {
super.setBackgroundResource(resId);
if (mBackgroundTintHelper != null) {
mBackgroundTintHelper.onSetBackgroundResource(resId);
}
}
@Override
public void setTextAppearance(@NonNull Context context, int resId) {
super.setTextAppearance(context, resId);
if (mTextHelper != null) {
mTextHelper.onSetTextAppearance(context, resId);
}
}
@Override
protected void drawableStateChanged() {
super.drawableStateChanged();
if (mTextHelper != null) {
mTextHelper.applyCompoundDrawablesTints();
}
if (mBackgroundTintHelper != null) {
mBackgroundTintHelper.applySupportBackgroundTint();
}
if (mCheckedHelper != null) {
mCheckedHelper.applyCheckMarkTint();
}
}
@Override
@Nullable
public InputConnection onCreateInputConnection(@NonNull EditorInfo outAttrs) {
return AppCompatHintHelper.onCreateInputConnection(super.onCreateInputConnection(outAttrs),
outAttrs, this);
}
/**
* See
* {@link TextViewCompat#setCustomSelectionActionModeCallback(TextView, ActionMode.Callback)}
*/
@Override
public void setCustomSelectionActionModeCallback(
@Nullable ActionMode.Callback actionModeCallback) {
super.setCustomSelectionActionModeCallback(
TextViewCompat.wrapCustomSelectionActionModeCallback(this, actionModeCallback));
}
@Override
@Nullable
public ActionMode.Callback getCustomSelectionActionModeCallback() {
return TextViewCompat.unwrapCustomSelectionActionModeCallback(
super.getCustomSelectionActionModeCallback());
}
/**
* This may be called from super constructors.
*/
@NonNull
private AppCompatEmojiTextHelper getEmojiTextViewHelper() {
//noinspection ConstantConditions
if (mAppCompatEmojiTextHelper == null) {
mAppCompatEmojiTextHelper = new AppCompatEmojiTextHelper(this);
}
return mAppCompatEmojiTextHelper;
}
@Override
public void setAllCaps(boolean allCaps) {
super.setAllCaps(allCaps);
getEmojiTextViewHelper().setAllCaps(allCaps);
}
@Override
public void setEmojiCompatEnabled(boolean enabled) {
getEmojiTextViewHelper().setEnabled(enabled);
}
@Override
public boolean isEmojiCompatEnabled() {
return getEmojiTextViewHelper().isEnabled();
}
@Override
public void setCompoundDrawables(@Nullable Drawable left, @Nullable Drawable top,
@Nullable Drawable right, @Nullable Drawable bottom) {
super.setCompoundDrawables(left, top, right, bottom);
if (mTextHelper != null) {
mTextHelper.onSetCompoundDrawables();
}
}
@RequiresApi(17)
@Override
public void setCompoundDrawablesRelative(@Nullable Drawable start, @Nullable Drawable top,
@Nullable Drawable end, @Nullable Drawable bottom) {
super.setCompoundDrawablesRelative(start, top, end, bottom);
if (mTextHelper != null) {
mTextHelper.onSetCompoundDrawables();
}
}
/**
* This should be accessed via
* {@link androidx.core.widget.TextViewCompat#getCompoundDrawableTintList(TextView)}
*
* @return the tint applied to the compound drawables
* @attr ref androidx.appcompat.R.styleable#AppCompatTextView_drawableTint
* @see #setSupportCompoundDrawablesTintList(ColorStateList)
*
* @hide
*/
@Nullable
@Override
@RestrictTo(LIBRARY_GROUP_PREFIX)
public ColorStateList getSupportCompoundDrawablesTintList() {
return mTextHelper.getCompoundDrawableTintList();
}
/**
* This should be accessed via {@link
* androidx.core.widget.TextViewCompat#setCompoundDrawableTintList(TextView, ColorStateList)}
*
* Applies a tint to the compound drawables. Does not modify the current tint mode, which is
* {@link PorterDuff.Mode#SRC_IN} by default.
* <p>
* Subsequent calls to {@link #setCompoundDrawables(Drawable, Drawable, Drawable, Drawable)} and
* related methods will automatically mutate the drawables and apply the specified tint and tint
* mode using {@link Drawable#setTintList(ColorStateList)}.
*
* @param tintList the tint to apply, may be {@code null} to clear tint
* @attr ref androidx.appcompat.R.styleable#AppCompatTextView_drawableTint
* @see #getSupportCompoundDrawablesTintList()
*
* @hide
*/
@Override
@RestrictTo(LIBRARY_GROUP_PREFIX)
public void setSupportCompoundDrawablesTintList(@Nullable ColorStateList tintList) {
mTextHelper.setCompoundDrawableTintList(tintList);
mTextHelper.applyCompoundDrawablesTints();
}
/**
* This should be accessed via
* {@link androidx.core.widget.TextViewCompat#getCompoundDrawableTintMode(TextView)}
*
* Returns the blending mode used to apply the tint to the compound drawables, if specified.
*
* @return the blending mode used to apply the tint to the compound drawables
* @attr ref androidx.appcompat.R.styleable#AppCompatTextView_drawableTintMode
* @see #setSupportCompoundDrawablesTintMode(PorterDuff.Mode)
*
* @hide
*/
@Nullable
@Override
@RestrictTo(LIBRARY_GROUP_PREFIX)
public PorterDuff.Mode getSupportCompoundDrawablesTintMode() {
return mTextHelper.getCompoundDrawableTintMode();
}
/**
* This should be accessed via {@link
* androidx.core.widget.TextViewCompat#setCompoundDrawableTintMode(TextView, PorterDuff.Mode)}
*
* Specifies the blending mode used to apply the tint specified by
* {@link #setSupportCompoundDrawablesTintList(ColorStateList)} to the compound drawables. The
* default mode is {@link PorterDuff.Mode#SRC_IN}.
*
* @param tintMode the blending mode used to apply the tint, may be {@code null} to clear tint
* @attr ref androidx.appcompat.R.styleable#AppCompatTextView_drawableTintMode
* @see #setSupportCompoundDrawablesTintList(ColorStateList)
*
* @hide
*/
@Override
@RestrictTo(LIBRARY_GROUP_PREFIX)
public void setSupportCompoundDrawablesTintMode(@Nullable PorterDuff.Mode tintMode) {
mTextHelper.setCompoundDrawableTintMode(tintMode);
mTextHelper.applyCompoundDrawablesTints();
}
}