StateListAnimator
public
class
StateListAnimator
extends Object
implements
Cloneable
| java.lang.Object | |
| ↳ | android.animation.StateListAnimator |
Lets you define a number of Animators that will run on the attached View depending on the View's drawable state.
It can be defined in an XML file with the <selector> element.
Each State Animator is defined in a nested <item> element.
Summary
XML attributes | |
|---|---|
android:animation |
Animation to use on each child. |
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.
|
Public constructors | |
|---|---|
StateListAnimator()
|
|
Public methods | |
|---|---|
void
|
addState(int[] specs, Animator animator)
Associates the given animator with the provided drawable state specs so that it will be run when the View's drawable state matches the specs. |
StateListAnimator
|
clone()
Creates and returns a copy of this object. |
void
|
jumpToCurrentState()
If there is an animation running for a recent state change, ends it. |
Inherited methods | |
|---|---|
XML attributes
android:animation
Animation to use on each child.
May be a reference to another resource, in the form
"@[+][package:]type/name" or a theme
attribute in the form
"?[package:]type/name".
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[] specs,
Animator animator)
Associates the given animator with the provided drawable state specs so that it will be run when the View's drawable state matches the specs.
| Parameters | |
|---|---|
specs |
int: The drawable state specs to match against |
animator |
Animator: The animator to run when the specs match |
clone
public StateListAnimator clone ()
Creates and returns a copy of this object. The precise meaning
of "copy" may depend on the class of the object. The general
intent is that, for any object x, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone. If a class and all of its superclasses (except
Object) obey this convention, it will be the case that
x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
| Returns | |
|---|---|
StateListAnimator |
a clone of this instance. |
jumpToCurrentState
public void jumpToCurrentState ()
If there is an animation running for a recent state change, ends it.
This causes the animation to assign the end value(s) to the View.
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 2024-04-04 UTC.