Skip to content

Most visited

Recently visited

navigation

DrawableWrapper

public abstract class DrawableWrapper
extends Drawable implements Drawable.Callback

java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.DrawableWrapper
Known Direct Subclasses


Drawable container with only one child element.

Summary

Public constructors

DrawableWrapper(Drawable dr)

Creates a new wrapper around the specified drawable.

Public methods

void applyTheme(Resources.Theme t)

Applies the specified theme to this Drawable and its children.

boolean canApplyTheme()
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 getAlpha()

Gets the current alpha value for the drawable.

int getChangingConfigurations()

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

Drawable.ConstantState getConstantState()

Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

Drawable getDrawable()
void getHotspotBounds(Rect outRect)

Populates outRect with the hotspot bounds.

int getIntrinsicHeight()

Returns the drawable's intrinsic height.

int getIntrinsicWidth()

Returns the drawable's intrinsic width.

int getOpacity()

Return the opacity/transparency of this Drawable.

void getOutline(Outline outline)

Called to get the drawable to populate the Outline that defines its drawing area.

boolean getPadding(Rect padding)

Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.

void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Inflate this Drawable from an XML resource optionally styled by a theme.

void invalidateDrawable(Drawable who)

Called when the drawable needs to be redrawn.

boolean isStateful()

Indicates whether this drawable will change its appearance based on state.

Drawable mutate()

Make this drawable mutable.

boolean onLayoutDirectionChanged(int layoutDirection)

Called when the drawable's resolved layout direction changes.

void scheduleDrawable(Drawable who, Runnable what, long when)

A Drawable can call this to schedule the next frame of its animation.

void setAlpha(int alpha)

Specify an alpha value for the drawable.

void setColorFilter(ColorFilter colorFilter)

Specify an optional color filter for the drawable.

void setDrawable(Drawable dr)

Sets the wrapped drawable.

void setHotspot(float x, float y)

Specifies the hotspot's location within the drawable.

void setHotspotBounds(int left, int top, int right, int bottom)

Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.

void setTintList(ColorStateList tint)

Specifies tint color for this drawable as a color state list.

void setTintMode(PorterDuff.Mode tintMode)

Specifies a tint blending mode for this drawable.

boolean setVisible(boolean visible, boolean restart)

Set whether this Drawable is visible.

void unscheduleDrawable(Drawable who, Runnable what)

A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable(Drawable, Runnable, long).

Protected methods

void onBoundsChange(Rect bounds)

Override this in your subclass to change appearance if you vary based on the bounds.

boolean onLevelChange(int level)

Override this in your subclass to change appearance if you vary based on level.

boolean onStateChange(int[] state)

Override this in your subclass to change appearance if you recognize the specified state.

Inherited methods

From class android.graphics.drawable.Drawable
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback

Public constructors

DrawableWrapper

added in API level 23
DrawableWrapper (Drawable dr)

Creates a new wrapper around the specified drawable.

Parameters
dr Drawable: the drawable to wrap

This value may be null.

Public methods

applyTheme

added in API level 23
void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

Parameters
t Resources.Theme: the theme to apply

This value must never be null.

canApplyTheme

added in API level 21
boolean canApplyTheme ()

Returns
boolean

draw

added in API level 1
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 must never be null.

getAlpha

added in API level 19
int getAlpha ()

Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

Returns
int

getChangingConfigurations

added in API level 1
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.

Returns
int Returns a mask of the changing configuration parameters, as defined by ActivityInfo.

getConstantState

added in API level 1
Drawable.ConstantState getConstantState ()

Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

Returns
Drawable.ConstantState The ConstantState associated to that Drawable.

This value may be null.

getDrawable

added in API level 3
Drawable getDrawable ()

Returns
Drawable the wrapped drawable

This value may be null.

getHotspotBounds

added in API level 23
void getHotspotBounds (Rect outRect)

Populates outRect with the hotspot bounds.

Parameters
outRect Rect: the rect to populate with the hotspot bounds

This value must never be null.

getIntrinsicHeight

added in API level 1
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

added in API level 1
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

added in API level 1
int getOpacity ()

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: UNKNOWN, TRANSLUCENT, TRANSPARENT, or 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.

getOutline

added in API level 21
void getOutline (Outline outline)

Called to get the drawable to populate the Outline that defines its drawing area.

This method is called by the default ViewOutlineProvider to define the outline of the View.

The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.

Parameters
outline Outline

This value must never be null.

getPadding

added in API level 1
boolean getPadding (Rect padding)

Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).

Parameters
padding Rect

This value must never be null.

Returns
boolean true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

inflate

added in API level 23
void inflate (Resources r, 
                XmlPullParser parser, 
                AttributeSet attrs, 
                Resources.Theme theme)

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.

Parameters
r Resources: Resources used to resolve attribute values

This value must never be null.

parser XmlPullParser: XML parser from which to inflate this Drawable

This value must never be null.

attrs AttributeSet: Base set of attribute values

This value must never be null.

theme Resources.Theme: Theme to apply, may be null

Throws
XmlPullParserException
IOException

invalidateDrawable

added in API level 1
void invalidateDrawable (Drawable who)

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).

Parameters
who Drawable: The drawable that is requesting the update.

This value must never be null.

isStateful

added in API level 1
boolean isStateful ()

Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.

Returns
boolean True if this drawable changes its appearance based on state, false otherwise.

mutate

added in API level 3
Drawable mutate ()

Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.

Returns
Drawable This drawable.

This value will never be null.

onLayoutDirectionChanged

added in API level 23
boolean onLayoutDirectionChanged (int layoutDirection)

Called when the drawable's resolved layout direction changes.

Parameters
layoutDirection int: the new resolved layout direction

Returns
boolean true if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, false otherwise

scheduleDrawable

added in API level 1
void scheduleDrawable (Drawable who, 
                Runnable what, 
                long when)

A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call postAtTime(Runnable, Object, long) with the parameters (what, who, when) to perform the scheduling.

Parameters
who Drawable: The drawable being scheduled.

This value must never be null.

what Runnable: The action to execute.

This value must never be null.

when long: The time (in milliseconds) to run. The timebase is uptimeMillis()

setAlpha

added in API level 1
void setAlpha (int alpha)

Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

Parameters
alpha int

setColorFilter

added in API level 1
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

setDrawable

added in API level 21
void setDrawable (Drawable dr)

Sets the wrapped drawable.

Parameters
dr Drawable: the wrapped drawable

This value may be null.

setHotspot

added in API level 21
void setHotspot (float x, 
                float y)

Specifies the hotspot's location within the drawable.

Parameters
x float: The X coordinate of the center of the hotspot

y float: The Y coordinate of the center of the hotspot

setHotspotBounds

added in API level 21
void setHotspotBounds (int left, 
                int top, 
                int right, 
                int bottom)

Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.

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

setTintList

added in API level 21
void setTintList (ColorStateList tint)

Specifies tint color for this drawable as a color state list.

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, PorterDuff.Mode).

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tint ColorStateList: Color state list to use for tinting this drawable, or null to clear the tint

setTintMode

added in API level 21
void setTintMode (PorterDuff.Mode tintMode)

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 SRC_IN.

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tintMode PorterDuff.Mode: A Porter-Duff blending mode

This value may be null.

setVisible

added in API level 1
boolean setVisible (boolean visible, 
                boolean restart)

Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.

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.

unscheduleDrawable

added in API level 1
void unscheduleDrawable (Drawable who, 
                Runnable what)

A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable(Drawable, Runnable, long). An implementation can generally simply call removeCallbacks(Runnable, Object) with the parameters (what, who) to unschedule the drawable.

Parameters
who Drawable: The drawable being unscheduled.

This value must never be null.

what Runnable: The action being unscheduled.

This value must never be null.

Protected methods

onBoundsChange

added in API level 1
void onBoundsChange (Rect bounds)

Override this in your subclass to change appearance if you vary based on the bounds.

Parameters
bounds Rect

This value must never be null.

onLevelChange

added in API level 1
boolean onLevelChange (int level)

Override this in your subclass to change appearance if you vary based on level.

Parameters
level int

Returns
boolean Returns true if the level 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 level.

onStateChange

added in API level 1
boolean onStateChange (int[] state)

Override this in your subclass to change appearance if you recognize the specified state.

Parameters
state 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.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)