Android APIs
public class

ShapeDrawable

extends Drawable
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.ShapeDrawable
Known Direct Subclasses

Class Overview

A Drawable object that draws primitive shapes. A ShapeDrawable takes a Shape object and manages its presence on the screen. If no Shape is given, then the ShapeDrawable will default to a RectShape.

This object can be defined in an XML file with the <shape> element.

Developer Guides

For more information about how to use ShapeDrawable, read the Canvas and Drawables document. For more information about defining a ShapeDrawable in XML, read the Drawable Resources document.

Summary

Nested Classes
class ShapeDrawable.ShaderFactory Base class defines a factory object that is called each time the drawable is resized (has a new width or height). 
XML Attributes
Attribute Name Related Method Description
android:bottom Bottom padding. 
android:color Defines the color of the shape. 
android:height Defines the height of the shape. 
android:left Left padding. 
android:right Right padding. 
android:top Top padding. 
android:width Defines the width of the shape. 
Public Constructors
ShapeDrawable()
ShapeDrawable constructor.
ShapeDrawable(Shape s)
Creates a ShapeDrawable with a specified Shape.
Public Methods
void applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children.
void draw(Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
int getAlpha()
Gets the current alpha value for the drawable.
int getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
Drawable.ConstantState getConstantState()
Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
int getIntrinsicHeight()
Return the intrinsic height of the underlying drawable object.
int getIntrinsicWidth()
Return the intrinsic width of the underlying drawable object.
int getOpacity()
Return the opacity/transparency of this Drawable.
void getOutline(Outline outline)
Called to get the drawable to populate the Outline that defines its drawing area.
boolean getPadding(Rect padding)
Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
Paint getPaint()
Returns the Paint used to draw the shape.
ShapeDrawable.ShaderFactory getShaderFactory()
Returns the ShaderFactory used by this ShapeDrawable for requesting a Shader.
Shape getShape()
Returns the Shape of this ShapeDrawable.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
boolean isStateful()
Indicates whether this drawable will change its appearance based on state.
Drawable mutate()
Make this drawable mutable.
void setAlpha(int alpha)
Set the alpha level for this drawable [0..255].
void setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable.
void setDither(boolean dither)
This method is deprecated. This property is ignored.
void setIntrinsicHeight(int height)
Sets the intrinsic (default) height for this shape.
void setIntrinsicWidth(int width)
Sets the intrinsic (default) width for this shape.
void setPadding(Rect padding)
Sets padding for this shape, defined by a Rect object.
void setPadding(int left, int top, int right, int bottom)
Sets padding for the shape.
void setShaderFactory(ShapeDrawable.ShaderFactory fact)
Sets a ShaderFactory to which requests for a Shader object will be made.
void setShape(Shape s)
Sets the Shape of this ShapeDrawable.
void setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list.
void setTintMode(PorterDuff.Mode tintMode)
Specifies a tint blending mode for this drawable.
Protected Methods
boolean inflateTag(String name, Resources r, XmlPullParser parser, AttributeSet attrs)
Subclasses override this to parse custom subelements.
void onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you vary based on the bounds.
void onDraw(Shape shape, Canvas canvas, Paint paint)
Called from the drawable's draw() method after the canvas has been set to draw the shape at (0,0).
boolean onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
[Expand]
Inherited Methods
From class android.graphics.drawable.Drawable
From class java.lang.Object

XML Attributes

android:bottom

Bottom padding.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol bottom.

Related Methods

android:color

Defines the color of the shape.

Must be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol color.

Related Methods

android:height

Defines the height of the shape.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol height.

Related Methods

android:left

Left padding.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol left.

Related Methods

android:right

Right padding.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol right.

Related Methods

android:top

Top padding.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol top.

Related Methods

android:width

Defines the width of the shape.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol width.

Related Methods

Public Constructors

public ShapeDrawable ()

Added in API level 1

ShapeDrawable constructor.

public ShapeDrawable (Shape s)

Added in API level 1

Creates a ShapeDrawable with a specified Shape.

Parameters
s Shape: the Shape that this ShapeDrawable should be

Public Methods

public void applyTheme (Resources.Theme t)

Added in API level 21

Applies the specified theme to this Drawable and its children.

Parameters
t Resources.Theme

public void draw (Canvas canvas)

Added in API level 1

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Parameters
canvas Canvas: The canvas to draw into

public int getAlpha ()

Added in API level 19

Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

Returns
int

public int getChangingConfigurations ()

Added in API level 1

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. The default implementation returns whatever was provided through setChangingConfigurations(int) or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.

Returns
int Returns a mask of the changing configuration parameters, as defined by ActivityInfo.

public Drawable.ConstantState getConstantState ()

Added in API level 1

Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

Returns
Drawable.ConstantState The ConstantState associated to that Drawable.

public int getIntrinsicHeight ()

Added in API level 1

Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

Returns
int

public int getIntrinsicWidth ()

Added in API level 1

Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

Returns
int

public int getOpacity ()

Added in API level 1

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: UNKNOWN, TRANSLUCENT, TRANSPARENT, or OPAQUE.

An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT.

Generally a Drawable should be as conservative as possible with the value it returns. For example, if it contains multiple child drawables and only shows one of them at a time, if only one of the children is TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be returned. You can use the method resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output.

Note that the returned value does not necessarily take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods. Some subclasses, such as BitmapDrawable, ColorDrawable, and GradientDrawable, do account for the value of setAlpha(int), but the general behavior is dependent upon the implementation of the subclass.

Returns
int int The opacity class of the Drawable.

public void getOutline (Outline outline)

Added in API level 21

Called to get the drawable to populate the Outline that defines its drawing area.

This method is called by the default ViewOutlineProvider to define the outline of the View.

The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.

Parameters
outline Outline

public boolean getPadding (Rect padding)

Added in API level 1

Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).

Parameters
padding Rect
Returns
boolean true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

public Paint getPaint ()

Added in API level 1

Returns the Paint used to draw the shape.

Returns
Paint

public ShapeDrawable.ShaderFactory getShaderFactory ()

Added in API level 1

Returns the ShaderFactory used by this ShapeDrawable for requesting a Shader.

Returns
ShapeDrawable.ShaderFactory

public Shape getShape ()

Added in API level 1

Returns the Shape of this ShapeDrawable.

Returns
Shape

public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Added in API level 21

Inflate this Drawable from an XML resource optionally styled by a theme.

Parameters
r Resources: Resources used to resolve attribute values
parser XmlPullParser: XML parser from which to inflate this Drawable
attrs AttributeSet: Base set of attribute values
theme Resources.Theme: Theme to apply, may be null
Throws
XmlPullParserException
IOException

public boolean isStateful ()

Added in API level 1

Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.

Returns
boolean True if this drawable changes its appearance based on state, false otherwise.

public Drawable mutate ()

Added in API level 3

Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.

Returns
Drawable This drawable.

public void setAlpha (int alpha)

Added in API level 1

Set the alpha level for this drawable [0..255]. Note that this drawable also has a color in its paint, which has an alpha as well. These two values are automatically combined during drawing. Thus if the color's alpha is 75% (i.e. 192) and the drawable's alpha is 50% (i.e. 128), then the combined alpha that will be used during drawing will be 37.5% (i.e. 96).

Parameters
alpha int

public void setColorFilter (ColorFilter colorFilter)

Added in API level 1

Specify an optional color filter for the drawable.

If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.

Pass null to remove any existing color filter.

Note: Setting a non-null color filter disables tint.

Parameters
colorFilter ColorFilter: The color filter to apply, or null to remove the existing color filter

public void setDither (boolean dither)

Added in API level 1

This method is deprecated.
This property is ignored.

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.

Parameters
dither boolean

public void setIntrinsicHeight (int height)

Added in API level 1

Sets the intrinsic (default) height for this shape.

Parameters
height int: the intrinsic height (in pixels)

public void setIntrinsicWidth (int width)

Added in API level 1

Sets the intrinsic (default) width for this shape.

Parameters
width int: the intrinsic width (in pixels)

public void setPadding (Rect padding)

Added in API level 1

Sets padding for this shape, defined by a Rect object. Define the padding in the Rect object as: left, top, right, bottom.

Parameters
padding Rect

public void setPadding (int left, int top, int right, int bottom)

Added in API level 1

Sets padding for the shape.

Parameters
left int: padding for the left side (in pixels)
top int: padding for the top (in pixels)
right int: padding for the right side (in pixels)
bottom int: padding for the bottom (in pixels)

public void setShaderFactory (ShapeDrawable.ShaderFactory fact)

Added in API level 1

Sets a ShaderFactory to which requests for a Shader object will be made.

Parameters
fact ShapeDrawable.ShaderFactory: an instance of your ShaderFactory implementation

public void setShape (Shape s)

Added in API level 1

Sets the Shape of this ShapeDrawable.

Parameters
s Shape

public void setTintList (ColorStateList tint)

Added in API level 21

Specifies tint color for this drawable as a color state list.

A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to setColorFilter(int, PorterDuff.Mode).

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tint ColorStateList: Color state list to use for tinting this drawable, or null to clear the tint

public void setTintMode (PorterDuff.Mode tintMode)

Added in API level 21

Specifies a tint blending mode for this drawable.

Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is SRC_IN.

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tintMode PorterDuff.Mode: A Porter-Duff blending mode

Protected Methods

protected boolean inflateTag (String name, Resources r, XmlPullParser parser, AttributeSet attrs)

Added in API level 1

Subclasses override this to parse custom subelements. If you handle it, return true, else return super.inflateTag(...).

Parameters
name String
r Resources
parser XmlPullParser
attrs AttributeSet
Returns
boolean

protected void onBoundsChange (Rect bounds)

Added in API level 1

Override this in your subclass to change appearance if you vary based on the bounds.

Parameters
bounds Rect

protected void onDraw (Shape shape, Canvas canvas, Paint paint)

Added in API level 1

Called from the drawable's draw() method after the canvas has been set to draw the shape at (0,0). Subclasses can override for special effects such as multiple layers, stroking, etc.

Parameters
shape Shape
canvas Canvas
paint Paint

protected boolean onStateChange (int[] stateSet)

Added in API level 1

Override this in your subclass to change appearance if you recognize the specified state.

Parameters
stateSet int
Returns
boolean Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state.