Bootstrap

自定义AttributeSet属性

在做项目的时候,用没人写的代码和看Android源码时,经常看attr.xml的使用,每次都不知道是什么意思,今天网上查了些资料,终于明白了,这里做一个笔记,方便以后使用

这里与一个关于AttributeSet的应用场景:

一个自定义控件的有些属性内容是随着外部条件而动态改变的,for example:一个自定义的ListView控件,需要在底部添加一个View,而这个View在不同的模块使用中传入的View是不同的,这时候有两种方法,一种方法就是在自定义ListView控件类中提供一个公开的接口给外部调用从而将View动态的传入进去;另外一种方法就是在通过自定义控件属性,直接类似于系统属性如Android:textsize 的用法 app:boottomView; 通过第二种方法自定义控件在XML中使用时和系统控件的属性使用方法一样,很简单、方便,而且动态、灵活、更具模块框架化,其属性内容直接在xml中动态配置,不了解其原理的人也能将该控件整合到自己的项目中快速使用起来。

在通过xml文件构造view组件的时候,往往都要使用到AttributeSet和defStyle这个两个参数,例如Button组件的构造方法Button(Context ctx, AttributeSet attrs, int defStyle)中,ctx会调用obtainStyledAttributes( AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)方法获得一个TypedArray,然后根据这个TypeArray来设置组件的属性。obtainStyledAttributes这类方法有好几个,真正的实现是Resources.Theme类,分别是:

     (1) obtainStyledAttributes( AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) : TypedArray

根据attrs确定要获取哪些属性,然后依次通过其余3个参数来取得相应的属性值,属性值获取的优先级从高到低依次是set, defStyleAttr, defStyleRes. defStyleAttr是一个reference, 它指向当前Theme中的一个style, style其实就是各种属性的集合,如果defStyleAttr为0或者在Theme中没有找到相应的style, 则 才会尝试从defStyleRes获取属性值,defStyleRes表示的是一个style的id, 当它为0时也无效。
     (2) obtainStyledAttributes( int resid, int[] attrs)  : TypeArray
     (3) obtainStyledAttributes(int[] attrs) : TypeArray

     (2)和(3)分别表示从style或Theme里获取属性值。

 R文件中会有styleable和attr这两个类,当我们要使用哪个属性集合或哪个属性的时候用的是styleable, 而attr类定义的仅仅是attr这个属性在layout中的id. AttributeSet有两个方法分别是

    int getAttributeNameResource(int index);

    int getAttributeResourceValue(int index, int defaultValue);

     前一个方法获取的就是attr属性名称的id,也也就是attr类定义的数值,后一个方法获取的才是attr属性值。


 自定义控件的AttributeSet属性步骤大致如下:

一、 首先要在res/values目录下建立一个attrs.xml(名字可以自己定义)的文件,并在此文件中增加对控件的属性的定义.其xml文件如下所示:

attrs.xml里通常包括若干个attr集合,例如

    

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


    就表示一个attr集合,declare-styleable标签里的name值表示的就是上面方法里的attrs参数,android会自动在R文件中生成一个数组, 它可以使任意的不一定要是view组件名称。在集合里定义每个属性的名称和它的类型,自定义属性的Value值可以有10种类型以及其类型的组合值,如果允许多个类型可以用"|"来隔开,比如reference | color,

1. reference:参考某一资源ID。
    (1)属性定义:
 
            <declare-styleable name = "名称">
 
                   <attr name = "background" format = "reference" />
 
            </declare-styleable>
			
 
    (2)属性使用:
 
            <ImageView
 
                     android:layout_width = "42dip"
 
                     android:layout_height = "42dip"
 
                     android:background = "@drawable/图片ID"
 
                     />
 



2. color:颜色值。
 
    (1)属性定义:
 
            <declare-styleable name = "名称">
 
                   <attr name = "textColor" format = "color" />
 
            </declare-styleable>
 
    (2)属性使用:
 
            <TextView
 
                     android:layout_width = "42dip"
 
                     android:layout_height = "42dip"
 
                     android:textColor = "#00FF00"
 
                     />
 



 3. boolean:布尔值。
 
    (1)属性定义:
 
            <declare-styleable name = "名称">
 
                <attr name = "focusable" format = "boolean" />
 
            </declare-styleable>
 
    (2)属性使用:
 
            <Button
 
                   android:layout_width = "42dip"
 
                   android:layout_height = "42dip"
 
                   android:focusable = "true"
 
                    />
 
 
 
4. dimension:尺寸值。
 
     (1)属性定义:
 
             <declare-styleable name = "名称">
 
                   <attr name = "layout_width" format = "dimension" />
 
            </declare-styleable>
 
    (2)属性使用:
 
            <Button
 
                   android:layout_width = "42dip"
 
                   android:layout_height = "42dip"
 
                  />
 



 5. float:浮点值。
 
    (1)属性定义:
 
            <declare-styleable name = "AlphaAnimation">
 
                   <attr name = "fromAlpha" format = "float" />
 
                   <attr name = "toAlpha" format = "float" />
 
            </declare-styleable>
 
    (2)属性使用:
 
            <alpha
 
                   android:fromAlpha = "1.0"
 
                   android:toAlpha = "0.7"
 
                   />
 
 
 
6. integer:整型值。
 
    (1)属性定义:
 
            <declare-styleable name = "AnimatedRotateDrawable">
 
                   <attr name = "visible" />
 
                   <attr name = "frameDuration" format="integer" />
 
                   <attr name = "framesCount" format="integer" />
 
                   <attr name = "pivotX" />
 
                   <attr name = "pivotY" />
 
                   <attr name = "drawable" />
 
            </declare-styleable>
 
    (2)属性使用:
 
            <animated-rotate
 
                   xmlns:android = "http://schemas.android.com/apk/res/android"  
 
                   android:drawable = "@drawable/图片ID"  
 
                   android:pivotX = "50%"  
 
                   android:pivotY = "50%"  
 
                   android:framesCount = "12"  
 
                   android:frameDuration = "100"
 
                   />
 
 
 
7. string:字符串。
 
    (1)属性定义:
 
            <declare-styleable name = "MapView">
 
                   <attr name = "apiKey" format = "string" />
 
            </declare-styleable>
 
    (2)属性使用:
 
            <com.google.android.maps.MapView
 
                    android:layout_width = "fill_parent"
 
                    android:layout_height = "fill_parent"
 
                    android:apiKey = "0jOkQ80oD1JL9C6HAja99uGXCRiS2CGjKO_bc_g"
 
                    />
 



8. fraction:百分数。
 
     (1)属性定义:
 
            <declare-styleable name="RotateDrawable">
 
                   <attr name = "visible" />
 
                   <attr name = "fromDegrees" format = "float" />
 
                   <attr name = "toDegrees" format = "float" />
 
                   <attr name = "pivotX" format = "fraction" />
 
                   <attr name = "pivotY" format = "fraction" />
 
                   <attr name = "drawable" />
 
            </declare-styleable>
 



    (2)属性使用:
 
            <rotate
 
                 xmlns:android = "http://schemas.android.com/apk/res/android" 
 
               android:interpolator = "@anim/动画ID"
 
                 android:fromDegrees = "0" 
 
               android:toDegrees = "360"
 
                 android:pivotX = "200%"
 
                 android:pivotY = "300%" 
 
               android:duration = "5000"
 
                 android:repeatMode = "restart"
 
                 android:repeatCount = "infinite"
 
                />
 



9. enum:枚举值。
 
    (1)属性定义:
 
            <declare-styleable name="名称">
 
                   <attr name="orientation">
 
                          <enum name="horizontal" value="0" />
 
                          <enum name="vertical" value="1" />
 
                   </attr>            
 
            </declare-styleable>
 
    (2)属性使用:
 
            <LinearLayout
 
                    xmlns:android = "http://schemas.android.com/apk/res/android"
 
                    android:orientation = "vertical"
 
                    android:layout_width = "fill_parent"
 
                    android:layout_height = "fill_parent"
 
                    >
 
            </LinearLayout>
 



10. flag:位或运算。
 
     (1)属性定义:
 
             <declare-styleable name="名称">
 
                    <attr name="windowSoftInputMode">
 
                            <flag name = "stateUnspecified" value = "0" />
 
                            <flag name = "stateUnchanged" value = "1" />
 
                            <flag name = "stateHidden" value = "2" />
 
                            <flag name = "stateAlwaysHidden" value = "3" />
 
                            <flag name = "stateVisible" value = "4" />
 
                            <flag name = "stateAlwaysVisible" value = "5" />
 
                            <flag name = "adjustUnspecified" value = "0x00" />
 
                            <flag name = "adjustResize" value = "0x10" />
 
                            <flag name = "adjustPan" value = "0x20" />
 
                            <flag name = "adjustNothing" value = "0x30" />
 
                     </attr>         
 
             </declare-styleable>
 



     (2)属性使用:
 
            <activity
 
                   android:name = ".StyleAndThemeActivity"
 
                   android:label = "@string/app_name"
 
                   android:windowSoftInputMode = "stateUnspecified | stateUnchanged | stateHidden">
 
                   <intent-filter>
 
                          <action android:name = "android.intent.action.MAIN" />
 
                          <category android:name = "android.intent.category.LAUNCHER" />
 
                   </intent-filter>
 
             </activity>
 
     注意:
 
     属性定义时可以指定多种类型值。
 
    (1)属性定义:
 
            <declare-styleable name = "名称">
 
                   <attr name = "background" format = "reference|color" />
 
            </declare-styleable>
 
    (2)属性使用:
 
             <ImageView
 
                     android:layout_width = "42dip"
 
                     android:layout_height = "42dip"
 
                     android:background = "@drawable/图片ID|#00FF00"
 
                     />

二,自定义view中获取我们定义的属性

public MyView(Context context,AttributeSet attrs)
{
super(context,attrs);
mPaint = new Paint();

TypedArray a = context.obtainStyledAttributes(attrs,
R.styleable.MyView);

int textColor = a.getColor(R.styleable.MyView_textColor,
0XFFFFFFFF);
float textSize = a.getDimension(R.styleable.MyView_textSize, 36);

mPaint.setTextSize(textSize);
mPaint.setColor(textColor);

a.recycle();
}

我们获取定义的属性我们R.sytleable.MyView_textColor, 获取方法中后面通常设定默认值(float textSize = a.getDimension(R.styleable.MyView_textSize, 36 ); ) 防止我们在xml 文件中没有定义.从而使用默认值!

获取,MyView 就是定义在<declare-styleable name="MyView "></declare-styleable> 里的 名字,获取里面属性用 名字_ 属性 连接起来就可以.TypedArray 通常最后调用 .recycle() 方法,为了保持以后使用该属性一致性!

三、将我们自定义的MyView 加入布局main.xml 文件中,使用自定义属性,自定义属性必须加上:

      xmlns:test ="http://schemas.android.com/apk/res/com.android.tutor "蓝色 是自定义属性的前缀,红色是我们包名.

<span style="font-size:14px;"><?xml 
version="1.0" encoding="utf-8"?>
<LinearLayout 
xmlns:android="http://schemas.android.com/apk/res/android"
              
xmlns:test="http://schemas.android.com/apk/res/com.android.tutor"
    android:orientation="vertical"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    >
<TextView  
    android:layout_width="fill_parent" 
    android:layout_height="wrap_content" 
    android:text="@string/hello"
    />
<com.android.tutor.MyView
	android:layout_width="fill_parent" 
    android:layout_height="fill_parent" 
    test:textSize="20px"
    test:textColor="#fff"
/>
</LinearLayout></span>

下面是完整代码

1.自定义属性

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

</resources>



2.自定义控件

package com.example.atrributesetdemo;

import android.content.Context;
import android.content.res.TypedArray;
import android.graphics.Canvas;
import android.graphics.Paint;
import android.util.AttributeSet;
import android.view.View;

public class MyView extends View{
	private Paint paint;
	public MyView(Context context, AttributeSet attrs) {
		super(context, attrs);
		//获取自定义属性数组
		TypedArray array=context.obtainStyledAttributes(attrs,R.styleable.MyView);
		//获得自定义字体颜色值
		int color=array.getColor(R.styleable.MyView_text_color,0x123);
		//获得自定义字体大小
		float size=array.getDimension(R.styleable.MyView_text_size, 12);
		//为画笔设置
		paint=new Paint();
		paint.setTextSize(size);
		paint.setColor(color);
<span style="white-space:pre">		array.recycle();</span>
	}
	@Override
	protected void onDraw(Canvas canvas) {
		super.onDraw(canvas);
		canvas.drawRect(0, 0, 100, 100, paint);
		canvas.drawText("今天学习自定义属性", 100, 100, paint);
	}
}


3.布局引用

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:my="http://schemas.android.com/apk/res/com.example.atrributesetdemo"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent" >
	<com.example.atrributesetdemo.MyView 
	    android:layout_width="match_parent"
	    android:layout_height="match_parent"
	    my:text_color="#ff0000"
	    my:text_size="20sp"/>
</RelativeLayout>
4.activity中代码

package com.example.atrributesetdemo;

import android.app.Activity;
import android.os.Bundle;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);
	}

}

更多深入http://blog.csdn.net/lmj623565791/article/details/45022631


;