public
class
StateListDrawable
extends DrawableContainer
| java.lang.Object | |||
| ↳ | android.graphics.drawable.Drawable | ||
| ↳ | android.graphics.drawable.DrawableContainer | ||
| ↳ | android.graphics.drawable.StateListDrawable | ||
 Known Direct Subclasses
|
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.
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 | |
|---|---|
StateListDrawable()
|
|
Public methods | |
|---|---|
void
|
addState(int[] stateSet, Drawable drawable)
Add a new image/string ID to the set of images. |
void
|
applyTheme(Resources.Theme theme)
Applies the specified theme to this Drawable and its children. |
void
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme. |
boolean
|
isStateful()
Indicates whether this drawable will change its appearance based on state. |
Drawable
|
mutate()
Make this drawable mutable. |
Protected methods | |
|---|---|
boolean
|
onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state. |
void
|
setConstantState(DrawableContainer.DrawableContainerState state)
|
Inherited methods | |
|---|---|
From
class
android.graphics.drawable.DrawableContainer
| |
From
class
android.graphics.drawable.Drawable
| |
From
class
java.lang.Object
| |
From
interface
android.graphics.drawable.Drawable.Callback
| |
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.
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 constantSize.
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,
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.
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,
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.
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,
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.
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,
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.
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,
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.
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.
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.
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 variablePadding.
Indicates whether the drawable should be initially visible.
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 visible.
Developers
void addState (int[] stateSet,
Drawable drawable)
Add a new image/string ID to the set of images.
| Parameters | |
|---|---|
stateSet |
int:
- An array of resource Ids to associate with the image.
Switch to this image by calling setState(). |
drawable |
Drawable:
-The image to show.
|
void applyTheme (Resources.Theme theme)
Applies the specified theme to this Drawable and its children.
| Parameters | |
|---|---|
theme |
Resources.Theme:
the theme to apply
|
void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
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:
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 | |
|---|---|
XmlPullParserException |
|
IOException |
|
boolean isStateful ()
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.
| Returns | |
|---|---|
boolean |
True if this drawable changes its appearance based on state, false otherwise. |
Drawable mutate ()
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.
| Returns | |
|---|---|
Drawable |
This drawable. |
boolean onStateChange (int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
| Parameters | |
|---|---|
stateSet |
int
|
| Returns | |
|---|---|
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. |
void setConstantState (DrawableContainer.DrawableContainerState state)
| Parameters | |
|---|---|
state |
DrawableContainer.DrawableContainerState
|