public class RippleDrawable
extends LayerDrawable
java.lang.Object | |||
↳ | android.graphics.drawable.Drawable | ||
↳ | android.graphics.drawable.LayerDrawable | ||
↳ | android.graphics.drawable.RippleDrawable |
可绘制的,显示响应状态变化的连锁反应。 给定状态的波动的锚定位置可以通过用相应的状态属性标识符调用setHotspot(float, float)
来指定。
触摸反馈drawable可能包含多个子图层,其中包括未绘制到屏幕的特殊遮罩图层。 通过指定android:id
值为mask
可以将单层设置为来自XML的掩码。 在运行时,可以使用setId(..., android.R.id.mask)
将单个图层设置为蒙setId(..., android.R.id.mask)
或者可以使用setDrawableByLayerId(android.R.id.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>
如果设置了遮罩层,则在将其绘制在其余子层的合成物上之前,将会将该波纹效果遮蔽在该层上。
如果没有设置遮罩层,则会对子层的合成物遮挡纹波效果。
<!-- 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>
如果未指定子图层或遮罩,并且将波动设置为查看背景,则波动将绘制在视图的层次结构中第一个可用的父背景上。 在这种情况下,绘图区域可能会延伸到可绘制边界之外。
<!-- An unbounded red ripple. --/>
<ripple android:color="#ffff0000" />
XML attributes |
|
---|---|
android:color |
The color to use for ripple effects. |
android:radius |
The radius of the ripple when fully expanded. |
Inherited XML attributes |
|
---|---|
From class android.graphics.drawable.LayerDrawable
|
Constants |
|
---|---|
int |
RADIUS_AUTO 指定波纹半径的半径值应根据波纹容器的大小进行计算。 |
Inherited constants |
---|
From class android.graphics.drawable.LayerDrawable
|
Public constructors |
|
---|---|
RippleDrawable(ColorStateList color, Drawable content, Drawable mask) 用指定的波纹颜色和可选的内容和遮罩可绘制创建一个新的波纹。 |
Public methods |
|
---|---|
void |
applyTheme(Resources.Theme t) 将指定的主题应用于此Drawable及其子项。 |
boolean |
canApplyTheme() |
void |
draw(Canvas canvas) 针对遮罩层和可选内容绘制涟漪进行了优化。 |
Drawable.ConstantState |
getConstantState() 返回保存此Drawable的共享状态的 |
Rect |
getDirtyBounds() 返回drawable的脏边界Rect。 |
void |
getHotspotBounds(Rect outRect) 用热点边界填充 |
int |
getOpacity() 返回此Drawable的不透明度/透明度。 |
void |
getOutline(Outline outline) 用第一个可用图层轮廓填充 |
int |
getRadius() |
void |
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) 从可选的由主题设计的XML资源中扩展此Drawable。 |
void |
invalidateSelf() 使用当前的 |
boolean |
isStateful() 指示此drawable是否会根据状态更改其外观。 |
void |
jumpToCurrentState() 如果此Drawable确实在状态之间转换动画,请求它立即跳转到当前状态并跳过任何活动动画。 |
Drawable |
mutate() 使这个drawable可变。 |
void |
setColor(ColorStateList color) 设置波纹颜色。 |
boolean |
setDrawableByLayerId(int id, Drawable drawable) 用给定的ID替换 |
void |
setHotspot(float x, float y) 指定可绘制内的热点位置。 |
void |
setHotspotBounds(int left, int top, int right, int bottom) 设置热点受限的边界,如果它们应该与可绘制边界不同。 |
void |
setPaddingMode(int mode) 指定图层填充应该如何影响后续图层的边界。 |
void |
setRadius(int radius) 设置完全展开纹波的半径(以像素为单位)。 |
boolean |
setVisible(boolean visible, boolean restart) 设置此Drawable是否可见。 |
Protected methods |
|
---|---|
void |
onBoundsChange(Rect bounds) 如果您根据边界而变化,请在您的子类中覆盖此内容以更改外观。 |
boolean |
onStateChange(int[] stateSet) 如果您认识到指定的状态,请在您的子类中覆盖此内容以更改外观。 |
Inherited methods |
|
---|---|
From class android.graphics.drawable.LayerDrawable
|
|
From class android.graphics.drawable.Drawable
|
|
From class java.lang.Object
|
|
From interface android.graphics.drawable.Drawable.Callback
|
用于涟漪效果的颜色。 该属性是必需的。
必须是“ #rgb
”,“ #argb
”,“ #rrggbb
”或“ #aarrggbb
”形式的颜色值。
这也可以是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 color
。
相关方法:
波纹半径完全展开时。 默认情况下,半径是根据波纹容器的大小计算出来的。
必须是维度值,这是一个浮点数,后面跟着一个单位,例如“ 14.5sp
”。 可用单位为:px(像素),dp(密度独立像素),sp(基于首选字体大小的缩放像素),单位为英寸,毫米(毫米)。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 radius
。
相关方法:
RippleDrawable (ColorStateList color, Drawable content, Drawable mask)
用指定的波纹颜色和可选的内容和遮罩可绘制创建一个新的波纹。
Parameters | |
---|---|
color |
ColorStateList : The ripple color |
content |
Drawable : The content drawable, may be null |
mask |
Drawable : The mask drawable, may be null |
void applyTheme (Resources.Theme t)
将指定的主题应用于此Drawable及其子项。
Parameters | |
---|---|
t |
Resources.Theme : the theme to apply |
void draw (Canvas canvas)
针对遮罩层和可选内容绘制涟漪进行了优化。
Parameters | |
---|---|
canvas |
Canvas : The canvas to draw into |
Drawable.ConstantState getConstantState ()
返回保存此Drawable的共享状态的 Drawable.ConstantState
实例。
Returns | |
---|---|
Drawable.ConstantState |
The ConstantState associated to that Drawable. |
Rect getDirtyBounds ()
返回drawable的脏边界Rect。 注意:为了提高效率,返回的对象可能是存储在drawable中的相同对象(尽管这不能保证)。
默认情况下,这将返回完整的可绘制边界。 自定义绘图可能会重写此方法以执行更精确的失效。
Returns | |
---|---|
Rect |
The dirty bounds of this drawable |
void getHotspotBounds (Rect outRect)
用热点边界填充 outRect
。
Parameters | |
---|---|
outRect |
Rect : the rect to populate with the hotspot bounds |
int getOpacity ()
返回此Drawable的不透明度/透明度。 返回的值是在抽象格式常数之一PixelFormat
: UNKNOWN
, TRANSLUCENT
, TRANSPARENT
,或OPAQUE
。
OPAQUE drawable是一个绘制所有内容的范围,完全覆盖drawable后面的所有内容。 一个TRANSPARENT drawable是一个在其范围内没有绘制任何东西的图形,允许它后面的所有东西都显示出来。 TRANSLUCENT drawable是任何其他状态中的drawable,drawable将绘制其边界内的一些内容,但不是全部内容,并且至少drawable后面的某些内容将可见。 如果无法确定可绘制内容的可见性,则最安全/最佳返回值为TRANSLUCENT。
一般而言,Drawable应该尽可能保守并且返回值。 例如,如果它包含多个子drawable,并且一次只显示其中一个,如果只有一个子项是TRANSLUCENT,而其他子项是OPAQUE,则应返回TRANSLUCENT。 您可以使用方法resolveOpacity(int, int)
将两个不透明度标准减少到适当的单个输出。
请注意,返回的值不一定会考虑客户端通过setAlpha(int)
或setColorFilter(ColorFilter)
方法应用的自定义alpha或颜色过滤器。 一些子类,比如BitmapDrawable
, ColorDrawable
,并GradientDrawable
,对价值做账setAlpha(int)
,但总的行为是依赖于子类实现的。
Returns | |
---|---|
int |
int The opacity class of the Drawable. |
void getOutline (Outline outline)
用第一个可用图层轮廓填充 outline
,不包括遮罩层。
Parameters | |
---|---|
outline |
Outline : Outline in which to place the first available layer outline |
int getRadius ()
相关XML属性:
Returns | |
---|---|
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 |
void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
从可选的由主题设计的XML资源中扩展此Drawable。 对于每个Drawable,这不能被调用一次以上。 请注意,框架可能已经调用过这一次从XML资源创建Drawable实例。
Parameters | |
---|---|
r |
Resources : Resources used to resolve attribute values |
parser |
XmlPullParser : XML parser from which to inflate this Drawable |
attrs |
AttributeSet : Base set of attribute values |
theme |
Resources.Theme : Theme to apply, may be null |
Throws | |
---|---|
XmlPullParserException |
|
IOException |
void invalidateSelf ()
使用当前的Drawable.Callback
实现将此Drawable重绘。 如果Drawable没有附加回调,则不执行任何操作。
boolean isStateful ()
指示此drawable是否会根据状态更改其外观。 客户可以使用它来确定是否有必要计算它们的状态并调用setState。
Returns | |
---|---|
boolean |
True if this drawable changes its appearance based on state, false otherwise. |
void jumpToCurrentState ()
如果此Drawable确实在状态之间转换动画,请求它立即跳转到当前状态并跳过任何活动动画。
Drawable mutate ()
使这个drawable可变。 这个操作不能逆转。 一个可变的drawable保证不与其他drawable共享它的状态。 当你需要修改从资源加载的drawable的属性时,这是特别有用的。 默认情况下,从同一资源加载的所有可绘制实例共享一个公共状态; 如果修改一个实例的状态,则所有其他实例都将收到相同的修改。 在可变Drawable上调用此方法将不起作用。
Returns | |
---|---|
Drawable |
This drawable. |
void setColor (ColorStateList color)
设置波纹颜色。
相关XML属性:
Parameters | |
---|---|
color |
ColorStateList : Ripple color as a color state list. |
boolean setDrawableByLayerId (int id, Drawable drawable)
用给定的ID替换 Drawable
。
Parameters | |
---|---|
id |
int : The layer ID to search for. |
drawable |
Drawable : The replacement Drawable . |
Returns | |
---|---|
boolean |
Whether the Drawable was replaced (could return false if the id was not found). |
void setHotspot (float x, float y)
指定可绘制内的热点位置。
Parameters | |
---|---|
x |
float : The X coordinate of the center of the hotspot |
y |
float : The Y coordinate of the center of the hotspot |
void setHotspotBounds (int left, int top, int right, int bottom)
设置热点受限的边界,如果它们应该与可绘制边界不同。
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 |
void setPaddingMode (int mode)
指定图层填充应该如何影响后续图层的边界。 RippleDrawable的默认值和推荐值是PADDING_MODE_STACK
。
Parameters | |
---|---|
mode |
int : padding mode, one of:
|
也可以看看:
void setRadius (int radius)
设置完全展开纹波的半径(以像素为单位)。
相关XML属性:
Parameters | |
---|---|
radius |
int : ripple radius in pixels, or RADIUS_AUTO to compute the radius based on the container size |
boolean setVisible (boolean visible, boolean restart)
设置此Drawable是否可见。 这通常不会影响Drawable的行为,但它是一些可供Drawables使用的提示,例如,可以决定是否运行动画。
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. |
void onBoundsChange (Rect bounds)
如果您根据边界而变化,请在您的子类中覆盖此内容以更改外观。
Parameters | |
---|---|
bounds |
Rect
|
boolean onStateChange (int[] stateSet)
如果您认识到指定的状态,请在您的子类中覆盖此内容以更改外观。
Parameters | |
---|---|
stateSet |
int
|
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. |