From 1bfe7f6c658dc279e36049ca5cc566c673d84b34 Mon Sep 17 00:00:00 2001 From: Adam Lesinski Date: Tue, 26 Apr 2016 15:44:57 -0700 Subject: [PATCH] Add Complex XML Resources guide to docs Bug:27101564 Change-Id: I701230a242e0ec6c4cea2808556f9b1054866612 --- docs/html/guide/guide_toc.cs | 7 +- .../topics/resources/complex-xml-resources.jd | 117 ++++++++++++++++++ docs/html/guide/topics/resources/overview.jd | 4 + 3 files changed, 126 insertions(+), 2 deletions(-) create mode 100644 docs/html/guide/topics/resources/complex-xml-resources.jd diff --git a/docs/html/guide/guide_toc.cs b/docs/html/guide/guide_toc.cs index 549a1b6b02e48..9257a76e93f28 100644 --- a/docs/html/guide/guide_toc.cs +++ b/docs/html/guide/guide_toc.cs @@ -121,7 +121,7 @@
  • Overview
    • -
  • +
  • Providing Resources
  • @@ -129,10 +129,13 @@
  • Handling Runtime Changes -
    • +
  • Localization
    • +
  • + Complex XML Resources +
  • Resource Types diff --git a/docs/html/guide/topics/resources/complex-xml-resources.jd b/docs/html/guide/topics/resources/complex-xml-resources.jd new file mode 100644 index 0000000000000..66dcb58347ab2 --- /dev/null +++ b/docs/html/guide/topics/resources/complex-xml-resources.jd @@ -0,0 +1,117 @@ +page.title=Inline Complex XML Resources +parent.title=Application Resources +parent.link=index.html +@jd:body + +

    Certain resource types are a composition of multiple complex resources represented by XML files. +One example is an animated vector drawable, which is a drawable resource encapsulating a vector +drawable and an animation. This requires the use of at least three XML files.

    + +
    + +
    res/drawable/avd.xml
    +
    +
    +<?xml version="1.0" encoding="utf-8"?>
+<animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:drawable="@drawable/vectordrawable" >
+    <target
+        android:name="rotationGroup"
+        android:animation="@anim/rotation" />
+</animated-vector>
+
    +
    + +
    res/drawable/vectordrawable.xml
    +
    +
    +<?xml version="1.0" encoding="utf-8"?>
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:height="64dp"
+    android:width="64dp"
+    android:viewportHeight="600"
+    android:viewportWidth="600" >
+
   <group
+        android:name="rotationGroup"
+        android:pivotX="300.0"
+        android:pivotY="300.0"
+        android:rotation="45.0" >
+        <path
+            android:fillColor="#000000"
+            android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
+
   </group>
+</vector>
+
    +
    + +
    res/anim/rotation.xml
    +
    +
    +<?xml version="1.0" encoding="utf-8"?>
+<objectAnimator xmlns:android="http://schemas.android.com/apk/android"
+    android:duration="6000"
+    android:propertyName="rotation"
+    android:valueFrom="0"
+
   android:valueTo="360" />
+
    +
    + +
    + +

    There are a lot of files here just to make a single animated vector drawable! +If the vector drawable and animations are re-used elsewhere, this is the best way to implement an +animated vector drawable. If they’re only ever used for this animated vector drawable, then there is +a more compact way to implement them.

    + +

    Using AAPT’s inline resource format, you can define all three resources in the same XML file. +Since we’re making an animated vector drawable, we put the file under res/drawable/.

    + +
    + +
    res/drawable/avd.xml
    +
    +
    +<?xml version="1.0" encoding="utf-8"?>
+<animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:aapt="http://schemas.android.com/aapt" >
+
+    <aapt:attr name="android:drawable" >
+        <vector
+            android:height="64dp"
+            android:width="64dp"
+            android:viewportHeight="600"
+            android:viewportWidth="600" >
+
           <group
+                android:name="rotationGroup"
+                android:pivotX="300.0"
+                android:pivotY="300.0"
+                android:rotation="45.0" >
+                <path
+                    android:fillColor="#000000"
+                    android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
+
           </group>
+        </vector>
+    <aapt:attr />
+
+    <target
+        android:name="rotationGroup" />
+        <aapt:attr name="android:animation" >
+            <objectAnimator
+                android:duration="6000"
+                android:propertyName="rotation"
+                android:valueFrom="0"
+
               android:valueTo="360" />
+        <aapt:attr>
+</animated-vector>
+
    +
    + +
    + +

    The XML tag <aapt:attr > tells AAPT that the tag’s child shall be treated as a +resource and extracted into its own resource file. The value in the attribute name specifies where +to use the inline resource within the parent tag.

    + +

    AAPT will generate resource files and names for all of the inline resources. +Applications built using this inline format are compatible with all versions of Android.

    + diff --git a/docs/html/guide/topics/resources/overview.jd b/docs/html/guide/topics/resources/overview.jd index c3bd0bfb05817..c496797016afc 100644 --- a/docs/html/guide/topics/resources/overview.jd +++ b/docs/html/guide/topics/resources/overview.jd @@ -9,6 +9,7 @@ page.title=Resources Overview
  • Accessing Resources
  • Handling Runtime Changes
  • Localization
    • +
  • Complex XML Resources

    • Reference

    @@ -79,6 +80,9 @@ code or from other XML resources.
    A bottom-up guide to localizing your application using alternative resources. While this is just one specific use of alternative resources, it is very important in order to reach more users.
    +
    Complex XML Resources
    +
    An XML format for building complex resources like animated vector drawables in a single +XML file.
    Resource Types
    A reference of various resource types you can provide, describing their XML elements, attributes, and syntax. For example, this reference shows you how to create a resource for