fullscreen Use Tree Navigation

Added in API level 21

public class

RippleDrawable

extends LayerDrawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.LayerDrawable
		↳	android.graphics.drawable.RippleDrawable

Class Overview

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 setHotspot(float, float) 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 by specifying its android:id value as mask.

 <!-- A red ripple masked against an opaque rectangle. --/>
 <ripple android:color="#ffff0000">
   <item android:id="@android:id/mask"
         android:drawable="@android:color/white" />
 </ripple>

If a mask layer is set, the ripple effect will be masked against that layer before it is drawn over the composite of the remaining child layers.

If no mask layer is set, the ripple effect is masked against the composite of the child layers.

 <!-- A green ripple drawn atop a black rectangle. --/>
 <ripple android:color="#ff00ff00">
   <item android:drawable="@android:color/black" />
 </ripple>

 <!-- A blue ripple drawn atop a drawable resource. --/>
 <ripple android:color="#ff0000ff">
   <item android:drawable="@drawable/my_drawable" />
 </ripple>

If no child layers or mask is specified and the ripple is set as a View background, the ripple will be drawn atop the first available parent background within the View's hierarchy. In this case, the drawing region may extend outside of the Drawable bounds.

 <!-- An unbounded red ripple. --/>
 <ripple android:color="#ffff0000" />

Summary

XML Attributes
Attribute Name	Related Method	Description
android:color		The color to use for ripple effects.

[Expand]

Inherited XML Attributes

From class android.graphics.drawable.LayerDrawable

[Expand]

Inherited Constants

From class android.graphics.drawable.LayerDrawable

Public Constructors
	RippleDrawable(ColorStateList color, Drawable content, Drawable mask) Creates a new ripple drawable with the specified ripple color and optional content and mask drawables.

Public Methods
void	applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	draw(Canvas canvas) Optimized for drawing ripples with a mask layer and optional content.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Rect	getDirtyBounds() Return the drawable's dirty bounds Rect.
int	getOpacity() Return the opacity/transparency of this Drawable.
void	getOutline(Outline outline) Populates `outline` with the first available layer outline, excluding the mask layer.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	invalidateSelf() Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
Drawable	mutate() Make this drawable mutable.
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setColor(ColorStateList color)
void	setColorFilter(ColorFilter cf) Specify an optional color filter for the drawable.
boolean	setDrawableByLayerId(int id, Drawable drawable) Sets (or replaces) the `Drawable` for the layer with the given id.
void	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
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.
void	setPaddingMode(int mode) Specifies how layer padding should affect the bounds of subsequent layers.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.

Protected Methods
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
boolean	onStateChange(int[] stateSet) Override this in your subclass to change appearance if you recognize the specified state.

[Expand]

Inherited Methods

From class android.graphics.drawable.LayerDrawable

void	applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
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).
Drawable	findDrawableByLayerId(int id) Looks for a layer with the given ID and returns its `Drawable`.
int	getAlpha() Gets the current alpha value for the drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getDrawable(int index) Returns the drawable at the specified layer index.
int	getId(int index) Returns the id of the specified layer.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
int	getNumberOfLayers() Returns the number of layers contained within this.
int	getOpacity() Return the opacity/transparency of this Drawable.
void	getOutline(Outline outline) Populates `outline` with the first available (non-empty) layer outline.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
int	getPaddingMode()
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	invalidateDrawable(Drawable who) Called when the drawable needs to be redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
void	scheduleDrawable(Drawable who, Runnable what, long when) A Drawable can call this to schedule the next frame of its animation.
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setColorFilter(ColorFilter cf) Specify an optional color filter for the drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
boolean	setDrawableByLayerId(int id, Drawable drawable) Sets (or replaces) the `Drawable` for the layer with the given id.
void	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
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.
void	setId(int index, int id) Sets the ID of a layer.
void	setLayerInset(int index, int l, int t, int r, int b) Specifies the insets in pixels for the drawable at the specified index.
void	setOpacity(int opacity) Sets the opacity of this drawable directly, instead of collecting the states from the layers
void	setPaddingMode(int mode) Specifies how layer padding should affect the bounds of subsequent layers.
void	setTintList(ColorStateList tint) Specifies a tint for this drawable as a color state list.
void	setTintMode(PorterDuff.Mode tintMode) Specifies a tint blending mode for this drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleDrawable(Drawable who, Runnable what) A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable(Drawable, Runnable, long)`.

From class android.graphics.drawable.Drawable

void	applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	clearColorFilter() Removes the color filter for this drawable.
final Rect	copyBounds() Return a copy of the drawable's bounds in a new Rect.
final void	copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
static Drawable	createFromPath(String pathName) Create a drawable from file path name.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromStream(InputStream is, String srcName) Create a drawable from an inputstream
static Drawable	createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme) Create a drawable from an XML document using an optional `Resources.Theme`.
static Drawable	createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Create a drawable from inside an XML document using an optional `Resources.Theme`.
abstract void	draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
int	getAlpha() Gets the current alpha value for the drawable.
final Rect	getBounds() Return the drawable's bounds Rect.
Drawable.Callback	getCallback() Return the current `Drawable.Callback` implementation attached to this Drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
ColorFilter	getColorFilter() Returns the current color filter, or `null` if none set.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getCurrent()
Rect	getDirtyBounds() Return the drawable's dirty bounds Rect.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
final int	getLevel() Retrieve the current level.
int	getMinimumHeight() Returns the minimum height suggested by this Drawable.
int	getMinimumWidth() Returns the minimum width suggested by this Drawable.
abstract int	getOpacity() Return the opacity/transparency of this Drawable.
void	getOutline(Outline outline) Called to get the drawable to populate the Outline that defines its drawing area.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
int[]	getState() Describes the current state, as a union of primitve states, such as `state_focused`, `state_selected`, etc.
Region	getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource.
void	invalidateSelf() Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
final boolean	isVisible()
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
static int	resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities.
void	scheduleSelf(Runnable what, long when) Use the current `Drawable.Callback` implementation to have this Drawable scheduled.
abstract void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setBounds(Rect bounds) Specify a bounding rectangle for the Drawable.
void	setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable.
final void	setCallback(Drawable.Callback cb) Bind a `Drawable.Callback` object to this Drawable.
void	setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
abstract void	setColorFilter(ColorFilter cf) Specify an optional color filter for the drawable.
void	setColorFilter(int color, PorterDuff.Mode mode) Specify a color and Porter-Duff mode to be the color filter for this drawable.
void	setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
void	setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps).
void	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
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.
final boolean	setLevel(int level) Specify the level for the drawable.
boolean	setState(int[] stateSet) Specify a set of states for the drawable.
void	setTint(int tint) Specifies a tint for this drawable.
void	setTintList(ColorStateList tint) Specifies a tint for this drawable as a color state list.
void	setTintMode(PorterDuff.Mode tintMode) Specifies a tint blending mode for this drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleSelf(Runnable what) Use the current `Drawable.Callback` implementation to have this Drawable unscheduled.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.graphics.drawable.Drawable.Callback

XML Attributes

android:color

The color to use for ripple effects. This attribute is required.

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

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

This corresponds to the global attribute resource symbol color.

color	The ripple color
content	The content drawable, may be `null`
mask	The mask drawable, may be `null`

r	Resources used to resolve attribute values
parser	XML parser from which to inflate this Drawable
attrs	Base set of attribute values
theme	Theme to apply, may be null

id	The layer ID to search for.
drawable	The replacement `Drawable`.

x	The X coordinate of the center of the hotspot
y	The Y coordinate of the center of the hotspot

visible	Set to true if visible, false if not.
restart	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.

Results

Interfaces

Classes

Enums

RippleDrawable

Class Overview

Summary

XML Attributes

android:color

Related Methods

Public Constructors

public RippleDrawable (ColorStateList color, Drawable content, Drawable mask)

Parameters

Public Methods

public void applyTheme (Resources.Theme t)

public boolean canApplyTheme ()

public void draw (Canvas canvas)

Parameters

public Drawable.ConstantState getConstantState ()

Returns

public Rect getDirtyBounds ()

Returns

public int getOpacity ()

Returns

public void getOutline (Outline outline)

Parameters

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

Parameters

Throws

public void invalidateSelf ()

public boolean isStateful ()

Returns

public void jumpToCurrentState ()

public Drawable mutate ()

Returns

public void setAlpha (int alpha)

public void setColor (ColorStateList color)

public void setColorFilter (ColorFilter cf)

Parameters

public boolean setDrawableByLayerId (int id, Drawable drawable)

Parameters

Returns

public void setHotspot (float x, float y)

Parameters

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

public void setPaddingMode (int mode)

Parameters

See Also

public boolean setVisible (boolean visible, boolean restart)

Parameters

Returns

Protected Methods

protected void onBoundsChange (Rect bounds)

protected boolean onStateChange (int[] stateSet)

Returns