Question

我需要在com.android.R.attr

中实现自己的属性

在官方文档中找不到任何内容，因此我需要有关如何定义这些attrs以及如何在我的代码中使用它们的信息。

Answer 1

目前最好的文档是来源。你可以看一下here (attrs.xml)。

您可以在顶部<resources>元素或<declare-styleable>元素内定义属性。如果我要在多个地方使用attr，我会把它放在根元素中。请注意，所有属性共享相同的全局命名空间。这意味着即使您在<declare-styleable>元素内部创建了一个新属性，也可以在其外部使用它，并且您无法创建具有相同名称的另一个属性。

<attr>元素有两个xml属性name和format。 name可让您调用它，这就是您最终在代码中引用它的方式，例如R.attr.my_attribute。 format属性可以具有不同的值，具体取决于您想要的属性的“类型”。

引用 - 如果它引用另一个资源ID（例如，“@ color / my_color”，“@ layout / my_layout”）
颜色
布尔
尺寸
浮
整数
字符串
分数
enum - 通常隐式定义
flag - 通常隐式定义

您可以使用|将格式设置为多种类型，例如format="reference|color"。

enum属性可以定义如下：

<attr name="my_enum_attr">
  <enum name="value1" value="1" />
  <enum name="value2" value="2" />
</attr>

flag属性是相似的，除了需要定义的值，以便它们可以一起进行位：

<attr name="my_flag_attr">
  <flag name="fuzzy" value="0x01" />
  <flag name="cold" value="0x02" />
</attr>

除属性外，还有<declare-styleable>元素。这允许您定义自定义视图可以使用的属性。您可以通过指定<attr>元素来执行此操作，如果之前已定义，则不指定format。如果您希望重用android attr，例如android：gravity，那么您可以在name中执行此操作，如下所示。

自定义视图的示例<declare-styleable>：

<declare-styleable name="MyCustomView">
  <attr name="my_custom_attribute" />
  <attr name="android:gravity" />
</declare-styleable>

在自定义视图中以XML格式定义自定义属性时，您需要执行一些操作。首先，您必须声明命名空间以查找属性。您可以在根布局元素上执行此操作。通常只有xmlns:android="http://schemas.android.com/apk/res/android"。您现在还必须添加xmlns:whatever="http://schemas.android.com/apk/res-auto"。

示例：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
  xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:whatever="http://schemas.android.com/apk/res-auto"
  android:orientation="vertical"
  android:layout_width="fill_parent"
  android:layout_height="fill_parent">

    <org.example.mypackage.MyCustomView
      android:layout_width="fill_parent"
      android:layout_height="wrap_content"
      android:gravity="center"
      whatever:my_custom_attribute="Hello, world!" />
</LinearLayout>

最后，要访问该自定义属性，通常在自定义视图的构造函数中执行此操作，如下所示。

public MyCustomView(Context context, AttributeSet attrs, int defStyle) {
  super(context, attrs, defStyle);

  TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.MyCustomView, defStyle, 0);

  String str = a.getString(R.styleable.MyCustomView_my_custom_attribute);

  //do something with str

  a.recycle();
}

结束。：）

Answer 2

Qberticus的答案很好，但缺少一个有用的细节。如果要在库中实现这些替换：

xmlns:whatever="http://schemas.android.com/apk/res/org.example.mypackage"

使用：

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

否则，使用该库的应用程序将出现运行时错误。

Answer 3

除了几件事之外，上面的答案非常详细地介绍了所有内容。

首先，如果没有样式，则(Context context, AttributeSet attrs)方法签名将用于实例化首选项。在这种情况下，只需使用context.obtainStyledAttributes(attrs, R.styleable.MyCustomView)来获取TypedArray。

其次，它没有涉及如何处理文化资源（数量字符串）。使用TypedArray无法处理这些问题。这是我的SeekBarPreference中的代码片段，它根据首选项的值设置首选项的摘要格式化其值。如果首选项的xml将android：summary设置为文本字符串或字符串resouce，则将首选项的值格式化为字符串（它应该包含％d，以获取值）。如果android：summary设置为plaurals资源，则用于格式化结果。

// Use your own name space if not using an android resource.
final static private String ANDROID_NS = 
    "http://schemas.android.com/apk/res/android";
private int pluralResource;
private Resources resources;
private String summary;

public SeekBarPreference(Context context, AttributeSet attrs) {
    // ...
    TypedArray attributes = context.obtainStyledAttributes(
        attrs, R.styleable.SeekBarPreference);
    pluralResource =  attrs.getAttributeResourceValue(ANDROID_NS, "summary", 0);
    if (pluralResource !=  0) {
        if (! resources.getResourceTypeName(pluralResource).equals("plurals")) {
            pluralResource = 0;
        }
    }
    if (pluralResource ==  0) {
        summary = attributes.getString(
            R.styleable.SeekBarPreference_android_summary);
    }
    attributes.recycle();
}

@Override
public CharSequence getSummary() {
    int value = getPersistedInt(defaultValue);
    if (pluralResource != 0) {
        return resources.getQuantityString(pluralResource, value, value);
    }
    return (summary == null) ? null : String.format(summary, value);
}

这仅作为示例提供，但是，如果您想要在首选项屏幕上设置摘要，则需要在首选项的notifyChanged()方法中调用onDialogClosed

Answer 4

传统方法充满了样板代码和笨拙的资源处理。这就是我制作Spyglass framework的原因。为了演示它是如何工作的，这里有一个示例，说明如何创建一个显示字符串标题的自定义视图。

第1步：创建自定义视图类。

public class CustomView extends FrameLayout {
    private TextView titleView;

    public CustomView(Context context) {
        super(context);
        init(null, 0, 0);
    }

    public CustomView(Context context, AttributeSet attrs) {
        super(context, attrs);
        init(attrs, 0, 0);
    }

    public CustomView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        init(attrs, defStyleAttr, 0);
    }

    @RequiresApi(21)
    public CustomView(
            Context context, 
            AttributeSet attrs,
            int defStyleAttr,
            int defStyleRes) {

        super(context, attrs, defStyleAttr, defStyleRes);
        init(attrs, defStyleAttr, defStyleRes);
    }

    public void setTitle(String title) {
        titleView.setText(title);
    }

    private void init(AttributeSet attrs, int defStyleAttr, int defStyleRes) {
        inflate(getContext(), R.layout.custom_view, this);

        titleView = findViewById(R.id.title_view);
    }
}

步骤2：在values/attrs.xml资源文件中定义字符串属性：

<resources>
    <declare-styleable name="CustomView">
        <attr name="title" format="string"/>
    </declare-styleable>
</resources>

步骤3：将@StringHandler注释应用于setTitle方法，以告知Spyglass框架在视图膨胀时将属性值路由到此方法。

@HandlesString(attributeId = R.styleable.CustomView_title)
public void setTitle(String title) {
    titleView.setText(title);
}

现在您的类具有Spyglass注释，Spyglass框架将在编译时检测它并自动生成CustomView_SpyglassCompanion类。

第4步：在自定义视图的init方法中使用生成的类：

private void init(AttributeSet attrs, int defStyleAttr, int defStyleRes) {
    inflate(getContext(), R.layout.custom_view, this);

    titleView = findViewById(R.id.title_view);

    CustomView_SpyglassCompanion
            .builder()
            .withTarget(this)
            .withContext(getContext())
            .withAttributeSet(attrs)
            .withDefaultStyleAttribute(defStyleAttr)
            .withDefaultStyleResource(defStyleRes)
            .build()
            .callTargetMethodsNow();
}

那就是它。现在，当您从XML实例化类时，Spyglass伴侣会解释属性并进行所需的方法调用。例如，如果我们夸大以下布局，则会以setTitle作为参数调用"Hello, World!"。

<FrameLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:width="match_parent"
    android:height="match_parent">

    <com.example.CustomView
        android:width="match_parent"
        android:height="match_parent"
        app:title="Hello, World!"/>
</FrameLayout>

框架不仅限于字符串资源，还有许多不同的注释用于处理其他资源类型。如果您的方法有多个参数，它还有注释用于定义默认值和传递占位符值。

查看Github回购以获取更多信息和示例。

Answer 5

如果您从format元素中省略了attr属性，则可以使用它来引用XML布局中的类。

来自attrs.xml的示例。
Android Studio知道正在从XML引用该类
- 即
  - Refactor > Rename有效
  - Find Usages有效
  - 依此类推...

不要在 ... / src / main / res / values / attrs.xml

中指定format属性

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <declare-styleable name="MyCustomView">
        ....
        <attr name="give_me_a_class"/>
        ....
    </declare-styleable>

</resources>

在某些布局文件中使用它 ... / src / main / res / layout / activity__main_menu.xml

<?xml version="1.0" encoding="utf-8"?>
<SomeLayout
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <!-- make sure to use $ dollar signs for nested classes -->
    <MyCustomView
        app:give_me_a_class="class.type.name.Outer$Nested/>

    <MyCustomView
        app:give_me_a_class="class.type.name.AnotherClass/>

</SomeLayout>

在您的视图初始化代码中解析类 ... / src / main / java /.../ MyCustomView.kt

class MyCustomView(
        context:Context,
        attrs:AttributeSet)
    :View(context,attrs)
{
    // parse XML attributes
    ....
    private val giveMeAClass:SomeCustomInterface
    init
    {
        context.theme.obtainStyledAttributes(attrs,R.styleable.ColorPreference,0,0).apply()
        {
            try
            {
                // very important to use the class loader from the passed-in context
                giveMeAClass = context::class.java.classLoader!!
                        .loadClass(getString(R.styleable.MyCustomView_give_me_a_class))
                        .newInstance() // instantiate using 0-args constructor
                        .let {it as SomeCustomInterface}
            }
            finally
            {
                recycle()
            }
        }
    }

定义自定义attrs

5 个答案: