android 自定义控件 自定义属性详细介绍

下面我会为您详细讲解“Android自定义控件自定义属性详细介绍”的攻略。

什么是自定义属性

在Android中，控件相关的属性值都是可以在xml布局文件中进行设置的。除了Android系统提供的属性之外，我们也可以自己定义一些属性，来达到更好的效果和定制化的需求。

自定义属性的方法

我们可以通过在attrs.xml文件中定义属性，来实现自定义属性的效果。这个文件通常会放在res/values目录下。这个文件中，我们需要按照如下方式进行定义：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="自定义控件名称">
        <!--  定义属性  -->
    </declare-styleable>
</resources>

其中，“自定义控件名称”是我们自定义控件的名称，对应该控件类名首字母小写后的名称。在declare-styleable标签中，我们可以通过<attr>标签定义对应的属性，定义如下：

<attr name="属性名" format="属性类型" />

其中，name表示属性名称，format表示属性类型。

现在，我们已经定义好了自定义控件的属性，接下来，我们可以将这些属性应用到我们的控件中。

在布局文件中使用自定义属性

在我们的控件对应的布局文件中，我们可以通过以下方式来使用自定义属性：

<com.example.MyView
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:自定义属性名="属性值" />

其中，app是我们定义属性时指定的命名空间前缀。

在控件代码中读取自定义属性

在自定义控件的代码中，我们也可以通过以下方式来读取自定义属性的值：

int value = context.obtainStyledAttributes(attrs, R.styleable.自定义控件名称, defStyleAttr, defStyleRes)
    .get属性类型(R.styleable.自定义控件名称_属性名);

其中，

• context是正常的上下文对象；
• attrs是传入自定义View的构造函数中的 AttributeSet 对象；
• R.styleable.自定义控件名称是在 values/attrs.xml 文件中定义的自定义属性集合；
• defStyleAttr 是系统样式属性，如果这个属性在当前应用的样式中被定义，则会被传入；
• defStyleRes 是自定义样式属性，它是一个引用，指向一个定义了样式的资源 ID；
• R.styleable.自定义控件名称_属性名 是当前属性在 R.styleable.自定义控件名称 类型集合中的索引。

通过以上方法，我们就能获取到自定义属性对应的值了。

自定义属性使用示例

1. 自定义控件的大小和颜色属性

下面代码实现了一个简单的自定义控件，包括两个自定义属性：大小和颜色。

首先，在 res/values/attrs.xml 中定义自定义属性：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="MyView">
        <attr name="mySize" format="dimension" />
        <attr name="myColor" format="color" />
    </declare-styleable>
</resources>

然后，在 MyView 控件的布局文件中使用这些属性：

<com.example.MyView
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:mySize="100dp"
    app:myColor="#FF0000" />

接着，在 MyView 控件的代码中读取这些属性：

public class MyView extends View {
    private int mSize;
    private int mColor;

    public MyView(Context context, AttributeSet attrs) {
        super(context, attrs);

        // 读取自定义属性
        TypedArray a = context.getTheme().obtainStyledAttributes(
                attrs, R.styleable.MyView, 0, 0);
        try {
            mSize = a.getDimensionPixelSize(R.styleable.MyView_mySize, 100);
            mColor = a.getColor(R.styleable.MyView_myColor, Color.RED);
        } finally {
            a.recycle();
        }
    }

    @Override
    protected void onDraw(Canvas canvas) {
        super.onDraw(canvas);

        // 绘制带有自定义颜色的文本
        String text = "Hello, World!";
        Paint paint = new Paint();
        paint.setColor(mColor);
        paint.setTextSize(mSize);
        canvas.drawText(text, 0, text.length(), 10, 50, paint);
    }
}

1. 自定义 RatingBar 控件，支持自定义颜色属性

以下代码实现了一个自定义的 RatingBar 控件，支持自定义颜色属性。

在 res/values/attrs.xml 中定义自定义属性：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="RatingBar">
        <attr name="barColor" format="color" />
    </declare-styleable>
</resources>

RatingBar.java：

public class RatingBar extends LinearLayout {
    private int mStarCount = 5;
    private float mRating = 0f;
    private RatingBarCallbacks mCallbacks;

    private Drawable mFilledStar;
    private Drawable mEmptyStar;

    private int mBarColor = Color.BLUE;

    public interface RatingBarCallbacks {
        void onRatingChanged(float rating);
    }

    public RatingBar(Context context) {
        super(context);
        init();
    }

    public RatingBar(Context context, @Nullable AttributeSet attrs) {
        super(context, attrs);
        initAttrs(attrs);
        init();
    }

    private void initAttrs(AttributeSet attrs) {
        TypedArray a = getContext().obtainStyledAttributes(attrs, R.styleable.RatingBar);
        mBarColor = a.getColor(R.styleable.RatingBar_barColor, mBarColor);
        a.recycle();
    }

    private void init() {
        setOrientation(HORIZONTAL);

        mFilledStar = getResources().getDrawable(R.drawable.ic_star_filled);
        mEmptyStar = getResources().getDrawable(R.drawable.ic_star_empty);

        for (int i = 0; i < mStarCount; i++) {
            final ImageView imageView = new ImageView(getContext());
            setStarColor(imageView, mEmptyStar);
            LinearLayout.LayoutParams layoutParams = new LinearLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT);
            layoutParams.gravity = Gravity.CENTER;
            layoutParams.weight = 1.0f;
            imageView.setLayoutParams(layoutParams);
            imageView.setOnClickListener(new OnClickListener() {
                @Override
                public void onClick(View v) {
                    mRating = indexOfChild(imageView) + 1;
                    updateRating();
                    if (mCallbacks != null) {
                        mCallbacks.onRatingChanged(mRating);
                    }
                }
            });
            addView(imageView);
        }

        updateRating();
    }

    private void updateRating() {
        for (int i = 0; i < mStarCount; i++) {
            final ImageView imageView = (ImageView) getChildAt(i);
            if (i < mRating) {
                setStarColor(imageView, mFilledStar);
            } else {
                setStarColor(imageView, mEmptyStar);
            }
        }
    }

    private void setStarColor(ImageView imageView, Drawable drawable) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
            drawable.setTint(mBarColor);
        } else {
            drawable.setColorFilter(mBarColor, PorterDuff.Mode.SRC_ATOP);
        }
        imageView.setImageDrawable(drawable);
    }

    public void setRatingBarCallbacks(RatingBarCallbacks callbacks) {
        mCallbacks = callbacks;
    }

    public void setRating(float rating) {
        mRating = rating;
        updateRating();
    }
}

最后，在使用 RatingBar 控件的布局文件中设置颜色属性：

<com.example.RatingBar
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    app:barColor="#FF0000" />

至此，我们已经完成了两个自定义属性使用示例的介绍。希望可以帮助您更好地理解自定义属性。

希望我的回答对您有所帮助。如果您还有其他问题，请随时提出。