AnimatedStateListDrawable

Kotlin |Java

open class AnimatedStateListDrawable : StateListDrawable

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.DrawableContainer
		↳	android.graphics.drawable.StateListDrawable
			↳	android.graphics.drawable.AnimatedStateListDrawable

Drawable containing a set of Drawable keyframes where the currently displayed keyframe is chosen based on the current state set. Animations between keyframes may optionally be defined using transition elements.

This drawable can be defined in an XML file with the <animated-selector> element. Each keyframe Drawable is defined in a nested <item> element. Transitions are defined in a nested <transition> element.

Summary

XML attributes
`android:state_activated`	State value for StateListDrawable , set when a view or its parent has been "activated" meaning the user has currently marked it as being of interest.
`android:state_active`	State value for StateListDrawable , set when a view or drawable is considered "active" by its host.
`android:state_checkable`	State identifier indicating that the object may display a check mark.
`android:state_checked`	State identifier indicating that the object is currently checked.
`android:state_enabled`	State value for StateListDrawable , set when a view is enabled.
`android:state_first`	State value for StateListDrawable , set when a view or drawable is in the first position in an ordered set.
`android:state_focused`	State value for StateListDrawable , set when a view has input focus.
`android:state_last`	State value for StateListDrawable , set when a view or drawable is in the last position in an ordered set.
`android:state_middle`	State value for StateListDrawable , set when a view or drawable is in the middle position in an ordered set.
`android:state_pressed`	State value for StateListDrawable , set when the user is pressing down in a view.
`android:state_selected`	State value for StateListDrawable , set when a view (or one of its parents) is currently selected.
`android:state_single`	State value for StateListDrawable , set when a view or drawable is considered "single" by its host.
`android:state_window_focused`	State value for StateListDrawable , set when a view's window has input focus.

Inherited XML attributes

From class StateListDrawable

`android:constantSize`	If true, the drawable's reported internal size will remain constant as the state changes; the size is the maximum of all of the states. If false, the size will vary based on the current state. May be a boolean value, such as "`true`" or "`false`".
`android:state_activated`	State value for `StateListDrawable`, set when a view or its parent has been "activated" meaning the user has currently marked it as being of interest. This is an alternative representation of state_checked for when the state should be propagated down the view hierarchy. May be a boolean value, such as "`true`" or "`false`".
`android:state_active`	State value for `StateListDrawable`, set when a view or drawable is considered "active" by its host. Actual usage may vary between views. Consult the host view documentation for details. May be a boolean value, such as "`true`" or "`false`".
`android:state_checkable`	State identifier indicating that the object may display a check mark. See `android.R.attr#state_checked` for the identifier that indicates whether it is actually checked. May be a boolean value, such as "`true`" or "`false`".
`android:state_checked`	State identifier indicating that the object is currently checked. See `android.R.attr#state_checkable` for an additional identifier that can indicate if any object may ever display a check, regardless of whether state_checked is currently set. May be a boolean value, such as "`true`" or "`false`".
`android:state_enabled`	State value for `StateListDrawable`, set when a view is enabled. May be a boolean value, such as "`true`" or "`false`".
`android:state_first`	State value for `StateListDrawable`, set when a view or drawable is in the first position in an ordered set. Actual usage may vary between views. Consult the host view documentation for details. May be a boolean value, such as "`true`" or "`false`".
`android:state_focused`	State value for `StateListDrawable`, set when a view has input focus. May be a boolean value, such as "`true`" or "`false`".
`android:state_last`	State value for `StateListDrawable`, set when a view or drawable is in the last position in an ordered set. Actual usage may vary between views. Consult the host view documentation for details. May be a boolean value, such as "`true`" or "`false`".
`android:state_middle`	State value for `StateListDrawable`, set when a view or drawable is in the middle position in an ordered set. Actual usage may vary between views. Consult the host view documentation for details. May be a boolean value, such as "`true`" or "`false`".
`android:state_pressed`	State value for `StateListDrawable`, set when the user is pressing down in a view. May be a boolean value, such as "`true`" or "`false`".
`android:state_selected`	State value for `StateListDrawable`, set when a view (or one of its parents) is currently selected. May be a boolean value, such as "`true`" or "`false`".
`android:state_single`	State value for `StateListDrawable`, set when a view or drawable is considered "single" by its host. Actual usage may vary between views. Consult the host view documentation for details. May be a boolean value, such as "`true`" or "`false`".
`android:state_window_focused`	State value for `StateListDrawable`, set when a view's window has input focus. May be a boolean value, such as "`true`" or "`false`".
`android:variablePadding`	If true, allows the drawable's padding to change based on the current state that is selected. If false, the padding will stay the same (based on the maximum padding of all the states). Enabling this feature requires that the owner of the drawable deal with performing layout when the state changes, which is often not supported. May be a boolean value, such as "`true`" or "`false`".
`android:visible`	Indicates whether the drawable should be initially visible. May be a boolean value, such as "`true`" or "`false`".

Public constructors
`AnimatedStateListDrawable()`

Public methods
open Unit	`addState(stateSet: IntArray, drawable: Drawable, id: Int)` Add a new drawable to the set of keyframes.
open Unit	`addTransition(fromId: Int, toId: Int, transition: T, reversible: Boolean)` Adds a new transition between keyframes.
open Unit	`applyTheme(theme: Resources.Theme!)` Applies the specified theme to this Drawable and its children.
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 Boolean	`isStateful()` Indicates whether this drawable will change its appearance based on state.
open Unit	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
open Drawable	`mutate()` Make this drawable mutable.
open Boolean	`setVisible(visible: Boolean, restart: Boolean)` Set whether this Drawable is visible.

Protected methods
open Boolean	`onStateChange(stateSet: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.
open Unit	`setConstantState(state: DrawableContainer.DrawableContainerState)`

Inherited functions

From class StateListDrawable

`Unit`	`addState(stateSet: IntArray!, drawable: Drawable!)` Add a new image/string ID to the set of images.
`Int`	`findStateDrawableIndex(stateSet: IntArray)` Gets the index of the drawable with the provided state set.
`Int`	`getStateCount()` Gets the number of states contained in this drawable.
`Drawable?`	`getStateDrawable(index: Int)` Gets the drawable at an index.
`IntArray`	`getStateSet(index: Int)` Gets the state set at an index.
`Boolean`	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.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 `android.R.attr#state_focused` to make sure the user knows which view is holding the focus.

From class DrawableContainer

`Boolean`	`canApplyTheme()`
`Unit`	`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. 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.
`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()` Return a `ConstantState` instance that holds the shared state of this Drawable.
`Drawable`	`getCurrent()`
`Unit`	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
`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.
`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.
`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.
`Int`	`getOpacity()` Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in `android.graphics.PixelFormat`: `android.graphics.PixelFormat#UNKNOWN`, `android.graphics.PixelFormat#TRANSLUCENT`, `android.graphics.PixelFormat#TRANSPARENT`, or `android.graphics.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` 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` or #setColorFilter methods. Some subclasses, such as `BitmapDrawable`, `ColorDrawable`, and `GradientDrawable`, do account for the value of `setAlpha`, but the general behavior is dependent upon the implementation of the subclass.
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`Unit`	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area. This method is called by the default `android.view.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.
`Boolean`	`getPadding(padding: Rect)` 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).
`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