ShapeDrawable

Kotlin |Java

open class ShapeDrawable : Drawable

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.ShapeDrawable

Known Direct Subclasses

PaintDrawable

Drawable that draws its bounds in the given paint, with optional rounded corners.

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

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

Summary

Nested classes
abstract	`ShaderFactory` Base class defines a factory object that is called each time the drawable is resized (has a new width or height).

XML attributes
`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(s: Shape!)` Creates a ShapeDrawable with a specified Shape.

Public methods
open Unit	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
open Unit	`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).
open Int	`getAlpha()` Gets the current alpha value for the drawable.
open Int	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open Drawable.ConstantState?	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
open Int	`getIntrinsicHeight()` Returns the drawable's intrinsic height.
open Int	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
open Int	`getOpacity()` Return the opacity/transparency of this Drawable.
open Unit	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area.
open Boolean	`getPadding(padding: Rect)` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
open Paint!	`getPaint()` Returns the Paint used to draw the shape.
open ShapeDrawable.ShaderFactory!	`getShaderFactory()` Returns the ShaderFactory used by this ShapeDrawable for requesting a `android.graphics.Shader`.
open Shape!	`getShape()` Returns the Shape of this ShapeDrawable.
open Boolean	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.R.attr#state_focused`.
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme.
open Boolean	`isStateful()` Indicates whether this drawable will change its appearance based on state.
open Drawable	`mutate()` Make this drawable mutable.
open Unit	`setAlpha(alpha: Int)` Set the alpha level for this drawable [0.
open Unit	`setColorFilter(colorFilter: ColorFilter?)` Specify an optional color filter for the drawable.
open Unit	`setDither(dither: Boolean)` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
open Unit	`setIntrinsicHeight(height: Int)` Sets the intrinsic (default) height for this shape.
open Unit	`setIntrinsicWidth(width: Int)` Sets the intrinsic (default) width for this shape.
open Unit	`setPadding(padding: Rect!)` Sets padding for this shape, defined by a Rect object.
open Unit	`setPadding(left: Int, top: Int, right: Int, bottom: Int)` Sets padding for the shape.
open Unit	`setShaderFactory(fact: ShapeDrawable.ShaderFactory!)` Sets a ShaderFactory to which requests for a `android.graphics.Shader` object will be made.
open Unit	`setShape(s: Shape!)` Sets the Shape of this ShapeDrawable.
open Unit	`setTintBlendMode(blendMode: BlendMode!)` Specifies a tint blending mode for this drawable.
open Unit	`setTintList(tint: ColorStateList?)` Specifies tint color for this drawable as a color state list.

Protected methods
open Boolean	`inflateTag(name: String!, r: Resources!, parser: XmlPullParser!, attrs: AttributeSet!)` Subclasses override this to parse custom subelements.
open Unit	`onBoundsChange(bounds: Rect)` Override this in your subclass to change appearance if you vary based on the bounds.
open Unit	`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).
open Boolean	`onStateChange(stateSet: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.

Inherited functions

From class Drawable

`Boolean`	`canApplyTheme()`
`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
`Unit`	`copyBounds(bounds: Rect)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
`Drawable?`	`createFromPath(pathName: String!)` Create a drawable from file path name.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromStream(is: InputStream?, srcName: String?)` Create a drawable from an inputstream
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser)` Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)` Create a drawable from an XML document using an optional `Theme`. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Create a drawable from inside an XML document using an optional `Theme`. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns `null` if the tag is not a valid drawable.
`Rect`	`getBounds()` Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
`Drawable.Callback?`	`getCallback()` Return the current `Callback` implementation attached to this Drawable.
`ColorFilter?`	`getColorFilter()` Returns the current color filter, or `null` if none set.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
`Unit`	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`Int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`IntArray`	`getState()` Describes the current state, as a union of primitive states, such as `android.R.attr#state_focused`, `android.R.attr#state_selected`, etc. Some drawables may modify their imagery based on the selected state.
`Region?`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Inflate this Drawable from an XML resource. Does not apply a theme.
`Unit`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See `android.util.LayoutDirection`.
`Boolean`	`isFilterBitmap()`
`Boolean`	`isProjected()` Whether this drawable requests projection. Indicates that the `android.graphics.RenderNode` this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.
`Boolean`	`isVisible()`
`Unit`	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onLevelChange(level: Int)` Override this in your subclass to change appearance if you vary based on level.
`Int`	`resolveOpacity(op1: Int, op2: Int)` Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing `getOpacity`.
`Unit`	`scheduleSelf(what: Runnable, when: Long)` Use the current `Callback` implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
`Unit`	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See `android.util.LayoutDirection`.
`Unit`	`setBounds(bounds: Rect)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setCallback(cb: Drawable.Callback?)` Bind a `Callback` object to this Drawable. Required for clients that want to support animated drawables.
`Unit`	`setChangingConfigurations(configs: Int)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`Unit`	`setColorFilter(color: Int, mode: PorterDuff.Mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for `setColorFilter(android.graphics.ColorFilter)` which constructs a `PorterDuffColorFilter`. Note: Setting a color filter disables `tint`.
`Unit`	`setFilterBitmap(filter: Boolean)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored.
`Unit`	`setHotspot(x: Float, y: Float)` Specifies the hotspot's location within the drawable.
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
`Boolean`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
`Boolean`	`setLevel(level: Int)` Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function.
`Boolean`	`setState(stateSet: IntArray)` Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [`android.R.attr#state_focused`, `android.R.attr#state_pressed`]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
`Unit`	`setTint(tintColor: Int)` Specifies tint color for this drawable. 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,android.graphics.PorterDuff.Mode)`. To clear the tint, pass `null` to `setTintList(android.content.res.ColorStateList)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintMode(tintMode: PorterDuff.Mode?)` 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 `PorterDuff.Mode.SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)` Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
`Unit`	`unscheduleSelf(what: Runnable)` Use the current `Callback` implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:bottom

android:bottom

Bottom padding.

May 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), and mm (millimeters).

android:color

android:color

Defines the color of the shape.

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

android:height

android:height

Defines the height of the shape.

android:left

android:left

Left padding.

android:right

android:right

Right padding.

android:top

android:top

Top padding.

android:width

android:width

Defines the width of the shape.

Parameters
`r`	Resources: Resources used to resolve attribute values. This value cannot be `null`.
`parser`	XmlPullParser: XML parser from which to inflate this Drawable. This value cannot be `null`.
`attrs`	AttributeSet: Base set of attribute values. This value cannot be `null`.
`theme`	Resources.Theme?: Theme to apply, may be null

Exceptions
`java.io.IOException`
`org.xmlpull.v1.XmlPullParserException`

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)

ShapeDrawable

Summary

XML attributes

android:bottom

android:color

android:height

android:left

android:right

android:top

android:width

Public constructors

ShapeDrawable

ShapeDrawable

Public methods

applyTheme

draw

getAlpha

getChangingConfigurations

getConstantState

getIntrinsicHeight

getIntrinsicWidth

getOpacity

getOutline

getPadding

getPaint

getShaderFactory

getShape

hasFocusStateSpecified

inflate

isStateful

mutate

setAlpha

setColorFilter

setDither

setIntrinsicHeight

setIntrinsicWidth

setPadding

setPadding

setShaderFactory

setShape

setTintBlendMode

setTintList

Protected methods

inflateTag

onBoundsChange

onDraw

onStateChange