android.graphics.drawable
Class ShapeDrawable

java.lang.Object
  android.graphics.drawable.Drawable
      android.graphics.drawable.ShapeDrawable

Direct Known Subclasses:

PaintDrawable

public class ShapeDrawable
extends Drawable

An 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.

Nested Class Summary

static class	ShapeDrawable.ShaderFactory Base class defines a factory object that is called each time the drawable is resized (has a new width or height).
(package private) static class	ShapeDrawable.ShapeState Defines the intrinsic properties of this ShapeDrawable's Shape.

Nested classes/interfaces inherited from class android.graphics.drawable.Drawable

Drawable.Callback, Drawable.ConstantState

Field Summary

Fields inherited from class android.graphics.drawable.Drawable

mCallback

Constructor Summary

ShapeDrawable()
ShapeDrawable constructor.

ShapeDrawable(Shape s)
Creates a ShapeDrawable with a specified Shape.

Method Summary

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	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable mau change, requiring that it be re-created.
Drawable.ConstantState	getConstantState()
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.
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)
protected boolean	inflateTag(String name, Resources r, XmlPullParser parser, AttributeSet attrs) Subclasses override this to parse custom subelements.
protected void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you recognize the specified state.
protected 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).
void	setAlpha(int alpha) Set the alpha level for this drawable [0..255].
void	setColorFilter(ColorFilter cf) Specify an optional colorFilter for the drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
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(int left, int top, int right, int bottom) Sets padding for the shape.
void	setPadding(Rect padding) Sets padding for this shape, defined by a Rect object.
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.

Methods inherited from class android.graphics.drawable.Drawable

clearColorFilter, copyBounds, copyBounds, createFromPath, createFromStream, createFromXml, createFromXmlInner, getBounds, getCurrent, getLevel, getMinimumHeight, getMinimumWidth, getState, getTransparentRegion, inflateWithAttributes, invalidateSelf, isStateful, isVisible, onLevelChange, onStateChange, resolveOpacity, scheduleSelf, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setFilterBitmap, setLevel, setState, setVisible, unscheduleSelf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShapeDrawable

public ShapeDrawable()

ShapeDrawable constructor.

ShapeDrawable

public ShapeDrawable(Shape s)

Creates a ShapeDrawable with a specified Shape.

Parameters:

s - the Shape that this ShapeDrawable should be

Method Detail

getShape

public Shape getShape()

Returns the Shape of this ShapeDrawable.

setShape

public void setShape(Shape s)

Sets the Shape of this ShapeDrawable.

setShaderFactory

public void setShaderFactory(ShapeDrawable.ShaderFactory fact)

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

Parameters:

fact - an instance of your ShaderFactory implementation

getShaderFactory

public ShapeDrawable.ShaderFactory getShaderFactory()

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

getPaint

public Paint getPaint()

Returns the Paint used to draw the shape.

setPadding

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

Sets padding for the shape.

Parameters:

left - padding for the left side (in pixels)

top - padding for the top (in pixels)

right - padding for the right side (in pixels)

bottom - padding for the bottom (in pixels)

setPadding

public void setPadding(Rect padding)

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

setIntrinsicWidth

public void setIntrinsicWidth(int width)

Sets the intrinsic (default) width for this shape.

Parameters:

width - the intrinsic width (in pixels)

setIntrinsicHeight

public void setIntrinsicHeight(int height)

Sets the intrinsic (default) height for this shape.

Parameters:

height - the intrinsic height (in pixels)

getIntrinsicWidth

public int getIntrinsicWidth()

Description copied from class: Drawable

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

Overrides:

getIntrinsicWidth in class Drawable

getIntrinsicHeight

public int getIntrinsicHeight()

Description copied from class: Drawable

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

Overrides:

getIntrinsicHeight in class Drawable

getPadding

public boolean getPadding(Rect padding)

Description copied from class: Drawable

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). Returns true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

Overrides:

getPadding in class Drawable

onDraw

protected 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). Subclasses can override for special effects such as multiple layers, stroking, etc.

draw

public void draw(Canvas canvas)

Description copied from class: Drawable

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

Specified by:

draw in class Drawable

Parameters:

canvas - The canvas to draw into

getChangingConfigurations

public int getChangingConfigurations()

Description copied from class: Drawable

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

Overrides:

getChangingConfigurations in class Drawable

Returns:

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

See Also:

Configuration

setAlpha

public void setAlpha(int alpha)

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).

Specified by:

setAlpha in class Drawable

setColorFilter

public void setColorFilter(ColorFilter cf)

Description copied from class: Drawable

Specify an optional colorFilter for the drawable. Pass null to remove any filters.

Specified by:

setColorFilter in class Drawable

getOpacity

public int getOpacity()

Description copied from class: Drawable

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

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 Drawable.resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output.

Note that the returned value does not take into account a custom alpha or color filter that has been applied by the client through the Drawable.setAlpha(int) or Drawable.setColorFilter(android.graphics.ColorFilter) methods.

Specified by:

getOpacity in class Drawable

Returns:

int The opacity class of the Drawable.

See Also:

PixelFormat

setDither

public void setDither(boolean dither)

Description copied from class: Drawable

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. This can improve the look on those devices, but can also slow down the drawing a little.

Overrides:

setDither in class Drawable

onBoundsChange

protected void onBoundsChange(Rect bounds)

Description copied from class: Drawable

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

Overrides:

onBoundsChange in class Drawable

inflateTag

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

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

inflate

public void inflate(Resources r,
                    XmlPullParser parser,
                    AttributeSet attrs)
             throws XmlPullParserException,
                    IOException

Overrides:

inflate in class Drawable

Throws:

XmlPullParserException

IOException

getConstantState

public Drawable.ConstantState getConstantState()

Overrides:

getConstantState in class Drawable