public class ShapeDrawable
extends Drawable
java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.ShapeDrawable |
Known Direct Subclasses |
绘制原始形状的可绘制对象。 ShapeDrawable需要一个Shape
对象并管理其在屏幕上的存在。 如果没有给出Shape,那么ShapeDrawable默认为RectShape
。
可以使用 <shape>
元素在XML文件中定义此对象。
有关如何使用ShapeDrawable的更多信息,请阅读Canvas and Drawables文档。 有关在XML中定义ShapeDrawable的更多信息,请阅读Drawable Resources文档。
Nested classes |
|
---|---|
class |
ShapeDrawable.ShaderFactory 基类定义了一个工厂对象,每当drawable被调整大小(有一个新的宽度或高度)时被调用。 |
XML attributes |
|
---|---|
android:bottom |
Bottom padding. |
android:color |
Defines the color of the shape. |
android:height |
Defines the height of the shape. |
android:left |
Left padding. |
android:right |
Right padding. |
android:top |
Top padding. |
android:width |
Defines the width of the shape. |
Public constructors |
|
---|---|
ShapeDrawable() ShapeDrawable构造函数。 |
|
ShapeDrawable(Shape s) 用指定的Shape创建一个ShapeDrawable。 |
Public methods |
|
---|---|
void |
applyTheme(Resources.Theme t) 将指定的主题应用于此Drawable及其子项。 |
void |
draw(Canvas canvas) 在其边界(通过setBounds设置)中绘制,考虑可选效果,如alpha(通过setAlpha设置)和color filter(通过setColorFilter设置)。 |
int |
getAlpha() 获取drawable的当前alpha值。 |
int |
getChangingConfigurations() 返回此drawable可能更改的配置参数的掩码,要求重新创建它。 |
Drawable.ConstantState |
getConstantState() 返回保存此Drawable的共享状态的 |
int |
getIntrinsicHeight() 返回drawable的内在高度。 |
int |
getIntrinsicWidth() 返回drawable的内部宽度。 |
int |
getOpacity() 返回此Drawable的不透明度/透明度。 |
void |
getOutline(Outline outline) 调用drawable来填充定义其绘图区域的Outline。 |
boolean |
getPadding(Rect padding) 返回填充此Drawable建议的插入内容以将内容放入drawable的边界内。 |
Paint |
getPaint() 返回用于绘制形状的Paint。 |
ShapeDrawable.ShaderFactory |
getShaderFactory() 返回此ShapeDrawable用于请求 |
Shape |
getShape() 返回此ShapeDrawable的形状。 |
void |
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) 从可选的由主题设计的XML资源中扩展此Drawable。 |
boolean |
isStateful() 指示此drawable是否会根据状态更改其外观。 |
Drawable |
mutate() 使这个drawable可变。 |
void |
setAlpha(int alpha) 为这个可绘制的[0..255]设置阿尔法等级。 |
void |
setColorFilter(ColorFilter colorFilter) 为绘图指定一个可选的颜色过滤器。 |
void |
setDither(boolean dither) 此方法已弃用。 该属性被忽略。 |
void |
setIntrinsicHeight(int height) 设置此形状的内在(默认)高度。 |
void |
setIntrinsicWidth(int width) 设置此形状的内在(默认)宽度。 |
void |
setPadding(Rect padding) 为由Rect对象定义的此形状设置填充。 |
void |
setPadding(int left, int top, int right, int bottom) 为形状设置填充。 |
void |
setShaderFactory(ShapeDrawable.ShaderFactory fact) 设置一个ShaderFactory,其中将创建 |
void |
setShape(Shape s) 设置此ShapeDrawable的形状。 |
void |
setTintList(ColorStateList tint) 指定该drawable的色彩颜色作为颜色状态列表。 |
void |
setTintMode(PorterDuff.Mode tintMode) 指定该drawable的色调混合模式。 |
Protected methods |
|
---|---|
boolean |
inflateTag(String name, Resources r, XmlPullParser parser, AttributeSet attrs) 子类重写此分析自定义子元素。 |
void |
onBoundsChange(Rect bounds) 如果您根据边界而变化,请在您的子类中覆盖此内容以更改外观。 |
void |
onDraw(Shape shape, Canvas canvas, Paint paint) 画布设置为在(0,0)处绘制形状后,从drawable的draw()方法调用。 |
boolean |
onStateChange(int[] stateSet) 如果您认识到指定的状态,请在您的子类中覆盖此内容以更改外观。 |
Inherited methods |
|
---|---|
From class android.graphics.drawable.Drawable
|
|
From class java.lang.Object
|
底部填充。
必须是一个维度值,这是一个浮点数,后面跟着一个单位,例如“ 14.5sp
”。 可用单位为:px(像素),dp(密度独立像素),sp(基于首选字体大小的缩放像素),单位为英寸,毫米(毫米)。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 bottom
。
定义形状的颜色。
必须是“ #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
。
这对应于全局属性资源符号 height
。
左填充。
必须是尺寸值,这是一个浮点数,后面跟着一个单位,例如“ 14.5sp
”。 可用单位为:px(像素),dp(密度独立像素),sp(基于首选字体大小的缩放像素),单位为英寸,毫米(毫米)。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 left
。
正确的填充。
必须是尺寸值,这是一个浮点数,后面跟着一个单位,例如“ 14.5sp
”。 可用单位为:px(像素),dp(密度独立像素),sp(基于首选字体大小的缩放像素),单位为英寸,毫米(毫米)。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 right
。
顶部填充。
必须是一个维度值,这是一个浮点数,后面跟着一个单位,例如“ 14.5sp
”。 可用单位为:px(像素),dp(密度独立像素),sp(基于首选字体大小的缩放像素),单位为英寸,毫米(毫米)。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 top
。
定义形状的宽度。
必须是尺寸值,这是一个浮点数,后面跟着诸如“ 14.5sp
”之类的单位。 可用单位为:px(像素),dp(密度独立像素),sp(基于首选字体大小的缩放像素),单位为英寸,毫米(毫米)。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 width
。
ShapeDrawable (Shape s)
用指定的Shape创建一个ShapeDrawable。
Parameters | |
---|---|
s |
Shape : the Shape that this ShapeDrawable should be |
void applyTheme (Resources.Theme t)
将指定的主题应用于此Drawable及其子项。
Parameters | |
---|---|
t |
Resources.Theme : the theme to apply |
void draw (Canvas canvas)
在其边界(通过setBounds设置)中绘制,考虑可选效果,如alpha(通过setAlpha设置)和color filter(通过setColorFilter设置)。
Parameters | |
---|---|
canvas |
Canvas : The canvas to draw into |
int getAlpha ()
获取drawable的当前alpha值。 0表示完全透明,255表示完全不透明。 该方法由Drawable子类实现,返回的值特定于该类如何处理alpha。 如果该类未覆盖此方法以返回特定于其使用alpha的值,则默认返回值为255。
Returns | |
---|---|
int |
int getChangingConfigurations ()
返回此drawable可能更改的配置参数的掩码,要求重新创建它。 默认实现返回默认情况下通过setChangingConfigurations(int)
或0提供的内容。 子类可以将其扩展到它们所拥有的任何其他drawable的变化配置中或其中。
Returns | |
---|---|
int |
Returns a mask of the changing configuration parameters, as defined by ActivityInfo . |
Drawable.ConstantState getConstantState ()
返回保存此Drawable的共享状态的 Drawable.ConstantState
实例。
Returns | |
---|---|
Drawable.ConstantState |
The ConstantState associated to that Drawable. |
int getIntrinsicHeight ()
返回drawable的内在高度。
固有高度是可拉伸的布局高度,包括任何固有的填充。 如果drawable没有固有的高度,例如纯色,则此方法返回-1。
Returns | |
---|---|
int |
the intrinsic height, or -1 if no intrinsic height |
int getIntrinsicWidth ()
返回drawable的内部宽度。
固有宽度是可展开的布局的宽度,包括任何固有的填充。 如果drawable没有固有的宽度,例如纯色,则此方法返回-1。
Returns | |
---|---|
int |
the intrinsic width, or -1 if no intrinsic width |
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)
调用drawable来填充定义其绘图区域的Outline。
此方法由默认的 ViewOutlineProvider
以定义视图的轮廓。
默认行为将轮廓定义为0 alpha的边界矩形。 希望传达不同形状或阿尔法值的子类必须重写此方法。
Parameters | |
---|---|
outline |
Outline
|
boolean getPadding (Rect padding)
返回填充此Drawable建议的插入内容以将内容放入drawable的边界内。 正值移向Drawable的中心(设置Rect.inset)。
Parameters | |
---|---|
padding |
Rect
|
Returns | |
---|---|
boolean |
true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0. |
ShapeDrawable.ShaderFactory getShaderFactory ()
返回此ShapeDrawable用于请求 Shader
。
Returns | |
---|---|
ShapeDrawable.ShaderFactory |
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 |
boolean isStateful ()
指示此drawable是否会根据状态更改其外观。 客户可以使用它来确定是否有必要计算它们的状态并调用setState。
Returns | |
---|---|
boolean |
True if this drawable changes its appearance based on state, false otherwise. |
Drawable mutate ()
使这个drawable可变。 这个操作不能逆转。 一个可变的drawable保证不与其他drawable共享它的状态。 当你需要修改从资源加载的drawable的属性时,这是特别有用的。 默认情况下,从同一资源加载的所有可绘制实例共享一个公共状态; 如果修改一个实例的状态,则所有其他实例都将收到相同的修改。 在可变Drawable上调用此方法将不起作用。
Returns | |
---|---|
Drawable |
This drawable. |
void setAlpha (int alpha)
为这个可绘制的[0..255]设置阿尔法等级。 请注意,这个drawable在它的paint中也有一个颜色,它也有一个alpha。 这两个值在绘图期间自动合并。 因此,如果颜色的alpha值为75%(即192),并且drawable的alpha值为50%(即128),那么在绘图期间将使用的组合alpha值将为37.5%(即96)。
Parameters | |
---|---|
alpha |
int
|
void setColorFilter (ColorFilter colorFilter)
为绘图指定一个可选的颜色过滤器。
如果Drawable具有ColorFilter,则Drawable的绘图内容的每个输出像素在混合到Canvas的渲染目标之前将被颜色过滤器修改。
通过 null
删除任何现有的颜色过滤器。
注意:设置非 null
颜色过滤器会禁用 tint
。
Parameters | |
---|---|
colorFilter |
ColorFilter : The color filter to apply, or null to remove the existing color filter |
void setDither (boolean dither)
此方法已弃用。
该属性被忽略。
将其设置为true时,绘制到每个颜色分量少于8位的设备时,其可绘制的颜色呈现抖动。
Parameters | |
---|---|
dither |
boolean
|
void setIntrinsicHeight (int height)
设置此形状的内在(默认)高度。
Parameters | |
---|---|
height |
int : the intrinsic height (in pixels) |
void setIntrinsicWidth (int width)
设置此形状的内在(默认)宽度。
Parameters | |
---|---|
width |
int : the intrinsic width (in pixels) |
void setPadding (Rect padding)
为由Rect对象定义的此形状设置填充。 将Rect对象中的填充定义为:left,top,right,bottom。
Parameters | |
---|---|
padding |
Rect
|
void setPadding (int left, int top, int right, int bottom)
为形状设置填充。
Parameters | |
---|---|
left |
int : padding for the left side (in pixels) |
top |
int : padding for the top (in pixels) |
right |
int : padding for the right side (in pixels) |
bottom |
int : padding for the bottom (in pixels) |
void setShaderFactory (ShapeDrawable.ShaderFactory fact)
设置一个ShaderFactory,其中将创建 Shader
对象的请求。
Parameters | |
---|---|
fact |
ShapeDrawable.ShaderFactory : an instance of your ShaderFactory implementation |
void setTintList (ColorStateList tint)
指定该drawable的色彩颜色作为颜色状态列表。
Drawable的绘图内容在绘制到屏幕前将与它的色调混合在一起。 这功能类似于setColorFilter(int, PorterDuff.Mode)
。
注意:通过 setColorFilter(ColorFilter)
或 setColorFilter(int, PorterDuff.Mode)
设置颜色过滤器会覆盖色调。
Parameters | |
---|---|
tint |
ColorStateList : Color state list to use for tinting this drawable, or null to clear the tint |
void setTintMode (PorterDuff.Mode tintMode)
指定该drawable的色调混合模式。
定义在绘制屏幕之前,该绘制的色调应该如何混合到绘图中。 默认色调模式是SRC_IN
。
注意:通过 setColorFilter(ColorFilter)
或 setColorFilter(int, PorterDuff.Mode)
设置颜色过滤器会覆盖色调。
Parameters | |
---|---|
tintMode |
PorterDuff.Mode : A Porter-Duff blending mode |
boolean inflateTag (String name, Resources r, XmlPullParser parser, AttributeSet attrs)
子类重写此分析自定义子元素。 如果你处理它,返回true,否则返回super.inflateTag(...) 。
Parameters | |
---|---|
name |
String
|
r |
Resources
|
parser |
XmlPullParser
|
attrs |
AttributeSet
|
Returns | |
---|---|
boolean |
void onBoundsChange (Rect bounds)
如果您根据边界而变化,请在您的子类中覆盖此内容以更改外观。
Parameters | |
---|---|
bounds |
Rect
|
void onDraw (Shape shape, Canvas canvas, Paint paint)
画布设置为在(0,0)处绘制形状后,从drawable的draw()方法调用。 子类可以覆盖特殊效果,如多个图层,抚摸等。
Parameters | |
---|---|
shape |
Shape
|
canvas |
Canvas
|
paint |
Paint
|
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. |