自定義組件之自定義屬性

一疆虚、組件的屬性

我們?cè)诓季治募惺褂媒M件時(shí),定義組件的寬水孩、高镰矿、背景等屬性,這些屬性我們并沒(méi)有特意去定義俘种,它們都是組件的默認(rèn)屬性秤标,在我們sdk安裝目錄下找到:
sdk\platforms\android-25\data\res\values\attrs.xml.
這里面定義了組件的默認(rèn)屬性,例如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>
.......

二宙刘、自定義屬性

在自定義組件時(shí)苍姜,我們常常需要自定義屬性,自定義屬性主要有3個(gè)步驟:

1悬包、在res\values\attrs.xml 文件中定義declare-styleable標(biāo)簽衙猪,并將自定義的屬性都定義在該標(biāo)簽中
<?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標(biāo)簽中,該標(biāo)簽的name一般都是自定義組件的名稱,此處為XView垫释,也可以取別的名字丝格,但是和自定義組件一個(gè)名字通俗易懂.
(2)自定義的屬性由2部分組成:屬性名name、屬性類型format棵譬,屬性類型一共有下面幾種:

boolean:布爾值
color:顏色值
dimension:尺寸显蝌,比如dp、sp订咸、px
string:字符串
float:浮點(diǎn)值
integer:整型值

fraction:百分?jǐn)?shù)
一般在動(dòng)畫(huà)資源中使用曼尊,比如:<scale> 、<rotate>中fromX算谈、fromY就是fraction類型

enum:枚舉值
需要在attr標(biāo)簽下使用<enum>標(biāo)簽定義枚舉值涩禀,例:
        <attr name="sex"  format="enum" >
            <enum name="man" value="0"/>
            <enum name="woman" value="1"/>
        </attr>

flag:位或運(yùn)算
需要在attr標(biāo)簽下使用<flag>標(biāo)簽定義子標(biāo)簽,像我們常用的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:引用另外一個(gè)資源
比如android:layout_width="@dimen/activity_horizontal_margin"就是引用另一個(gè)尺寸資源


PS:屬性可以指定多種類型,比如我們常用的background
    <attr name="background" format="color|reference" />
在布局文件中使用時(shí)值為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="隨風(fēng)飄揚(yáng)的Smile"
        app:attr2="#ff0000ff" />

</FrameLayout>

使用自定義屬性需要導(dǎo)入命名空間屿岂,上面有2個(gè)命名空間:

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

第1個(gè)是Android本身的,如果沒(méi)有的話就不能使用組件的默認(rèn)屬性了鲸匿,第2個(gè)是我們自定義屬性的.
(1)xmlns后面的android爷怀、app是空間名稱,我們?cè)谠O(shè)置屬性時(shí)的前綴就是這個(gè)
(2)后面的res/android带欢、res-auto表明屬性的出處运授,前者是android本身的,后者是AndroidStudio里面自定義屬性固定的寫(xiě)法.

3乔煞、在自定義組件的構(gòu)造方法中讀取屬性值
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

上面寫(xiě)了如何自定義屬性、如何使用渡贾,但是你肯定疑惑為什么這么寫(xiě)逗宜,下面就介紹上面寫(xiě)法的原因.

1、AttributeSet

構(gòu)造方法中有個(gè)參數(shù)AttributeSet空骚,之前介紹過(guò)纺讲,它表示屬性集,我們?yōu)樵摻M件定義的所有屬性都保存在其中囤屹,拿上面的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);
        }
    }
}

結(jié)合Log一看就明白了熬甚,AttributeSet 中還有一些其它的方法,感興趣的可以去看看.

2肋坚、TypedArray

(1)獲取TypedArray對(duì)象
TypedArray是一個(gè)數(shù)組容器则涯,這個(gè)容器中裝有Context.obtainStyledAttributes( )方法獲取到的屬性值.
在獲取TypedArray時(shí)复局,一共4個(gè)重載方法冲簿,我們來(lái)看最長(zhǎng)的一個(gè):

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

set:屬性集

attrs:我們定義的屬性都會(huì)在R.java下生成一個(gè)id
      在declare-styleable標(biāo)簽下的屬性id又會(huì)在R.styleable下生成一個(gè)int[]類型數(shù)組
      數(shù)組元素就是declare-styleable標(biāo)簽下所有屬性的id
      這里需要的就是這個(gè)int[]類型數(shù)組

defStyleAttr
defStyleRes
這兩個(gè)參數(shù)涉及到默認(rèn)theme粟判,一般defStyleAttr傳構(gòu)造方法里面的defStyleAttr,defStyleRes傳0就可以了

(2)讀取屬性值
獲取到TypedArray對(duì)象之后峦剔,我們就可以根據(jù)TypedArray一系列g(shù)etXXX( )方法獲取到屬性值.比如上面的:

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

TypedArray中定義了很多getXXX( )方法档礁,XXX是我們定義的屬性類型,有些方法有1個(gè)參數(shù)吝沫,有些方法有2個(gè)參數(shù)呻澜,第1個(gè)參數(shù)是索引值,第2個(gè)參數(shù)是默認(rèn)值.

(3)釋放資源
使用完TypedArray之后需要調(diào)用recycle( )方法釋放資源.

3惨险、declare-styleable標(biāo)簽

<?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下所有自定義屬性都會(huì)在項(xiàng)目的R.java中生成相應(yīng)的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)如果這些自定義屬性時(shí)定義在declare-styleable標(biāo)簽下羹幸,還會(huì)在R.java中生成對(duì)應(yīng)int[]類型數(shù)組(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 中生成了一個(gè)int[]類型數(shù)組,數(shù)組元素就是上面所有自定義屬性的id
同時(shí)辫愉,數(shù)組的每個(gè)元素都有一個(gè)索引XView_attr1 栅受、XView_attr2 
(3)讀取在declare-styleable標(biāo)簽下的自定義屬性
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);

根據(jù)int[]類型數(shù)組R.styleable.XView獲取TypedArray 對(duì)象
根據(jù)數(shù)組元素索引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="隨風(fēng)飄揚(yáng)的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();
    }

    /**
     * 初始化畫(huà)筆
     */
    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);//繪制文本
    }
}

這里自定義了一個(gè)十分簡(jiǎn)陋的“TextView”屏镊,很多東西都沒(méi)有考慮,不過(guò)不要緊痰腮,這里主要是讓大家明白自定義屬性如何定義而芥、使用而已.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市膀值,隨后出現(xiàn)的幾起案子棍丐,更是在濱河造成了極大的恐慌,老刑警劉巖沧踏,帶你破解...
    沈念sama閱讀 210,978評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件歌逢,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡悦冀,警方通過(guò)查閱死者的電腦和手機(jī)趋翻,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,954評(píng)論 2 384
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)盒蟆,“玉大人踏烙,你說(shuō)我怎么就攤上這事±龋” “怎么了讨惩?”我有些...
    開(kāi)封第一講書(shū)人閱讀 156,623評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)寒屯。 經(jīng)常有香客問(wèn)我荐捻,道長(zhǎng)黍少,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,324評(píng)論 1 282
  • 正文 為了忘掉前任处面,我火速辦了婚禮厂置,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘魂角。我一直安慰自己昵济,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,390評(píng)論 5 384
  • 文/花漫 我一把揭開(kāi)白布野揪。 她就那樣靜靜地躺著访忿,像睡著了一般。 火紅的嫁衣襯著肌膚如雪斯稳。 梳的紋絲不亂的頭發(fā)上海铆,一...
    開(kāi)封第一講書(shū)人閱讀 49,741評(píng)論 1 289
  • 那天,我揣著相機(jī)與錄音挣惰,去河邊找鬼卧斟。 笑死,一個(gè)胖子當(dāng)著我的面吹牛通熄,可吹牛的內(nèi)容都是我干的唆涝。 我是一名探鬼主播,決...
    沈念sama閱讀 38,892評(píng)論 3 405
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼唇辨,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼廊酣!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起赏枚,我...
    開(kāi)封第一講書(shū)人閱讀 37,655評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤亡驰,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后饿幅,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體凡辱,經(jīng)...
    沈念sama閱讀 44,104評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評(píng)論 2 325
  • 正文 我和宋清朗相戀三年栗恩,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了透乾。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,569評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡磕秤,死狀恐怖乳乌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情市咆,我是刑警寧澤汉操,帶...
    沈念sama閱讀 34,254評(píng)論 4 328
  • 正文 年R本政府宣布,位于F島的核電站蒙兰,受9級(jí)特大地震影響磷瘤,放射性物質(zhì)發(fā)生泄漏芒篷。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,834評(píng)論 3 312
  • 文/蒙蒙 一采缚、第九天 我趴在偏房一處隱蔽的房頂上張望针炉。 院中可真熱鬧,春花似錦仰担、人聲如沸糊识。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,725評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至愉耙,卻和暖如春贮尉,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背朴沿。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,950評(píng)論 1 264
  • 我被黑心中介騙來(lái)泰國(guó)打工猜谚, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人赌渣。 一個(gè)月前我還...
    沈念sama閱讀 46,260評(píng)論 2 360
  • 正文 我出身青樓魏铅,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親坚芜。 傳聞我的和親對(duì)象是個(gè)殘疾皇子览芳,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,446評(píng)論 2 348