Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [XML Attrs](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#lattrs) \| [Inherited XML Attrs](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#inhattrs) \| [Constants](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#constants) \| [Inherited Constants](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#inhconstants) \| [Ctors](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#inhmethods)
# RippleDrawable
*** ** * ** ***
`
public
class
RippleDrawable
`
`
`
`
`
`
extends https://developer.android.com/reference/android/graphics/drawable/LayerDrawable
`
`
`
|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||||
| ↳ | [android.graphics.drawable.Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) |||
| | ↳ | [android.graphics.drawable.LayerDrawable](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable) ||
| | | ↳ | android.graphics.drawable.RippleDrawable |
*** ** * ** ***
Drawable that shows a ripple effect in response to state changes. The
anchoring position of the ripple for a given state may be specified by
calling `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setHotspot(float,%20float)` with the corresponding state
attribute identifier.
A touch feedback drawable may contain multiple child layers, including a
special mask layer that is not drawn to the screen. A single layer may be
set as the mask from XML by specifying its `android:id` value as
`https://developer.android.com/reference/android/R.id#mask`. At run time, a single layer may be set as the
mask using `setId(..., android.R.id.mask)` or an existing mask layer
may be replaced using `setDrawableByLayerId(android.R.id.mask, ...)`.
## Summary
| ### XML attributes ||
|---|---|
| [`android:color`](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:color) | The color to use for ripple effects. |
| [`android:effectColor`](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:effectColor) | Secondary color of the ripple effect. |
| [`android:radius`](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:radius) | The radius of the ripple when fully expanded. |
### Inherited XML attributes
From class `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable` [`android:bottom`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:bottom) Bottom inset to apply to the layer. [`android:drawable`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:drawable) Drawable used to render the layer. [`android:end`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:end) End inset to apply to the layer. [`android:gravity`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:gravity) Gravity used to align the layer within its container. [`android:height`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:height) Height of the layer. [`android:id`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:id) Identifier of the layer. [`android:left`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:left) Left inset to apply to the layer. [`android:paddingBottom`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingBottom) Explicit bottom padding. [`android:paddingEnd`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingEnd) Explicit end padding. [`android:paddingLeft`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingLeft) Explicit left padding. [`android:paddingMode`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingMode) Indicates how layer padding should affect the bounds of subsequent layers. [`android:paddingRight`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingRight) Explicit right padding. [`android:paddingStart`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingStart) Explicit start padding. [`android:paddingTop`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:paddingTop) Explicit top padding. [`android:right`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:right) Right inset to apply to the layer. [`android:start`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:start) Start inset to apply to the layer. [`android:top`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:top) Top inset to apply to the layer. [`android:width`](https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#attr_android:width) Width of the layer.
| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#RADIUS_AUTO` Radius value that specifies the ripple radius should be computed based on the size of the ripple's container. |
### Inherited constants
From class `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable` `int` `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#INSET_UNDEFINED`
Value used for undefined start and end insets.
`int` `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#PADDING_MODE_NEST`
Padding mode used to nest each layer inside the padding of the previous
layer.
`int` `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#PADDING_MODE_STACK`
Padding mode used to stack each layer directly atop the previous layer.
| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#RippleDrawable(android.content.res.ColorStateList,%20android.graphics.drawable.Drawable,%20android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/content/res/ColorStateList color, https://developer.android.com/reference/android/graphics/drawable/Drawable content, https://developer.android.com/reference/android/graphics/drawable/Drawable mask) ` Creates a new ripple drawable with the specified ripple color and optional content and mask drawables. |
| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t) ` Applies the specified theme to this Drawable and its children. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#canApplyTheme()() ` |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/Canvas canvas) ` Optimized for drawing ripples with a mask layer and optional content. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getConstantState()() ` Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable. |
| ` https://developer.android.com/reference/android/graphics/Rect` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getDirtyBounds()() ` Return the drawable's dirty bounds Rect. |
| ` https://developer.android.com/reference/android/content/res/ColorStateList` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getEffectColor()() ` |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getHotspotBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect outRect) ` Populates `outRect` with the hotspot bounds. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getOpacity()() ` *This method is deprecated. This method is no longer used in graphics optimizations* |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline) ` Populates `outline` with the first available layer outline, excluding the mask layer. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#getRadius()() ` |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#hasFocusStateSpecified()() ` Indicates whether this drawable has at least one state spec explicitly specifying `https://developer.android.com/reference/android/R.attr#state_focused`. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme) ` Inflate this Drawable from an XML resource optionally styled by a theme. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#invalidateSelf()() ` Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable redrawn. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#isProjected()() ` Whether this drawable requests projection. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#isStateful()() ` Indicates whether this drawable will change its appearance based on state. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#jumpToCurrentState()() ` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#mutate()() ` Make this drawable mutable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setColor(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList color) ` Sets the ripple color. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setDrawableByLayerId(int,%20android.graphics.drawable.Drawable)(int id, https://developer.android.com/reference/android/graphics/drawable/Drawable drawable) ` Replaces the `https://developer.android.com/reference/android/graphics/drawable/Drawable` for the layer with the given id. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setEffectColor(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList color) ` Sets the ripple effect color. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setHotspot(float,%20float)(float x, float y) ` Specifies the hotspot's location within the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setHotspotBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom) ` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setPaddingMode(int)(int mode) ` Specifies how layer padding should affect the bounds of subsequent layers. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setRadius(int)(int radius) ` Sets the radius in pixels of the fully expanded ripple. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart) ` Set whether this Drawable is visible. |
| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#onBoundsChange(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds) ` Override this in your subclass to change appearance if you vary based on the bounds. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#onStateChange(int[])(int[] stateSet) ` Override this in your subclass to change appearance if you recognize the specified state. |
### Inherited methods
From class `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#addLayer(android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable dr)
`
Adds a new layer containing the specified `drawable` to the end of
the layer list and returns its index.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t)
`
Applies the specified theme to this Drawable and its children.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#canApplyTheme()()
`
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/Canvas canvas)
`
Draw in its bounds (set via setBounds) respecting optional effects such
as alpha (set via setAlpha) and color filter (set via setColorFilter).
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#findDrawableByLayerId(int)(int id)
`
Looks for a layer with the given ID and returns its `https://developer.android.com/reference/android/graphics/drawable/Drawable`.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#findIndexByLayerId(int)(int id)
`
Returns the layer with the specified `id`.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getAlpha()()
`
Gets the current alpha value for the drawable.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getBottomPadding()()
`
Returns the bottom padding in pixels.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getChangingConfigurations()()
`
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getConstantState()()
`
Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getDrawable(int)(int index)
`
Returns the drawable for the layer at the specified index.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getEndPadding()()
`
Returns the end padding in pixels.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getHotspotBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect outRect)
`
Populates `outRect` with the hotspot bounds.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getId(int)(int index)
`
Returns the ID of the specified layer.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getIntrinsicHeight()()
`
Returns the drawable's intrinsic height.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getIntrinsicWidth()()
`
Returns the drawable's intrinsic width.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerGravity(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerHeight(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerInsetBottom(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerInsetEnd(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerInsetLeft(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerInsetRight(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerInsetStart(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerInsetTop(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLayerWidth(int)(int index)
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getLeftPadding()()
`
Returns the left padding in pixels.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getNumberOfLayers()()
`
Returns the number of layers contained within this layer drawable.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getOpacity()()
`
*This method is deprecated.
This method is no longer used in graphics optimizations*
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline)
`
Populates `outline` with the first available (non-empty) layer outline.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getPadding(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect padding)
`
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getPaddingMode()()
` `
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getRightPadding()()
`
Returns the right padding in pixels.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getStartPadding()()
`
Returns the start padding in pixels.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getTopPadding()()
`
Returns the top padding in pixels.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#hasFocusStateSpecified()()
`
Indicates whether this drawable has at least one state spec explicitly
specifying `https://developer.android.com/reference/android/R.attr#state_focused`.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Inflate this Drawable from an XML resource optionally styled by a theme.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#invalidateDrawable(android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who)
`
Called when the drawable needs to be redrawn.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#isAutoMirrored()()
`
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#isProjected()()
`
Whether this drawable requests projection.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#isStateful()()
`
Indicates whether this drawable will change its appearance based on
state.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#jumpToCurrentState()()
`
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#mutate()()
`
Make this drawable mutable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#onBoundsChange(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Override this in your subclass to change appearance if you vary based on
the bounds.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#onLayoutDirectionChanged(int)(int layoutDirection)
`
Called when the drawable's resolved layout direction changes.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#onLevelChange(int)(int level)
`
Override this in your subclass to change appearance if you vary based
on level.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#onStateChange(int[])(int[] state)
`
Override this in your subclass to change appearance if you recognize the
specified state.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what, long when)
`
A Drawable can call this to schedule the next frame of its
animation.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setAlpha(int)(int alpha)
`
Specify an alpha value for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setAutoMirrored(boolean)(boolean mirrored)
`
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left).
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setColorFilter(android.graphics.ColorFilter)(https://developer.android.com/reference/android/graphics/ColorFilter colorFilter)
`
Specify an optional color filter for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setDither(boolean)(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` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setDrawable(int,%20android.graphics.drawable.Drawable)(int index, https://developer.android.com/reference/android/graphics/drawable/Drawable drawable)
`
Sets the drawable for the layer at the specified index.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setDrawableByLayerId(int,%20android.graphics.drawable.Drawable)(int id, https://developer.android.com/reference/android/graphics/drawable/Drawable drawable)
`
Replaces the `https://developer.android.com/reference/android/graphics/drawable/Drawable` for the layer with the given id.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setHotspot(float,%20float)(float x, float y)
`
Specifies the hotspot's location within the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setHotspotBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom)
`
Sets the bounds to which the hotspot is constrained, if they should be
different from the drawable bounds.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setId(int,%20int)(int index, int id)
`
Sets the ID of a layer.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerGravity(int,%20int)(int index, int gravity)
`
Sets the gravity used to position or stretch the specified layer within
its container.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerHeight(int,%20int)(int index, int h)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInset(int,%20int,%20int,%20int,%20int)(int index, int l, int t, int r, int b)
`
Specifies the insets in pixels for the drawable at the specified index.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetBottom(int,%20int)(int index, int b)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetEnd(int,%20int)(int index, int e)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetLeft(int,%20int)(int index, int l)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetRelative(int,%20int,%20int,%20int,%20int)(int index, int s, int t, int e, int b)
`
Specifies the relative insets in pixels for the drawable at the
specified index.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetRight(int,%20int)(int index, int r)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetStart(int,%20int)(int index, int s)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerInsetTop(int,%20int)(int index, int t)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerSize(int,%20int,%20int)(int index, int w, int h)
`
Sets an explicit size for the specified layer.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setLayerWidth(int,%20int)(int index, int w)
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setOpacity(int)(int opacity)
`
Sets the opacity of this drawable directly instead of collecting the
states from the layers.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setPadding(int,%20int,%20int,%20int)(int left, int top, int right, int bottom)
`
Sets the absolute padding.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setPaddingMode(int)(int mode)
`
Specifies how layer padding should affect the bounds of subsequent
layers.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setPaddingRelative(int,%20int,%20int,%20int)(int start, int top, int end, int bottom)
`
Sets the relative padding.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setTintBlendMode(android.graphics.BlendMode)(https://developer.android.com/reference/android/graphics/BlendMode blendMode)
`
Specifies a tint blending mode for this drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setTintList(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList tint)
`
Specifies tint color for this drawable as a color state list.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart)
`
Set whether this Drawable is visible.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#unscheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what)
`
A Drawable can call this to unschedule an action previously
scheduled with `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)`.
From class `
https://developer.android.com/reference/android/graphics/drawable/Drawable
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t)
`
Applies the specified theme to this Drawable and its children.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#canApplyTheme()()
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#clearColorFilter()()
`
Removes the color filter for this drawable.
`
final
https://developer.android.com/reference/android/graphics/Rect` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#copyBounds()()
`
Return a copy of the drawable's bounds in a new Rect.
`
final
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#copyBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Return a copy of the drawable's bounds in the specified Rect (allocated
by the caller).
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromPath(java.lang.String)(https://developer.android.com/reference/java/lang/String pathName)
`
Create a drawable from file path name.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromResourceStream(android.content.res.Resources,%20android.util.TypedValue,%20java.io.InputStream,%20java.lang.String,%20android.graphics.BitmapFactory.Options)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/util/TypedValue value, https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName, https://developer.android.com/reference/android/graphics/BitmapFactory.Options opts)
`
*This method was deprecated
in API level 28.
Prefer the version without an Options object.*
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromResourceStream(android.content.res.Resources,%20android.util.TypedValue,%20java.io.InputStream,%20java.lang.String)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/util/TypedValue value, https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName)
`
Create a drawable from an inputstream, using the given resources and
value to determine density information.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromStream(java.io.InputStream,%20java.lang.String)(https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName)
`
Create a drawable from an inputstream
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXml(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser)
`
Create a drawable from an XML document.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXml(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Create a drawable from an XML document using an optional `https://developer.android.com/reference/android/content/res/Resources.Theme`.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXmlInner(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Create a drawable from inside an XML document using an optional
`https://developer.android.com/reference/android/content/res/Resources.Theme`.
`
static
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXmlInner(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs)
`
Create from inside an XML document.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/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` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getAlpha()()
`
Gets the current alpha value for the drawable.
`
final
https://developer.android.com/reference/android/graphics/Rect` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getBounds()()
`
Return the drawable's bounds Rect.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getCallback()()
`
Return the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation attached to this
Drawable.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getChangingConfigurations()()
`
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
`
https://developer.android.com/reference/android/graphics/ColorFilter` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getColorFilter()()
`
Returns the current color filter, or `null` if none set.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getConstantState()()
`
Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getCurrent()()
` `
https://developer.android.com/reference/android/graphics/Rect` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getDirtyBounds()()
`
Return the drawable's dirty bounds Rect.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getHotspotBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect outRect)
`
Populates `outRect` with the hotspot bounds.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getIntrinsicHeight()()
`
Returns the drawable's intrinsic height.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getIntrinsicWidth()()
`
Returns the drawable's intrinsic width.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getLayoutDirection()()
`
Returns the resolved layout direction for this Drawable.
`
final
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getLevel()()
`
Retrieve the current level.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getMinimumHeight()()
`
Returns the minimum height suggested by this Drawable.
`
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getMinimumWidth()()
`
Returns the minimum width suggested by this Drawable.
`
abstract
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getOpacity()()
`
*This method was deprecated
in API level 29.
This method is no longer used in graphics optimizations*
`
https://developer.android.com/reference/android/graphics/Insets` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getOpticalInsets()()
`
Return in insets the layout insets suggested by this Drawable for use with alignment
operations during layout.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline)
`
Called to get the drawable to populate the Outline that defines its drawing area.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getPadding(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect padding)
`
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
`
int[]` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getState()()
`
Describes the current state, as a union of primitive states, such as
`https://developer.android.com/reference/android/R.attr#state_focused`,
`https://developer.android.com/reference/android/R.attr#state_selected`, etc.
`
https://developer.android.com/reference/android/graphics/Region` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#getTransparentRegion()()
`
Returns a Region representing the part of the Drawable that is completely
transparent.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#hasFocusStateSpecified()()
`
Indicates whether this drawable has at least one state spec explicitly
specifying `https://developer.android.com/reference/android/R.attr#state_focused`.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme)
`
Inflate this Drawable from an XML resource optionally styled by a theme.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs)
`
Inflate this Drawable from an XML resource.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#invalidateSelf()()
`
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
redrawn.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isAutoMirrored()()
`
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isFilterBitmap()()
` `
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isProjected()()
`
Whether this drawable requests projection.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isStateful()()
`
Indicates whether this drawable will change its appearance based on
state.
`
final
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#isVisible()()
` `
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#jumpToCurrentState()()
`
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
`
https://developer.android.com/reference/android/graphics/drawable/Drawable` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#mutate()()
`
Make this drawable mutable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onBoundsChange(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Override this in your subclass to change appearance if you vary based on
the bounds.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onLayoutDirectionChanged(int)(int layoutDirection)
`
Called when the drawable's resolved layout direction changes.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onLevelChange(int)(int level)
`
Override this in your subclass to change appearance if you vary based
on level.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#onStateChange(int[])(int[] state)
`
Override this in your subclass to change appearance if you recognize the
specified state.
`
static
int` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#resolveOpacity(int,%20int)(int op1, int op2)
`
Return the appropriate opacity value for two source opacities.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#scheduleSelf(java.lang.Runnable,%20long)(https://developer.android.com/reference/java/lang/Runnable what, long when)
`
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
scheduled.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)(int alpha)
`
Specify an alpha value for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setAutoMirrored(boolean)(boolean mirrored)
`
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left).
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom)
`
Specify a bounding rectangle for the Drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds)
`
Specify a bounding rectangle for the Drawable.
`
final
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setCallback(android.graphics.drawable.Drawable.Callback)(https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback cb)
`
Bind a `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` object to this Drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setChangingConfigurations(int)(int configs)
`
Set a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)(int color, https://developer.android.com/reference/android/graphics/PorterDuff.Mode mode)
`
*This method was deprecated
in API level 29.
use `https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` with an instance
of `https://developer.android.com/reference/android/graphics/BlendModeColorFilter`*
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)(https://developer.android.com/reference/android/graphics/ColorFilter colorFilter)
`
Specify an optional color filter for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setDither(boolean)(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` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setFilterBitmap(boolean)(boolean filter)
`
Set to true to have the drawable filter its bitmaps with bilinear
sampling when they are scaled or rotated.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setHotspot(float,%20float)(float x, float y)
`
Specifies the hotspot's location within the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setHotspotBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom)
`
Sets the bounds to which the hotspot is constrained, if they should be
different from the drawable bounds.
`
final
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setLayoutDirection(int)(int layoutDirection)
`
Set the layout direction for this drawable.
`
final
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setLevel(int)(int level)
`
Specify the level for the drawable.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setState(int[])(int[] stateSet)
`
Specify a set of states for the drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTint(int)(int tintColor)
`
Specifies tint color for this drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintBlendMode(android.graphics.BlendMode)(https://developer.android.com/reference/android/graphics/BlendMode blendMode)
`
Specifies a tint blending mode for this drawable.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintList(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList tint)
`
Specifies tint color for this drawable as a color state list.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintMode(android.graphics.PorterDuff.Mode)(https://developer.android.com/reference/android/graphics/PorterDuff.Mode tintMode)
`
Specifies a tint blending mode for this drawable.
`
boolean` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart)
`
Set whether this Drawable is visible.
`
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable#unscheduleSelf(java.lang.Runnable)(https://developer.android.com/reference/java/lang/Runnable what)
`
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
unscheduled.
From class `
https://developer.android.com/reference/java/lang/Object
` `
https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`
Creates and returns a copy of this object.
`
boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`
Indicates whether some other object is "equal to" this one.
`
void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
`
final
https://developer.android.com/reference/java/lang/Class` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`
Returns the runtime class of this `Object`.
`
int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`
Returns a hash code value for the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`
Wakes up a single thread that is waiting on this object's
monitor.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`
Wakes up all threads that are waiting on this object's monitor.
`
https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`
Returns a string representation of the object.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos)
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis)
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.
`
final
void` `
https://developer.android.com/reference/java/lang/Object#wait()()
`
Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.
From interface `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback
` `
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#invalidateDrawable(android.graphics.drawable.Drawable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who)
`
Called when the drawable needs to be redrawn.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what, long when)
`
A Drawable can call this to schedule the next frame of its
animation.
`
abstract
void` `
https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#unscheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable)(https://developer.android.com/reference/android/graphics/drawable/Drawable who, https://developer.android.com/reference/java/lang/Runnable what)
`
A Drawable can call this to unschedule an action previously
scheduled with `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback#scheduleDrawable(android.graphics.drawable.Drawable,%20java.lang.Runnable,%20long)`.
## XML attributes
### android:color
The color to use for ripple effects. This attribute is required.
May be a color value, in the form of "`#*rgb*`",
"`#*argb*`", "`#*rrggbb*`", or
"`#*aarrggbb*`".
**Related methods:**
- `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setColor(android.content.res.ColorStateList)`
### android:effectColor
Secondary color of the ripple effect.
May be a color value, in the form of "`#*rgb*`",
"`#*argb*`", "`#*rrggbb*`", or
"`#*aarrggbb*`".
**Related methods:**
- `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setEffectColor(android.content.res.ColorStateList)`
### android:radius
The radius of the ripple when fully expanded. By default, the
radius is computed based on the size of the ripple's container.
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).
**Related methods:**
- `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#setRadius(int)`
## Constants
### RADIUS_AUTO
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int RADIUS_AUTO
```
Radius value that specifies the ripple radius should be computed based
on the size of the ripple's container.
Constant Value:
-1
(0xffffffff)
## Public constructors
### RippleDrawable
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public RippleDrawable (ColorStateList color,
Drawable content,
Drawable mask)
```
Creates a new ripple drawable with the specified ripple color and
optional content and mask drawables.
| Parameters ||
|---|---|
| `color` | `ColorStateList`: The ripple color. This value cannot be `null`.
|
| `content` | `Drawable`: The content drawable, may be `null`
|
| `mask` | `Drawable`: The mask drawable, may be `null`
|
## Public methods
### applyTheme
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void applyTheme (Resources.Theme t)
```
Applies the specified theme to this Drawable and its children.
| Parameters ||
|---|---|
| `t` | `Resources.Theme`: This value cannot be `null`.
|
### canApplyTheme
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean canApplyTheme ()
```
| Returns ||
|---|---|
| `boolean` |
|
### draw
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void draw (Canvas canvas)
```
Optimized for drawing ripples with a mask layer and optional content.
| Parameters ||
|---|---|
| `canvas` | `Canvas`: This value cannot be `null`.
|
### getConstantState
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable.ConstantState getConstantState ()
```
Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | The ConstantState associated to that Drawable. This value may be `null`.
|
### getDirtyBounds
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Rect` | The dirty bounds of this drawable. This value cannot be `null`.
|
### getEffectColor
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public ColorStateList getEffectColor ()
```
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/res/ColorStateList` | The ripple effect color as a color state list. This value cannot be `null`.
|
### getHotspotBounds
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void getHotspotBounds (Rect outRect)
```
Populates `outRect` with the hotspot bounds.
| Parameters ||
|---|---|
| `outRect` | `Rect`: the rect to populate with the hotspot bounds. This value cannot be `null`.
|
### getOpacity
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getOpacity ()
```
**This method is deprecated.**
This method is no longer used in graphics optimizations
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
`https://developer.android.com/reference/android/graphics/PixelFormat`:
`https://developer.android.com/reference/android/graphics/PixelFormat#UNKNOWN`,
`https://developer.android.com/reference/android/graphics/PixelFormat#TRANSLUCENT`,
`https://developer.android.com/reference/android/graphics/PixelFormat#TRANSPARENT`, or
`https://developer.android.com/reference/android/graphics/PixelFormat#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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#resolveOpacity(int,%20int)` 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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)` or `https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` methods. Some subclasses,
such as `https://developer.android.com/reference/android/graphics/drawable/BitmapDrawable`, `https://developer.android.com/reference/android/graphics/drawable/ColorDrawable`, and `https://developer.android.com/reference/android/graphics/drawable/GradientDrawable`,
do account for the value of `https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)`, but the general behavior is dependent
upon the implementation of the subclass.
| Returns ||
|---|---|
| `int` | int The opacity class of the Drawable. Value is one of the following: - `https://developer.android.com/reference/android/graphics/PixelFormat#UNKNOWN` - `https://developer.android.com/reference/android/graphics/PixelFormat#TRANSLUCENT` - `https://developer.android.com/reference/android/graphics/PixelFormat#TRANSPARENT` - `https://developer.android.com/reference/android/graphics/PixelFormat#OPAQUE` |
### getOutline
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void getOutline (Outline outline)
```
Populates `outline` with the first available layer outline,
excluding the mask layer.
| Parameters ||
|---|---|
| `outline` | `Outline`: Outline in which to place the first available layer outline. This value cannot be `null`.
|
### getRadius
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getRadius ()
```
**Related XML Attributes:**
- [android:radius](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:radius)
| Returns ||
|---|---|
| `int` | the radius in pixels of the fully expanded ripple if an explicit radius has been set, or `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#RADIUS_AUTO` if the radius is computed based on the container size
|
### hasFocusStateSpecified
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean hasFocusStateSpecified ()
```
Indicates whether this drawable has at least one state spec explicitly
specifying `https://developer.android.com/reference/android/R.attr#state_focused`.
Note: A View uses a `https://developer.android.com/reference/android/graphics/drawable/Drawable` instance as its background and it
changes its appearance based on a state. On keyboard devices, it should
specify its `https://developer.android.com/reference/android/R.attr#state_focused` to make sure the user
knows which view is holding the focus.
| Returns ||
|---|---|
| `boolean` | `true` if `https://developer.android.com/reference/android/R.attr#state_focused` is specified for this drawable.
|
### inflate
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Parameters ||
|---|---|
| `r` | `Resources`: This value cannot be `null`.
|
| `parser` | `XmlPullParser`: This value cannot be `null`.
|
| `attrs` | `AttributeSet`: This value cannot be `null`.
|
| `theme` | `Resources.Theme`: This value may be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | |
| `https://developer.android.com/reference/org/xmlpull/v1/XmlPullParserException` | |
### invalidateSelf
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void invalidateSelf ()
```
Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable
redrawn. Does nothing if there is no Callback attached to the
Drawable.
### isProjected
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isProjected ()
```
Whether this drawable requests projection. Indicates that the
`https://developer.android.com/reference/android/graphics/RenderNode` this Drawable will draw into should be drawn immediately
after the closest ancestor RenderNode containing a projection receiver.
| Returns ||
|---|---|
| `boolean` |
|
### isStateful
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Returns ||
|---|---|
| `boolean` | True if this drawable changes its appearance based on state, false otherwise.
|
### jumpToCurrentState
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void jumpToCurrentState ()
```
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
### mutate
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public 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.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | This drawable. This value cannot be `null`.
|
### setColor
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setColor (ColorStateList color)
```
Sets the ripple color.
**Related XML Attributes:**
- [android:color](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:color)
| Parameters ||
|---|---|
| `color` | `ColorStateList`: Ripple color as a color state list. This value cannot be `null`.
|
### setDrawableByLayerId
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean setDrawableByLayerId (int id,
Drawable drawable)
```
Replaces the `https://developer.android.com/reference/android/graphics/drawable/Drawable` for the layer with the given id.
| Parameters ||
|---|---|
| `id` | `int`: The layer ID to search for.
|
| `drawable` | `Drawable`: The replacement `https://developer.android.com/reference/android/graphics/drawable/Drawable`.
|
| Returns ||
|---|---|
| `boolean` | Whether the `https://developer.android.com/reference/android/graphics/drawable/Drawable` was replaced (could return false if the id was not found).
|
### setEffectColor
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setEffectColor (ColorStateList color)
```
Sets the ripple effect color.
**Related XML Attributes:**
- [android:effectColor](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:effectColor)
| Parameters ||
|---|---|
| `color` | `ColorStateList`: Ripple color as a color state list. This value cannot be `null`.
|
### setHotspot
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setHotspot (float x,
float y)
```
Specifies the hotspot's location within the drawable.
| Parameters ||
|---|---|
| `x` | `float`: The X coordinate of the center of the hotspot
|
| `y` | `float`: The Y coordinate of the center of the hotspot
|
### setHotspotBounds
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setHotspotBounds (int left,
int top,
int right,
int bottom)
```
Sets the bounds to which the hotspot is constrained, if they should be
different from the drawable bounds.
| Parameters ||
|---|---|
| `left` | `int`: position in pixels of the left bound
|
| `top` | `int`: position in pixels of the top bound
|
| `right` | `int`: position in pixels of the right bound
|
| `bottom` | `int`: position in pixels of the bottom bound
|
### setPaddingMode
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setPaddingMode (int mode)
```
Specifies how layer padding should affect the bounds of subsequent
layers. The default and recommended value for RippleDrawable is
`https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#PADDING_MODE_STACK`.
| Parameters ||
|---|---|
| `mode` | `int`: padding mode, one of: - `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#PADDING_MODE_NEST` to nest each layer inside the padding of the previous layer - `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#PADDING_MODE_STACK` to stack each layer directly atop the previous layer
|
**See also:**
- `https://developer.android.com/reference/android/graphics/drawable/LayerDrawable#getPaddingMode()`
### setRadius
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setRadius (int radius)
```
Sets the radius in pixels of the fully expanded ripple.
**Related XML Attributes:**
- [android:radius](https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#attr_android:radius)
| Parameters ||
|---|---|
| `radius` | `int`: ripple radius in pixels, or `https://developer.android.com/reference/android/graphics/drawable/RippleDrawable#RADIUS_AUTO` to compute the radius based on the container size
|
### setVisible
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean setVisible (boolean visible,
boolean restart)
```
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.
| Parameters ||
|---|---|
| `visible` | `boolean`: Set to true if visible, false if not.
|
| `restart` | `boolean`: You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.
|
| Returns ||
|---|---|
| `boolean` | boolean Returns true if the new visibility is different than its previous state.
|
## Protected methods
### onBoundsChange
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected void onBoundsChange (Rect bounds)
```
Override this in your subclass to change appearance if you vary based on
the bounds.
| Parameters ||
|---|---|
| `bounds` | `Rect`: This value cannot be `null`.
|
### onStateChange
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean onStateChange (int[] stateSet)
```
Override this in your subclass to change appearance if you recognize the
specified state.
| Parameters ||
|---|---|
| `stateSet` | `int`: This value cannot be `null`.
|
| 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.
|