StateListDrawableCompat

Artifact: androidx.appcompat:appcompat-resources

Added in 1.6.0

Kotlin |Java

class StateListDrawableCompat : DrawableContainerCompat

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	androidx.appcompat.graphics.drawable.DrawableContainerCompat
		↳	androidx.appcompat.graphics.drawable.StateListDrawableCompat

Known direct subclasses

AnimatedStateListDrawableCompat

AnimatedStateListDrawableCompat

A Drawable providing animated transitions between states.

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

Adapted from platform class; altered with API level checks as necessary &uses ResourceManagerInternal for Drawable inflation.

Summary

Public constructors
`StateListDrawableCompat()` Creates an empty state list drawable.

Public functions
`Unit`	`addState(stateSet: IntArray!, drawable: Drawable!)` Add a new image/string ID to the set of images.
`Unit`	`@RequiresApi(value = 21) applyTheme(theme: Resources.Theme)`
`Unit`	`inflate( context: Context, r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme? )` Inflate this Drawable from an XML resource optionally styled by a theme.
`Boolean`	`isStateful()`
`Drawable`	`mutate()`

Protected functions
`Boolean`	`onStateChange(stateSet: IntArray)`

Inherited functions

From android.graphics.drawable.Drawable

`Unit`	`applyTheme(t: Resources.Theme!)`
`Boolean`	`canApplyTheme()`
`Unit`	`clearColorFilter()`
`Rect!`	`copyBounds()`
`Unit`	`copyBounds(bounds: Rect!)`
`java-static Drawable!`	`createFromPath(pathName: String!)`
`java-static Drawable!`	`createFromResourceStream( res: Resources!, value: TypedValue!, is: InputStream!, srcName: String! )`
`java-static Drawable!`	`createFromStream(is: InputStream!, srcName: String!)`
`java-static Drawable!`	`createFromXml(r: Resources!, parser: XmlPullParser!)`
`java-static Drawable!`	`createFromXmlInner( r: Resources!, parser: XmlPullParser!, attrs: AttributeSet! )`
`abstract Unit`	`draw(p: Canvas!)`
`Int`	`getAlpha()`
`Rect!`	`getBounds()`
`Drawable.Callback!`	`getCallback()`
`Int`	`getChangingConfigurations()`
`ColorFilter!`	`getColorFilter()`
`Drawable.ConstantState!`	`getConstantState()`
`Drawable!`	`getCurrent()`
`Rect!`	`getDirtyBounds()`
`Unit`	`getHotspotBounds(outRect: Rect!)`
`Int`	`getIntrinsicHeight()`
`Int`	`getIntrinsicWidth()`
`Int`	`getLayoutDirection()`
`Int`	`getLevel()`
`Int`	`getMinimumHeight()`
`Int`	`getMinimumWidth()`
`abstract Int`	`getOpacity()` This function is deprecated.
`Insets!`	`getOpticalInsets()`
`Unit`	`getOutline(outline: Outline!)`
`Boolean`	`getPadding(padding: Rect!)`
`IntArray<Int>!`	`getState()`
`Region!`	`getTransparentRegion()`
`Boolean`	`hasFocusStateSpecified()`
`Unit`	`inflate(r: Resources!, parser: XmlPullParser!, attrs: AttributeSet!)`
`Unit`	`invalidateSelf()`
`Boolean`	`isAutoMirrored()`
`Boolean`	`isFilterBitmap()`
`Boolean`	`isProjected()`
`Boolean`	`isStateful()`
`Boolean`	`isVisible()`
`Unit`	`jumpToCurrentState()`
`Drawable!`	`mutate()`
`Unit`	`onBoundsChange(bounds: Rect!)`
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)`
`Boolean`	`onLevelChange(level: Int)`
`Boolean`	`onStateChange(state: IntArray!)`
`java-static Int`	`resolveOpacity(op1: Int, op2: Int)`
`Unit`	`scheduleSelf(what: Runnable!, when: Long)`
`abstract Unit`	`setAlpha(p: Int)`
`Unit`	`setAutoMirrored(mirrored: Boolean)`
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setCallback(cb: Drawable.Callback!)`
`Unit`	`setChangingConfigurations(configs: Int)`
`abstract Unit`	`setColorFilter(p: ColorFilter!)`
`Unit`	`setDither(dither: Boolean)` This function is deprecated.
`Unit`	`setFilterBitmap(filter: Boolean)`
`Unit`	`setHotspot(x: Float, y: Float)`
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)`
`Boolean`	`setLayoutDirection(layoutDirection: Int)`
`Boolean`	`setLevel(level: Int)`
`Boolean`	`setState(stateSet: IntArray!)`
`Unit`	`setTint(tintColor: Int)`
`Unit`	`setTintBlendMode(blendMode: BlendMode!)`
`Unit`	`setTintList(tint: ColorStateList!)`
`Unit`	`setTintMode(tintMode: PorterDuff.Mode!)`
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)`
`Unit`	`unscheduleSelf(what: Runnable!)`

From android.graphics.drawable.Drawable.Callback

`abstract Unit`	`invalidateDrawable(p: Drawable!)`
`abstract Unit`	`scheduleDrawable(p: Drawable!, p1: Runnable!, p2: Long)`
`abstract Unit`	`unscheduleDrawable(p: Drawable!, p1: Runnable!)`

From androidx.appcompat.graphics.drawable.DrawableContainerCompat

`Boolean`	`@RequiresApi(value = 21) canApplyTheme()`
`Unit`	`draw(canvas: Canvas)`
`Int`	`getAlpha()`
`Int`	`getChangingConfigurations()`
`Drawable.ConstantState!`	`getConstantState()`
`Drawable`	`getCurrent()`
`Unit`	`getHotspotBounds(outRect: Rect)`
`Int`	`getIntrinsicHeight()`
`Int`	`getIntrinsicWidth()`
`Int`	`getMinimumHeight()`
`Int`	`getMinimumWidth()`
`Int`	`getOpacity()` This function is deprecated.
`Unit`	`@RequiresApi(value = 21) getOutline(outline: Outline)`
`Boolean`	`getPadding(padding: Rect)`
`Unit`	`invalidateDrawable(who: Drawable)`
`Boolean`	`isAutoMirrored()`
`Unit`	`jumpToCurrentState()`
`Unit`	`onBoundsChange(bounds: Rect!)`
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)`
`Boolean`	`onLevelChange(level: Int)`
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)`
`Unit`	`setAlpha(alpha: Int)`
`Unit`	`setAutoMirrored(mirrored: Boolean)`
`Unit`	`setColorFilter(colorFilter: ColorFilter!)`
`Unit`	`setDither(dither: Boolean)` This function is deprecated.
`Unit`	`setEnterFadeDuration(ms: Int)` Change the global fade duration when a new drawable is entering the scene.
`Unit`	`setExitFadeDuration(ms: Int)` Change the global fade duration when a new drawable is leaving the scene.
`Unit`	`setHotspot(x: Float, y: Float)`
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setTint(tintColor: @ColorInt Int)`
`Unit`	`setTintList(tint: ColorStateList!)`
`Unit`	`setTintMode(tintMode: PorterDuff.Mode)`
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)`
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)`

Public constructors

StateListDrawableCompat

Added in 1.6.0

StateListDrawableCompat()

Creates an empty state list drawable.

Public functions

addState

Added in 1.6.0

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.

applyTheme

@RequiresApi(value = 21)
fun applyTheme(theme: Resources.Theme): Unit

inflate

Added in 1.6.0

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

Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable.

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

Throws
`org.xmlpull.v1.XmlPullParserException`
`java.io.IOException`

isStateful

fun isStateful(): Boolean

mutate

fun mutate(): Drawable

Protected functions

onStateChange

protected fun onStateChange(stateSet: IntArray): Boolean