LevelListDrawable


public class LevelListDrawable
extends DrawableContainer

java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.DrawableContainer
       ↳ android.graphics.drawable.LevelListDrawable


A resource that manages a number of alternate Drawables, each assigned a maximum numerical value. Setting the level value of the object with Drawable.setLevel(int) will load the image with the next greater or equal value assigned to its max attribute. A good example use of a LevelListDrawable would be a battery level indicator icon, with different images to indicate the current battery level.

It can be defined in an XML file with the <level-list> element. Each Drawable level is defined in a nested <item>. For example:

 <level-list xmlns:android="http://schemas.android.com/apk/res/android">
  <item android:maxLevel="0" android:drawable="@drawable/ic_wifi_signal_1" />
  <item android:maxLevel="1" android:drawable="@drawable/ic_wifi_signal_2" />
  <item android:maxLevel="2" android:drawable="@drawable/ic_wifi_signal_3" />
  <item android:maxLevel="3" android:drawable="@drawable/ic_wifi_signal_4" />
 </level-list>

With this XML saved into the res/drawable/ folder of the project, it can be referenced as the drawable for an ImageView. The default image is the first in the list. It can then be changed to one of the other levels with ImageView.setImageLevel(int). For more information, see the guide to Drawable Resources.

Summary

XML attributes

android:drawable Reference to a drawable resource to use for the frame. 
android:maxLevel The maximum level allowed for this item. 
android:minLevel The minimum level allowed for this item. 

Public constructors

LevelListDrawable()

Public methods

void addLevel(int low, int high, Drawable drawable)
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Inflate this Drawable from an XML resource optionally styled by a theme.

Drawable mutate()

Make this drawable mutable.

Protected methods

boolean onLevelChange(int level)

Override this in your subclass to change appearance if you vary based on level.

void setConstantState(DrawableContainer.DrawableContainerState state)

Inherited methods

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).

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 primitive 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.

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.

abstract void invalidateDrawable(Drawable who)

Called when the drawable needs to be redrawn.

abstract void scheduleDrawable(Drawable who, Runnable what, long when)

A Drawable can call this to schedule the next frame of its animation.

abstract void unscheduleDrawable(Drawable who, Runnable what)

A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable(Drawable, Runnable, long).

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:maxLevel

The maximum level allowed for this item.

May be an integer value, such as "100".

android:minLevel

The minimum level allowed for this item.

May be an integer value, such as "100".

Public constructors

LevelListDrawable

Added in API level 1
public LevelListDrawable ()

Public methods

addLevel

Added in API level 1
public void addLevel (int low, 
                int high, 
                Drawable drawable)

Parameters
low int

high int

drawable Drawable

inflate

Added in API level 21
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

mutate

Added in API level 3
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.

Protected methods

onLevelChange

Added in API level 1
protected boolean onLevelChange (int level)

Override this in your subclass to change appearance if you vary based on level.

Parameters
level int

Returns
boolean Returns true if the level 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 level.

setConstantState

Added in API level 1
protected void setConstantState (DrawableContainer.DrawableContainerState state)

Parameters
state DrawableContainer.DrawableContainerState: This value cannot be null.