Added in API level 1

Summary: Nested Classes | Ctors | Methods | Protected Methods | Inherited Methods

DrawableContainer

Kotlin |Java

public class DrawableContainer
extends Drawable implements Drawable.Callback

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.DrawableContainer

Known direct subclasses

AnimationDrawable, LevelListDrawable, StateListDrawable

AnimationDrawable	An object used to create frame-by-frame animations, defined by a series of Drawable objects, which can be used as a View object's background.
LevelListDrawable	A resource that manages a number of alternate Drawables, each assigned a maximum numerical value.
StateListDrawable	Lets you assign a number of graphic images to a single Drawable and swap out the visible item by a string ID value.

Known indirect subclasses

AnimatedStateListDrawable

AnimatedStateListDrawable Drawable containing a set of Drawable keyframes where the currently displayed keyframe is chosen based on the current state set.

A helper class that contains several Drawables and selects which one to use. You can subclass it to create your own DrawableContainers or directly use one its child classes.

Summary

Nested classes
`class`	`DrawableContainer.DrawableContainerState` A ConstantState that can contain several `Drawable`s.

Public constructors
`DrawableContainer()`

Public methods
`void`	`applyTheme(Resources.Theme theme)` 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 `ConstantState` instance that holds the shared state of this Drawable.
`Drawable`	`getCurrent()`
`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`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable.
`int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable.
`int`	`getOpacity()` This method is deprecated. This method is no longer used in graphics optimizations
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`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.
`boolean`	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `R.attr.state_focused`.
`void`	`invalidateDrawable(Drawable who)` Called when the drawable needs to be redrawn.
`boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
`boolean`	`isStateful()` Indicates whether this drawable will change its appearance based on state.
`void`	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
`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.
`boolean`	`selectDrawable(int index)` Sets the currently displayed drawable by index.
`void`	`setAlpha(int alpha)` Specify an alpha value for the drawable.
`void`	`setAutoMirrored(boolean mirrored)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
`void`	`setColorFilter(ColorFilter colorFilter)` Specify an optional color filter for the drawable.
`void`	`setDither(boolean dither)` This method is deprecated. This property is ignored.
`void`	`setEnterFadeDuration(int ms)` Change the global fade duration when a new drawable is entering the scene.
`void`	`setExitFadeDuration(int ms)` Change the global fade duration when a new drawable is leaving the scene.
`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`	`setTintBlendMode(BlendMode blendMode)` Specifies a tint blending mode for this drawable.
`void`	`setTintList(ColorStateList tint)` Specifies tint color for this drawable as a color state list.
`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.
`void`	`setConstantState(DrawableContainer.DrawableContainerState state)`

Inherited methods

From class


        
          android.graphics.drawable.Drawable

`void`	`applyTheme(Resources.Theme t)` Applies the specified theme to this Drawable and its children.
`boolean`	`canApplyTheme()`
`void`	`clearColorFilter()` Removes the color filter for this drawable.
`final Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect.
`final void`	`copyBounds(Rect bounds)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
`static Drawable`	`createFromPath(String pathName)` Create a drawable from file path name.
`static Drawable`	`createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts)` This method was deprecated in API level 28. Prefer the version without an Options object.
`static Drawable`	`createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`static Drawable`	`createFromStream(InputStream is, String srcName)` Create a drawable from an inputstream
`static Drawable`	`createFromXml(Resources r, XmlPullParser parser)` Create a drawable from an XML document.
`static Drawable`	`createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme)` Create a drawable from an XML document using an optional `Theme`.
`static Drawable`	`createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)` Create a drawable from inside an XML document using an optional `Theme`.
`static Drawable`	`createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs)` Create from inside an XML document.
`abstract 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.
`final Rect`	`getBounds()` Return the drawable's bounds Rect.
`Drawable.Callback`	`getCallback()` Return the current `Callback` implementation attached to this Drawable.
`int`	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`ColorFilter`	`getColorFilter()` Returns the current color filter, or `null` if none set.
`Drawable.ConstantState`	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect.
`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`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`final int`	`getLevel()` Retrieve the current level.
`int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable.
`int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable.
`abstract int`	`getOpacity()` This method was deprecated in API level 29. This method is no longer used in graphics optimizations
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`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.
`int[]`	`getState()` Describes the current state, as a union of primitive states, such as `R.attr.state_focused`, `R.attr.state_selected`, etc.
`Region`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent.
`boolean`	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `R.attr.state_focused`.
`void`	`inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)` Inflate this Drawable from an XML resource optionally styled by a theme.
`void`	`inflate(Resources r, XmlPullParser parser, AttributeSet attrs)` Inflate this Drawable from an XML resource.
`void`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn.
`boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
`boolean`	`isFilterBitmap()`
`boolean`	`isProjected()` Whether this drawable requests projection.
`boolean`	`isStateful()` Indicates whether this drawable will change its appearance based on state.
`final boolean`	`isVisible()`
`void`	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
`Drawable`	`mutate()` Make this drawable mutable.
`void`	`onBoundsChange(Rect bounds)` Override this in your subclass to change appearance if you vary based on the bounds.
`boolean`	`onLayoutDirectionChanged(int layoutDirection)` Called when the drawable's resolved layout direction changes.
`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.
`static int`	`resolveOpacity(int op1, int op2)` Return the appropriate opacity value for two source opacities.
`void`	`scheduleSelf(Runnable what, long when)` Use the current `Callback` implementation to have this Drawable scheduled.
`abstract void`	`setAlpha(int alpha)` Specify an alpha value for the drawable.
`void`	`setAutoMirrored(boolean mirrored)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
`void`	`setBounds(int left, int top, int right, int bottom)` Specify a bounding rectangle for the Drawable.
`void`	`setBounds(Rect bounds)` Specify a bounding rectangle for the Drawable.
`final void`	`setCallback(Drawable.Callback cb)` Bind a `Callback` object to this Drawable.
`void`	`setChangingConfigurations(int configs)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`void`	`setColorFilter(int color, PorterDuff.Mode mode)` This method was deprecated in API level 29. use `setColorFilter(android.graphics.ColorFilter)` with an instance of `BlendModeColorFilter`
`abstract void`	`setColorFilter(ColorFilter colorFilter)` Specify an optional color filter for the drawable.
`void`	`setDither(boolean dither)` This method was deprecated in API level 23. This property is ignored.
`void`	`setFilterBitmap(boolean filter)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
`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.
`final boolean`	`setLayoutDirection(int layoutDirection)` Set the layout direction for this drawable.
`final boolean`	`setLevel(int level)` Specify the level for the drawable.
`boolean`	`setState(int[] stateSet)` Specify a set of states for the drawable.
`void`	`setTint(int tintColor)` Specifies tint color for this drawable.
`void`	`setTintBlendMode(BlendMode blendMode)` Specifies a tint blending mode for this drawable.
`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`	`unscheduleSelf(Runnable what)` Use the current `Callback` implementation to have this Drawable unscheduled.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.graphics.drawable.Drawable.Callback

`abstract void`	`invalidateDrawable(Drawable who)` Called when the drawable needs to be redrawn.
`abstract void`	`scheduleDrawable(Drawable who, Runnable what, long when)` A Drawable can call this to schedule the next frame of its animation.
`abstract void`	`unscheduleDrawable(Drawable who, Runnable what)` A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable(Drawable, Runnable, long)`.

Public constructors

DrawableContainer

public DrawableContainer ()

Public methods

applyTheme

Added in API level 21

public void applyTheme (Resources.Theme theme)

Applies the specified theme to this Drawable and its children.

Parameters
`theme`	`Resources.Theme`: the theme to apply This value cannot be `null`.

canApplyTheme

Added in API level 21

public boolean canApplyTheme ()

Returns
`boolean`

draw

Added in API level 1

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

getAlpha

Added in API level 19

public 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`	Value is between 0 and 255 inclusive

getChangingConfigurations

Added in API level 1

public 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

Returns
`int`	Value is either `0` or a combination of `ActivityInfo.CONFIG_MCC`, `ActivityInfo.CONFIG_MNC`, `ActivityInfo.CONFIG_LOCALE`, `ActivityInfo.CONFIG_TOUCHSCREEN`, `ActivityInfo.CONFIG_KEYBOARD`, `ActivityInfo.CONFIG_KEYBOARD_HIDDEN`, `ActivityInfo.CONFIG_NAVIGATION`, `ActivityInfo.CONFIG_ORIENTATION`, `ActivityInfo.CONFIG_SCREEN_LAYOUT`, `ActivityInfo.CONFIG_UI_MODE`, `ActivityInfo.CONFIG_SCREEN_SIZE`, `ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE`, `ActivityInfo.CONFIG_DENSITY`, `ActivityInfo.CONFIG_LAYOUT_DIRECTION`, `ActivityInfo.CONFIG_COLOR_MODE`, `ActivityInfo.CONFIG_FONT_SCALE`, `ActivityInfo.CONFIG_GRAMMATICAL_GENDER`, `ActivityInfo.CONFIG_ASSETS_PATHS`, and `ActivityInfo.CONFIG_RESOURCES_UNUSED`

int

Value is either 0 or a combination of ActivityInfo.CONFIG_MCC, ActivityInfo.CONFIG_MNC, ActivityInfo.CONFIG_LOCALE, ActivityInfo.CONFIG_TOUCHSCREEN, ActivityInfo.CONFIG_KEYBOARD, ActivityInfo.CONFIG_KEYBOARD_HIDDEN, ActivityInfo.CONFIG_NAVIGATION, ActivityInfo.CONFIG_ORIENTATION, ActivityInfo.CONFIG_SCREEN_LAYOUT, ActivityInfo.CONFIG_UI_MODE, ActivityInfo.CONFIG_SCREEN_SIZE, ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE, ActivityInfo.CONFIG_DENSITY, ActivityInfo.CONFIG_LAYOUT_DIRECTION, ActivityInfo.CONFIG_COLOR_MODE, ActivityInfo.CONFIG_FONT_SCALE, ActivityInfo.CONFIG_GRAMMATICAL_GENDER, ActivityInfo.CONFIG_ASSETS_PATHS, and ActivityInfo.CONFIG_RESOURCES_UNUSED

getConstantState

Added in API level 1

public Drawable.ConstantState getConstantState ()

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

Returns
`Drawable.ConstantState`	The ConstantState associated to that Drawable. This value may be `null`.

getCurrent

Added in API level 1

public Drawable getCurrent ()

Returns
`Drawable`	The current drawable that will be used by this drawable. For simple drawables, this is just the drawable itself. For drawables that change state like `StateListDrawable` and `LevelListDrawable` this will be the child drawable currently in use. This value cannot be `null`.

getHotspotBounds

Added in API level 23

public void getHotspotBounds (Rect outRect)

Populates outRect with the hotspot bounds.

Parameters
`outRect`	`Rect`: the rect to populate with the hotspot bounds This value cannot be `null`.

getIntrinsicHeight

Added in API level 1

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

Added in API level 1

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

getMinimumHeight

Added in API level 1

public int getMinimumHeight ()

Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.

Returns
`int`	The minimum height suggested by this Drawable. If this Drawable doesn't have a suggested minimum height, 0 is returned.

getMinimumWidth

Added in API level 1

public int getMinimumWidth ()

Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.

Returns
`int`	The minimum width suggested by this Drawable. If this Drawable doesn't have a suggested minimum width, 0 is returned.

getOpacity

Added in API level 1

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`

getOpticalInsets

Added in API level 29

public Insets getOpticalInsets ()

Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.

Returns
`Insets`	This value cannot be `null`.

getOutline

Added in API level 21

public 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 cannot be `null`.

getPadding

Added in API level 1

public 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 cannot 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.

hasFocusStateSpecified

Added in API level 31

public boolean hasFocusStateSpecified ()

Indicates whether this drawable has at least one state spec explicitly specifying R.attr.state_focused.

Note: A View uses a Drawable instance as its background and it changes its appearance based on a state. On keyboard devices, it should specify its R.attr.state_focused to make sure the user knows which view is holding the focus.

Returns
`boolean`	`true` if `R.attr.state_focused` is specified for this drawable.

invalidateDrawable

Added in API level 1

public 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`: This value cannot be `null`.

isAutoMirrored

Added in API level 19

public boolean isAutoMirrored ()

Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection.

Returns
`boolean`	boolean Returns true if this Drawable will be automatically mirrored.

isStateful

Added in API level 1

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

jumpToCurrentState

Added in API level 11

public void jumpToCurrentState ()

If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.

mutate

Added in API level 3

public 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 cannot be `null`.

onLayoutDirectionChanged

Added in API level 23

public boolean onLayoutDirectionChanged (int layoutDirection)

Called when the drawable's resolved layout direction changes.

Parameters
`layoutDirection`	`int`: Value is `View.LAYOUT_DIRECTION_LTR`, or `View.LAYOUT_DIRECTION_RTL`

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

public 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 Handler.postAtTime(Runnable, Object, long) with the parameters (what, who, when) to perform the scheduling.

Parameters
`who`	`Drawable`: This value cannot be `null`.
`what`	`Runnable`: This value cannot be `null`.
`when`	`long`: The time (in milliseconds) to run. The timebase is `SystemClock.uptimeMillis()`

selectDrawable

Added in API level 1

public boolean selectDrawable (int index)

Sets the currently displayed drawable by index.

If an invalid index is specified, the current drawable will be set to null and the index will be set to -1.

Parameters
`index`	`int`: the index of the drawable to display

Returns
`boolean`	`true` if the drawable changed, `false` otherwise

setAlpha

Added in API level 1

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

setAutoMirrored

Added in API level 19

public void setAutoMirrored (boolean mirrored)

Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection.

Parameters
`mirrored`	`boolean`: Set to true if the Drawable should be mirrored, false if not.

setColorFilter

Added in API level 1

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

setDither

Added in API level 1

public void setDither (boolean dither)

This method is deprecated.
This property is ignored.

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.

Parameters
`dither`	`boolean`

setEnterFadeDuration

Added in API level 11

public void setEnterFadeDuration (int ms)

Change the global fade duration when a new drawable is entering the scene.

Parameters
`ms`	`int`: The amount of time to fade in milliseconds.

setExitFadeDuration

Added in API level 11

public void setExitFadeDuration (int ms)

Change the global fade duration when a new drawable is leaving the scene.

Parameters
`ms`	`int`: The amount of time to fade in milliseconds.

setHotspot

Added in API level 21

public 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

public 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

setTintBlendMode

Added in API level 29

public void setTintBlendMode (BlendMode blendMode)

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

Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)

Parameters
`blendMode`	`BlendMode`: This value cannot be `null`.

setTintList

Added in API level 21

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

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

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

setVisible

Added in API level 1

public 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

public 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 Handler.removeCallbacks(Runnable, Object) with the parameters (what, who) to unschedule the drawable.

Parameters
`who`	`Drawable`: This value cannot be `null`.
`what`	`Runnable`: This value cannot be `null`.

Protected methods

onBoundsChange

Added in API level 1

protected void onBoundsChange (Rect bounds)

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

Parameters
`bounds`	`Rect`: This value cannot be `null`.

onLevelChange

Added in API level 1

protected 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

protected boolean onStateChange (int[] state)

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

Parameters
`state`	`int`: This value cannot be `null`.

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.

setConstantState

Added in API level 1

protected void setConstantState (DrawableContainer.DrawableContainerState state)

Parameters
`state`	`DrawableContainer.DrawableContainerState`

DrawableContainer

Summary

Nested classes

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

DrawableContainer

Public methods

applyTheme

canApplyTheme

draw

getAlpha

getChangingConfigurations

getConstantState

getCurrent

getHotspotBounds

getIntrinsicHeight

getIntrinsicWidth

getMinimumHeight

getMinimumWidth

getOpacity

getOpticalInsets

getOutline

getPadding

hasFocusStateSpecified

invalidateDrawable

isAutoMirrored

isStateful

jumpToCurrentState

mutate

onLayoutDirectionChanged

scheduleDrawable

selectDrawable

setAlpha

setAutoMirrored

setColorFilter

setDither

setEnterFadeDuration

setExitFadeDuration

setHotspot

setHotspotBounds

setTintBlendMode

setTintList

setVisible

unscheduleDrawable

Protected methods

onBoundsChange

onLevelChange

onStateChange

setConstantState