Added in API level 1

LayerDrawable

---

Kotlin |Java

open class LayerDrawable : Drawable, Drawable.Callback

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.LayerDrawable

Known Direct Subclasses RippleDrawable, TransitionDrawable RippleDrawable Drawable that shows a ripple effect in response to state changes. TransitionDrawable An extension of LayerDrawables that is intended to cross-fade between the first and second layer.

A Drawable that manages an array of other Drawables. These are drawn in array order, so the element with the largest index will be drawn on top.

It can be defined in an XML file with the <layer-list> element. Each Drawable in the layer is defined in a nested <item>.

For more information, see the guide to Drawable Resources.

Summary

XML attributes
android:bottom	Bottom inset to apply to the layer.
android:drawable	Drawable used to render the layer.
android:end	End inset to apply to the layer.
android:gravity	Gravity used to align the layer within its container.
android:height	Height of the layer.
android:id	Identifier of the layer.
android:left	Left inset to apply to the layer.
android:paddingMode	Indicates how layer padding should affect the bounds of subsequent layers.
android:right	Right inset to apply to the layer.
android:start	Start inset to apply to the layer.
android:top	Top inset to apply to the layer.
android:width	Width of the layer.

Constants
static Int	INSET_UNDEFINED Value used for undefined start and end insets.
static Int	PADDING_MODE_NEST Padding mode used to nest each layer inside the padding of the previous layer.
static Int	PADDING_MODE_STACK Padding mode used to stack each layer directly atop the previous layer.

Public constructors
LayerDrawable(layers: Array<Drawable!>) Creates a new layer drawable with the list of specified layers.

Public methods
open Int	addLayer(dr: Drawable!) Adds a new layer containing the specified drawable to the end of the layer list and returns its index.
open Unit	applyTheme(t: Resources.Theme) Applies the specified theme to this Drawable and its children.
open Boolean	canApplyTheme()
open Unit	draw(canvas: Canvas)
open Drawable!	findDrawableByLayerId(id: Int) Looks for a layer with the given ID and returns its Drawable.
open Int	findIndexByLayerId(id: Int) Returns the layer with the specified id.
open Int	getAlpha()
open Int	getBottomPadding() Returns the bottom padding in pixels.
open Int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open Drawable.ConstantState?	getConstantState()
open Drawable!	getDrawable(index: Int) Returns the drawable for the layer at the specified index.
open Int	getEndPadding() Returns the end padding in pixels.
open Unit	getHotspotBounds(outRect: Rect)
open Int	getId(index: Int) Returns the ID of the specified layer.
open Int	getIntrinsicHeight()
open Int	getIntrinsicWidth()
open Int	getLayerGravity(index: Int)
open Int	getLayerHeight(index: Int)
open Int	getLayerInsetBottom(index: Int)
open Int	getLayerInsetEnd(index: Int)
open Int	getLayerInsetLeft(index: Int)
open Int	getLayerInsetRight(index: Int)
open Int	getLayerInsetStart(index: Int)
open Int	getLayerInsetTop(index: Int)
open Int	getLayerWidth(index: Int)
open Int	getLeftPadding() Returns the left padding in pixels.
open Int	getNumberOfLayers() Returns the number of layers contained within this layer drawable.
open Int	getOpacity()
open Unit	getOutline(outline: Outline) Populates outline with the first available (non-empty) layer outline.
open Boolean	getPadding(padding: Rect)
open Int	getPaddingMode()
open Int	getRightPadding() Returns the right padding in pixels.
open Int	getStartPadding() Returns the start padding in pixels.
open Int	getTopPadding() Returns the top padding in pixels.
open Boolean	hasFocusStateSpecified()
open Unit	inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?) Inflate this Drawable from an XML resource optionally styled by a theme.
open Unit	invalidateDrawable(who: Drawable) Called when the drawable needs to be redrawn.
open Boolean	isAutoMirrored()
open Boolean	isStateful()
open Unit	jumpToCurrentState()
open Drawable	mutate()
open Boolean	onLayoutDirectionChanged(layoutDirection: Int) Called when the drawable's resolved layout direction changes.
open Unit	scheduleDrawable(who: Drawable, what: Runnable, when: Long) A Drawable can call this to schedule the next frame of its animation.
open Unit	setAlpha(alpha: Int)
open Unit	setAutoMirrored(mirrored: Boolean)
open Unit	setColorFilter(colorFilter: ColorFilter?)
open Unit	setDither(dither: Boolean)
open Unit	setDrawable(index: Int, drawable: Drawable!) Sets the drawable for the layer at the specified index.
open Boolean	setDrawableByLayerId(id: Int, drawable: Drawable!) Replaces the Drawable for the layer with the given id.
open Unit	setHotspot(x: Float, y: Float)
open Unit	setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)
open Unit	setId(index: Int, id: Int) Sets the ID of a layer.
open Unit	setLayerGravity(index: Int, gravity: Int) Sets the gravity used to position or stretch the specified layer within its container.
open Unit	setLayerHeight(index: Int, h: Int)
open Unit	setLayerInset(index: Int, l: Int, t: Int, r: Int, b: Int) Specifies the insets in pixels for the drawable at the specified index.
open Unit	setLayerInsetBottom(index: Int, b: Int)
open Unit	setLayerInsetEnd(index: Int, e: Int)
open Unit	setLayerInsetLeft(index: Int, l: Int)
open Unit	setLayerInsetRelative(index: Int, s: Int, t: Int, e: Int, b: Int) Specifies the relative insets in pixels for the drawable at the specified index.
open Unit	setLayerInsetRight(index: Int, r: Int)
open Unit	setLayerInsetStart(index: Int, s: Int)
open Unit	setLayerInsetTop(index: Int, t: Int)
open Unit	setLayerSize(index: Int, w: Int, h: Int) Sets an explicit size for the specified layer.
open Unit	setLayerWidth(index: Int, w: Int)
open Unit	setOpacity(opacity: Int) Sets the opacity of this drawable directly instead of collecting the states from the layers.
open Unit	setPadding(left: Int, top: Int, right: Int, bottom: Int) Sets the absolute padding.
open Unit	setPaddingMode(mode: Int) Specifies how layer padding should affect the bounds of subsequent layers.
open Unit	setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int) Sets the relative padding.
open Unit	setTintBlendMode(blendMode: BlendMode!) Specifies a tint blending mode for this drawable.
open Unit	setTintList(tint: ColorStateList?)
open Boolean	setVisible(visible: Boolean, restart: Boolean)
open Unit	unscheduleDrawable(who: Drawable, what: Runnable) A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable.

Protected methods
open Unit	onBoundsChange(bounds: Rect)
open Boolean	onLevelChange(level: Int)
open Boolean	onStateChange(state: IntArray)

Inherited functions

From class Drawable Unit clearColorFilter() Removes the color filter for this drawable. Unit copyBounds(bounds: Rect) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called. Rect copyBounds() Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect). Drawable? createFromPath(pathName: String!) Create a drawable from file path name. Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?) Create a drawable from an inputstream, using the given resources and value to determine density information. Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?) Create a drawable from an inputstream, using the given resources and value to determine density information. Drawable? createFromStream(is: InputStream?, srcName: String?) Create a drawable from an inputstream Drawable createFromXml(r: Resources, parser: XmlPullParser) Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources. Drawable createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?) Create a drawable from an XML document using an optional Theme. For more information on how to create resources in XML, see Drawable Resources. Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable. Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?) Create a drawable from inside an XML document using an optional Theme. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable. Rect getBounds() Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable. Drawable.Callback? getCallback() Return the current Callback implementation attached to this Drawable. ColorFilter? getColorFilter() Returns the current color filter, or null if none set. Drawable getCurrent() Rect getDirtyBounds() Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation. Int getLayoutDirection() Returns the resolved layout direction for this Drawable. Int getLevel() Retrieve the current level. 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. 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. Insets getOpticalInsets() Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout. IntArray getState() Describes the current state, as a union of primitive states, such as android.R.attr#state_focused, android.R.attr#state_selected, etc. Some drawables may modify their imagery based on the selected state. Region? getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so. Unit inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Inflate this Drawable from an XML resource. Does not apply a theme. Unit invalidateSelf() Use the current Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable. Boolean isFilterBitmap() Boolean isVisible() Int resolveOpacity(op1: Int, op2: Int) Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing getOpacity. Unit scheduleSelf(what: Runnable, when: Long) Use the current Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable. Unit setBounds(left: Int, top: Int, right: Int, bottom: Int) Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called. Unit setBounds(bounds: Rect) Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called. Unit setCallback(cb: Drawable.Callback?) Bind a Callback object to this Drawable. Required for clients that want to support animated drawables. Unit setChangingConfigurations(configs: Int) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. Unit setColorFilter(color: Int, mode: PorterDuff.Mode) Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for setColorFilter(android.graphics.ColorFilter) which constructs a PorterDuffColorFilter. Note: Setting a color filter disables tint. Unit setFilterBitmap(filter: Boolean) Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored. Boolean setLayoutDirection(layoutDirection: Int) Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own. Boolean setLevel(level: Int) Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function. Boolean setState(stateSet: IntArray) Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [android.R.attr#state_focused, android.R.attr#state_pressed]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time. Unit setTint(tintColor: Int) Specifies tint color for this drawable. 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). To clear the tint, pass null to setTintList(android.content.res.ColorStateList). Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint. Unit setTintMode(tintMode: PorterDuff.Mode?) 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 PorterDuff.Mode#SRC_IN. Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint. Unit unscheduleSelf(what: Runnable) Use the current Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:bottom

android:bottom

Bottom inset to apply to the layer.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:drawable

android:drawable

Drawable used to render the layer.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:end

android:end

End inset to apply to the layer. Overrides left or right depending on layout direction.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:gravity

android:gravity

Gravity used to align the layer within its container. If no value is specified, the default behavior depends on whether an explicit width or height has been set, If no dimension is set, gravity in that direction defaults to fill_horizontal or fill_vertical; otherwise, it defaults to left or top.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
bottom	50	Push object to the bottom of its container, not changing its size.
center	11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
center_horizontal	1	Place object in the horizontal center of its container, not changing its size.
center_vertical	10	Place object in the vertical center of its container, not changing its size.
clip_horizontal	8	Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.
clip_vertical	80	Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
end	800005	Push object to the end of its container, not changing its size.
fill	77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
fill_horizontal	7	Grow the horizontal size of the object if needed so it completely fills its container.
fill_vertical	70	Grow the vertical size of the object if needed so it completely fills its container.
left	3	Push object to the left of its container, not changing its size.
right	5	Push object to the right of its container, not changing its size.
start	800003	Push object to the beginning of its container, not changing its size.
top	30	Push object to the top of its container, not changing its size.

android:height

android:height

Height of the layer. Defaults to the layer's intrinsic height.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:id

android:id

Identifier of the layer. This can be used to retrieve the layer from a drawable container.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:left

android:left

Left inset to apply to the layer.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:paddingMode

android:paddingMode

Indicates how layer padding should affect the bounds of subsequent layers. The default padding mode value is nest.

Must be one of the following constant values.

Constant	Value	Description
nest	0	Nest each layer inside the padding of the previous layer.
stack	1	Stack each layer directly atop the previous layer.

android:right

android:right

Right inset to apply to the layer.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:start

android:start

Start inset to apply to the layer. Overrides left or right depending on layout direction.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:top

android:top

Top inset to apply to the layer.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

android:width

android:width

Width of the layer. Defaults to the layer's intrinsic width.

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters).

Constants

INSET_UNDEFINED

Added in API level 24

static val INSET_UNDEFINED: Int

Value used for undefined start and end insets.

Value: -2147483648

See Also

• #getLayerInsetStart(int)
• #getLayerInsetEnd(int)

PADDING_MODE_NEST

Added in API level 21

static val PADDING_MODE_NEST: Int

Padding mode used to nest each layer inside the padding of the previous layer.

Value: 0

See Also

• #setPaddingMode(int)

PADDING_MODE_STACK

Added in API level 21

static val PADDING_MODE_STACK: Int

Padding mode used to stack each layer directly atop the previous layer.

Value: 1

See Also

• #setPaddingMode(int)

Public constructors

LayerDrawable

Added in API level 1

LayerDrawable(layers: Array<Drawable!>)

Creates a new layer drawable with the list of specified layers.

Parameters
layers	Array<Drawable!>: a list of drawables to use as layers in this new drawable, must be non-null

Public methods

addLayer

Added in API level 23

open fun addLayer(dr: Drawable!): Int

Adds a new layer containing the specified drawable to the end of the layer list and returns its index.

Parameters
dr	Drawable!: The drawable to add as a new layer.

Return
Int	The index of the new layer.

applyTheme

Added in API level 21

open fun applyTheme(t: Resources.Theme): Unit

Applies the specified theme to this Drawable and its children.

Parameters
t	Resources.Theme: This value cannot be null.

canApplyTheme

Added in API level 21

open fun canApplyTheme(): Boolean

draw

Added in API level 1

open fun draw(canvas: Canvas): Unit

Parameters
canvas	Canvas: The canvas to draw into This value cannot be null.

findDrawableByLayerId

Added in API level 1

open fun findDrawableByLayerId(id: Int): Drawable!

Looks for a layer with the given ID and returns its Drawable.

If multiple layers are found for the given ID, returns the Drawable for the matching layer at the highest index.

Parameters
id	Int: The layer ID to search for.

Return
Drawable!	The Drawable for the highest-indexed layer that has the given ID, or null if not found.

findIndexByLayerId

Added in API level 23

open fun findIndexByLayerId(id: Int): Int

Returns the layer with the specified id.

If multiple layers have the same ID, returns the layer with the lowest index.

Parameters
id	Int: The ID of the layer to return.

Return
Int	The index of the layer with the specified ID.

getAlpha

Added in API level 19

open fun getAlpha(): Int

Return
Int	Value is between 0 and 255 inclusive

getBottomPadding

Added in API level 23

open fun getBottomPadding(): Int

Returns the bottom padding in pixels.

A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

Return
Int	the bottom padding in pixels, or -1 if not explicitly specified

See Also

• #setPadding(int, int, int, int)
• #setPaddingRelative(int, int, int, int)
• #getPadding(Rect)

getChangingConfigurations

Added in API level 1

open fun getChangingConfigurations(): Int

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.

Return

Int

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

getConstantState

Added in API level 1

open fun getConstantState(): Drawable.ConstantState?

Return
Drawable.ConstantState?	The ConstantState associated to that Drawable. This value may be null.

getDrawable

Added in API level 1

open fun getDrawable(index: Int): Drawable!

Returns the drawable for the layer at the specified index.

Parameters
index	Int: The index of the layer, must be in the range 0...getNumberOfLayers()-1.

Return
Drawable!	The Drawable at the specified layer index.

See Also

• #setDrawable(int, Drawable)

getEndPadding

Added in API level 23

open fun getEndPadding(): Int

Returns the end padding in pixels.

A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

Return
Int	the end padding in pixels, or -1 if not explicitly specified

See Also

• #setPaddingRelative(int, int, int, int)
• #getPadding(Rect)

getHotspotBounds

Added in API level 23

open fun getHotspotBounds(outRect: Rect): Unit

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

getId

Added in API level 1

open fun getId(index: Int): Int

Returns the ID of the specified layer.

Parameters
index	Int: The index of the layer, must be in the range 0...getNumberOfLayers()-1.

Return
Int	The id of the layer or android.view.View#NO_ID if the layer has no id.

See Also

• #setId(int, int)

getIntrinsicHeight

Added in API level 1

open fun getIntrinsicHeight(): Int

Return
Int	the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth

Added in API level 1

open fun getIntrinsicWidth(): Int

Return
Int	the intrinsic width, or -1 if no intrinsic width

getLayerGravity

Added in API level 23

open fun getLayerGravity(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	the gravity used to position or stretch the specified layer within its container

See Also

• #setLayerGravity(int, int)

getLayerHeight

Added in API level 23

open fun getLayerHeight(index: Int): Int

Parameters
index	Int: the index of the drawable to adjust

Return
Int	the explicit height of the layer, or -1 if not specified

See Also

• #setLayerSize(int, int, int)

getLayerInsetBottom

Added in API level 23

open fun getLayerInsetBottom(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	number of pixels to inset from the bottom bound

getLayerInsetEnd

Added in API level 23

open fun getLayerInsetEnd(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	number of pixels to inset from the end bound

getLayerInsetLeft

Added in API level 23

open fun getLayerInsetLeft(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	number of pixels to inset from the left bound

getLayerInsetRight

Added in API level 23

open fun getLayerInsetRight(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	number of pixels to inset from the right bound

getLayerInsetStart

Added in API level 23

open fun getLayerInsetStart(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	the number of pixels to inset from the start bound, or INSET_UNDEFINED if not specified

getLayerInsetTop

Added in API level 23

open fun getLayerInsetTop(index: Int): Int

Parameters
index	Int: the index of the layer

Return
Int	number of pixels to inset from the top bound

getLayerWidth

Added in API level 23

open fun getLayerWidth(index: Int): Int

Parameters
index	Int: the index of the drawable to adjust

Return
Int	the explicit width of the layer, or -1 if not specified

See Also

• #setLayerSize(int, int, int)

getLeftPadding

Added in API level 23

open fun getLeftPadding(): Int

Returns the left padding in pixels.

A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

Return
Int	the left padding in pixels, or -1 if not explicitly specified

See Also

• #setPadding(int, int, int, int)
• #getPadding(Rect)

getNumberOfLayers

Added in API level 1

open fun getNumberOfLayers(): Int

Returns the number of layers contained within this layer drawable.

Return
Int	The number of layers.

getOpacity

Added in API level 1

open fun getOpacity(): Int

Return
Int	int The opacity class of the Drawable. Value is android.graphics.PixelFormat#UNKNOWN, android.graphics.PixelFormat#TRANSLUCENT, android.graphics.PixelFormat#TRANSPARENT, or android.graphics.PixelFormat#OPAQUE

getOutline

Added in API level 21

open fun getOutline(outline: Outline): Unit

Populates outline with the first available (non-empty) layer outline.

Parameters
outline	Outline: Outline in which to place the first available layer outline This value cannot be null.

getPadding

Added in API level 1

open fun getPadding(padding: Rect): Boolean

Parameters
padding	Rect: This value cannot be null.

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

getPaddingMode

Added in API level 21

open fun getPaddingMode(): Int

Return
Int	the current padding mode

See Also

• #setPaddingMode(int)

getRightPadding

Added in API level 23

open fun getRightPadding(): Int

Returns the right padding in pixels.

A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

Return
Int	the right padding in pixels, or -1 if not explicitly specified

See Also

• #setPadding(int, int, int, int)
• #getPadding(Rect)

getStartPadding

Added in API level 23

open fun getStartPadding(): Int

Returns the start padding in pixels.

A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

Return
Int	the start padding in pixels, or -1 if not explicitly specified

See Also

• #setPaddingRelative(int, int, int, int)
• #getPadding(Rect)

getTopPadding

Added in API level 23

open fun getTopPadding(): Int

Returns the top padding in pixels.

A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(android.graphics.Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

Return
Int	the top padding in pixels, or -1 if not explicitly specified

See Also

• #setPadding(int, int, int, int)
• #setPaddingRelative(int, int, int, int)
• #getPadding(Rect)

hasFocusStateSpecified

Added in API level 31

open fun hasFocusStateSpecified(): Boolean

Return
Boolean	true if android.R.attr#state_focused is specified for this drawable.

inflate

Added in API level 21

open fun inflate(
    r: Resources, 
    parser: XmlPullParser, 
    attrs: AttributeSet, 
    theme: Resources.Theme?
): Unit

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: This value cannot be null.
parser	XmlPullParser: This value cannot be null.
attrs	AttributeSet: This value cannot be null.
theme	Resources.Theme?: This value may be null.

Exceptions
org.xmlpull.v1.XmlPullParserException
java.io.IOException

invalidateDrawable

Added in API level 1

open fun invalidateDrawable(who: Drawable): Unit

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

open fun isAutoMirrored(): Boolean

Return
Boolean	boolean Returns true if this Drawable will be automatically mirrored.

isStateful

Added in API level 1

open fun isStateful(): Boolean

Return
Boolean	True if this drawable changes its appearance based on state, false otherwise.

jumpToCurrentState

Added in API level 11

open fun jumpToCurrentState(): Unit

mutate

Added in API level 3

open fun mutate(): Drawable

Return
Drawable	This drawable. This value cannot be null.

onLayoutDirectionChanged

Added in API level 23

open fun onLayoutDirectionChanged(layoutDirection: Int): Boolean

Called when the drawable's resolved layout direction changes.

Parameters
layoutDirection	Int: Value is android.view.View#LAYOUT_DIRECTION_LTR, or android.view.View#LAYOUT_DIRECTION_RTL

Return
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

open fun scheduleDrawable(
    who: Drawable, 
    what: Runnable, 
    when: Long
): Unit

A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call android.os.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 android.os.SystemClock#uptimeMillis

setAlpha

Added in API level 1

open fun setAlpha(alpha: Int): Unit

Parameters
alpha	Int: Value is between 0 and 255 inclusive

setAutoMirrored

Added in API level 19

open fun setAutoMirrored(mirrored: Boolean): Unit

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

setColorFilter

Added in API level 1

open fun setColorFilter(colorFilter: ColorFilter?): Unit

Parameters
colorFilter	ColorFilter?: The color filter to apply, or null to remove the existing color filter

setDither

Added in API level 1

open fun setDither(dither: Boolean): Unit

setDrawable

Added in API level 23

open fun setDrawable(
    index: Int, 
    drawable: Drawable!
): Unit

Sets the drawable for the layer at the specified index.

Parameters
index	Int: The index of the layer to modify, must be in the range 0...getNumberOfLayers()-1.
drawable	Drawable!: The drawable to set for the layer.

See Also

• #getDrawable(int)

setDrawableByLayerId

Added in API level 1

open fun setDrawableByLayerId(
    id: Int, 
    drawable: Drawable!
): Boolean

Replaces the Drawable for the layer with the given id.

Parameters
id	Int: The layer ID to search for.
drawable	Drawable!: The replacement Drawable.

Return
Boolean	Whether the Drawable was replaced (could return false if the id was not found).

setHotspot

Added in API level 21

open fun setHotspot(
    x: Float, 
    y: Float
): Unit

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

open fun setHotspotBounds(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

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

setId

Added in API level 1

open fun setId(
    index: Int, 
    id: Int
): Unit

Sets the ID of a layer.

Parameters
index	Int: The index of the layer to modify, must be in the range 0...getNumberOfLayers()-1.
id	Int: The id to assign to the layer.

See Also

• #getId(int)

setLayerGravity

Added in API level 23

open fun setLayerGravity(
    index: Int, 
    gravity: Int
): Unit

Sets the gravity used to position or stretch the specified layer within its container. Gravity is applied after any layer insets (see setLayerInset(int,int,int,int,int)) or padding (see setPaddingMode(int)).

If gravity is specified as Gravity#NO_GRAVITY, the default behavior depends on whether an explicit width or height has been set (see setLayerSize(int,int,int)), If a dimension is not set, gravity in that direction defaults to Gravity#FILL_HORIZONTAL or Gravity#FILL_VERTICAL; otherwise, gravity in that direction defaults to Gravity#LEFT or Gravity#TOP.

Parameters
index	Int: the index of the drawable to adjust
gravity	Int: the gravity to set for the layer

See Also

• #getLayerGravity(int)

setLayerHeight

Added in API level 23

open fun setLayerHeight(
    index: Int, 
    h: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
h	Int: height in pixels, or -1 to use the intrinsic height

setLayerInset

Added in API level 1

open fun setLayerInset(
    index: Int, 
    l: Int, 
    t: Int, 
    r: Int, 
    b: Int
): Unit

Specifies the insets in pixels for the drawable at the specified index.

Parameters
index	Int: the index of the drawable to adjust
l	Int: number of pixels to add to the left bound
t	Int: number of pixels to add to the top bound
r	Int: number of pixels to subtract from the right bound
b	Int: number of pixels to subtract from the bottom bound

setLayerInsetBottom

Added in API level 23

open fun setLayerInsetBottom(
    index: Int, 
    b: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
b	Int: number of pixels to inset from the bottom bound

setLayerInsetEnd

Added in API level 23

open fun setLayerInsetEnd(
    index: Int, 
    e: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
e	Int: number of pixels to inset from the end bound, or INSET_UNDEFINED if not specified

setLayerInsetLeft

Added in API level 23

open fun setLayerInsetLeft(
    index: Int, 
    l: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
l	Int: number of pixels to inset from the left bound

setLayerInsetRelative

Added in API level 23

open fun setLayerInsetRelative(
    index: Int, 
    s: Int, 
    t: Int, 
    e: Int, 
    b: Int
): Unit

Specifies the relative insets in pixels for the drawable at the specified index.

Parameters
index	Int: the index of the layer to adjust
s	Int: number of pixels to inset from the start bound
t	Int: number of pixels to inset from the top bound
e	Int: number of pixels to inset from the end bound
b	Int: number of pixels to inset from the bottom bound

setLayerInsetRight

Added in API level 23

open fun setLayerInsetRight(
    index: Int, 
    r: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
r	Int: number of pixels to inset from the right bound

setLayerInsetStart

Added in API level 23

open fun setLayerInsetStart(
    index: Int, 
    s: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
s	Int: number of pixels to inset from the start bound

setLayerInsetTop

Added in API level 23

open fun setLayerInsetTop(
    index: Int, 
    t: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
t	Int: number of pixels to inset from the top bound

setLayerSize

Added in API level 23

open fun setLayerSize(
    index: Int, 
    w: Int, 
    h: Int
): Unit

Sets an explicit size for the specified layer.

Note: Setting an explicit layer size changes the default layer gravity behavior. See setLayerGravity(int,int) for more information.

Parameters
index	Int: the index of the layer to adjust
w	Int: width in pixels, or -1 to use the intrinsic width
h	Int: height in pixels, or -1 to use the intrinsic height

See Also

• #getLayerWidth(int)
• #getLayerHeight(int)

setLayerWidth

Added in API level 23

open fun setLayerWidth(
    index: Int, 
    w: Int
): Unit

Parameters
index	Int: the index of the layer to adjust
w	Int: width in pixels, or -1 to use the intrinsic width

setOpacity

Added in API level 11

open fun setOpacity(opacity: Int): Unit

Sets the opacity of this drawable directly instead of collecting the states from the layers.

Parameters
opacity	Int: The opacity to use, or PixelFormat.UNKNOWN for the default behavior

See Also

• android.graphics.PixelFormat#UNKNOWN
• android.graphics.PixelFormat#TRANSLUCENT
• android.graphics.PixelFormat#TRANSPARENT
• android.graphics.PixelFormat#OPAQUE

setPadding

Added in API level 23

open fun setPadding(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

Sets the absolute padding.

If padding in a dimension is specified as -1, the resolved padding will use the value computed according to the padding mode (see setPaddingMode(int)).

Calling this method clears any relative padding values previously set using setPaddingRelative(int,int,int,int).

Parameters
left	Int: the left padding in pixels, or -1 to use computed padding
top	Int: the top padding in pixels, or -1 to use computed padding
right	Int: the right padding in pixels, or -1 to use computed padding
bottom	Int: the bottom padding in pixels, or -1 to use computed padding

See Also

• #setPaddingRelative(int, int, int, int)

setPaddingMode

Added in API level 21

open fun setPaddingMode(mode: Int): Unit

Specifies how layer padding should affect the bounds of subsequent layers. The default value is PADDING_MODE_NEST.

Parameters
mode	Int: padding mode, one of: PADDING_MODE_NEST to nest each layer inside the padding of the previous layer PADDING_MODE_STACK to stack each layer directly atop the previous layer

See Also

• #getPaddingMode()

setPaddingRelative

Added in API level 23

open fun setPaddingRelative(
    start: Int, 
    top: Int, 
    end: Int, 
    bottom: Int
): Unit

Sets the relative padding.

If padding in a dimension is specified as -1, the resolved padding will use the value computed according to the padding mode (see setPaddingMode(int)).

Calling this method clears any absolute padding values previously set using setPadding(int,int,int,int).

Parameters
start	Int: the start padding in pixels, or -1 to use computed padding
top	Int: the top padding in pixels, or -1 to use computed padding
end	Int: the end padding in pixels, or -1 to use computed padding
bottom	Int: the bottom padding in pixels, or -1 to use computed padding

See Also

• #setPadding(int, int, int, int)

setTintBlendMode

Added in API level 29

open fun setTintBlendMode(blendMode: BlendMode!): Unit

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

open fun setTintList(tint: ColorStateList?): Unit

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

setVisible

Added in API level 1

open fun setVisible(
    visible: Boolean, 
    restart: Boolean
): Boolean

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.

Return
Boolean	boolean Returns true if the new visibility is different than its previous state.

unscheduleDrawable

Added in API level 1

open fun unscheduleDrawable(
    who: Drawable, 
    what: Runnable
): Unit

A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable. An implementation can generally simply call android.os.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 open fun onBoundsChange(bounds: Rect): Unit

Parameters
bounds	Rect: This value cannot be null.

onLevelChange

Added in API level 1

protected open fun onLevelChange(level: Int): Boolean

Return
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 open fun onStateChange(state: IntArray): Boolean

Parameters
state	IntArray: This value cannot be null.

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