Added in API level 1

StateListDrawable


open class StateListDrawable : DrawableContainer
kotlin.Any
   ↳ android.graphics.drawable.Drawable
   ↳ android.graphics.drawable.DrawableContainer
   ↳ android.graphics.drawable.StateListDrawable

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
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_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.
android:variablePadding If true, allows the drawable's padding to change based on the current state that is selected.
android:visible Indicates whether the drawable should be initially visible.
Public constructors

Public methods
open Unit
addState(stateSet: IntArray!, drawable: Drawable!)

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

open Unit

open Int

Gets the index of the drawable with the provided state set.

open Int

Gets the number of states contained in this drawable.

open Drawable?

Gets the drawable at an index.

open IntArray
getStateSet(index: Int)

Gets the state set at an index.

open Boolean

open Unit
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)

open Boolean

open Drawable

Protected methods
open Boolean

open Unit

Inherited functions

XML attributes

android:constantSize

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

android:visible
Indicates whether the drawable should be initially visible.

May be a boolean value, such as "true" or "false".

Public constructors

StateListDrawable

Added in API level 1
StateListDrawable()

Public methods

addState

Added in API level 1
open fun addState(
    stateSet: IntArray!,
    drawable: Drawable!
): Unit

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

Parameters
stateSet IntArray!: An array of resource Ids to associate with the image. Switch to this image by calling setState().
drawable Drawable!: The image to show. Note this must be a unique Drawable that is not shared between any other View or Drawable otherwise the results are undefined and can lead to unexpected rendering behavior

applyTheme

Added in API level 21
open fun applyTheme(theme: Resources.Theme): Unit
Parameters
t the theme to apply This value cannot be null.

findStateDrawableIndex

Added in API level 29
open fun findStateDrawableIndex(stateSet: IntArray): Int

Gets the index of the drawable with the provided state set.

Parameters
stateSet IntArray: the state set to look up This value cannot be null.
Return
Int the index of the provided state set, or -1 if not found

getStateCount

Added in API level 29
open fun getStateCount(): Int

Gets the number of states contained in this drawable.

Return
Int The number of states contained in this drawable.

getStateDrawable

Added in API level 29
open fun getStateDrawable(index: Int): Drawable?

Gets the drawable at an index.

Parameters
index Int: The index of the drawable.
Return
Drawable? The drawable at the index. This value may be null.

getStateSet

Added in API level 29
open fun getStateSet(index: Int): IntArray

Gets the state set at an index.

Parameters
index Int: The index of the state set.
Return
IntArray The state set at the index. This value cannot be null.

hasFocusStateSpecified

Added in API level 31
open fun hasFocusStateSpecified(): Boolean
Return
Boolean true if android.R.attr#state_focused is specified for this drawable.

inflate

Added in API level 21
open fun inflate(
    r: Resources,
    parser: XmlPullParser,
    attrs: AttributeSet,
    theme: Resources.Theme?
): Unit
Parameters
r Resources: Resources used to resolve attribute values This value cannot be null.
parser XmlPullParser: XML parser from which to inflate this Drawable This value cannot be null.
attrs AttributeSet: Base set of attribute values This value cannot be null.
theme Resources.Theme?: Theme to apply, may be null
Exceptions
org.xmlpull.v1.XmlPullParserException
java.io.IOException

isStateful

Added in API level 1
open fun isStateful(): Boolean
Return
Boolean True if this drawable changes its appearance based on state, false otherwise.

mutate

Added in API level 3
open fun mutate(): Drawable
Return
Drawable This drawable. This value cannot be null.

Protected methods

onStateChange

Added in API level 1
protected open fun onStateChange(stateSet: IntArray): Boolean
Parameters
state This value cannot be null.
Return
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

Added in API level 1
protected open fun setConstantState(state: DrawableContainer.DrawableContainerState): Unit
Parameters
state DrawableContainer.DrawableContainerState: This value cannot be null.