An object used to create frame-by-frame animations, defined by a series of
Drawable objects, which can be used as a View object's background.
The simplest way to create a frame-by-frame animation is to define the
animation in an XML file, placed in the res/drawable/ folder, and set it as
the background to a View object. Then, call start()
to run the
animation.
Here is the code to load and play this animation.
XML attributes |
android:drawable |
Reference to a drawable resource to use for the frame.
|
android:duration |
Amount of time (in milliseconds) to display this frame.
|
android:oneshot |
If true, the animation will only run a single time and then
stop.
|
android:variablePadding |
If true, allows the drawable's padding to change based on the
current state that is selected.
|
android:visible |
Provides initial visibility state of the drawable; the default
value is false.
|
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.
|
|
|
From interface
java.lang.Runnable
abstract
void
|
run()
When an object implementing interface Runnable is used
to create a thread, starting the thread causes the object's
run method to be called in that separately executing
thread.
|
|
|
XML attributes
android:drawable
Reference to a drawable resource to use for the frame. If not
given, the drawable must be defined by the first child tag.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
android:duration
Amount of time (in milliseconds) to display this frame.
May be an integer value, such as "100
".
android:oneshot
If true, the animation will only run a single time and then
stop. If false (the default), it will continually run,
restarting at the first frame after the last has finished.
May be a boolean value, such as "true
" or
"false
".
android:variablePadding
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.
May be a boolean value, such as "true
" or
"false
".
android:visible
Provides initial visibility state of the drawable; the default
value is false. See
Drawable.setVisible(boolean, boolean)
.
May be a boolean value, such as "true
" or
"false
".
Public constructors
AnimationDrawable
public AnimationDrawable ()
Public methods
addFrame
public void addFrame (Drawable frame,
int duration)
Adds a frame to the animation
Parameters |
frame |
Drawable : The frame to add
This value cannot be null . |
duration |
int : How long in milliseconds the frame should appear |
getDuration
public int getDuration (int i)
Returns |
int |
The duration in milliseconds of the frame at the
specified index |
getFrame
public Drawable getFrame (int index)
Returns |
Drawable |
The Drawable at the specified frame index |
getNumberOfFrames
public int getNumberOfFrames ()
Returns |
int |
The number of frames in the animation |
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 : Resources used to resolve attribute values
This value cannot be null . |
parser |
XmlPullParser : XML parser from which to inflate this Drawable
This value cannot be null . |
attrs |
AttributeSet : Base set of attribute values
This value cannot be null . |
theme |
Resources.Theme : Theme to apply, may be null |
isOneShot
public boolean isOneShot ()
Returns |
boolean |
True of the animation will play once, false otherwise |
isRunning
public boolean isRunning ()
Indicates whether the animation is currently running or not.
Returns |
boolean |
true if the animation is running, false otherwise |
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 value cannot be null . |
run
public void run ()
This method exists for implementation purpose only and should not be
called directly. Invoke start()
instead.
setOneShot
public void setOneShot (boolean oneShot)
Sets whether the animation should play once or repeat.
Parameters |
oneShot |
boolean : Pass true if the animation should only play once |
setVisible
public boolean setVisible (boolean visible,
boolean restart)
Sets whether this AnimationDrawable is visible.
When the drawable becomes invisible, it will pause its animation. A subsequent change to
visible with restart
set to true will restart the animation from the
first frame. If restart
is false, the drawable will resume from the most recent
frame. If the drawable has already reached the last frame, it will then loop back to the
first frame, unless it's a one shot drawable (set through setOneShot(boolean)
),
in which case, it will stay on the last frame.
Parameters |
visible |
boolean : true if visible, false otherwise |
restart |
boolean : when visible, true to force the animation to restart
from the first frame |
Returns |
boolean |
true if the new visibility is different than its previous state |
start
public void start ()
Starts the animation from the first frame, looping if necessary. This method has no effect
if the animation is running.
Note: Do not call this in the
Activity.onCreate(Bundle)
method of your activity, because
the AnimationDrawable
is not yet fully attached to the window.
If you want to play the animation immediately without requiring
interaction, then you might want to call it from the
Activity.onWindowFocusChanged(boolean)
method in your
activity, which will get called when Android brings your window into
focus.
stop
public void stop ()
Stops the animation at the current frame. This method has no effect if the animation is not
running.
unscheduleSelf
public void unscheduleSelf (Runnable what)
Use the current Callback
implementation to have this Drawable
unscheduled. Does nothing if there is no Callback attached to the
Drawable.
Parameters |
what |
Runnable : The runnable that you no longer want called.
This value cannot be null . |
Protected methods
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"
}]