TransitionDrawable

Kotlin |Java

open class TransitionDrawable : LayerDrawable, Drawable.Callback

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

An extension of LayerDrawables that is intended to cross-fade between the first and second layer. To start the transition, call startTransition(int). To display just the first layer, call resetTransition().

It can be defined in an XML file with the <transition> element. Each Drawable in the transition 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:id`	Identifier of the layer.
`android:left`	Left inset to apply to the layer.
`android:right`	Right inset to apply to the layer.
`android:top`	Top inset to apply to the layer.

Inherited XML attributes

From class LayerDrawable

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

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

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

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

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

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

Left inset to apply to the layer.

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

Right inset to apply to the layer.

android:start

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

android:top

Top inset to apply to the layer.

android:width

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

Inherited constants

From class LayerDrawable

Int

INSET_UNDEFINED

Value used for undefined start and end insets.

Int

PADDING_MODE_NEST

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

Int

PADDING_MODE_STACK

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

Public constructors
`TransitionDrawable(layers: Array<Drawable!>!)` Create a new transition drawable with the specified list of layers.

Public methods
open Unit	`draw(canvas: Canvas)`
open Boolean	`isCrossFadeEnabled()` Indicates whether the cross fade is enabled for this transition.
open Unit	`resetTransition()` Show only the first layer.
open Unit	`reverseTransition(duration: Int)` Reverses the transition, picking up where the transition currently is.
open Unit	`setCrossFadeEnabled(enabled: Boolean)` Enables or disables the cross fade of the drawables.
open Unit	`startTransition(durationMillis: Int)` Begin the second layer on top of the first layer.

Inherited functions

From class LayerDrawable

`Int`	`addLayer(dr: Drawable!)` Adds a new layer containing the specified `drawable` to the end of the layer list and returns its index.
`Unit`	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
`Boolean`	`canApplyTheme()`
`Drawable!`	`findDrawableByLayerId(id: Int)` 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.
`Int`	`findIndexByLayerId(id: Int)` Returns the layer with the specified `id`. If multiple layers have the same ID, returns the layer with the lowest index.
`Int`	`getAlpha()`
`Int`	`getBottomPadding()` 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()`.
`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.
`Drawable.ConstantState?`	`getConstantState()`
`Drawable!`	`getDrawable(index: Int)` Returns the drawable for the layer at the specified index.
`Int`	`getEndPadding()` 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()`.
`Unit`	`getHotspotBounds(outRect: Rect)`
`Int`	`getId(index: Int)` Returns the ID of the specified layer.
`Int`	`getIntrinsicHeight()`
`Int`	`getIntrinsicWidth()`
`Int`	`getLayerGravity(index: Int)`
`Int`	`getLayerHeight(index: Int)`
`Int`	`getLayerInsetBottom(index: Int)`
`Int`	`getLayerInsetEnd(index: Int)`
`Int`	`getLayerInsetLeft(index: Int)`
`Int`	`getLayerInsetRight(index: Int)`
`Int`	`getLayerInsetStart(index: Int)`
`Int`	`getLayerInsetTop(index: Int)`
`Int`	`getLayerWidth(index: Int)`
`Int`	`getLeftPadding()` 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()`.
`Int`	`getNumberOfLayers()` Returns the number of layers contained within this layer drawable.
`Int`	`getOpacity()`
`Unit`	`getOutline(outline: Outline)` Populates `outline` with the first available (non-empty) layer outline.
`Boolean`	`getPadding(padding: Rect)`
`Int`	`getPaddingMode()`
`Int`	`getRightPadding()` 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()`.
`Int`	`getStartPadding()` 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()`.
`Int`	`getTopPadding()` 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()`.
`Boolean`	`hasFocusStateSpecified()`
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.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.
`Unit`	`invalidateDrawable(who: Drawable)` 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).
`Boolean`	`isAutoMirrored()`
`Boolean`	`isStateful()`
`Unit`	`jumpToCurrentState()`
`Drawable`	`mutate()`
`Unit`	`onBoundsChange(bounds: Rect)`
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onLevelChange(level: Int)`
`Boolean`	`onStateChange(state: IntArray)`
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)` 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.
`Unit`	`setAlpha(alpha: Int)`
`Unit`	`setAutoMirrored(mirrored: Boolean)`
`Unit`	`setColorFilter(colorFilter: ColorFilter?)`
`Unit`	`setDither(dither: Boolean)`
`Unit`	`setDrawable(index: Int, drawable: Drawable!)` Sets the drawable for the layer at the specified index.
`Boolean`	`setDrawableByLayerId(id: Int, drawable: Drawable!)` Replaces the `Drawable` for the layer with the given id.
`Unit`	`setHotspot(x: Float, y: Float)`
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setId(index: Int, id: Int)` Sets the ID of a layer.
`Unit`	`setLayerGravity(index: Int, gravity: Int)` 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`.
`Unit`	`setLayerHeight(index: Int, h: Int)`
`Unit`	`setLayerInset(index: Int, l: Int, t: Int, r: Int, b: Int)` Specifies the insets in pixels for the drawable at the specified index.
`Unit`	`setLayerInsetBottom(index: Int, b: Int)`
`Unit`	`setLayerInsetEnd(index: Int, e: Int)`
`Unit`	`setLayerInsetLeft(index: Int, l: Int)`
`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.
`Unit`	`setLayerInsetRight(index: Int, r: Int)`
`Unit`	`setLayerInsetStart(index: Int, s: Int)`
`Unit`	`setLayerInsetTop(index: Int, t: Int)`
`Unit`	`setLayerSize(index: Int, w: Int, h: Int)` 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.
`Unit`	`setLayerWidth(index: Int, w: Int)`
`Unit`	`setOpacity(opacity: Int)` Sets the opacity of this drawable directly instead of collecting the states from the layers.
`Unit`	`setPadding(left: Int, top: Int, right: Int, bottom: Int)` 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)`.
`Unit`	`setPaddingMode(mode: Int)` Specifies how layer padding should affect the bounds of subsequent layers. The default value is `PADDING_MODE_NEST`.
`Unit`	`setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)` 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)`.
`Unit`	`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)`
`Unit`	`setTintList(tint: ColorStateList?)`
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)`
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)` 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.

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.

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

android:right

android:right

Right inset to apply to the layer.

android:top

android:top

Top inset to apply to the layer.

Public constructors

TransitionDrawable

Added in API level 3

TransitionDrawable(layers: Array<Drawable!>!)

Create a new transition drawable with the specified list of layers. At least 2 layers are required for this drawable to work properly.

Public methods

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

isCrossFadeEnabled

Added in API level 1

open fun isCrossFadeEnabled(): Boolean

Indicates whether the cross fade is enabled for this transition.

Return
`Boolean`	True if cross fading is enabled, false otherwise.

resetTransition

Added in API level 1

open fun resetTransition(): Unit

Show only the first layer.

reverseTransition

Added in API level 1

open fun reverseTransition(duration: Int): Unit

Reverses the transition, picking up where the transition currently is. If the transition is not currently running, this will start the transition with the specified duration. If the transition is already running, the last known duration will be used.

Parameters
`duration`	Int: The duration to use if no transition is running.

setCrossFadeEnabled

Added in API level 1

open fun setCrossFadeEnabled(enabled: Boolean): Unit

Enables or disables the cross fade of the drawables. When cross fade is disabled, the first drawable is always drawn opaque. With cross fade enabled, the first drawable is drawn with the opposite alpha of the second drawable. Cross fade is disabled by default.

Parameters
`enabled`	Boolean: True to enable cross fading, false otherwise.

startTransition

Added in API level 1

open fun startTransition(durationMillis: Int): Unit

Begin the second layer on top of the first layer.

Parameters
`durationMillis`	Int: The length of the transition in milliseconds