RippleDrawable
open class RippleDrawable : LayerDrawable
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 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, ...)
.
<code><!-- A red ripple masked against an opaque rectangle. -->
<ripple android:color="#ffff0000">
<item android:id="@android:id/mask"
android:drawable="@android:color/white" />
</ripple></code>
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.
<code><!-- 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></code>
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.
<code><!-- An unbounded red ripple. -->
<ripple android:color="#ffff0000" /></code>
Summary
XML attributes |
android:color |
The color to use for ripple effects. |
Inherited XML attributes |
From class LayerDrawable
android:bottom |
Bottom inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:drawable |
Drawable used to render the layer.
May be a reference to another resource, in the form "@[+][package:]type/name " or a theme attribute in the form "?[package:]type/name ".
|
android:end |
End inset to apply to the layer. Overrides left or right depending on layout direction.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:gravity |
Gravity used to align the layer within its container. If no value is specified, the default behavior depends on whether an explicit width or height has been set, If no dimension is set, gravity in that direction defaults to fill_horizontal or fill_vertical ; otherwise, it defaults to left or top .
Must be one or more (separated by '|') of the following constant values.
Constant |
Value |
Description |
bottom |
50 |
Push object to the bottom of its container, not changing its size. |
center |
11 |
Place the object in the center of its container in both the vertical and horizontal axis, not changing its size. |
center_horizontal |
1 |
Place object in the horizontal center of its container, not changing its size. |
center_vertical |
10 |
Place object in the vertical center of its container, not changing its size. |
clip_horizontal |
8 |
Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges. |
clip_vertical |
80 |
Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges. |
end |
800005 |
Push object to the end of its container, not changing its size. |
fill |
77 |
Grow the horizontal and vertical size of the object if needed so it completely fills its container. |
fill_horizontal |
7 |
Grow the horizontal size of the object if needed so it completely fills its container. |
fill_vertical |
70 |
Grow the vertical size of the object if needed so it completely fills its container. |
left |
3 |
Push object to the left of its container, not changing its size. |
right |
5 |
Push object to the right of its container, not changing its size. |
start |
800003 |
Push object to the beginning of its container, not changing its size. |
top |
30 |
Push object to the top of its container, not changing its size. |
|
android:height |
Height of the layer. Defaults to the layer's intrinsic height.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:id |
Identifier of the layer. This can be used to retrieve the layer from a drawable container.
May be a reference to another resource, in the form "@[+][package:]type/name " or a theme attribute in the form "?[package:]type/name ".
|
android:left |
Left inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:paddingMode |
Indicates how layer padding should affect the bounds of subsequent layers. The default padding mode value is nest.
Must be one of the following constant values.
Constant |
Value |
Description |
nest |
0 |
Nest each layer inside the padding of the previous layer. |
stack |
1 |
Stack each layer directly atop the previous layer. |
|
android:right |
Right inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:start |
Start inset to apply to the layer. Overrides left or right depending on layout direction.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:top |
Top inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).
|
android:width |
Width of the layer. Defaults to the layer's intrinsic width.
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).
|
|
Constants |
static Int |
Radius value that specifies the ripple radius should be computed based on the size of the ripple's container.
|
Public constructors |
Creates a new ripple drawable with the specified ripple color and optional content and mask drawables.
|
Public methods |
open Unit |
Applies the specified theme to this Drawable and its children.
|
open Boolean |
|
open Unit |
Optimized for drawing ripples with a mask layer and optional content.
|
open Drawable.ConstantState? |
|
open Rect |
|
open ColorStateList |
|
open Unit |
|
open Int |
|
open Unit |
Populates outline with the first available layer outline, excluding the mask layer.
|
open Int |
|
open Boolean |
|
open Unit |
Inflate this Drawable from an XML resource optionally styled by a theme.
|
open Unit |
|
open Boolean |
|
open Unit |
|
open Drawable |
|
open Unit |
Sets the ripple color.
|
open Boolean |
|
open Unit |
Sets the ripple effect color.
|
open Unit |
|
open Unit |
|
open Unit |
Specifies how layer padding should affect the bounds of subsequent layers.
|
open Unit |
Sets the radius in pixels of the fully expanded ripple.
|
open Boolean |
|
Inherited functions |
From class LayerDrawable
Int |
addLayer(dr: Drawable!)
Adds a new layer containing the specified drawable to the end of the layer list and returns its index.
|
Drawable! |
findDrawableByLayerId(id: Int)
Looks for a layer with the given ID and returns its Drawable .
If multiple layers are found for the given ID, returns the Drawable for the matching layer at the highest index.
|
Int |
findIndexByLayerId(id: Int)
Returns the layer with the specified id .
If multiple layers have the same ID, returns the layer with the lowest index.
|
Int |
getAlpha()
|
Int |
getBottomPadding()
Returns the bottom padding in pixels.
A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode() .
|
Int |
getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. The default implementation returns whatever was provided through setChangingConfigurations(int) or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.
|
Drawable! |
getDrawable(index: Int)
Returns the drawable for the layer at the specified index.
|
Int |
getEndPadding()
Returns the end padding in pixels.
A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode() .
|
Int |
getId(index: Int)
Returns the ID of the specified layer.
|
Int |
getIntrinsicHeight()
|
Int |
getIntrinsicWidth()
|
Int |
getLayerGravity(index: Int)
|
Int |
getLayerHeight(index: Int)
|
Int |
getLayerInsetBottom(index: Int)
|
Int |
getLayerInsetEnd(index: Int)
|
Int |
getLayerInsetLeft(index: Int)
|
Int |
getLayerInsetRight(index: Int)
|
Int |
getLayerInsetStart(index: Int)
|
Int |
getLayerInsetTop(index: Int)
|
Int |
getLayerWidth(index: Int)
|
Int |
getLeftPadding()
Returns the left padding in pixels.
A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode() .
|
Int |
getNumberOfLayers()
Returns the number of layers contained within this layer drawable.
|
Boolean |
getPadding(padding: Rect)
|
Int |
getPaddingMode()
|
Int |
getRightPadding()
Returns the right padding in pixels.
A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode() .
|
Int |
getStartPadding()
Returns the start padding in pixels.
A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode() .
|
Int |
getTopPadding()
Returns the top padding in pixels.
A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode() .
|
Unit |
invalidateDrawable(who: Drawable)
Called when the drawable needs to be redrawn. A view at this point should invalidate itself (or at least the part of itself where the drawable appears).
|
Boolean |
isAutoMirrored()
|
Boolean |
onLayoutDirectionChanged(layoutDirection: Int)
Called when the drawable's resolved layout direction changes.
|
Boolean |
onLevelChange(level: Int)
|
Unit |
scheduleDrawable(who: Drawable, what: Runnable, when: Long)
A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call android.os.Handler#postAtTime(Runnable, Object, long) with the parameters (what, who, when) to perform the scheduling.
|
Unit |
setAlpha(alpha: Int)
|
Unit |
setAutoMirrored(mirrored: Boolean)
|
Unit |
setColorFilter(colorFilter: ColorFilter?)
|
Unit |
setDither(dither: Boolean)
|
Unit |
setDrawable(index: Int, drawable: Drawable!)
Sets the drawable for the layer at the specified index.
|
Unit |
setId(index: Int, id: Int)
Sets the ID of a layer.
|
Unit |
setLayerGravity(index: Int, gravity: Int)
Sets the gravity used to position or stretch the specified layer within its container. Gravity is applied after any layer insets (see setLayerInset(int,int,int,int,int) ) or padding (see setPaddingMode(int) ).
If gravity is specified as Gravity#NO_GRAVITY , the default behavior depends on whether an explicit width or height has been set (see setLayerSize(int,int,int) ), If a dimension is not set, gravity in that direction defaults to Gravity#FILL_HORIZONTAL or Gravity#FILL_VERTICAL ; otherwise, gravity in that direction defaults to Gravity#LEFT or Gravity#TOP .
|
Unit |
setLayerHeight(index: Int, h: Int)
|
Unit |
setLayerInset(index: Int, l: Int, t: Int, r: Int, b: Int)
Specifies the insets in pixels for the drawable at the specified index.
|
Unit |
setLayerInsetBottom(index: Int, b: Int)
|
Unit |
setLayerInsetEnd(index: Int, e: Int)
|
Unit |
setLayerInsetLeft(index: Int, l: Int)
|
Unit |
setLayerInsetRelative(index: Int, s: Int, t: Int, e: Int, b: Int)
Specifies the relative insets in pixels for the drawable at the specified index.
|
Unit |
setLayerInsetRight(index: Int, r: Int)
|
Unit |
setLayerInsetStart(index: Int, s: Int)
|
Unit |
setLayerInsetTop(index: Int, t: Int)
|
Unit |
setLayerSize(index: Int, w: Int, h: Int)
Sets an explicit size for the specified layer.
Note: Setting an explicit layer size changes the default layer gravity behavior. See setLayerGravity(int,int) for more information.
|
Unit |
setLayerWidth(index: Int, w: Int)
|
Unit |
setOpacity(opacity: Int)
Sets the opacity of this drawable directly instead of collecting the states from the layers.
|
Unit |
setPadding(left: Int, top: Int, right: Int, bottom: Int)
Sets the absolute padding.
If padding in a dimension is specified as -1 , the resolved padding will use the value computed according to the padding mode (see setPaddingMode(int) ).
Calling this method clears any relative padding values previously set using setPaddingRelative(int,int,int,int) .
|
Unit |
setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)
Sets the relative padding.
If padding in a dimension is specified as -1 , the resolved padding will use the value computed according to the padding mode (see setPaddingMode(int) ).
Calling this method clears any absolute padding values previously set using setPadding(int,int,int,int) .
|
Unit |
setTintBlendMode(blendMode: BlendMode!)
Specifies a tint blending mode for this drawable.
Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is BlendMode#SRC_IN .
Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)
|
Unit |
setTintList(tint: ColorStateList?)
|
Unit |
unscheduleDrawable(who: Drawable, what: Runnable)
A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable . An implementation can generally simply call android.os.Handler#removeCallbacks(Runnable, Object) with the parameters (what, who) to unschedule the drawable.
|
|
From class Drawable
Unit |
clearColorFilter()
Removes the color filter for this drawable.
|
Unit |
copyBounds(bounds: Rect)
Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
|
Rect |
copyBounds()
Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
|
Drawable? |
createFromPath(pathName: String!)
Create a drawable from file path name.
|
Drawable? |
createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)
Create a drawable from an inputstream, using the given resources and value to determine density information.
|
Drawable? |
createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)
Create a drawable from an inputstream, using the given resources and value to determine density information.
|
Drawable? |
createFromStream(is: InputStream?, srcName: String?)
Create a drawable from an inputstream
|
Drawable |
createFromXml(r: Resources, parser: XmlPullParser)
Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
|
Drawable |
createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)
Create a drawable from an XML document using an optional Theme . For more information on how to create resources in XML, see Drawable Resources.
|
Drawable |
createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)
Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
|
Drawable |
createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)
Create a drawable from inside an XML document using an optional Theme . Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
|
Rect |
getBounds()
Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
|
Drawable.Callback? |
getCallback()
Return the current Callback implementation attached to this Drawable.
|
ColorFilter? |
getColorFilter()
Returns the current color filter, or null if none set.
|
Drawable |
getCurrent()
|
Rect |
getDirtyBounds()
Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed).
By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
|
Int |
getLayoutDirection()
Returns the resolved layout direction for this Drawable.
|
Int |
getLevel()
Retrieve the current level.
|
Int |
getMinimumHeight()
Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
|
Int |
getMinimumWidth()
Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
|
Insets |
getOpticalInsets()
Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
|
IntArray |
getState()
Describes the current state, as a union of primitive states, such as android.R.attr#state_focused , android.R.attr#state_selected , etc. Some drawables may modify their imagery based on the selected state.
|
Region? |
getTransparentRegion()
Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
|
Unit |
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)
Inflate this Drawable from an XML resource. Does not apply a theme.
|
Unit |
invalidateSelf()
Use the current Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
|
Boolean |
isFilterBitmap()
|
Boolean |
isVisible()
|
Int |
resolveOpacity(op1: Int, op2: Int)
Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned.
This is to help in implementing getOpacity .
|
Unit |
scheduleSelf(what: Runnable, when: Long)
Use the current Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
|
Unit |
setBounds(left: Int, top: Int, right: Int, bottom: Int)
Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
|
Unit |
setBounds(bounds: Rect)
Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
|
Unit |
setCallback(cb: Drawable.Callback?)
Bind a Callback object to this Drawable. Required for clients that want to support animated drawables.
|
Unit |
setChangingConfigurations(configs: Int)
Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
|
Unit |
setColorFilter(color: Int, mode: PorterDuff.Mode)
Specify a color and Porter-Duff mode to be the color filter for this drawable.
Convenience for setColorFilter(android.graphics.ColorFilter) which constructs a PorterDuffColorFilter .
Note: Setting a color filter disables tint .
|
Unit |
setFilterBitmap(filter: Boolean)
Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored.
|
Boolean |
setLayoutDirection(layoutDirection: Int)
Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
|
Boolean |
setLevel(level: Int)
Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level.
If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function.
|
Boolean |
setState(stateSet: IntArray)
Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [android.R.attr#state_focused , android.R.attr#state_pressed ].
If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function.
Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
|
Unit |
setTint(tintColor: Int)
Specifies tint color for this drawable.
A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to setColorFilter(int,android.graphics.PorterDuff.Mode) .
To clear the tint, pass null to setTintList(android.content.res.ColorStateList) .
Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint.
|
Unit |
setTintMode(tintMode: PorterDuff.Mode?)
Specifies a tint blending mode for this drawable.
Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is PorterDuff.Mode#SRC_IN .
Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint.
|
Unit |
unscheduleSelf(what: Runnable)
Use the current Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.
|
|
XML attributes
android:color
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
".
Constants
RADIUS_AUTO
static val RADIUS_AUTO: Int
Radius value that specifies the ripple radius should be computed based on the size of the ripple's container.
Value: -1
Public constructors
RippleDrawable
RippleDrawable(
color: ColorStateList,
content: Drawable?,
mask: Drawable?)
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
open fun applyTheme(t: Resources.Theme): Unit
Applies the specified theme to this Drawable and its children.
canApplyTheme
open fun canApplyTheme(): Boolean
draw
open fun draw(canvas: Canvas): Unit
Optimized for drawing ripples with a mask layer and optional content.
Parameters |
canvas |
Canvas: This value cannot be null . |
getDirtyBounds
open fun getDirtyBounds(): Rect
Return |
Rect |
The dirty bounds of this drawable This value cannot be null . |
getEffectColor
open fun getEffectColor(): ColorStateList
Return |
ColorStateList |
The ripple effect color as a color state list. This value cannot be null . |
getHotspotBounds
open fun getHotspotBounds(outRect: Rect): Unit
Parameters |
outRect |
Rect: the rect to populate with the hotspot bounds This value cannot be null . |
getOpacity
open fun getOpacity(): Int
getOutline
open fun getOutline(outline: Outline): Unit
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
open fun getRadius(): Int
Return |
Int |
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 |
hasFocusStateSpecified
open fun hasFocusStateSpecified(): Boolean
inflate
open fun inflate(
r: Resources,
parser: XmlPullParser,
attrs: AttributeSet,
theme: Resources.Theme?
): Unit
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.
Exceptions |
org.xmlpull.v1.XmlPullParserException |
|
java.io.IOException |
|
invalidateSelf
open fun invalidateSelf(): Unit
isStateful
open fun isStateful(): Boolean
Return |
Boolean |
True if this drawable changes its appearance based on state, false otherwise. |
jumpToCurrentState
open fun jumpToCurrentState(): Unit
mutate
open fun mutate(): Drawable
Return |
Drawable |
This drawable. This value cannot be null . |
setColor
open fun setColor(color: ColorStateList): Unit
Sets the ripple color.
Parameters |
color |
ColorStateList: Ripple color as a color state list. This value cannot be null . |
setDrawableByLayerId
open fun setDrawableByLayerId(
id: Int,
drawable: Drawable!
): Boolean
Return |
Boolean |
Whether the Drawable was replaced (could return false if the id was not found). |
setEffectColor
open fun setEffectColor(color: ColorStateList): Unit
Sets the ripple effect color.
Parameters |
color |
ColorStateList: Ripple color as a color state list. This value cannot be null . |
setHotspot
open fun setHotspot(
x: Float,
y: Float
): Unit
Parameters |
x |
Float: The X coordinate of the center of the hotspot |
y |
Float: The Y coordinate of the center of the hotspot |
setHotspotBounds
open fun setHotspotBounds(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
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
open fun setPaddingMode(mode: Int): Unit
Specifies how layer padding should affect the bounds of subsequent layers. The default and recommended value for RippleDrawable is PADDING_MODE_STACK
.
Parameters |
mode |
Int: padding mode, one of:
|
setRadius
open fun setRadius(radius: Int): Unit
Sets the radius in pixels of the fully expanded ripple.
Parameters |
radius |
Int: ripple radius in pixels, or RADIUS_AUTO to compute the radius based on the container size |
setVisible
open fun setVisible(
visible: Boolean,
restart: Boolean
): Boolean
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. |
Return |
Boolean |
boolean Returns true if the new visibility is different than its previous state. |
Protected methods
onBoundsChange
protected open fun onBoundsChange(bounds: Rect): Unit
Parameters |
bounds |
Rect: This value cannot be null . |
onStateChange
protected open fun onStateChange(stateSet: IntArray): Boolean
Parameters |
state |
This value cannot be null . |
Return |
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. |