carbon.drawable.ripple

Class RippleDrawableICS

java.lang.Object

android.graphics.drawable.Drawable

carbon.drawable.ripple.LollipopDrawable

carbon.drawable.ripple.LayerDrawable

carbon.drawable.ripple.RippleDrawableICS

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, AlphaDrawable, RippleDrawable

public class RippleDrawableICS
extends LayerDrawable
implements 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 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 from XML by specifying its android:id value as R.id.mask. At run time, a single layer may be set as the mask using setId(..., R.id.carbon_mask) or an existing mask layer may be replaced using setDrawableByLayerId(R.id.carbon_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" />
 

Nested Class Summary

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

android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Nested classes/interfaces inherited from interface carbon.drawable.ripple.RippleDrawable

RippleDrawable.Style

Field Summary

Fields

Modifier and Type	Field and Description
static int	RADIUS_AUTO Radius value that specifies the ripple radius should be computed based on the size of the ripple's container.

Fields inherited from class carbon.drawable.ripple.LayerDrawable

PADDING_MODE_NEST, PADDING_MODE_STACK

Constructor Summary

Constructors

Constructor and Description
RippleDrawableICS(android.content.res.ColorStateList color, android.graphics.drawable.Drawable content, android.graphics.drawable.Drawable mask) Creates a new ripple drawable with the specified ripple color and optional content and mask drawables.
RippleDrawableICS(android.content.res.ColorStateList color, android.graphics.drawable.Drawable background, RippleDrawable.Style style)

Method Summary

Modifier and Type	Method and Description
void	applyTheme(android.content.res.Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	draw(android.graphics.Canvas canvas) Optimized for drawing ripples with a mask layer and optional content.
int	getAlpha() Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque.
android.graphics.drawable.Drawable	getBackground()
android.content.res.ColorStateList	getColor()
android.graphics.drawable.Drawable.ConstantState	getConstantState()
android.graphics.Rect	getDirtyBounds()
void	getHotspotBounds(android.graphics.Rect outRect)
int	getOpacity()
void	getOutline(android.graphics.Outline outline) Populates outline with the first available layer outline, excluding the mask layer.
int	getRadius()
RippleDrawable.Style	getStyle()
void	inflate(android.content.res.Resources r, org.xmlpull.v1.XmlPullParser parser, android.util.AttributeSet attrs, android.content.res.Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	invalidateSelf()
boolean	isHotspotEnabled()
boolean	isStateful()
void	jumpToCurrentState()
android.graphics.drawable.Drawable	mutate()
protected void	onBoundsChange(android.graphics.Rect bounds)
protected boolean	onStateChange(int[] stateSet)
void	setColor(android.content.res.ColorStateList color) Sets the ripple color.
boolean	setDrawableByLayerId(int id, android.graphics.drawable.Drawable drawable) 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	setHotspotEnabled(boolean useHotspot)
void	setPaddingMode(int mode) Specifies how layer padding should affect the bounds of subsequent layers.
void	setRadius(int radius) Sets the radius in pixels of the fully expanded ripple.
boolean	setVisible(boolean visible, boolean restart)

Methods inherited from class carbon.drawable.ripple.LayerDrawable

addLayer, findDrawableByLayerId, findIndexByLayerId, getBottomPadding, getChangingConfigurations, getDrawable, getEndPadding, getId, getIntrinsicHeight, getIntrinsicWidth, getLayerGravity, getLayerHeight, getLayerInsetBottom, getLayerInsetEnd, getLayerInsetLeft, getLayerInsetRight, getLayerInsetStart, getLayerInsetTop, getLayerWidth, getLeftPadding, getNumberOfLayers, getPadding, getPaddingMode, getRightPadding, getStartPadding, getTopPadding, invalidateDrawable, isAutoMirrored, onLayoutDirectionChanged, onLevelChange, scheduleDrawable, setAlpha, setAutoMirrored, setColorFilter, setDither, setDrawable, setId, setLayerGravity, setLayerHeight, setLayerInset, setLayerInsetBottom, setLayerInsetEnd, setLayerInsetLeft, setLayerInsetRelative, setLayerInsetRight, setLayerInsetStart, setLayerInsetTop, setLayerSize, setLayerWidth, setOpacity, setPadding, setPaddingRelative, setTintList, setTintMode, unscheduleDrawable

Methods inherited from class carbon.drawable.ripple.LollipopDrawable

getColorFilter, setTint

Methods inherited from class android.graphics.drawable.Drawable

clearColorFilter, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getBounds, getCallback, getCurrent, getLayoutDirection, getLevel, getMinimumHeight, getMinimumWidth, getState, getTransparentRegion, inflate, isFilterBitmap, isVisible, resolveOpacity, scheduleSelf, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setFilterBitmap, setLayoutDirection, setLevel, setState, unscheduleSelf

Methods inherited from class java.lang.Object

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

Methods inherited from interface carbon.drawable.ripple.RippleDrawable

setAlpha, setBounds, setBounds, setCallback, setColorFilter, setState

Field Detail

RADIUS_AUTO

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.

See Also:

Constant Field Values

Constructor Detail

RippleDrawableICS

public RippleDrawableICS(android.content.res.ColorStateList color,
                         android.graphics.drawable.Drawable background,
                         RippleDrawable.Style style)

RippleDrawableICS

public RippleDrawableICS(@NonNull
                         android.content.res.ColorStateList color,
                         @Nullable
                         android.graphics.drawable.Drawable content,
                         @Nullable
                         android.graphics.drawable.Drawable mask)

Creates a new ripple drawable with the specified ripple color and optional content and mask drawables.

Parameters:

color - The ripple color

content - The content drawable, may be null

mask - The mask drawable, may be null

Method Detail

jumpToCurrentState

public void jumpToCurrentState()

Specified by:

jumpToCurrentState in interface RippleDrawable

Overrides:

jumpToCurrentState in class android.graphics.drawable.Drawable

getOpacity

public int getOpacity()

Specified by:

getOpacity in interface RippleDrawable

Overrides:

getOpacity in class LayerDrawable

onStateChange

protected boolean onStateChange(int[] stateSet)

Overrides:

onStateChange in class LayerDrawable

onBoundsChange

protected void onBoundsChange(android.graphics.Rect bounds)

Overrides:

onBoundsChange in class LayerDrawable

setVisible

public boolean setVisible(boolean visible,
                          boolean restart)

Overrides:

setVisible in class LayerDrawable

isStateful

public boolean isStateful()

Specified by:

isStateful in interface RippleDrawable

Overrides:

isStateful in class LayerDrawable

setColor

public void setColor(android.content.res.ColorStateList color)

Sets the ripple color.

Parameters:

color - Ripple color as a color state list.

setRadius

public void setRadius(int radius)

Sets the radius in pixels of the fully expanded ripple.

Specified by:

setRadius in interface RippleDrawable

Parameters:

radius - ripple radius in pixels, or RADIUS_AUTO to compute the radius based on the container size

getRadius

public int getRadius()

Specified by:

getRadius in interface RippleDrawable

Returns:

the radius in pixels of the fully expanded ripple if an explicit radius has been set, or RADIUS_AUTO if the radius is computed based on the container size

inflate

public void inflate(android.content.res.Resources r,
                    org.xmlpull.v1.XmlPullParser parser,
                    android.util.AttributeSet attrs,
                    android.content.res.Resources.Theme theme)
             throws org.xmlpull.v1.XmlPullParserException,
                    java.io.IOException

Description copied from class: LollipopDrawable

Inflate this Drawable from an XML resource optionally styled by a theme.

Overrides:

inflate in class LayerDrawable

Parameters:

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

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

setDrawableByLayerId

public boolean setDrawableByLayerId(int id,
                                    android.graphics.drawable.Drawable drawable)

Description copied from class: LayerDrawable

Replaces the Drawable for the layer with the given id.

Overrides:

setDrawableByLayerId in class LayerDrawable

Parameters:

id - The layer ID to search for.

drawable - The replacement Drawable.

Returns:

Whether the Drawable was replaced (could return false if the id was not found).

setPaddingMode

public void setPaddingMode(int mode)

Specifies how layer padding should affect the bounds of subsequent layers. The default and recommended value for RippleDrawable is LayerDrawable.PADDING_MODE_STACK.

Overrides:

setPaddingMode in class LayerDrawable

Parameters:

mode - padding mode, one of:

• LayerDrawable.PADDING_MODE_NEST to nest each layer inside the padding of the previous layer
• LayerDrawable.PADDING_MODE_STACK to stack each layer directly atop the previous layer

See Also:

LayerDrawable.getPaddingMode()

applyTheme

public void applyTheme(android.content.res.Resources.Theme t)

Description copied from class: LollipopDrawable

Applies the specified theme to this Drawable and its children.

Overrides:

applyTheme in class LayerDrawable

canApplyTheme

public boolean canApplyTheme()

Overrides:

canApplyTheme in class LayerDrawable

setHotspot

public void setHotspot(float x,
                       float y)

Description copied from class: LollipopDrawable

Specifies the hotspot's location within the drawable.

Specified by:

setHotspot in interface RippleDrawable

Overrides:

setHotspot in class LayerDrawable

Parameters:

x - The X coordinate of the center of the hotspot

y - The Y coordinate of the center of the hotspot

setHotspotBounds

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

Description copied from class: LollipopDrawable

Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.

Overrides:

setHotspotBounds in class LayerDrawable

getHotspotBounds

public void getHotspotBounds(android.graphics.Rect outRect)

Overrides:

getHotspotBounds in class LayerDrawable

getOutline

public void getOutline(@NonNull
                       android.graphics.Outline outline)

Populates outline with the first available layer outline, excluding the mask layer.

Overrides:

getOutline in class LayerDrawable

Parameters:

outline - Outline in which to place the first available layer outline

draw

public void draw(@NonNull
                 android.graphics.Canvas canvas)

Optimized for drawing ripples with a mask layer and optional content.

Specified by:

draw in interface RippleDrawable

Overrides:

draw in class LayerDrawable

invalidateSelf

public void invalidateSelf()

Overrides:

invalidateSelf in class android.graphics.drawable.Drawable

getDirtyBounds

public android.graphics.Rect getDirtyBounds()

Overrides:

getDirtyBounds in class android.graphics.drawable.Drawable

getConstantState

public android.graphics.drawable.Drawable.ConstantState getConstantState()

Overrides:

getConstantState in class LayerDrawable

mutate

public android.graphics.drawable.Drawable mutate()

Overrides:

mutate in class LayerDrawable

getBackground

public android.graphics.drawable.Drawable getBackground()

Specified by:

getBackground in interface RippleDrawable

getStyle

public RippleDrawable.Style getStyle()

Specified by:

getStyle in interface RippleDrawable

isHotspotEnabled

public boolean isHotspotEnabled()

Specified by:

isHotspotEnabled in interface RippleDrawable

setHotspotEnabled

public void setHotspotEnabled(boolean useHotspot)

Specified by:

setHotspotEnabled in interface RippleDrawable

getColor

public android.content.res.ColorStateList getColor()

Specified by:

getColor in interface RippleDrawable

getAlpha

public int getAlpha()

Description copied from class: LollipopDrawable

Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

Specified by:

getAlpha in interface AlphaDrawable

Specified by:

getAlpha in interface RippleDrawable

Overrides:

getAlpha in class LayerDrawable