diff options
author | Scott Main <smain@google.com> | 2010-07-15 11:23:08 -0700 |
---|---|---|
committer | Android Git Automerger <android-git-automerger@android.com> | 2010-07-15 11:23:08 -0700 |
commit | 4fd416880e53c172bac4a51b2eafea699b58badf (patch) | |
tree | 65ba0abf51ee25e98fed39e60beeb9936a44f7eb /graphics | |
parent | b068b47c6d0214256116a0c661740bddf7acc18c (diff) | |
parent | 5352d2378d2f92ebe0657e4caedb4498492fc404 (diff) | |
download | frameworks_base-4fd416880e53c172bac4a51b2eafea699b58badf.zip frameworks_base-4fd416880e53c172bac4a51b2eafea699b58badf.tar.gz frameworks_base-4fd416880e53c172bac4a51b2eafea699b58badf.tar.bz2 |
am 5352d237: am 38137d7a: Merge "docs: lots of additions to the resources docs new drawable resources add <merge> and <include> to layout resource update drawable class descriptioons to point to resources guide add ID resource type" into froyo
Merge commit '5352d2378d2f92ebe0657e4caedb4498492fc404' into gingerbread-plus-aosp
* commit '5352d2378d2f92ebe0657e4caedb4498492fc404':
docs: lots of additions to the resources docs
Diffstat (limited to 'graphics')
13 files changed, 46 insertions, 18 deletions
diff --git a/graphics/java/android/graphics/drawable/AnimationDrawable.java b/graphics/java/android/graphics/drawable/AnimationDrawable.java index fdc4c92..e275ba8 100644 --- a/graphics/java/android/graphics/drawable/AnimationDrawable.java +++ b/graphics/java/android/graphics/drawable/AnimationDrawable.java @@ -64,6 +64,8 @@ import android.util.AttributeSet; * // Start the animation (looped playback by default). * frameAnimation.start() * </pre> + * <p>For more information, see the guide to <a + * href="{@docRoot}guide/topics/resources/animation-resource.html">Animation Resources</a>.</p> * * @attr ref android.R.styleable#AnimationDrawable_visible * @attr ref android.R.styleable#AnimationDrawable_variablePadding diff --git a/graphics/java/android/graphics/drawable/BitmapDrawable.java b/graphics/java/android/graphics/drawable/BitmapDrawable.java index 29e14d2..32111e8 100644 --- a/graphics/java/android/graphics/drawable/BitmapDrawable.java +++ b/graphics/java/android/graphics/drawable/BitmapDrawable.java @@ -40,7 +40,9 @@ import java.io.IOException; * A Drawable that wraps a bitmap and can be tiled, stretched, or aligned. You can create a * BitmapDrawable from a file path, an input stream, through XML inflation, or from * a {@link android.graphics.Bitmap} object. - * <p>It can be defined in an XML file with the <code><bitmap></code> element.</p> + * <p>It can be defined in an XML file with the <code><bitmap></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * <p> * Also see the {@link android.graphics.Bitmap} class, which handles the management and * transformation of raw bitmap graphics, and should be used when drawing to a diff --git a/graphics/java/android/graphics/drawable/ClipDrawable.java b/graphics/java/android/graphics/drawable/ClipDrawable.java index c387a9b..a772871 100644 --- a/graphics/java/android/graphics/drawable/ClipDrawable.java +++ b/graphics/java/android/graphics/drawable/ClipDrawable.java @@ -32,9 +32,14 @@ import java.io.IOException; * level value. You can control how much the child Drawable gets clipped in width * and height based on the level, as well as a gravity to control where it is * placed in its overall container. Most often used to implement things like - * progress bars. + * progress bars, by increasing the drawable's level with {@link + * android.graphics.drawable.Drawable#setLevel(int) setLevel()}. + * <p class="note"><strong>Note:</strong> The drawable is clipped completely and not visible when + * the level is 0 and fully revealed when the level is 10,000.</p> * - * <p>It can be defined in an XML file with the <code><clip></code> element.</p> + * <p>It can be defined in an XML file with the <code><clip></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * * @attr ref android.R.styleable#ClipDrawable_clipOrientation * @attr ref android.R.styleable#ClipDrawable_gravity diff --git a/graphics/java/android/graphics/drawable/Drawable.java b/graphics/java/android/graphics/drawable/Drawable.java index 6a7b2d1..3125321 100644 --- a/graphics/java/android/graphics/drawable/Drawable.java +++ b/graphics/java/android/graphics/drawable/Drawable.java @@ -93,8 +93,8 @@ import android.util.TypedValue; * whose overall size is modified based on the current level. * </ul> * <p>For information and examples of creating drawable resources (XML or bitmap files that - * can be loaded in code), see <a href="{@docRoot}guide/topics/resources/resources-i18n.html">Resources - * and Internationalization</a>. + * can be loaded in code), see <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>. */ public abstract class Drawable { private static final Rect ZERO_BOUNDS_RECT = new Rect(); @@ -709,8 +709,7 @@ public abstract class Drawable { /** * Create a drawable from an XML document. For more information on how to * create resources in XML, see - * <a href="{@docRoot}guide/topics/resources/resources-i18n.html">Resources and - * Internationalization</a>. + * <a href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>. */ public static Drawable createFromXml(Resources r, XmlPullParser parser) throws XmlPullParserException, IOException { diff --git a/graphics/java/android/graphics/drawable/GradientDrawable.java b/graphics/java/android/graphics/drawable/GradientDrawable.java index 63d1446..33ecbea 100644 --- a/graphics/java/android/graphics/drawable/GradientDrawable.java +++ b/graphics/java/android/graphics/drawable/GradientDrawable.java @@ -42,7 +42,9 @@ import java.io.IOException; /** * A Drawable with a color gradient for buttons, backgrounds, etc. * - * <p>It can be defined in an XML file with the <code><shape></code> element.</p> + * <p>It can be defined in an XML file with the <code><shape></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * * @attr ref android.R.styleable#GradientDrawable_visible * @attr ref android.R.styleable#GradientDrawable_shape diff --git a/graphics/java/android/graphics/drawable/InsetDrawable.java b/graphics/java/android/graphics/drawable/InsetDrawable.java index 4fa9d44..a9c983e 100644 --- a/graphics/java/android/graphics/drawable/InsetDrawable.java +++ b/graphics/java/android/graphics/drawable/InsetDrawable.java @@ -32,7 +32,9 @@ import java.io.IOException; * This is used when a View needs a background that is smaller than * the View's actual bounds. * - * <p>It can be defined in an XML file with the <code><inset></code> element.</p> + * <p>It can be defined in an XML file with the <code><inset></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * * @attr ref android.R.styleable#InsetDrawable_visible * @attr ref android.R.styleable#InsetDrawable_drawable diff --git a/graphics/java/android/graphics/drawable/LayerDrawable.java b/graphics/java/android/graphics/drawable/LayerDrawable.java index 389fd40..8047dd4 100644 --- a/graphics/java/android/graphics/drawable/LayerDrawable.java +++ b/graphics/java/android/graphics/drawable/LayerDrawable.java @@ -32,8 +32,9 @@ import java.io.IOException; * order, so the element with the largest index will be drawn on top. * <p> * It can be defined in an XML file with the <code><layer-list></code> element. - * Each Drawable in the layer is defined in a nested <code><item></code>. - * </p> + * Each Drawable in the layer is defined in a nested <code><item></code>. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * * @attr ref android.R.styleable#LayerDrawableItem_left * @attr ref android.R.styleable#LayerDrawableItem_top diff --git a/graphics/java/android/graphics/drawable/LevelListDrawable.java b/graphics/java/android/graphics/drawable/LevelListDrawable.java index ae8f224..21be983 100644 --- a/graphics/java/android/graphics/drawable/LevelListDrawable.java +++ b/graphics/java/android/graphics/drawable/LevelListDrawable.java @@ -47,7 +47,10 @@ import android.util.AttributeSet; * <p>With this XML saved into the res/drawable/ folder of the project, it can be referenced as * the drawable for an {@link android.widget.ImageView}. The default image is the first in the list. * It can then be changed to one of the other levels with - * {@link android.widget.ImageView#setImageLevel(int)}.</p> + * {@link android.widget.ImageView#setImageLevel(int)}. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> + * * @attr ref android.R.styleable#LevelListDrawableItem_minLevel * @attr ref android.R.styleable#LevelListDrawableItem_maxLevel * @attr ref android.R.styleable#LevelListDrawableItem_drawable diff --git a/graphics/java/android/graphics/drawable/RotateDrawable.java b/graphics/java/android/graphics/drawable/RotateDrawable.java index 2083e05..9c47dab 100644 --- a/graphics/java/android/graphics/drawable/RotateDrawable.java +++ b/graphics/java/android/graphics/drawable/RotateDrawable.java @@ -35,7 +35,9 @@ import java.io.IOException; * value. The start and end angles of rotation can be controlled to map any * circular arc to the level values range.</p> * - * <p>It can be defined in an XML file with the <code><rotate></code> element.</p> + * <p>It can be defined in an XML file with the <code><rotate></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/animation-resource.html">Animation Resources</a>.</p> * * @attr ref android.R.styleable#RotateDrawable_visible * @attr ref android.R.styleable#RotateDrawable_fromDegrees diff --git a/graphics/java/android/graphics/drawable/ScaleDrawable.java b/graphics/java/android/graphics/drawable/ScaleDrawable.java index 275e36f..b623d80 100644 --- a/graphics/java/android/graphics/drawable/ScaleDrawable.java +++ b/graphics/java/android/graphics/drawable/ScaleDrawable.java @@ -34,7 +34,9 @@ import java.io.IOException; * placed in its overall container. Most often used to implement things like * progress bars. * - * <p>It can be defined in an XML file with the <code><scale></code> element.</p> + * <p>It can be defined in an XML file with the <code><scale></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * * @attr ref android.R.styleable#ScaleDrawable_scaleWidth * @attr ref android.R.styleable#ScaleDrawable_scaleHeight diff --git a/graphics/java/android/graphics/drawable/ShapeDrawable.java b/graphics/java/android/graphics/drawable/ShapeDrawable.java index c699a82..be1892e 100644 --- a/graphics/java/android/graphics/drawable/ShapeDrawable.java +++ b/graphics/java/android/graphics/drawable/ShapeDrawable.java @@ -34,6 +34,10 @@ import java.io.IOException; * the ShapeDrawable will default to a * {@link android.graphics.drawable.shapes.RectShape}. * + * <p>It can be defined in an XML file with the <code><shape></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> + * * @attr ref android.R.styleable#ShapeDrawablePadding_left * @attr ref android.R.styleable#ShapeDrawablePadding_top * @attr ref android.R.styleable#ShapeDrawablePadding_right diff --git a/graphics/java/android/graphics/drawable/StateListDrawable.java b/graphics/java/android/graphics/drawable/StateListDrawable.java index b94df84..239be40 100644 --- a/graphics/java/android/graphics/drawable/StateListDrawable.java +++ b/graphics/java/android/graphics/drawable/StateListDrawable.java @@ -31,7 +31,9 @@ import android.util.StateSet; * ID value. * <p/> * <p>It can be defined in an XML file with the <code><selector></code> element. - * Each state Drawable is defined in a nested <code><item></code> element.</p> + * Each state Drawable is defined in a nested <code><item></code> element. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> * * @attr ref android.R.styleable#StateListDrawable_visible * @attr ref android.R.styleable#StateListDrawable_variablePadding diff --git a/graphics/java/android/graphics/drawable/TransitionDrawable.java b/graphics/java/android/graphics/drawable/TransitionDrawable.java index 97b45d8..4470356 100644 --- a/graphics/java/android/graphics/drawable/TransitionDrawable.java +++ b/graphics/java/android/graphics/drawable/TransitionDrawable.java @@ -26,8 +26,10 @@ import android.os.SystemClock; * display just the first layer, call {@link #resetTransition()}. * <p> * It can be defined in an XML file with the <code><transition></code> element. - * Each Drawable in the transition is defined in a nested <code><item></code>. - * </p> + * Each Drawable in the transition is defined in a nested <code><item></code>. For more + * information, see the guide to <a + * href="{@docRoot}guide/topics/resources/drawable-resource.html">Drawable Resources</a>.</p> + * * @attr ref android.R.styleable#LayerDrawableItem_left * @attr ref android.R.styleable#LayerDrawableItem_top * @attr ref android.R.styleable#LayerDrawableItem_right @@ -212,7 +214,7 @@ public class TransitionDrawable extends LayerDrawable implements Drawable.Callba * Enables or disables the cross fade of the drawables. When cross fade * is disabled, the first drawable is always drawn opaque. With cross * fade enabled, the first drawable is drawn with the opposite alpha of - * the second drawable. + * the second drawable. Cross fade is disabled by default. * * @param enabled True to enable cross fading, false otherwise. */ |