java.lang.Object | ||||
↳ | 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.
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 . |
||||||||||
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 . |
||||||||||
android:state_focused | State value for StateListDrawable ,
set when a view has input focus. |
||||||||||
android:state_last | State value for StateListDrawable . |
||||||||||
android:state_middle | State value for StateListDrawable . |
||||||||||
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 . |
||||||||||
android:state_window_focused | State value for StateListDrawable ,
set when a view's window has input focus. |
[Expand]
Inherited XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.graphics.drawable.StateListDrawable
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add a new drawable to the set of keyframes.
| |||||||||||
Adds a new transition between keyframes.
| |||||||||||
Inflate this Drawable from an XML resource optionally styled by a theme.
| |||||||||||
Indicates whether this drawable will change its appearance based on
state.
| |||||||||||
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
| |||||||||||
Make this drawable mutable.
| |||||||||||
Set whether this Drawable is visible.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this in your subclass to change appearance if you recognize the
specified state.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.graphics.drawable.StateListDrawable
| |||||||||||
From class
android.graphics.drawable.DrawableContainer
| |||||||||||
From class
android.graphics.drawable.Drawable
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.graphics.drawable.Drawable.Callback
|
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.
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_activated
.
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
.
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
.
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
.
State value for StateListDrawable
,
set when a view is enabled.
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
.
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
.
State value for StateListDrawable
,
set when a view has input focus.
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
.
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
.
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
.
State value for StateListDrawable
,
set when the user is pressing down in a view.
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
.
State value for StateListDrawable
,
set when a view (or one of its parents) is currently selected.
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
.
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
.
State value for StateListDrawable
,
set when a view's window has input focus.
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
.
Add a new drawable to the set of keyframes.
stateSet | An array of resource IDs to associate with the keyframe |
---|---|
drawable | The drawable to show when in the specified state |
id | The unique identifier for the keyframe |
Adds a new transition between keyframes.
fromId | Unique identifier of the starting keyframe |
---|---|
toId | Unique identifier of the ending keyframe |
anim | An AnimationDrawable to use as a transition |
reversible | Whether the transition can be reversed |
Inflate this Drawable from an XML resource optionally styled by a theme.
r | Resources used to resolve attribute values |
---|---|
parser | XML parser from which to inflate this Drawable |
attrs | Base set of attribute values |
theme | Theme to apply, may be null |
Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.
If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
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.
Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
visible | Set to true if visible, false if not. |
---|---|
restart | 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. |
Override this in your subclass to change appearance if you recognize the specified state.