Drawable Resources

Bitmap

A bitmap image. Android supports bitmap files in a three formats:.png (preferred), .jpg (acceptable), .gif (discouraged).

You can reference a bitmap file directly, using the filename as the resource ID, or create analias resource ID in XML.

Note: Bitmap files may be automatically optimized with losslessimage compression by the aapt tool during the build process. Forexample, a true-color PNG that does not require more than 256 colors may be converted to an 8-bitPNG with a color palette. This will result in an image of equal quality but which requires lessmemory. So be aware that the image binaries placed in this directory can change during the build. Ifyou plan on reading an image as a bit stream in order to convert it to a bitmap, put your images inthe res/raw/ folder instead, where they will not be optimized.

Bitmap File

A bitmap file is a .png, .jpg, or .gif file. Android creates a Drawableresource for any of these files when you save them in the res/drawable/ directory.

file location:

res/drawable/filename.png ( .png, .jpg, or .gif)
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a BitmapDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

example:

With an image saved at res/drawable/myimage.png, this layout XML appliesthe image to a View:

<ImageView  android:layout_height="wrap_content"  android:layout_width="wrap_content"  android:src="@drawable/myimage" />

The following application code retrieves the image as a Drawable:

Resources res = getResources();Drawable drawable = res.getDrawable(R.drawable.myimage);

see also:

2D Graphics
BitmapDrawable

XML Bitmap

An XML bitmap is a resource defined in XML that points to a bitmap file. The effect is an alias for araw bitmap file. The XML can specify additional properties for the bitmap such as dithering and tiling.

Note: You can use a <bitmap> element as a child ofan <item> element. Forexample, when creating a state list or layer list,you can exclude the android:drawableattribute from an <item> element and nest a <bitmap> inside itthat defines the drawable item.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a BitmapDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><bitmap  xmlns:android="http://schemas.android.com/apk/res/android"  android:src="@[package:]drawable/drawable_resource"  android:antialias=["true" | "false"]  android:dither=["true" | "false"]  android:filter=["true" | "false"]  android:gravity=["top" | "bottom" | "left" | "right" | "center_vertical" |           "fill_vertical" | "center_horizontal" | "fill_horizontal" |           "center" | "fill" | "clip_vertical" | "clip_horizontal"]  android:tileMode=["disabled" | "clamp" | "repeat" | "mirror"] />

elements:

<bitmap>

Defines the bitmap source and its properties.

attributes:

xmlns:android

String. Defines the XML namespace, which must be "http://schemas.android.com/apk/res/android". This is required only if the <bitmap> is the root element—it is not needed when the <bitmap> is nested inside an <item>.

android:src

Drawable resource. Required. Reference to a drawableresource.

android:antialias

Boolean. Enables or disables antialiasing.

android:dither

Boolean. Enables or disables dithering of the bitmap if the bitmap does nothave the same pixel configuration as the screen (for instance: a ARGB 8888 bitmap with an RGB 565screen).

android:filter

Boolean. Enables or disables bitmap filtering. Filtering is used when thebitmap is shrunk or stretched to smooth its apperance.

android:gravity

Keyword. Defines the gravity for the bitmap. The gravity indicates where toposition the drawable in its container if the bitmap is smaller than the container.

Must be one or more (separated by '|') of the following constant values:

Value	Description
`top`	Put the object at the top of its container, not changing its size.
`bottom`	Put the object at the bottom of its container, not changing its size.
`left`	Put the object at the left edge of its container, not changing its size.
`right`	Put the object at the right edge of its container, not changing its size.
`center_vertical`	Place object in the vertical center of its container, not changing its size.
`fill_vertical`	Grow the vertical size of the object if needed so it completely fills its container.
`center_horizontal`	Place object in the horizontal center of its container, not changing its size.
`fill_horizontal`	Grow the horizontal size of the object if needed so it completely fills its container.
`center`	Place the object in the center of its container in both the vertical and horizontal axis, notchanging its size.
`fill`	Grow the horizontal and vertical size of the object if needed so it completely fills itscontainer. This is the default.
`clip_vertical`	Additional option that can be set to have the top and/or bottom edges of the child clipped toits container's bounds. The clip is based on the vertical gravity: a top gravity clips thebottom edge, a bottom gravity clips the top edge, and neither clips both edges.
`clip_horizontal`	Additional option that can be set to have the left and/or right edges of the child clipped toits container's bounds. The clip is based on the horizontal gravity: a left gravity clipsthe right edge, a right gravity clips the left edge, and neither clips both edges.

android:tileMode

Keyword. Defines the tile mode. When the tile mode is enabled, the bitmap isrepeated. Gravity is ignored when the tile mode is enabled.

Must be one of the following constant values:

Value	Description
`disabled`	Do not tile the bitmap. This is the default value.
`clamp`	Replicates the edge color if the shader draws outside of its original bounds
`repeat`	Repeats the shader's image horizontally and vertically.
`mirror`	Repeats the shader's image horizontally and vertically, alternating mirror images so thatadjacent images always seam.

example:

<?xml version="1.0" encoding="utf-8"?><bitmap xmlns:android="http://schemas.android.com/apk/res/android"  android:src="@drawable/icon"  android:tileMode="repeat" />

see also:

BitmapDrawable
Creatingalias resources

Nine-Patch

A NinePatch is a PNG image in which you can define stretchable regionsthat Android scales when content within the View exceeds the normal image bounds. Youtypically assign this type of image as the background of a View that has at least one dimension setto "wrap_content", and when the View grows to accomodate the content, the Nine-Patch imageis also scaled to match the size of the View. An example use of a Nine-Patch image is thebackground used by Android's standard Button widget, which must stretch toaccommodate the text (or image) inside the button.

Same as with a normal bitmap, you can reference a Nine-Patch file directlyor from a resource defined by XML.

For a complete discussion about how to create a Nine-Patch file with stretchable regions,see the 2D Graphicsdocument.

Nine-Patch File

file location:

res/drawable/filename.9.png
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a NinePatchDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

example:

With an image saved at res/drawable/myninepatch.9.png, this layout XMLapplies the Nine-Patch to a View:

<Button  android:layout_height="wrap_content"  android:layout_width="wrap_content"  android:background="@drawable/myninepatch" />

see also:

2D Graphics
NinePatchDrawable

XML Nine-Patch

An XML Nine-Patch is a resource defined in XML that points to a Nine-Patch file. The XML canspecify dithering for the image.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a NinePatchDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><nine-patch  xmlns:android="http://schemas.android.com/apk/res/android"  android:src="@[package:]drawable/drawable_resource"  android:dither=["true" | "false"] />

elements:

example:

<?xml version="1.0" encoding="utf-8"?><nine-patch xmlns:android="http://schemas.android.com/apk/res/android"  android:src="@drawable/myninepatch"  android:dither="false" />

Layer List

A LayerDrawable is a drawable objectthat manages an array of other drawables. Each drawable in the list is drawn in the order of thelist—the last drawable in the list is drawn on top.

Each drawable is represented by an <item> element inside a single <layer-list> element.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a LayerDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><layer-list  xmlns:android="http://schemas.android.com/apk/res/android" >  <item    android:drawable="@[package:]drawable/drawable_resource"    android:id="@[+][package:]id/resource_name"    android:top="dimension"    android:right="dimension"    android:bottom="dimension"    android:left="dimension" /></layer-list>

elements:

example:

XML file saved at res/drawable/layers.xml:

<?xml version="1.0" encoding="utf-8"?><layer-list xmlns:android="http://schemas.android.com/apk/res/android">  <item>   <bitmap android:src="@drawable/android_red"    android:gravity="center" />  </item>  <item android:top="10dp" android:left="10dp">   <bitmap android:src="@drawable/android_green"    android:gravity="center" />  </item>  <item android:top="20dp" android:left="20dp">   <bitmap android:src="@drawable/android_blue"    android:gravity="center" />  </item></layer-list>

Notice that this example uses a nested <bitmap> element to define the drawableresource for each item with a "center" gravity. This ensures that none of the images are scaled tofit the size of the container, due to resizing caused by the offset images.

This layout XML applies the drawable to a View:

<ImageView  android:layout_height="wrap_content"  android:layout_width="wrap_content"  android:src="@drawable/layers" />

The result is a stack of increasingly offset images:

see also:

LayerDrawable

State List

A StateListDrawable is a drawable object defined in XMLthat uses a several different images to represent the same graphic, depending on the state ofthe object. For example, a Button widget can exist in one of several different states (pressed, focused,or niether) and, using a state list drawable, you can provide a different background image for eachstate.

You can describe the state list in an XML file. Each graphic is represented by an <item> element inside a single <selector> element. Each <item>uses various attributes to describe the state in which it should be used as the graphic for thedrawable.

During each state change, the state list is traversed top to bottom and the first item thatmatches the current state is used—the selection is not based on the "bestmatch," but simply the first item that meets the minimum criteria of the state.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a StateListDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><selector xmlns:android="http://schemas.android.com/apk/res/android"  android:constantSize=["true" | "false"]  android:dither=["true" | "false"]  android:variablePadding=["true" | "false"] >  <item    android:drawable="@[package:]drawable/drawable_resource"    android:state_pressed=["true" | "false"]    android:state_focused=["true" | "false"]    android:state_selected=["true" | "false"]    android:state_checkable=["true" | "false"]    android:state_checked=["true" | "false"]    android:state_enabled=["true" | "false"]    android:state_window_focused=["true" | "false"] /></selector>

elements:

<selector>

Required. This must be the root element. Contains one or more <item> elements.

attributes:

xmlns:android: String. Required. Defines the XML namespace, which must be "http://schemas.android.com/apk/res/android".
android:constantSize: Boolean. "true" if the drawable's reported internal size remains constant as the statechanges (the size is the maximum of all of the states); "false" if the size varies based onthe current state. Default is false.
android:dither: Boolean. "true" to enable dithering of the bitmap if the bitmap does not have the same pixelconfiguration as the screen (for instance, an ARGB 8888 bitmap with an RGB 565 screen); "false" todisable dithering. Default is true.
android:variablePadding: Boolean. "true" if the drawable's padding should change based on the currentstate that is selected; "false" if the padding should stay the same (based on the maximumpadding of all the states). Enabling this feature requires that you deal withperforming layout when the state changes, which is often not supported. Default is false.

<item>

Defines a drawable to use during certain states, as described by its attributes. Must be achild of a <selector> element.

attributes:

android:drawable: Drawable resource. Required. Reference to a drawable resource.
android:state_pressed: Boolean. "true" if this item should be used when the object is pressed (such as when a buttonis touched/clicked); "false" if this item should be used in the default, non-pressed state.
android:state_focused: Boolean. "true" if this item should be used when the object is focused (such as when a buttonis highlighted using the trackball/d-pad); "false" if this item should be used in the default,non-focused state.
android:state_selected: Boolean. "true" if this item should be used when the object is selected (such as when atab is opened); "false" if this item should be used when the object is not selected.
android:state_checkable: Boolean. "true" if this item should be used when the object is checkable; "false" if thisitem should be used when the object is not checkable. (Only useful if the object cantransition between a checkable and non-checkable widget.)
android:state_checked: Boolean. "true" if this item should be used when the object is checked; "false" if itshould be used when the object is un-checked.
android:state_enabled: Boolean. "true" if this item should be used when the object is enabled (capable ofreceiving touch/click events); "false" if it should be used when the object is disabled.
android:state_window_focused: Boolean. "true" if this item should be used when the application window has focus (theapplication is in the foreground), "false" if this item should be used when the applicationwindow does not have focus (for example, if the notification shade is pulled down or a dialog appears).

Note: Remember that Android applies the first item in the state list thatmatches the current state of the object. So, if the first item in the list containsnone of the state attributes above, then it is applied every time, which is why yourdefault value should always be last (as demonstrated in the following example).

example:

XML file saved at res/drawable/button.xml:

<?xml version="1.0" encoding="utf-8"?><selector xmlns:android="http://schemas.android.com/apk/res/android">  <item android:state_pressed="true"     android:drawable="@drawable/button_pressed" /> <!-- pressed -->  <item android:state_focused="true"     android:drawable="@drawable/button_focused" /> <!-- focused -->  <item android:drawable="@drawable/button_normal" /> <!-- default --></selector>

This layout XML applies the state list drawable to a Button:

<Button  android:layout_height="wrap_content"  android:layout_width="wrap_content"  android:background="@drawable/button" />

see also:

StateListDrawable

Level List

A Drawable that manages a number of alternate Drawables, each assigned a maximum numericalvalue. Setting the level value of the drawable with setLevel() loads the drawable resource in thelevel list that has a android:maxLevel value greater than or equal to the valuepassed to the method.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a LevelListDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><level-list  xmlns:android="http://schemas.android.com/apk/res/android" >  <item    android:drawable="@drawable/drawable_resource"    android:maxLevel="integer"    android:minLevel="integer" /></level-list>

elements:

example:

<?xml version="1.0" encoding="utf-8"?><level-list xmlns:android="http://schemas.android.com/apk/res/android" >  <item    android:drawable="@drawable/status_off"    android:maxLevel="0" />  <item    android:drawable="@drawable/status_on"    android:maxLevel="1" /></level-list>

Once this is applied to a View, the level can be changed with setLevel() or setImageLevel().

see also:

LevelListDrawable

Transition Drawable

A TransitionDrawable is a drawable objectthat can cross-fade between the two drawable resources.

Each drawable is represented by an <item> element inside a single <transition> element. No more than two items are supported. To transition forward, callstartTransition(). Totransition backward, call reverseTransition().

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a TransitionDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><transitionxmlns:android="http://schemas.android.com/apk/res/android" >  <item    android:drawable="@[package:]drawable/drawable_resource"    android:id="@[+][package:]id/resource_name"    android:top="dimension"    android:right="dimension"    android:bottom="dimension"    android:left="dimension" /></transition>

elements:

example:

XML file saved at res/drawable/transition.xml:

<?xml version="1.0" encoding="utf-8"?><transition xmlns:android="http://schemas.android.com/apk/res/android">  <item android:drawable="@drawable/on" />  <item android:drawable="@drawable/off" /></transition>

This layout XML applies the drawable to a View:

<ImageButton  android:id="@+id/button"  android:layout_height="wrap_content"  android:layout_width="wrap_content"  android:src="@drawable/transition" />

And the following code performs a 500ms transition from the first item to the second:

ImageButton button = (ImageButton) findViewById(R.id.button);TransitionDrawable drawable = (TransitionDrawable) button.getDrawable();drawable.startTransition(500);

see also:

TransitionDrawable

Inset Drawable

A drawable defined in XML that insets another drawable by a specified distance. This is usefulwhen a View needs a background that is smaller than the View's actual bounds.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a InsetDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><inset  xmlns:android="http://schemas.android.com/apk/res/android"  android:drawable="@drawable/drawable_resource"  android:insetTop="dimension"  android:insetRight="dimension"  android:insetBottom="dimension"  android:insetLeft="dimension" />

elements:

example:

<?xml version="1.0" encoding="utf-8"?><inset xmlns:android="http://schemas.android.com/apk/res/android"  android:drawable="@drawable/background"  android:insetTop="10dp"  android:insetLeft="10dp" />

see also:

InsetDrawable

Clip Drawable

A drawable defined in XML that clips another drawable based on this Drawable's current level. Youcan control how much the child drawable gets clipped in width and height based on the level, as wellas a gravity to control where it is placed in its overall container. Most often used to implementthings like progress bars.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a ClipDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><clip  xmlns:android="http://schemas.android.com/apk/res/android"  android:drawable="@drawable/drawable_resource"  android:clipOrientation=["horizontal" | "vertical"]  android:gravity=["top" | "bottom" | "left" | "right" | "center_vertical" |          "fill_vertical" | "center_horizontal" | "fill_horizontal" |          "center" | "fill" | "clip_vertical" | "clip_horizontal"] />

elements:

<clip>

Defines the clip drawable. This must be the root element.

attributes:

xmlns:android

String. Required. Defines the XML namespace, which must be "http://schemas.android.com/apk/res/android".

android:drawable

Drawable resource. Required. Reference to a drawableresource to be clipped.

android:clipOrientation

Keyword. The orientation for the clip.

Must be one of the following constant values:

Value	Description
`horizontal`	Clip the drawable horizontally.
`vertical`	Clip the drawable vertically.

android:gravity

Keyword. Specifies where to clip within the drawable.

Must be one or more (separated by '|') of the following constant values:

Value	Description
`top`	Put the object at the top of its container, not changing its size. When `clipOrientation` is `"vertical"`, clipping occurs at the bottom of the drawable.
`bottom`	Put the object at the bottom of its container, not changing its size. When `clipOrientation` is `"vertical"`, clipping occurs at the top of the drawable.
`left`	Put the object at the left edge of its container, not changing its size. This is thedefault. When `clipOrientation` is `"horizontal"`, clipping occurs at the right side ofthe drawable. This is the default.
`right`	Put the object at the right edge of its container, not changing its size. When `clipOrientation` is `"horizontal"`, clipping occurs at the left side ofthe drawable.
`center_vertical`	Place object in the vertical center of its container, not changing its size. Clipping behavesthe same as when gravity is `"center"`.
`fill_vertical`	Grow the vertical size of the object if needed so it completely fills its container. When `clipOrientation` is `"vertical"`, no clipping occurs because the drawable fills thevertical space (unless the drawable level is 0, in which case it's not visible).
`center_horizontal`	Place object in the horizontal center of its container, not changing its size.Clipping behaves the same as when gravity is `"center"`.
`fill_horizontal`	Grow the horizontal size of the object if needed so it completely fills its container. When`clipOrientation` is `"horizontal"`, no clipping occurs because the drawable fills thehorizontal space (unless the drawable level is 0, in which case it's not visible).
`center`	Place the object in the center of its container in both the vertical and horizontal axis, notchanging its size. When `clipOrientation` is `"horizontal"`, clipping occurs on the left and right. When `clipOrientation` is `"vertical"`, clipping occurs on the top and bottom.
`fill`	Grow the horizontal and vertical size of the object if needed so it completely fills itscontainer. No clipping occurs because the drawable fills thehorizontal and vertical space (unless the drawable level is 0, in which case it's notvisible).
`clip_vertical`	Additional option that can be set to have the top and/or bottom edges of the child clipped toits container's bounds. The clip is based on the vertical gravity: a top gravity clips thebottom edge, a bottom gravity clips the top edge, and neither clips both edges.
`clip_horizontal`	Additional option that can be set to have the left and/or right edges of the child clipped toits container's bounds. The clip is based on the horizontal gravity: a left gravity clipsthe right edge, a right gravity clips the left edge, and neither clips both edges.

example:

XML file saved at res/drawable/clip.xml:

<?xml version="1.0" encoding="utf-8"?><clip xmlns:android="http://schemas.android.com/apk/res/android"  android:drawable="@drawable/android"  android:clipOrientation="horizontal"  android:gravity="left" /></clip>

The following layout XML applies the clip drawable to a View:

<ImageView  android:id="@+id/image"  android:background="@drawable/clip"  android:layout_height="wrap_content"  android:layout_width="wrap_content" />

The following code gets the drawable and increases the amount of clipping in order toprogressively reveal the image:

ImageView imageview = (ImageView) findViewById(R.id.image);ClipDrawable drawable = (ClipDrawable) imageview.getDrawable();drawable.setLevel(drawable.getLevel() + 1000);

Increasing the level reduces the amount of clipping and slowly reveals the image. Here it isat a level of 7000:

Note: The default level is 0, which is fully clipped so the imageis not visible. When the level is 10,000, the image is not clipped and completely visible.

see also:

ClipDrawable

Scale Drawable

A drawable defined in XML that changes the size of another drawable based on its currentlevel.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a ScaleDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><scale  xmlns:android="http://schemas.android.com/apk/res/android"  android:drawable="@drawable/drawable_resource"  android:scaleGravity=["top" | "bottom" | "left" | "right" | "center_vertical" |             "fill_vertical" | "center_horizontal" | "fill_horizontal" |             "center" | "fill" | "clip_vertical" | "clip_horizontal"]  android:scaleHeight="percentage"  android:scaleWidth="percentage" />

elements:

<scale>

Defines the scale drawable. This must be the root element.

attributes:

xmlns:android

String. Required. Defines the XML namespace, which must be "http://schemas.android.com/apk/res/android".

android:drawable

Drawable resource. Required. Reference to a drawableresource.

android:scaleGravity

Keyword. Specifies the gravity position after scaling.

Must be one or more (separated by '|') of the following constant values:

Value	Description
`top`	Put the object at the top of its container, not changing its size.
`bottom`	Put the object at the bottom of its container, not changing its size.
`left`	Put the object at the left edge of its container, not changing its size. This is thedefault.
`right`	Put the object at the right edge of its container, not changing its size.
`center_vertical`	Place object in the vertical center of its container, not changing its size.
`fill_vertical`	Grow the vertical size of the object if needed so it completely fills its container.
`center_horizontal`	Place object in the horizontal center of its container, not changing its size.
`fill_horizontal`	Grow the horizontal size of the object if needed so it completely fills its container.
`center`	Place the object in the center of its container in both the vertical and horizontal axis, notchanging its size.
`fill`	Grow the horizontal and vertical size of the object if needed so it completely fills itscontainer.
`clip_vertical`	Additional option that can be set to have the top and/or bottom edges of the child clipped toits container's bounds. The clip is based on the vertical gravity: a top gravity clips thebottom edge, a bottom gravity clips the top edge, and neither clips both edges.
`clip_horizontal`	Additional option that can be set to have the left and/or right edges of the child clipped toits container's bounds. The clip is based on the horizontal gravity: a left gravity clipsthe right edge, a right gravity clips the left edge, and neither clips both edges.

android:scaleHeight

Percentage. The scale height, expressed as a percentage of the drawable'sbound. The value's format is XX%. For instance: 100%, 12.5%, etc.

android:scaleWidth

Percentage. The scale width, expressed as a percentage of the drawable'sbound. The value's format is XX%. For instance: 100%, 12.5%, etc.

example:

<?xml version="1.0" encoding="utf-8"?><scale xmlns:android="http://schemas.android.com/apk/res/android"  android:drawable="@drawable/logo"  android:scaleGravity="center_vertical|center_horizontal"  android:scaleHeight="80%"  android:scaleWidth="80%" />

see also:

ScaleDrawable

Shape Drawable

This is a generic shape defined in XML.

file location:

res/drawable/filename.xml
The filename is used as the resource ID.

compiled resource datatype:

Resource pointer to a GradientDrawable.

resource reference:

In Java: R.drawable.filename
In XML: @[package:]drawable/filename

syntax:

<?xml version="1.0" encoding="utf-8"?><shape  xmlns:android="http://schemas.android.com/apk/res/android"  android:shape=["rectangle" | "oval" | "line" | "ring"] >  <corners    android:radius="integer"    android:topLeftRadius="integer"    android:topRightRadius="integer"    android:bottomLeftRadius="integer"    android:bottomRightRadius="integer" />  <gradient    android:angle="integer"    android:centerX="integer"    android:centerY="integer"    android:centerColor="integer"    android:endColor="color"    android:gradientRadius="integer"    android:startColor="color"    android:type=["linear" | "radial" | "sweep"]    android:usesLevel=["true" | "false"] />  <padding    android:left="integer"    android:top="integer"    android:right="integer"    android:bottom="integer" />  <size    android:width="integer"    android:height="integer" />  <solid    android:color="color" />  <stroke    android:width="integer"    android:color="color"    android:dashWidth="integer"    android:dashGap="integer" /></shape>

elements:

<shape>

The shape drawable. This must be the root element.

attributes:

xmlns:android

String. Required. Defines the XML namespace, which must be "http://schemas.android.com/apk/res/android".

android:shape

Keyword. Defines the type of shape. Valid values are:

Value	Desciption
`"rectangle"`	A rectangle that fills the containing View. This is the default shape.
`"oval"`	An oval shape that fits the dimensions of the containing View.
`"line"`	A horizontal line that spans the width of the containing View. This shape requires the `<stroke>` element to define the width of the line.
`"ring"`	A ring shape.

The following attributes are used only when android:shape="ring":

android:innerRadius: Dimension. The radius for theinner part of the ring (the hole in the middle), as a dimension value or dimension resource.
android:innerRadiusRatio: Float. The radius for the innerpart of the ring, expressed as a ratio of the ring's width. For instance, if android:innerRadiusRatio="5", then the inner radius equals the ring's width divided by 5. Thisvalue is overridden by android:innerRadius. Default value is 9.
android:thickness: Dimension. The thickness of thering, as a dimension value or dimension resource.
android:thicknessRatio: Float. The thickness of the ring,expressed as a ratio of the ring's width. For instance, if android:thicknessRatio="2", thenthe thickness equals the ring's width divided by 2. This value is overridden by android:innerRadius. Default value is 3.
android:useLevel: Boolean. "true" if this is used asa LevelListDrawable. This should normally be "false" or your shape may not appear.

<corners>

Creates rounded corners for the shape. Applies only when the shape is a rectangle.

attributes:

android:radius: Dimension. The radius for all corners, as a dimension value or dimension resource. This is overridden for eachcorner by the following attributes.
android:topLeftRadius: Dimension. The radius for the top-left corner, as a dimension value or dimension resource.
android:topRightRadius: Dimension. The radius for the top-right corner, as a dimension value or dimension resource.
android:bottomLeftRadius: Dimension. The radius for the bottom-left corner, as a dimension value or dimension resource.
android:bottomRightRadius: Dimension. The radius for the bottom-right corner, as a dimension value or dimension resource.

Note: Every corner must (initially) be provided a cornerradius greater than 1, or else no corners are rounded. If you want specific cornersto not be rounded, a work-around is to use android:radius to set a default cornerradius greater than 1, but then override each and every corner with the values you reallywant, providing zero ("0dp") where you don't want rounded corners.

<gradient>

Specifies a gradient color for the shape.

attributes:

android:angle

Integer. The angle for the gradient, in degrees. 0 is left to right, 90 isbottom to top. It must be a multiple of 45. Default is 0.

android:centerX

Float. The relative X-position for the center of the gradient (0 - 1.0).Does not apply when android:type="linear".

android:centerY

Float. The relative Y-position for the center of the gradient (0 - 1.0).Does not apply when android:type="linear".

android:centerColor

Color. Optional color that comes between the start and end colors, as ahexadecimal value or color resource.

android:endColor

Color. The ending color, as a hexadecimalvalue or color resource.

android:gradientRadius

Float. The radius for the gradient. Only applied when android:type="radial".

android:startColor

Color. The starting color, as a hexadecimalvalue or color resource.

android:type

Keyword. The type of gradient pattern to apply. Valid values are:

Value	Description
`"linear"`	A linear gradient. This is the default.
`"radial"`	A radial gradient. The start color is the center color.
`"sweep"`	A sweeping line gradient.

android:useLevel

Boolean. "true" if this is used as a LevelListDrawable.

<padding>

Padding to apply to the containing View element (this pads the position of the Viewcontent, not the shape).

attributes:

android:left: Dimension. Left padding, as a dimension value or dimension resource.
android:top: Dimension. Top padding, as a dimension value or dimension resource.
android:right: Dimension. Right padding, as a dimension value or dimension resource.
android:bottom: Dimension. Bottom padding, as a dimension value or dimension resource.

<size>

The size of the shape.

attributes:

android:height: Dimension. The height of the shape, as a dimension value or dimension resource.
android:width: Dimension. The width of the shape, as a dimension value or dimension resource.

Note: The shape scales to the size of the containerView proportionate to the dimensions defined here, by default. When you use the shape in an ImageView, you can restrict scaling by setting the android:scaleType to "center".

<solid>

A solid color to fill the shape.

attributes:

android:color: Color. The color to apply to the shape, as a hexadecimalvalue or color resource.

<stroke>

A stroke line for the shape.

attributes:

android:width: Dimension. The thickness of the line, as a dimension value or dimension resource.
android:color: Color. The color of the line, as ahexadecimal value or color resource.
android:dashGap: Dimension. The distance between line dashes, as a dimension value or dimension resource. Only valid if android:dashWidth is set.
android:dashWidth: Dimension. The size of each dash line, as a dimension value or dimension resource. Only valid if android:dashGap is set.

example:

XML file saved at res/drawable/gradient_box.xml:

<?xml version="1.0" encoding="utf-8"?><shape xmlns:android="http://schemas.android.com/apk/res/android"  android:shape="rectangle">  <gradient    android:startColor="#FFFF0000"    android:endColor="#80FF00FF"    android:angle="45"/>  <padding android:left="7dp"    android:top="7dp"    android:right="7dp"    android:bottom="7dp" />  <corners android:radius="8dp" /></shape>

This layout XML applies the shape drawable to a View:

<TextView  android:background="@drawable/gradient_box"  android:layout_height="wrap_content"  android:layout_width="wrap_content" />

This application code gets the shape drawable and applies it to a View:

Resources res = getResources();Drawable shape = res. getDrawable(R.drawable.gradient_box);TextView tv = (TextView)findViewByID(R.id.textview);tv.setBackground(shape);

see also:

ShapeDrawable

Android(安卓)绘制资源

Drawable Resources

See also

Bitmap

Bitmap File

XML Bitmap

Nine-Patch

Nine-Patch File

XML Nine-Patch

Layer List

State List

Level List

Transition Drawable

Inset Drawable

Clip Drawable

Scale Drawable

Shape Drawable

更多相关文章

随机推荐