AnimatedStateListDrawable
  public
  
  
  
  class
  AnimatedStateListDrawable
  
  
  
  
  
  
  
  
  
  
    extends StateListDrawable
  
  
  
  
  
  
| java.lang.Object | ||||
| ↳ | 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 | |
|---|---|
| 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)
      
 | 
| Inherited methods | |
|---|---|
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.
 
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
 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
 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".
Public constructors
Public methods
addState
public void addState (int[] stateSet, 
                Drawable drawable, 
                int id)Add a new drawable to the set of keyframes.
| Parameters | |
|---|---|
| stateSet | int: An array of resource IDs to associate with the keyframe
 This value cannot benull. | 
| drawable | Drawable: The drawable to show when in the specified state, may not be null | 
| id | int: The unique identifier for the keyframe | 
addTransition
public void addTransition (int fromId, 
                int toId, 
                T transition, 
                boolean reversible)Adds a new transition between keyframes.
| Parameters | |
|---|---|
| fromId | int: Unique identifier of the starting keyframe | 
| toId | int: Unique identifier of the ending keyframe | 
| transition | T: AnAnimatabledrawable to use as a transition, may not be null | 
| reversible | boolean: Whether the transition can be reversed | 
applyTheme
public void applyTheme (Resources.Theme theme)
Applies the specified theme to this Drawable and its children.
| Parameters | |
|---|---|
| theme | Resources.Theme: This value may benull. | 
inflate
public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme 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.
| Parameters | |
|---|---|
| r | Resources: This value cannot benull. | 
| parser | XmlPullParser: This value cannot benull. | 
| attrs | AttributeSet: This value cannot benull. | 
| theme | Resources.Theme: This value may benull. | 
| Throws | |
|---|---|
| IOException | |
| XmlPullParserException | |
isStateful
public boolean isStateful ()
Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.
| Returns | |
|---|---|
| boolean | True if this drawable changes its appearance based on state, false otherwise. | 
jumpToCurrentState
public void jumpToCurrentState ()
If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
mutate
public Drawable mutate ()
Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.
| Returns | |
|---|---|
| Drawable | This drawable.
 This value cannot be null. | 
setVisible
public boolean setVisible (boolean visible, 
                boolean restart)Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
| Parameters | |
|---|---|
| visible | boolean: Set to true if visible, false if not. | 
| restart | boolean: You can supply true here to force the drawable to behave
                as if it has just become visible, even if it had last
                been set visible.  Used for example to force animations
                to restart. | 
| Returns | |
|---|---|
| boolean | boolean Returns true if the new visibility is different than its previous state. | 
Protected methods
onStateChange
protected boolean onStateChange (int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
| Parameters | |
|---|---|
| stateSet | int: This value cannot benull. | 
| Returns | |
|---|---|
| boolean | Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state. | 
setConstantState
protected void setConstantState (DrawableContainer.DrawableContainerState state)
| Parameters | |
|---|---|
| state | DrawableContainer.DrawableContainerState: This value cannot benull. | 
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
