本文翻译自android开发指导文档Creating a View Class
创建View类
一个设计良好的自定义view很像其他的优秀类。它封装了一组有着易用接口的特定功能,可以高效地使用CPU和内存,等等。除了是一个设计良好的类,一个自定义View应该:
- 复合android标准
- 提供可用于android xml布局的自定义样式属性
- 发送访问事件
- 兼容多个android平台
android框架提供了一系列类和xml标签来帮助你创建一个满足这些需求的view。这篇文档讨论了如何使用android框架创建view类的核心功能。
View的子类
所有定义在android框架中的view类都是View的子类。你的自定义view也可以直接继承View,或者你可以继承一个存在的子类来节约时间,比如说Button。
为了让ADT可以和你的view交互,你至少应该提供一个以Context和AttributeSet为参数的构造方法。这个构造方法允许布局编辑器创建和编辑一个你的view的实例。
class PieChart extends View {
public PieChart(Context context, AttributeSet attrs) {
super(context, attrs);
}
}
定义自定义属性
为了在你的用户界面添加一个内置view,你可以在xml元素中指定它,并且通过元素属性来控制它的样式和表现。优秀的自定义view也可以通过xml添加并定义样式。为了使你的view拥有这些表现,你必须:
- 在<declare-styleable>资源中给你的view定义自定义属性
- 在xml布局中给属性指定值
- 在运行时提取属性值
- 把这些属性值应用到你的view
这节内容告诉你如何自定义属性和指定它们的值。下一节将处理在运行时提取和使用这些属性值。
为了自定义属性,应该在工程的res中添加<declare-styleable>。一般将这些资源放在res/values/attrs.xml文件中。这里有一个例子:
<resources>
<declare-styleable name="PieChart">
<attr name="showText" format="boolean" />
<attr name="labelPosition" format="enum">
<enum name="left" value="0"/>
<enum name="right" value="1"/>
</attr>
</declare-styleable>
</resources>
这些代码声明了两个自定义属性:
showText和
labelPosition,它们属于一个名叫
PieChart的styleable实体。按照惯例,这个styleable实体的名字和自定义view的类名一样。尽管这不是严格要求的,但很多著名的代码编辑器基于该惯例来提供完整声明。
一旦你定义了这些属性,你可以在xml布局文件中像使用内置属性一样使用它们。唯一不同的是,你的自定义属性和内置属性属于不同的命名空间。它们属于http://schemas.android.com/apk/res/[your package name]而不是
http://schemas.android.com/apk/res/android
。例如,这里展示了如何使用PieChart的属性:
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:custom="http://schemas.android.com/apk/res/com.example.customviews">
<com.example.customviews.charting.PieChart
custom:showText="true"
custom:labelPosition="left" />
</LinearLayout>
为了避免重复很长的命名空间URI,示例使用一个xmlns指令。这个指令给命名空间
http://schemas.android.com/apk/res/com.example.customviews
分配了别名custom。你可以为你的命名空间任意选择别名。
注意添加到布局中自定义view的xml标签的名字。它是自定义view类的全限定名。如果你的view类是一个内部类,你必须进一步限定view外部类的名字。例如,PieChart类有一个内部类PieView。为了使用自定义属性,你应该使用
com.example.customviews.charting.PieChart$PieView标签。
com.example.customviews.charting.PieChart$PieView标签。
使用自定义属性
当一个view是从xml布局中创建时,xml标签中的所有属性都是从资源包中读取并作为AttributeSet传递到构造方法中。尽管可以从AttributeSet中直接读取值,但这样做有缺点:
- 属性值引用的资源没有解决
- 样式没有被使用
相反,应该将AttributeSet传递给obtainStyleAttributes()。这个方法返回一个属性值的TypedArray数组,这些属性值已经被间接引用并设计。
android资源编译器做了很多工作是你调用obtainStyleAttributes()更容易。对res文件夹中的每一个<declare-styleable>资源,生成的R.java定义了属性id数组和定义数组中每一个属性的常量的集合。你使用预先定义的常量来读取TypedArray中的属性。
public PieChart(Context context, AttributeSet attrs) {
super(context, attrs);
TypedArray a = context.getTheme().obtainStyledAttributes(
attrs,
R.styleable.PieChart,
0, 0);
try {
mShowText = a.getBoolean(R.styleable.PieChart_showText, false);
mTextPos = a.getInteger(R.styleable.PieChart_labelPosition, 0);
} finally {
a.recycle();
}
}
注意:TypedArray对象是共享资源,在使用后必须回收。
添加属性和事件
属性是控制view表现和外观的有力方式,但是它们只能在view初始化的时候读取。为了提供动态的行为,应该为每一个属性提供getter和setter方法。下面的代码片段展示了PieChart如何暴露showText的属性:
public boolean isShowText() {
return mShowText;
}
public void setShowText(boolean showText) {
mShowText = showText;
invalidate();
requestLayout();
}
注意setShowText调用了invalidate()和requestLayout()。这些调用是至关重要的,以确保view可靠的表现。你必须在view改变它的属性之后invalidate这个view,因为那可能会改变view的外观,这样系统就会知道这个view需要重绘。忘记调用这些方法会引起难以发现的bug。
自定义view也应该支持事件监听器和重要事件通信。例如,PieChart暴露了一个自定义事件叫OnCurrentItemChanged来提醒监听器用户旋转了pie chart。
很容易忘记暴露这些属性和事件,尤其是当这些自定义view的用户仅仅是你时。花一些时间小心定义你的view的接口会减少维护的成本。一个好的原则是,总是暴露那些会影响你的view外观和行为的属性。