自定义 view - 自定义属性

自定义 view 里面自定义属性是常常会用到的,大家必须做到熟练使用,但是奈何谁都有忘的时候,临时找别人的看着不爽,还是决定自己写一篇出来

自定义属性定义过程:

  1. 在 values 中的 attr 文件声明所需的参数
  2. 然后 rebuild 一下
  3. 在 xml 布局中添加资源引用地址
  4. 在 xml 的 view 标签中使用
  5. 在 view 中解析自定义属性,获取参数

attr 文件

attr 是 values 目录下的资源文件,新建项目是没有 attr 文件的,我们自己新建一个出来放到 values 里面就行,注意名字别写错


Snip20180715_1.png

attr 中的自定义属性样式

    <declare-styleable name="MyView">
        <attr name="name" format="string"></attr>
        <attr name="info" format="float"></attr>
    </declare-styleable>

Android 项目只有一个 attr.xml 文件,所有的自定义属性都写在一起,为了方便 attr 中的自定义属性以所在 view 分组存放。其中 MyView 就是这个 view 的名字,以 <declare-styleable> 为标签,里面自然就是一个个自定义属性啦

细心的朋友可以发现,自定义 view 可以指定不同的数据类型,Android 中自定义属性支持的数据类型还是挺多的,详细见下表:


Snip20180715_2.png

我这markdown 写表格bug ,所以直接用被人的图,我再补充一下:

  • boolean
    表示attr取值为true或者false
  • color
    表示attr取值是颜色类型,例如#ff3344,或者是一个指向color的资源id,例如R.color.colorAccent.
  • dimension
    表示 attr 取值是尺寸类型,例如例如取值16sp、16dp,也可以是一个指向dimen的资源id,例如R.dimen.dp_16
  • float
    表示attr取值是整形或者浮点型
  • fraction
    表示 attr取值是百分数类型,只能以%结尾,例如30%
  • integer
    表示attr取值是整型
  • string
    表示attr取值是String类型,或者一个指向String的资源id,例如R.string.testString
  • reference
    表示attr取值只能是一个指向资源的id。
  • enum
    表示attr取值只能是枚举类型。
  • flag
    表示attr取值是flag类型。
  • color | reference
    加 | 表示这个属性可以接受2种参数

自定义属性提供枚举值

按照下面这样写就性,enum 就能看出来这是枚举

        <attr name="showMode">
            <enum name="left" value="0" />
            <enum name="center" value="1" />
        </attr>

view 中获取自定义属性值

window 会解析整个视图树并对象化,然后把每个 view 在 xml 中的属性发包成一个结合传递给相关的 view ,这个属性集合就是 TypedArray 了,我们在 view 的构造函数中可以获取 TypedArray

有一点要注意,自定义属性的 id 是系统自动生成的,id = 自定义属性组名 + "_" + 自定义属性名,例如:

String name = typedArray.getString(R.styleable.MyView_name);

MyView 是自定义属性组名,name 是自定义属性名

获取自定义参数

    public MyView(Context context, @Nullable AttributeSet attrs) {
        super(context, attrs);
        setOnTouchListener(touchListener);

        // 获取属性集合 TypedArray 
        TypedArray typedArray = context.obtainStyledAttributes(attrs, R.styleable.MyView);

        // 获取字符串
        String name = typedArray.getString(R.styleable.MyView_string);
        // 获取 float ,后面是默认值
        float age = typedArray.getFloat(R.styleable.MyView_float,1);
        // 获取颜色值,后面是默认值
        int color = typedArray.getFloat.getColor(R.styleable.MyView_color, Color.BLACK);
        // 获取 dimension,后面是默认值
        int dimens = typedArray.getDimension(R.styleable.MyView_dimens, 0);
        // 获取图片
        Drawable drawable = typedArray.getDrawable(R.styleable.MyView_drawable);
        // 获取引用类型,这里获取的是引用类型资源的资源 id ,然后还得我们自己用这个id 才恩那个拿到引用了;类型资源对象
        int resourceId = typedArray.getResourceId(R.styleable.MyView_info, 0);

        // 用完要关闭回收资源,必须的强制性的
        typedArray.recycle();
    }

attr 的命名空间

我更喜欢称attr 的引用空间为资源引用地址,这块其实很简单,基本用不着我们自己写,1.0.1 版本的 AS 工具直接就帮你写好了,但是具体的我们还是要知道的,这里可能能会出问题,明白原理我们才能处理问题

理论上 attr 的命名空间是 "http://schemas.android.com/apk/res/" + 应用包名,比如例子中应该写成这样:

xmlns:myview="http://schemas.android.com/apk/com.bloodcrown.aaa02"

系统自带的属性后面直接跟 android

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

但是呢还是推荐使用 AS 工具推荐的方法,只写一个命名空间,可以包含所有的自定义属性

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

不推荐因为多个 view 写多个 命名空间,可能会引发混乱或是替代

有的朋友说我在 xml 里面怎么不能自动提示自定义 view 呢,其实着就像我们使用 R 文件的引用一样,我们得先 rebuild / 重启, 告知系统才行,要不系统怎么知道有什么呢


使用系统定义好的 xml 属性

日过我们能像使用系统属性那样,使用自定义属性,那么将会是十分友好的,感官上非常 Nice,就像下面这样

       <com.bloodcrown.aaa02.MyView
            android:id="@+id/view_a"
            android:layout_width="match_parent"
            android:layout_height="200dp"
            android:layout_gravity="center"
            android:background="@color/colorPrimaryDark"
            app:info="12.0"
            app:name="全都是测试"/>
  1. 定义 xml 属性时使用 android: 前缀
    <declare-styleable name="RollingTextView">
        <attr name="duration" format="reference|integer" />

        <!-- Custom implementations of common android text attributes -->
        <attr name="android:gravity" tools:ignore="ResourceName" />
        <attr name="android:shadowColor" tools:ignore="ResourceName" />
        <attr name="android:shadowDx" tools:ignore="ResourceName" />
        <attr name="android:shadowDy" tools:ignore="ResourceName" />
        <attr name="android:shadowRadius" tools:ignore="ResourceName" />
        <attr name="android:text" tools:ignore="ResourceName" />
        <attr name="android:textAppearance" tools:ignore="ResourceName" />
        <attr name="android:textColor" tools:ignore="ResourceName" />
        <attr name="android:textSize" tools:ignore="ResourceName" />
        <attr name="android:textStyle" tools:ignore="ResourceName" />
    </declare-styleable>
  1. 获取自定义属性
            gravity = arr.getInt(R.styleable.RollingTextView_android_gravity, gravity)
            shadowColor = arr.getColor(R.styleable.RollingTextView_android_shadowColor, shadowColor)
            shadowDx = arr.getFloat(R.styleable.RollingTextView_android_shadowDx, shadowDx)
            shadowDy = arr.getFloat(R.styleable.RollingTextView_android_shadowDy, shadowDy)
            shadowRadius = arr.getFloat(R.styleable.RollingTextView_android_shadowRadius, shadowRadius)
            text = arr.getString(R.styleable.RollingTextView_android_text) ?: ""
            textColor = arr.getColor(R.styleable.RollingTextView_android_textColor, textColor)
            textSize = arr.getDimension(R.styleable.RollingTextView_android_textSize, textSize)
            textStyle = arr.getInt(R.styleable.RollingTextView_android_textStyle, textStyle)
  1. xml 种使用
    <com.yy.mobile.rollingtextview.RollingTextView
        android:id="@+id/carryTextView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/stickyLayout2"
        android:layout_centerHorizontal="true"
        android:layout_marginTop="20dp"
        android:textSize="30sp" />

如何获取自定义 view 中的 style

上面我们可以让自定义 view 的自定义属性使用系统默认的属性,但是一旦view 设置了通用的 style 样式,那我们处理呢,也好办

  1. 一般我们获取自定义 view 自定义 属性时填的都是这个自定义属性在 style xml 文件中配置的 name
        val arr = context.obtainStyledAttributes(attrs, R.styleable.RollingTextView,
                defStyleAttr, defStyleRes)
  1. 那么我们在自定义属性中添加一个配置 style 的属性,用系统原生的,我们在获取数据时没有 id 可用
<attr name="android:textAppearance" tools:ignore="ResourceName" />
  1. 然后我们获取这个我们添加的 style
        val arr = context.obtainStyledAttributes(attrs, R.styleable.RollingTextView,
                defStyleAttr, defStyleRes)

        val textAppearanceResId = arr.getResourceId(
                R.styleable.RollingTextView_android_textAppearance, -1)
  1. 判断是不是有确定值,要是有我们就获取通用值。这里就传上面我们在 stype xml 文件中的 name,而是直接用这个通用样式值,重新解析数据
       if (textAppearanceResId != -1) {
            val textAppearanceArr = context.obtainStyledAttributes(
                    textAppearanceResId, R.styleable.RollingTextView)
            applyTypedArray(textAppearanceArr)
            textAppearanceArr.recycle()
        }

获取在带样式的构造函数中获取参数

public MyTextView(Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        TypedArray typedArray = context.getTheme().obtainStyledAttributes(attrs, R.styleable.MyTextViewApprence, defStyleAttr, 0);
        mText = typedArray.getString(R.styleable.MyTextViewApprence_text);
        mTextColor = typedArray.getColor(R.styleable.MyTextViewApprence_textColor, Color.BLACK);
        mTextSize = (int) typedArray.getDimension(R.styleable.MyTextViewApprence_textSize, 15);
        showMode = typedArray.getInt(R.styleable.MyTextViewApprence_showMode, 0);
        typedArray.recycle();
    }

系统如何给自定义 attr 设置常量值

  1. 先声明出 attr


  2. 设置 theme item ,引用 style 的常量值


  3. style 声明常量值



参考资料:

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