自定义组件之自定义属性

一、组件的属性

我们在布局文件中使用组件时,定义组件的宽、高、背景等属性,这些属性我们并没有特意去定义,它们都是组件的默认属性,在我们sdk安装目录下找到:
sdk\platforms\android-25\data\res\values\attrs.xml.
这里面定义了组件的默认属性,例如View的属性:

.......
<declare-styleable name="View">
        <attr name="id" format="reference" />
        <attr name="background" format="reference|color" />
        <attr name="padding" format="dimension" />
        <attr name="paddingTop" format="dimension" />
        <attr name="paddingBottom" format="dimension" />
        <attr name="paddingStart" format="dimension" />
        <attr name="paddingEnd" format="dimension" />
        <attr name="visibility">
            <enum name="visible" value="0" />
            <enum name="invisible" value="1" />
            <enum name="gone" value="2" />
        </attr>
    .......省略
</declare-styleable>
.......

二、自定义属性

在自定义组件时,我们常常需要自定义属性,自定义属性主要有3个步骤:

1、在res\values\attrs.xml 文件中定义declare-styleable标签,并将自定义的属性都定义在该标签中
<?xml version="1.0" encoding="utf-8"?>
<resources>

    <declare-styleable name="XView">
        <attr name="attr1" format="string" />
        <attr name="attr2" format="color" />
    </declare-styleable>

</resources>

(1)自定义的属性都放在declare-styleable标签中,该标签的name一般都是自定义组件的名称,此处为XView,也可以取别的名字,但是和自定义组件一个名字通俗易懂.
(2)自定义的属性由2部分组成:属性名name、属性类型format,属性类型一共有下面几种:

boolean:布尔值
color:颜色值
dimension:尺寸,比如dp、sp、px
string:字符串
float:浮点值
integer:整型值

fraction:百分数
一般在动画资源中使用,比如:<scale> 、<rotate>中fromX、fromY就是fraction类型

enum:枚举值
需要在attr标签下使用<enum>标签定义枚举值,例:
        <attr name="sex"  format="enum" >
            <enum name="man" value="0"/>
            <enum name="woman" value="1"/>
        </attr>

flag:位或运算
需要在attr标签下使用<flag>标签定义子标签,像我们常用的gravity、layout_gravity都是该属性类型,例:
        <attr name="my_gravity" format="flag">
            <flag name="left" value="0" />
            <flag name="top" value="1" />
            <flag name="right" value="2" />
            <flag name="bottom" value="3" />
        </attr>

reference:引用另外一个资源
比如android:layout_width="@dimen/activity_horizontal_margin"就是引用另一个尺寸资源


PS:属性可以指定多种类型,比如我们常用的background
    <attr name="background" format="color|reference" />
在布局文件中使用时值为color或者reference都可以:
  android:background="#ff0000ff"
  android:background="@mipmap/ic_launcher"
2、在布局文件中使用自定义属性
<?xml version="1.0" encoding="utf-8"?>
<FrameLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.fgq.demo.XView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:attr1="随风飘扬的Smile"
        app:attr2="#ff0000ff" />

</FrameLayout>

使用自定义属性需要导入命名空间,上面有2个命名空间:

    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"

第1个是Android本身的,如果没有的话就不能使用组件的默认属性了,第2个是我们自定义属性的.
(1)xmlns后面的android、app是空间名称,我们在设置属性时的前缀就是这个
(2)后面的res/android、res-auto表明属性的出处,前者是android本身的,后者是AndroidStudio里面自定义属性固定的写法.

3、在自定义组件的构造方法中读取属性值
public class XView extends View {

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

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

    public XView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);

        TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.XView);
        String attr1 = a.getString(R.styleable.XView_attr1);
        int attr2 = a.getColor(R.styleable.XView_attr2, 0);
        a.recycle();
    }
}

三、Why

上面写了如何自定义属性、如何使用,但是你肯定疑惑为什么这么写,下面就介绍上面写法的原因.

1、AttributeSet

构造方法中有个参数AttributeSet,之前介绍过,它表示属性集,我们为该组件定义的所有属性都保存在其中,拿上面的XView示例:

public class XView extends View {

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

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

    public XView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);

        for (int i = 0; i < attrs.getAttributeCount(); i++) {
            String attributeName = attrs.getAttributeName(i);
            String attributeValue = attrs.getAttributeValue(i);
            Log.d("获取属性", "属性名" + attributeName + "------" + "属性值" + attributeValue);
        }
    }
}

结合Log一看就明白了,AttributeSet 中还有一些其它的方法,感兴趣的可以去看看.

2、TypedArray

(1)获取TypedArray对象
TypedArray是一个数组容器,这个容器中装有Context.obtainStyledAttributes( )方法获取到的属性值.
在获取TypedArray时,一共4个重载方法,我们来看最长的一个:

public final TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr,int defStyleRes) 

set:属性集

attrs:我们定义的属性都会在R.java下生成一个id
      在declare-styleable标签下的属性id又会在R.styleable下生成一个int[]类型数组
      数组元素就是declare-styleable标签下所有属性的id
      这里需要的就是这个int[]类型数组

defStyleAttr
defStyleRes
这两个参数涉及到默认theme,一般defStyleAttr传构造方法里面的defStyleAttr,defStyleRes传0就可以了

(2)读取属性值
获取到TypedArray对象之后,我们就可以根据TypedArray一系列getXXX( )方法获取到属性值.比如上面的:

String attr1 = a.getString(R.styleable.XView_attr1);
int attr2 = a.getColor(R.styleable.XView_attr2, 0);

TypedArray中定义了很多getXXX( )方法,XXX是我们定义的属性类型,有些方法有1个参数,有些方法有2个参数,第1个参数是索引值,第2个参数是默认值.

(3)释放资源
使用完TypedArray之后需要调用recycle( )方法释放资源.

3、declare-styleable标签

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="XView">
        <attr name="attr1" format="string" />
        <attr name="attr2" format="color" />
    </declare-styleable>
</resources>
(1)在attrs.xml下所有自定义属性都会在项目的R.java中生成相应的id(R.attr中)
public final class R {
      public static final class attr {
        public static final int attr1=0x7f01013a;
        public static final int attr2=0x7f01013b;
      }
}
(2)如果这些自定义属性时定义在declare-styleable标签下,还会在R.java中生成对应int[]类型数组(R.styleable 中)
public final class R {
      public static final class styleable {
        public static final int[] XView = {
            0x7f01013a, 0x7f01013b
        };
        public static final int XView_attr1 = 0;
        public static final int XView_attr2 = 1;
      }
}
可以看到:R.styleable 中生成了一个int[]类型数组,数组元素就是上面所有自定义属性的id
同时,数组的每个元素都有一个索引XView_attr1 、XView_attr2 
(3)读取在declare-styleable标签下的自定义属性
TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.XView);
String attr1 = a.getString(R.styleable.XView_attr1);
int attr2 = a.getColor(R.styleable.XView_attr2, 0);

根据int[]类型数组R.styleable.XView获取TypedArray 对象
根据数组元素索引R.styleable.XView_attr1、R.styleable.XView_attr2获取属性值

四、Demo

attrs.xml:

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <declare-styleable name="XView">
        <attr name="text" format="string" />
        <attr name="textSize" format="dimension" />
        <attr name="textColor" format="color" />
    </declare-styleable>

</resources>

布局文件:

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

    <com.fgq.demo.XView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:text="随风飘扬的Smile"
        app:textColor="#ff0000ff"
        app:textSize="16sp" />

</FrameLayout>

XView:

public class XView extends View {

    private static final int DEFAULT_TEXT_COLOR = Color.BLACK;
    private static final int DEFAULT_TEXT_SIZE = 16;

    private String mText;
    private int mTextColor = DEFAULT_TEXT_COLOR;
    private int mTextSize = DEFAULT_TEXT_SIZE;

    private Paint mPaint;

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

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

    public XView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);

        //读取属性
        TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.XView);
        mText = a.getString(R.styleable.XView_text);
        mTextColor = a.getColor(R.styleable.XView_textColor, DEFAULT_TEXT_COLOR);
        mTextSize = a.getDimensionPixelSize(R.styleable.XView_textSize, DEFAULT_TEXT_SIZE);
        a.recycle();

        initPaint();
    }

    /**
     * 初始化画笔
     */
    private void initPaint() {
        mPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
        mPaint.setTextSize(mTextSize);
        mPaint.setColor(mTextColor);
        mPaint.setTextAlign(Paint.Align.CENTER);
    }

    @Override
    protected void onDraw(Canvas canvas) {
        super.onDraw(canvas);
        canvas.drawText(mText, getMeasuredWidth() / 2, getHeight() / 2, mPaint);//绘制文本
    }
}

这里自定义了一个十分简陋的“TextView”,很多东西都没有考虑,不过不要紧,这里主要是让大家明白自定义属性如何定义、使用而已.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352