declare-styleable 自定义控件的属性 简单总结

在自定义组件时，不可避免的需要使用到自定义属性。

此文将尽量精炼的总结其中要点，以备后查。

一、定义位置。

1、定义在values文件夹下，任意xml文件中即可（一般建议是在attrs.xml中，方便归类）。

2、xml的格式

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="TestView">
        <attr name="my_name" format="boolean|reference"/>
        <attr name="my_enum">
            <enum name="style1" value="1"/>
            <enum name="style2" value="2"/>
        </attr>
    </declare-styleable>
</resources>
 
 
注意点：


一定要在resources标签内，大部分只要配置name和value值即可，而enum枚举，flag位或运算需要在标签内设置子节点。
declare-styleable的name最好和自定义控件的名字相同，这样在使用的时候studio会有代码提示。
enum和flag中的value必须是数字。
format类型支持多选，以“|”连接。

二、使用
和android自带的属性一样，在对应控件内添加属性即可

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.mylife.utils.TestView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:my_enum="style1" />
</LinearLayout>

 
注意：


不要忘了配置命名空间。
如果名称相同时，studio会自动提示，选择后命名空间会自动帮你添加好，名字默认是app，也可以自己修改。

三、获取

 接下来就是在自定义的空间中获取属性。


 在空间的构造函数中获取。


  

public TestView(Context context, AttributeSet attrs) {
    this(context, attrs,0);
}

public TestView(Context context) {
    this(context, null);
}

public TestView(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
    TypedArray a = context.getTheme().obtainStyledAttributes(attrs, R.styleable.TestView, defStyleAttr, 0);
    text = a.getInt(R.styleable.TestView_my_enum, 0);
    a.recycle();
}


  还有一种方法是：


public TestView(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
    TypedArray a = context.getTheme().obtainStyledAttributes(attrs, R.styleable.TestView, defStyleAttr, 0);
    for(int i = 0; i < a.getIndexCount();i++){
        switch (a.getIndex(i)){
            case R.styleable.TestView_my_enum:
                text = a.getInt(a.getIndex(i),0);
                break;
        }
    }
    a.recycle();
}
 区别是：

 第一种方法如果用户没有设置这个属性，会得到默认值。


 第二种方法则不会对text赋值。


 
 


  注意：



TypedArray用完后一定要回收，使用recycle()方法。
默认View的构造函数有好多个，要么用this的传导不可少。
R.styleable.TestView_my_enum是系统自动生成的id，规则就是declare-styeable的name+下划线+属性的name。
TypedArray有各种get方法获取属性值，这里就不一一赘述，基本都很好理解。
format类型设置成int我们也可以按照string获取这并不会报错，而是用getInteger获取字符串则会报错。


   ps:
 

  这里说一下，getFraction这个获取百分比的函数。
 

   

public float getFraction(@StyleableRes int index, int base, int pbase, float defValue) 


   这里有base和pbase这两个值，代表的是：
 

   当输入的值为60%时，我们得到的值会是60%*base。
 

   当输入的值设为60%p时，我们会得到60%*pbase。
 

   defValue就是默认值。
 
四、format类型


 

 reference 引用


 color 颜色


 boolean 布尔值


 dimension 尺寸值


 string 字符串


 float 浮点值


 integer 整数


 fraction 百分数 必须带%的数字，如果不是，在设置的时候不会出错，但是build会报错


 

比较特殊的两个：
enum 枚举类型

 设置时选择enum中的name，获取的时候获取到的是enum节点中的value。


 这个属性，必须选择enum的name中的一个，否则就会报错。


 value值必须是一个数字。


 flag 位或类型


 和enum类似，但它可以支持位运算。


  也就是如下写法


  

app:my_enum="style1|style2"


 
 


  加设style1值为1，style2值为4，1|4=5我们取到的值便为5。


今天的文章declare-styleable 自定义控件的属性 简单总结分享到此就结束了，感谢您的阅读，如果确实帮到您，您可以动动手指转发给其他人。
                                                        
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
如需转载请保留出处：https://bianchenghao.cn/31752.html