ShapeDrawable

ShapeDrawable

ShapeDrawable ()

ShapeDrawable constructor.

ShapeDrawable

ShapeDrawable (Shape s)

Creates a ShapeDrawable with a specified Shape.

applyTheme

void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

draw

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

getAlpha

int getAlpha ()

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.

getChangingConfigurations

int getChangingConfigurations ()

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.

getConstantState

Drawable.ConstantState getConstantState ()

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

getIntrinsicHeight

int getIntrinsicHeight ()

Returns the drawable's intrinsic height.

Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.

getIntrinsicWidth

int getIntrinsicWidth ()

Returns the drawable's intrinsic width.

Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.

getOpacity

int getOpacity ()

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.

getOutline

void getOutline (Outline outline)

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.

getPadding

boolean getPadding (Rect padding)

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

getPaint

Paint getPaint ()

Returns the Paint used to draw the shape.

getShaderFactory

ShapeDrawable.ShaderFactory getShaderFactory ()

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

getShape

Shape getShape ()

Returns the Shape of this ShapeDrawable.

inflate

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

Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.

isStateful

boolean isStateful ()

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.

mutate

Drawable mutate ()

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.

setAlpha

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

setColorFilter

void setColorFilter (ColorFilter colorFilter)

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.

setDither

void setDither (boolean dither)

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.

setIntrinsicHeight

void setIntrinsicHeight (int height)

Sets the intrinsic (default) height for this shape.

setIntrinsicWidth

void setIntrinsicWidth (int width)

Sets the intrinsic (default) width for this shape.

setPadding

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.

setPadding

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

Sets padding for the shape.

setShaderFactory

void setShaderFactory (ShapeDrawable.ShaderFactory fact)

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

setShape

void setShape (Shape s)

Sets the Shape of this ShapeDrawable.

setTintList

void setTintList (ColorStateList tint)

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.

setTintMode

void setTintMode (PorterDuff.Mode tintMode)

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.

inflateTag

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

onBoundsChange

void onBoundsChange (Rect bounds)

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

onDraw

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.

onStateChange

boolean onStateChange (int[] stateSet)

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