今天总结一下自定义 View 时自定义属性的相关。
定义
在 res/values 中创建 attrs.xml 文件。
示例代码:
<?xml version="1.0" encoding="utf-8"?>
<resources>
<attr name="custom_color" format="color"/>
<declare-styleable name="CustomAttribute">
<attr name="custom_radius" format="dimension"/>
<attr name="custom_color"/>
</declare-styleable>
</resources>
- attr 标签定义一个属性,name 是属性的名字,不能和其它属性的名字冲突,format 是属性的格式,可以用给一个属性指定多种格式;
- declare-styleable 标签定义一个属性组,可以在里面定义属性,也可以直接引用 resource 标签下面定义的属性,区别就是不用写 format;
格式
自定义属性共有10种 format
- integer 整型值;
- float 浮点值;
- string 字符串;
- boolean 布尔值;
- dimension 尺寸值;
- color 颜色值;
- fraction 百分数;
- enum 枚举值;
- flag 位或运算
- reference 引用资源 ID
获取
属性的获取有两种方式:
获取 resource 下的 attr
第一种是直接获取 resource 标签下定义的 attr。
每一个 attr 都会在 R 文件的 attr 类中生成一个对应 ID,我们可以根据这个 ID 获取自己定义的属性,也可以获取系统定义的属性。
通常是在 View 的构造方法中获取:
//获取自定义属性
int[] customAttrs = {R.attr.custom_color};
TypedArray a = context.obtainStyledAttributes(attrs, customAttrs);
int color = a.getColor(0, Color.WHITE);
a.recycle();
//获取系统定义属性
int[] customAttrs = {android.R.attr.color};
TypedArray a = context.obtainStyledAttributes(attrs, customAttrs);
mColor = a.getColor(0, mColor);
a.recycle();
获取 declare-styleable 下的 attr
更常用的是获取 declare-styleable 属性集中的属性。
当定义 declare-styleable 时,R 文件在 styleable 内部类中自动生成一个 int[] 常量,数组中的元素是 declare-styleable 属性集中的属性的 ID,这样就不需要自己再定义 int[] 了,数组中的每一个元素也会生成一个 ID 指向数组中的元素,ID 格式为:属性集名_属性名,直接通过属性 ID 获取对应 attr。
TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CustomAttribute);
mColor = a.getColor(R.styleable.CustomAttribute_custom_color, mColor);
mRadius = a.getDimension(R.styleable.CustomAttribute_custom_radius, mRadius);
a.recycle();
也可以获取系统中定义的属性,这里 android:color
变成了 android_color
:
//把系统定义的属性放在属性集中
<declare-styleable name="CustomAttribute">
<attr name="android:color"/>
</declare-styleable>
TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CustomAttribute);
mColor = a.getColor(R.styleable.CustomAttribute_android_color, mColor);
a.recycle();
Context#obtainStyledAttributes
上面获取属性的方式是调用了 Context 类的 obtainStyledAttributes 方法,该方法有四个重载方法:
//从 Theme 中获取属性
obtainStyledAttributes(int[] attrs)
//从 style 中获取属性
obtainStyledAttributes(int resid, int[] attrs)
//从 layout 文件中获取属性
obtainStyledAttributes(AttributeSet set, int[] attrs)
//从 layout 文件中获取属性
obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr,int defStyleRes)
参数中的 int[] attrs 就是要获取的属性的名称,前面说过这个参数一般为 declare-styleable 在 R 文件的 styleable 类中生成的 ID。
obtainStyledAttributes(int[] attrs)
一个参数的方法是从应用的主题中获取属性,如果想从主题中获取我们自定义的属性,就需要在应用的主题中声明自定义的属性值。
加入定义了如下属性:
<declare-styleable name="CustomAttribute">
<attr name="custom_color" format="color"/>
<attr name="custom_radius" format="dimension"/>
</declare-styleable>
那么在应用的主题中:
<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
<!--直接在主题中指定-->
<item name="custom_color">#FF0000</item>
<item name="custom_radius">100dp</item>
</style>
obtainStyledAttributes(int resid, int[] attrs)
该方法是从指定的 style 中获取,参数 resid 就是 style 在 R 文件中生成的 ID,我们需要在定义的 style 中声明相应的属性值:
<style name="CustomTheme">
<item name="custom_color">#00FF00</item>
<item name="custom_radius">10dp</item>
</style>
obtainStyledAttributes(AttributeSet set, int[] attrs)
该方法是最常用的,是从 layout 文件中获取,AttributeSet 类型的参数是从 xml 文件中解析出来的控件属性集合,也包括控件应用的 style 中声明的属性。
obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr,int defStyleRes)
第一个参数是从 xml 文件中解析出来的控件属性集合,第三个参数是 style.xml 文件中定义的某一 Theme 的 ID,第四个参数是 style.xml 中定义的某一 Style 的 ID。
该方法首先从第一个参数 AttributeSet 也就是 layout 文件中获取属性,如果没有取到属性,那么从第三个参数 defStyleAttr 指定的主题中获取,如果还没有取到,那么从第四个参数 defStyleRes 指定的 style 中获取,如果还没有获取到,那么返回的结果就为 null 了。
TypedArray
Context 类的 obtainStyledAttributes 方法实质调用的都是 Resources 类的内部类 Theme 类的对应的 obtainStyledAttributes 方法,最终调用的都是 ResourcesImpl.ThemeImpl 类的 obtainStyledAttributes 方法,这里不作讨论,该方法返回的是一个 TypedArray 对象,TypedArray 类就是一个获取到的属性值数组的容器,该类提供了一系列获取属性值的方法:
//获取属性的数量
public int getIndexCount()
//获取属性名
public int getIndex (int at)
//获取属性类型
public int getType (int index)
//在使用之后要进行回收才能重用
public void recycle ()
public boolean getBoolean (int index, boolean defValue)
public int getColor (int index, int defValue)
publicColorStateList getColorStateList(int index)
public float getDimension (int index, float defValue)
public int getDimensionPixelOffset (int index, int defValue)
public int getDimensionPixelSize (int index, int defValue)
publicDrawable getDrawable(int index)
public float getFloat (int index, float defValue)
public float getFraction (int index, int base, int pbase, float defValue)
public int getInt (int index, int defValue)
public int getInteger (int index, int defValue)
public intgetLayoutDimension(int index,Stringname)
public int getResourceId (int index, int defValue)
publicString (int index)
publicCharSequencegetText(int index)
publicCharSequence[]getTextArray(int index)