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.
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 |
From class
android.graphics.drawable.StateListDrawable
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 methods |
void
|
addState(int[] stateSet, Drawable drawable, int id)
Add a new drawable to the set of keyframes.
|
<T extends Drawable & Animatable>
void
|
addTransition(int fromId, int toId, T transition, boolean reversible)
Adds a new transition between keyframes.
|
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.
|
void
|
jumpToCurrentState()
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
|
Drawable
|
mutate()
Make this drawable mutable.
|
boolean
|
setVisible(boolean visible, boolean restart)
Set whether this Drawable is visible.
|
Inherited methods |
|
From class
android.graphics.drawable.DrawableContainer
void
|
applyTheme(Resources.Theme theme)
Applies the specified theme to this Drawable and its children.
|
boolean
|
canApplyTheme()
|
void
|
draw(Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such
as alpha (set via setAlpha) and color filter (set via setColorFilter).
|
int
|
getAlpha()
Gets the current alpha value for the drawable.
|
int
|
getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
|
Drawable.ConstantState
|
getConstantState()
Return a ConstantState instance that holds the shared state of this Drawable.
|
Drawable
|
getCurrent()
|
void
|
getHotspotBounds(Rect outRect)
Populates outRect with the hotspot bounds.
|
int
|
getIntrinsicHeight()
Returns the drawable's intrinsic height.
|
int
|
getIntrinsicWidth()
Returns the drawable's intrinsic width.
|
int
|
getMinimumHeight()
Returns the minimum height suggested by this Drawable.
|
int
|
getMinimumWidth()
Returns the minimum width suggested by this Drawable.
|
int
|
getOpacity()
This method is deprecated.
This method is no longer used in graphics optimizations
|
Insets
|
getOpticalInsets()
Return in insets the layout insets suggested by this Drawable for use with alignment
operations during layout.
|
void
|
getOutline(Outline outline)
Called to get the drawable to populate the Outline that defines its drawing area.
|
boolean
|
getPadding(Rect padding)
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
|
boolean
|
hasFocusStateSpecified()
Indicates whether this drawable has at least one state spec explicitly
specifying R.attr.state_focused .
|
void
|
invalidateDrawable(Drawable who)
Called when the drawable needs to be redrawn.
|
boolean
|
isAutoMirrored()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left.
|
boolean
|
isStateful()
Indicates whether this drawable will change its appearance based on
state.
|
void
|
jumpToCurrentState()
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
|
Drawable
|
mutate()
Make this drawable mutable.
|
void
|
onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you vary based on
the bounds.
|
boolean
|
onLayoutDirectionChanged(int layoutDirection)
Called when the drawable's resolved layout direction changes.
|
boolean
|
onLevelChange(int level)
Override this in your subclass to change appearance if you vary based
on level.
|
boolean
|
onStateChange(int[] state)
Override this in your subclass to change appearance if you recognize the
specified state.
|
void
|
scheduleDrawable(Drawable who, Runnable what, long when)
A Drawable can call this to schedule the next frame of its
animation.
|
boolean
|
selectDrawable(int index)
Sets the currently displayed drawable by index.
|
void
|
setAlpha(int alpha)
Specify an alpha value for the drawable.
|
void
|
setAutoMirrored(boolean mirrored)
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left).
|
void
|
setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable.
|
void
|
setConstantState(DrawableContainer.DrawableContainerState state)
|
void
|
setDither(boolean dither)
This method is deprecated.
This property is ignored.
|
void
|
setEnterFadeDuration(int ms)
Change the global fade duration when a new drawable is entering
the scene.
|
void
|
setExitFadeDuration(int ms)
Change the global fade duration when a new drawable is leaving
the scene.
|
void
|
setHotspot(float x, float y)
Specifies the hotspot's location within the drawable.
|
void
|
setHotspotBounds(int left, int top, int right, int bottom)
Sets the bounds to which the hotspot is constrained, if they should be
different from the drawable bounds.
|
void
|
setTintBlendMode(BlendMode blendMode)
Specifies a tint blending mode for this drawable.
|
void
|
setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list.
|
boolean
|
setVisible(boolean visible, boolean restart)
Set whether this Drawable is visible.
|
void
|
unscheduleDrawable(Drawable who, Runnable what)
A Drawable can call this to unschedule an action previously
scheduled with scheduleDrawable(Drawable, Runnable, long) .
|
|
From class
android.graphics.drawable.Drawable
void
|
applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children.
|
boolean
|
canApplyTheme()
|
void
|
clearColorFilter()
Removes the color filter for this drawable.
|
final
Rect
|
copyBounds()
Return a copy of the drawable's bounds in a new Rect.
|
final
void
|
copyBounds(Rect bounds)
Return a copy of the drawable's bounds in the specified Rect (allocated
by the caller).
|
static
Drawable
|
createFromPath(String pathName)
Create a drawable from file path name.
|
static
Drawable
|
createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts)
This method was deprecated
in API level 28.
Prefer the version without an Options object.
|
static
Drawable
|
createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName)
Create a drawable from an inputstream, using the given resources and
value to determine density information.
|
static
Drawable
|
createFromStream(InputStream is, String srcName)
Create a drawable from an inputstream
|
static
Drawable
|
createFromXml(Resources r, XmlPullParser parser)
Create a drawable from an XML document.
|
static
Drawable
|
createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme)
Create a drawable from an XML document using an optional Theme .
|
static
Drawable
|
createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Create a drawable from inside an XML document using an optional
Theme .
|
static
Drawable
|
createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs)
Create from inside an XML document.
|
abstract
void
|
draw(Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such
as alpha (set via setAlpha) and color filter (set via setColorFilter).
|
int
|
getAlpha()
Gets the current alpha value for the drawable.
|
final
Rect
|
getBounds()
Return the drawable's bounds Rect.
|
Drawable.Callback
|
getCallback()
Return the current Callback implementation attached to this
Drawable.
|
int
|
getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
|
ColorFilter
|
getColorFilter()
Returns the current color filter, or null if none set.
|
Drawable.ConstantState
|
getConstantState()
Return a ConstantState instance that holds the shared state of this Drawable.
|
Drawable
|
getCurrent()
|
Rect
|
getDirtyBounds()
Return the drawable's dirty bounds Rect.
|
void
|
getHotspotBounds(Rect outRect)
Populates outRect with the hotspot bounds.
|
int
|
getIntrinsicHeight()
Returns the drawable's intrinsic height.
|
int
|
getIntrinsicWidth()
Returns the drawable's intrinsic width.
|
int
|
getLayoutDirection()
Returns the resolved layout direction for this Drawable.
|
final
int
|
getLevel()
Retrieve the current level.
|
int
|
getMinimumHeight()
Returns the minimum height suggested by this Drawable.
|
int
|
getMinimumWidth()
Returns the minimum width suggested by this Drawable.
|
abstract
int
|
getOpacity()
This method was deprecated
in API level 29.
This method is no longer used in graphics optimizations
|
Insets
|
getOpticalInsets()
Return in insets the layout insets suggested by this Drawable for use with alignment
operations during layout.
|
void
|
getOutline(Outline outline)
Called to get the drawable to populate the Outline that defines its drawing area.
|
boolean
|
getPadding(Rect padding)
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
|
int[]
|
getState()
Describes the current state, as a union of primitve states, such as
R.attr.state_focused ,
R.attr.state_selected , etc.
|
Region
|
getTransparentRegion()
Returns a Region representing the part of the Drawable that is completely
transparent.
|
boolean
|
hasFocusStateSpecified()
Indicates whether this drawable has at least one state spec explicitly
specifying R.attr.state_focused .
|
void
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
|
void
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
Inflate this Drawable from an XML resource.
|
void
|
invalidateSelf()
Use the current Callback implementation to have this Drawable
redrawn.
|
boolean
|
isAutoMirrored()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left.
|
boolean
|
isFilterBitmap()
|
boolean
|
isProjected()
Whether this drawable requests projection.
|
boolean
|
isStateful()
Indicates whether this drawable will change its appearance based on
state.
|
final
boolean
|
isVisible()
|
void
|
jumpToCurrentState()
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
|
Drawable
|
mutate()
Make this drawable mutable.
|
void
|
onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you vary based on
the bounds.
|
boolean
|
onLayoutDirectionChanged(int layoutDirection)
Called when the drawable's resolved layout direction changes.
|
boolean
|
onLevelChange(int level)
Override this in your subclass to change appearance if you vary based
on level.
|
boolean
|
onStateChange(int[] state)
Override this in your subclass to change appearance if you recognize the
specified state.
|
static
int
|
resolveOpacity(int op1, int op2)
Return the appropriate opacity value for two source opacities.
|
void
|
scheduleSelf(Runnable what, long when)
Use the current Callback implementation to have this Drawable
scheduled.
|
abstract
void
|
setAlpha(int alpha)
Specify an alpha value for the drawable.
|
void
|
setAutoMirrored(boolean mirrored)
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left).
|
void
|
setBounds(int left, int top, int right, int bottom)
Specify a bounding rectangle for the Drawable.
|
void
|
setBounds(Rect bounds)
Specify a bounding rectangle for the Drawable.
|
final
void
|
setCallback(Drawable.Callback cb)
Bind a Callback object to this Drawable.
|
void
|
setChangingConfigurations(int configs)
Set a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
|
void
|
setColorFilter(int color, PorterDuff.Mode mode)
This method was deprecated
in API level 29.
use setColorFilter(android.graphics.ColorFilter) with an instance
of BlendModeColorFilter
|
abstract
void
|
setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable.
|
void
|
setDither(boolean dither)
This method was deprecated
in API level 23.
This property is ignored.
|
void
|
setFilterBitmap(boolean filter)
Set to true to have the drawable filter its bitmaps with bilinear
sampling when they are scaled or rotated.
|
void
|
setHotspot(float x, float y)
Specifies the hotspot's location within the drawable.
|
void
|
setHotspotBounds(int left, int top, int right, int bottom)
Sets the bounds to which the hotspot is constrained, if they should be
different from the drawable bounds.
|
final
boolean
|
setLayoutDirection(int layoutDirection)
Set the layout direction for this drawable.
|
final
boolean
|
setLevel(int level)
Specify the level for the drawable.
|
boolean
|
setState(int[] stateSet)
Specify a set of states for the drawable.
|
void
|
setTint(int tintColor)
Specifies tint color for this drawable.
|
void
|
setTintBlendMode(BlendMode blendMode)
Specifies a tint blending mode for this drawable.
|
void
|
setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list.
|
void
|
setTintMode(PorterDuff.Mode tintMode)
Specifies a tint blending mode for this drawable.
|
boolean
|
setVisible(boolean visible, boolean restart)
Set whether this Drawable is visible.
|
void
|
unscheduleSelf(Runnable what)
Use the current Callback implementation to have this Drawable
unscheduled.
|
|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
|
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. 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
AnimatedStateListDrawable
public AnimatedStateListDrawable ()
Public methods
addState
public void addState (int[] stateSet,
Drawable drawable,
int id)
Add a new drawable to the set of keyframes.
Parameters |
stateSet |
int : 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
public void addTransition (int fromId,
int toId,
T transition,
boolean reversible)
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
public void applyTheme (Resources.Theme theme)
Applies the specified theme to this Drawable and its children.
Parameters |
theme |
Resources.Theme : This value may be null . |
inflate
public 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 : 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 . |
isStateful
public 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. |
jumpToCurrentState
public void jumpToCurrentState ()
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
mutate
public 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.
This value cannot be null . |
setVisible
public boolean setVisible (boolean visible,
boolean restart)
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.
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. |
Returns |
boolean |
boolean Returns true if the new visibility is different than
its previous state. |
Protected methods
onStateChange
protected boolean onStateChange (int[] stateSet)
Override this in your subclass to change appearance if you recognize the
specified state.
Parameters |
stateSet |
int : This value cannot be null . |
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. |
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.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]