PictureDrawable
public
class
PictureDrawable
extends Drawable
java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.PictureDrawable |
Drawable subclass that wraps a Picture, allowing the picture to be used wherever a Drawable is supported.
Summary
Public constructors | |
---|---|
PictureDrawable(Picture picture)
Construct a new drawable referencing the specified picture. |
Public methods | |
---|---|
void
|
draw(Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). |
int
|
getIntrinsicHeight()
Returns the drawable's intrinsic height. |
int
|
getIntrinsicWidth()
Returns the drawable's intrinsic width. |
int
|
getOpacity()
This method is deprecated. This method is no longer used in graphics optimizations |
Picture
|
getPicture()
Return the picture associated with the drawable. |
void
|
setAlpha(int alpha)
Specify an alpha value for the drawable. |
void
|
setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable. |
void
|
setPicture(Picture picture)
Associate a picture with this drawable. |
Inherited methods | |
---|---|
Public constructors
PictureDrawable
public PictureDrawable (Picture picture)
Construct a new drawable referencing the specified picture. The picture may be null.
Parameters | |
---|---|
picture |
Picture : The picture to associate with the drawable. May be null. |
Public methods
draw
public void draw (Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
Parameters | |
---|---|
canvas |
Canvas : The canvas to draw into
This value cannot be null . |
getIntrinsicHeight
public int getIntrinsicHeight ()
Returns the drawable's intrinsic height.
Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.
Returns | |
---|---|
int |
the intrinsic height, or -1 if no intrinsic height |
getIntrinsicWidth
public int getIntrinsicWidth ()
Returns the drawable's intrinsic width.
Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.
Returns | |
---|---|
int |
the intrinsic width, or -1 if no intrinsic width |
getOpacity
public int getOpacity ()
This method is deprecated.
This method is no longer used in graphics optimizations
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
PixelFormat
:
PixelFormat.UNKNOWN
,
PixelFormat.TRANSLUCENT
,
PixelFormat.TRANSPARENT
, or
PixelFormat.OPAQUE
.
An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT.
Generally a Drawable should be as conservative as possible with the
value it returns. For example, if it contains multiple child drawables
and only shows one of them at a time, if only one of the children is
TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be
returned. You can use the method resolveOpacity(int, int)
to perform a
standard reduction of two opacities to the appropriate single output.
Note that the returned value does not necessarily take into account a
custom alpha or color filter that has been applied by the client through
the setAlpha(int)
or setColorFilter(ColorFilter)
methods. Some subclasses,
such as BitmapDrawable
, ColorDrawable
, and GradientDrawable
,
do account for the value of setAlpha(int)
, but the general behavior is dependent
upon the implementation of the subclass.
Returns | |
---|---|
int |
int The opacity class of the Drawable.
Value is PixelFormat.UNKNOWN , PixelFormat.TRANSLUCENT , PixelFormat.TRANSPARENT , or PixelFormat.OPAQUE |
getPicture
public Picture getPicture ()
Return the picture associated with the drawable. May be null.
Returns | |
---|---|
Picture |
the picture associated with the drawable, or null. |
setAlpha
public void setAlpha (int alpha)
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
Parameters | |
---|---|
alpha |
int : Value is between 0 and 255 inclusive |
setColorFilter
public void setColorFilter (ColorFilter colorFilter)
Specify an optional color filter for the drawable.
If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.
Pass null
to remove any existing color filter.
Note: Setting a non-null
color
filter disables tint
.
Parameters | |
---|---|
colorFilter |
ColorFilter : The color filter to apply, or null to remove the
existing color filter |
setPicture
public void setPicture (Picture picture)
Associate a picture with this drawable. The picture may be null.
Parameters | |
---|---|
picture |
Picture : The picture to associate with the drawable. May be null. |