Android APIs
public class

AnimatedStateListDrawable

extends StateListDrawable
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.DrawableContainer
       ↳ android.graphics.drawable.StateListDrawable
         ↳ android.graphics.drawable.AnimatedStateListDrawable

Class Overview

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
Attribute Name Related Method Description
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
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
android:state_focused State value for StateListDrawable, set when a view has input focus. 
android:state_last State value for StateListDrawable
android:state_middle State value for StateListDrawable
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
android:state_window_focused State value for StateListDrawable, set when a view's window has input focus. 
[Expand]
Inherited XML Attributes
From class android.graphics.drawable.StateListDrawable
Public Constructors
AnimatedStateListDrawable()
Public Methods
void addState(int[] stateSet, Drawable drawable, int id)
Add a new drawable to the set of keyframes.
<T extends Drawable & Animatable> void addTransition(int fromId, int toId, T transition, boolean reversible)
Adds a new transition between keyframes.
void applyTheme(Resources.Theme theme)
Applies the specified theme to this Drawable and its children.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
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 setVisible(boolean visible, boolean restart)
Set whether this Drawable is visible.
Protected Methods
boolean onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
void setConstantState(DrawableContainer.DrawableContainerState state)
[Expand]
Inherited Methods
From class android.graphics.drawable.StateListDrawable
From class android.graphics.drawable.DrawableContainer
From class android.graphics.drawable.Drawable
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback

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. This is an alternative representation of state_checked for when the state should be propagated down the view hierarchy.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_activated.

Related Methods

android:state_active

State value for StateListDrawable.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_active.

Related Methods

android:state_checkable

State identifier indicating that the object may display a check mark. See state_checked for the identifier that indicates whether it is actually checked.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_checkable.

Related Methods

android:state_checked

State identifier indicating that the object is currently checked. See 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.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_checked.

Related Methods

android:state_enabled

State value for StateListDrawable, set when a view is enabled.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_enabled.

Related Methods

android:state_first

State value for StateListDrawable.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_first.

Related Methods

android:state_focused

State value for StateListDrawable, set when a view has input focus.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_focused.

Related Methods

android:state_last

State value for StateListDrawable.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_last.

Related Methods

android:state_middle

State value for StateListDrawable.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_middle.

Related Methods

android:state_pressed

State value for StateListDrawable, set when the user is pressing down in a view.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_pressed.

Related Methods

android:state_selected

State value for StateListDrawable, set when a view (or one of its parents) is currently selected.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_selected.

Related Methods

android:state_single

State value for StateListDrawable.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_single.

Related Methods

android:state_window_focused

State value for StateListDrawable, set when a view's window has input focus.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol state_window_focused.

Related Methods

Public Constructors

public AnimatedStateListDrawable ()

Added in API level 21

Public Methods

public void addState (int[] stateSet, Drawable drawable, int id)

Added in API level 21

Add a new drawable to the set of keyframes.

Parameters
stateSet An array of resource IDs to associate with the keyframe
drawable The drawable to show when in the specified state, may not be null
id The unique identifier for the keyframe

public void addTransition (int fromId, int toId, T transition, boolean reversible)

Added in API level 21

Adds a new transition between keyframes.

Parameters
fromId Unique identifier of the starting keyframe
toId Unique identifier of the ending keyframe
transition An Animatable drawable to use as a transition, may not be null
reversible Whether the transition can be reversed

public void applyTheme (Resources.Theme theme)

Added in API level 21

Applies the specified theme to this Drawable and its children.

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

Added in API level 21

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

Parameters
r Resources used to resolve attribute values
parser XML parser from which to inflate this Drawable
attrs Base set of attribute values
theme Theme to apply, may be null

public boolean isStateful ()

Added in API level 21

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
  • True if this drawable changes its appearance based on state, false otherwise.

public void jumpToCurrentState ()

Added in API level 21

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

public Drawable mutate ()

Added in API level 21

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
  • This drawable.

public boolean setVisible (boolean visible, boolean restart)

Added in API level 21

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 Set to true if visible, false if not.
restart 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 Returns true if the new visibility is different than its previous state.

Protected Methods

protected boolean onStateChange (int[] stateSet)

Added in API level 21

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

Returns
  • 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.

protected void setConstantState (DrawableContainer.DrawableContainerState state)

Added in API level 21