AnimatedStateListDrawable
open class AnimatedStateListDrawable : StateListDrawable
kotlin.Any | ||||
↳ | 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 | |
---|---|
Public methods | |
---|---|
open Unit |
Add a new drawable to the set of keyframes. |
open Unit |
addTransition(fromId: Int, toId: Int, transition: T, reversible: Boolean) Adds a new transition between keyframes. |
open Unit |
applyTheme(theme: Resources.Theme!) Applies the specified theme to this Drawable and its children. |
open Unit |
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?) Inflate this Drawable from an XML resource optionally styled by a theme. |
open Boolean | |
open Unit | |
open Drawable |
mutate() |
open Boolean |
setVisible(visible: Boolean, restart: Boolean) |
Protected methods | |
---|---|
open Boolean |
onStateChange(stateSet: IntArray) |
open Unit |
Inherited functions | |
---|---|
XML attributes
android:state_activated
android:state_activated
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
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
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
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
StateListDrawable
, set when a view is enabled.
May be a boolean value, such as "true
" or "false
".
android:state_first
android:state_first
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
StateListDrawable
, set when a view has input focus.
May be a boolean value, such as "true
" or "false
".
android:state_last
android:state_last
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
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
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
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
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
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
open fun addState(
stateSet: IntArray,
drawable: Drawable,
id: Int
): Unit
Add a new drawable to the set of keyframes.
Parameters | |
---|---|
stateSet |
IntArray: An array of resource IDs to associate with the keyframe This value cannot be null . |
drawable |
Drawable: The drawable to show when in the specified state, may not be null |
id |
Int: The unique identifier for the keyframe |
addTransition
open fun <T> addTransition(
fromId: Int,
toId: Int,
transition: T,
reversible: Boolean
): Unit where T : Drawable!, T : Animatable!
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: An Animatable drawable to use as a transition, may not be null |
reversible |
Boolean: Whether the transition can be reversed |
applyTheme
open fun applyTheme(theme: Resources.Theme!): Unit
Applies the specified theme to this Drawable and its children.
Parameters | |
---|---|
t |
the theme to apply This value cannot be null . |
theme |
Resources.Theme!: This value may be null . |
inflate
open fun inflate(
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. Note that framework may have called this once to create the Drawable instance from XML resource.
Parameters | |
---|---|
r |
Resources: This value cannot be null . |
parser |
XmlPullParser: This value cannot be null . |
attrs |
AttributeSet: This value cannot be null . |
theme |
Resources.Theme?: This value may be null . |
Exceptions | |
---|---|
org.xmlpull.v1.XmlPullParserException |
|
java.io.IOException |
isStateful
open fun isStateful(): Boolean
Return | |
---|---|
Boolean |
True if this drawable changes its appearance based on state, false otherwise. |
mutate
open fun mutate(): Drawable
Return | |
---|---|
Drawable |
This drawable. This value cannot be null . |
setVisible
open fun setVisible(
visible: Boolean,
restart: Boolean
): Boolean
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. |
Return | |
---|---|
Boolean |
boolean Returns true if the new visibility is different than its previous state. |
Protected methods
onStateChange
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
protected open fun setConstantState(state: DrawableContainer.DrawableContainerState): Unit
Parameters | |
---|---|
state |
DrawableContainer.DrawableContainerState: This value cannot be null . |