public class

StateListDrawable

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

Class Overview

Lets you assign a number of graphic images to a single Drawable and swap out the visible item by a string ID value.

It can be defined in an XML file with the <selector> element. Each state Drawable is defined in a nested <item> element. For more information, see the guide to Drawable Resources.

Summary

XML Attributes
Attribute NameRelated MethodDescription
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. 
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
android:state_first State value for StateListDrawable
android:state_focused State value for StateListDrawable
android:state_last State value for StateListDrawable
android:state_middle State value for StateListDrawable
android:state_pressed State value for StateListDrawable
android:state_selected State value for StateListDrawable
android:state_single State value for StateListDrawable
android:state_window_focused State value for StateListDrawable
android:variablePadding If true, allows the drawable's padding to change based on the current state that is selected. 
android:visible Provides initial visibility state of the drawable; the default value is false. 
Public Constructors
StateListDrawable()
Public Methods
void addState(int[] stateSet, Drawable drawable)
Add a new image/string ID to the set of images.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
boolean isStateful()
Indicates whether this view will change its appearance based on state.
Drawable mutate()
Make this drawable mutable.
Protected Methods
boolean onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
[Expand]
Inherited Methods
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:constantSize

Since: API Level

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.

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

Related Methods

    android:state_active

    Since: API Level

    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

      Since: API Level

      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

        Since: API Level

        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

          Since: API Level

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

          Related Methods

            android:state_first

            Since: API Level

            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

              Since: API Level

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

              Related Methods

                android:state_last

                Since: API Level

                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

                  Since: API Level

                  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

                    Since: API Level

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

                    Related Methods

                      android:state_selected

                      Since: API Level

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

                      Related Methods

                        android:state_single

                        Since: API Level

                        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

                          Since: API Level

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

                          Related Methods

                            android:variablePadding

                            Since: API Level

                            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.

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

                            Related Methods

                              android:visible

                              Since: API Level

                              Provides initial visibility state of the drawable; the default value is false. See setVisible(boolean, boolean).

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

                              Related Methods

                                Public Constructors

                                public StateListDrawable ()

                                Since: API Level 1

                                Public Methods

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

                                Since: API Level 1

                                Add a new image/string ID to the set of images.

                                Parameters
                                stateSet - An array of resource Ids to associate with the image. Switch to this image by calling setState().
                                drawable -The image to show.

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

                                Since: API Level 1

                                public boolean isStateful ()

                                Since: API Level 1

                                Indicates whether this view 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 view changes its appearance based on state, false otherwise.

                                public Drawable mutate ()

                                Since: API Level 3

                                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.

                                Protected Methods

                                protected boolean onStateChange (int[] stateSet)

                                Since: API Level 1

                                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.