public class NinePatchDrawable
extends Drawable
java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.NinePatchDrawable |
可调整大小的位图,带有可定义的可伸缩区域。 这种类型的图像是使用特殊格式在.png文件中定义的。
有关如何使用NinePatchDrawable的更多信息,请阅读Canvas and Drawables开发人员指南。 有关使用draw9patch工具创建NinePatch图像文件的信息,请参阅Draw 9-patch工具指南。
Public constructors |
|
---|---|
NinePatchDrawable(Bitmap bitmap, byte[] chunk, Rect padding, String srcName) 此构造函数在API级别4中已被弃用。使用 |
|
NinePatchDrawable(Resources res, Bitmap bitmap, byte[] chunk, Rect padding, String srcName) 根据原始九补丁数据创建drawable,根据资源的显示度量设置初始目标密度。 |
|
NinePatchDrawable(NinePatch patch) 此构造函数在API级别4中已弃用。使用 |
|
NinePatchDrawable(Resources res, NinePatch patch) 从现有的九个补丁创建drawable,根据资源的显示度量设置初始目标密度。 |
Public methods |
|
---|---|
void |
applyTheme(Resources.Theme t) 将指定的主题应用于此Drawable及其子项。 |
boolean |
canApplyTheme() |
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() |
Region |
getTransparentRegion() 返回表示完全透明的Drawable部分的区域。 |
void |
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) 从可选的由主题设计的XML资源中扩展此Drawable。 |
boolean |
isAutoMirrored() 当它的布局方向是从右到左的RTL时,告诉它是否自动镜像。 |
boolean |
isFilterBitmap() |
boolean |
isStateful() 指示此drawable是否会根据状态更改其外观。 |
Drawable |
mutate() 使这个drawable可变。 |
void |
setAlpha(int alpha) 为drawable指定一个alpha值。 |
void |
setAutoMirrored(boolean mirrored) 设置当其布局方向为RTL(从右到左)时,此Drawable是否自动镜像。 |
void |
setColorFilter(ColorFilter colorFilter) 为绘图指定一个可选的颜色过滤器。 |
void |
setDither(boolean dither) 此方法已弃用。 该属性被忽略。 |
void |
setFilterBitmap(boolean filter) 设置为true时,在缩放或旋转时使可绘制滤镜具有双线性采样的位图。 |
void |
setTargetDensity(DisplayMetrics metrics) 设置将绘制该drawable的密度刻度。 |
void |
setTargetDensity(Canvas canvas) 设置将绘制该drawable的密度刻度。 |
void |
setTargetDensity(int density) 设置该drawable将被渲染的密度。 |
void |
setTintList(ColorStateList tint) 指定该drawable的色彩颜色作为颜色状态列表。 |
void |
setTintMode(PorterDuff.Mode tintMode) 指定该drawable的色调混合模式。 |
Protected methods |
|
---|---|
boolean |
onStateChange(int[] stateSet) 如果您认识到指定的状态,请在您的子类中覆盖此内容以更改外观。 |
Inherited methods |
|
---|---|
From class android.graphics.drawable.Drawable
|
|
From class java.lang.Object
|
NinePatchDrawable (Bitmap bitmap, byte[] chunk, Rect padding, String srcName)
此构造函数在API级别4中已被弃用。
使用NinePatchDrawable(Resources, Bitmap, byte[], Rect, String)
以确保绘图工具已正确设置其目标密度。
从原始九块补丁数据创建drawable,而不是处理密度。
Parameters | |
---|---|
bitmap |
Bitmap
|
chunk |
byte
|
padding |
Rect
|
srcName |
String
|
NinePatchDrawable (Resources res, Bitmap bitmap, byte[] chunk, Rect padding, String srcName)
根据原始九补丁数据创建drawable,根据资源的显示度量设置初始目标密度。
Parameters | |
---|---|
res |
Resources
|
bitmap |
Bitmap
|
chunk |
byte
|
padding |
Rect
|
srcName |
String
|
NinePatchDrawable (NinePatch patch)
此构造函数在API级别4中已被弃用。
使用NinePatchDrawable(Resources, NinePatch)
确保绘图已正确设置其目标密度。
从现有的九个补丁创建drawable,而不是处理密度。
Parameters | |
---|---|
patch |
NinePatch
|
NinePatchDrawable (Resources res, NinePatch patch)
从现有的九个补丁创建drawable,根据资源的显示度量设置初始目标密度。
Parameters | |
---|---|
res |
Resources
|
patch |
NinePatch
|
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. |
Region getTransparentRegion ()
返回表示完全透明的Drawable部分的区域。 这可用于执行绘图操作,确定绘制Drawable时目标的哪些部分不会更改。 默认实现返回null,表示没有透明区域; 如果子类想要提供这个优化信息,子类可以选择性地覆盖它以返回一个实际的区域,但并不要求它们这样做。
Returns | |
---|---|
Region |
Returns null if the Drawables has no transparent region to report, else a Region holding the parts of the Drawable's bounds that are transparent. |
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 isAutoMirrored ()
当它的布局方向是从右到左的RTL时,告诉它是否自动镜像。 见LayoutDirection
。
Returns | |
---|---|
boolean |
boolean Returns true if this Drawable will be automatically mirrored. |
boolean isFilterBitmap ()
Returns | |
---|---|
boolean |
whether this drawable filters its bitmaps |
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)
为drawable指定一个alpha值。 0表示完全透明,255表示完全不透明。
Parameters | |
---|---|
alpha |
int
|
void setAutoMirrored (boolean mirrored)
设置当其布局方向为RTL(从右到左)时,此Drawable是否自动镜像。 见LayoutDirection
。
Parameters | |
---|---|
mirrored |
boolean : Set to true if the Drawable should be mirrored, false if not. |
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 setFilterBitmap (boolean filter)
设置为true时,在缩放或旋转时使可绘制滤镜具有双线性采样的位图。
当位图旋转时,这可以改善外观。 如果drawable不使用位图,则该调用将被忽略。
Parameters | |
---|---|
filter |
boolean
|
void setTargetDensity (DisplayMetrics metrics)
设置将绘制该drawable的密度刻度。
Parameters | |
---|---|
metrics |
DisplayMetrics : The DisplayMetrics indicating the density scale for this drawable. |
也可以看看:
void setTargetDensity (Canvas canvas)
设置将绘制该drawable的密度刻度。 该方法假定drawable将以与指定画布相同的密度呈现。
Parameters | |
---|---|
canvas |
Canvas : The Canvas from which the density scale must be obtained. |
也可以看看:
void setTargetDensity (int density)
设置该drawable将被渲染的密度。
Parameters | |
---|---|
density |
int : The density scale for this drawable. |
也可以看看:
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 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. |