declare-styleable：自定義控件的屬性

作Android佈局是件很享受的事，這得益於他良好的xml方式。使用xml能夠快速有效的爲軟件定義界面。但是有時候咱們總感受官方定義的一些基本組件不夠用，自定義組件就不可避免了。那麼如何才能作到像官方提供的那些組件同樣用xml來定義他的屬性呢？如今咱們就來討論一下他的用法。

1、在res/values文件下定義一個attrs.xml文件，代碼以下：

<?xml version="1.0" encoding="utf-8"?> 
<resources> 
    <declare-styleable name="ToolBar"> 
        <attr name="buttonNum" format="integer"/> 
        <attr name="itemBackground" format="reference|color"/> 
    </declare-styleable> 
</resources>

2、在佈局xml中以下使用該屬性:

<?xml version="1.0" encoding="utf-8"?> 
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android" 
    xmlns:toolbar="http://schemas.android.com/apk/res/cn.zzm.toolbar" 
    android:orientation="vertical" 
    android:layout_width="fill_parent" 
    android:layout_height="fill_parent" 
    > 
    <cn.zzm.toolbar.ToolBar android:id="@+id/gridview_toolbar" 
        android:layout_width="fill_parent" 
        android:layout_height="wrap_content" 
        android:layout_alignParentBottom="true" 
        android:background="@drawable/control_bar" 
        android:gravity="center" 
        toolbar:buttonNum="5" 
        toolbar:itemBackground="@drawable/control_bar_item_bg"/> 
</RelativeLayout>

3、在自定義組件中，能夠以下得到xml中定義的值：

TypedArray a = context.obtainStyledAttributes(attrs,R.styleable.ToolBar); 
buttonNum = a.getInt(R.styleable.ToolBar_buttonNum, 5); 
itemBg = a.getResourceId(R.styleable.ToolBar_itemBackground, -1);

a.recycle();

就這麼簡單的三步，便可完成對自定義屬性的使用。

*********************************************************************

好了，基本用法已經講完了，如今來看看一些注意點和知識點吧。

首先來看看attrs.xml文件。

該文件是定義屬性名和格式的地方，須要用<declare-styleable name="ToolBar"></declare-styleable>包圍全部屬性。其中name爲該屬性集的名字，主要用途是標識該屬性集。那在什麼地方會用到呢？主要是在第三步。看到沒？在獲取某屬性標識時，用到"R.styleable.ToolBar_buttonNum"，很顯然，他在每一個屬性前面都加了"ToolBar_"。

在來看看各類屬性都有些什麼類型吧：string , integer , dimension , reference , color , enum......

前面幾種的聲明方式都是一致的，例如：<attr name="buttonNum" format="integer"/>。 
只有enum是不一樣的，用法舉例：

<attr name="testEnum"> 
    <enum name="fill_parent" value="-1"/> 
    <enum name="wrap_content" value="-2"/> 
</attr>

若是該屬性可同時傳兩種不一樣的屬性，則能夠用「|」分割開便可。

 

讓咱們再來看看佈局xml中須要注意的事項。

首先得聲明一下：xmlns:toolbar=http://schemas.android.com/apk/res/cn.zzm.toolbar 
注意，「toolbar」能夠換成其餘的任何名字，後面的url地址必須最後一部分必須用上自定義組件的包名。自定義屬性了，在屬性名前加上「toolbar」便可。

 

最後來看看java代碼中的注意事項。

在自定義組件的構造函數中，用

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

來得到對屬性集的引用，而後就能夠用「a」的各類方法來獲取相應的屬性值了。這裏須要注意的是，若是使用的方法和獲取值的類型不對的話，則會返回默認值。所以，若是一個屬性是帶兩個及以上不用類型的屬性，須要作屢次判斷，知道讀取完畢後才能判斷應該賦予何值。固然，在取完值的時候別忘了回收資源哦！

自定義屬性數據類型簡介：

1、reference：參考指定Theme中資源ID。

1.定義：

    <declare-styleable name="My">

        <attr name="label" format="reference" >

    </declare-styleable>

2.使用：

    <Buttonzkx:label="@string/label" >

2、Color：顏色

1.定義：

    <declare-styleable name="My">

        <attr name="textColor" format="color" />

    </declare-styleable>

2.使用：

1

    <Button zkx:textColor="#ff0000"/>

3、boolean：布爾值

1.定義：

    <declare-styleable name="My">

        <attr name="isVisible" format="boolean" />

    </declare-styleable>

2.使用：

    <Button zkx:isVisible="false"/>

4、dimension：尺寸值

1.定義：

    <declare-styleable name="My">

        <attr name="myWidth" format="dimension" />

    </declare-styleable>

2.使用：

    <Button zkx:myWidth="100dip"/>

5、float：浮點型

1.定義：

    <declare-styleable name="My">

        <attr name="fromAlpha" format="float" />

    </declare-styleable>

2.使用：

1

    <alpha zkx:fromAlpha="0.3"/>

6、integer：整型

1.定義：

    <declare-styleable name="My">

        <attr name="frameDuration" format="integer" />

    </declare-styleable>

2.使用：

    <animated-rotate zkx:framesCount="22"/>

7、string：字符串

1.定義：

    <declare-styleable name="My">

        <attr name="Name" format="string" />

    </declare-styleable>

2.使用：

1

    <rotate zkx:pivotX="200%"/>

8、fraction：百分數

1.定義：

    <declare-styleable name="My">

        <attr name="pivotX" format="fraction" />

    </declare-styleable>

2.使用：

1

    <rotate zkx:Name="My name is zhang kun xiang"/>

9、enum：枚舉

1.定義：

    <declare-styleable name="My">

        <attr name="language">

            <enum name="English" value="1"/>

        </attr>

    </declare-styleable>

2.使用：

1

    <Button zkx:language="English"/>

10、flag：位或運算

1.定義：

    <declare-styleable name="My">

        <attr name="windowSoftInputMode">

    <flag name="stateUnspecified" value="1" />

    <flag name = "adjustNothing" value = "0x30" />

        </attr>

    </declare-styleable>

2.使用：

1

    <activity android:windowSoftInputMode="stateUnspecified | adjustNothing">

屬性定義時能夠指定多種類型值：

    <declare-styleable name = "名稱">    

<attr name="background" format="reference|color" />

    </declare-styleable>

使用：

1

    <ImageView android:background = "@drawable/圖片ID|#00FF00"/>