A Drawable that changes the size of another Drawable based on its current
level value. You can control how much the child Drawable changes in width
and height based on the level, as well as a gravity to control where it is
placed in its overall container. Most often used to implement things like
progress bars.
XML attributes |
android:drawable |
Reference to a drawable resource to draw with the specified scale.
|
android:level |
Specifies the initial drawable level in the range 0 to 10000.
|
android:scaleGravity |
Specifies where the drawable is positioned after scaling.
|
android:scaleHeight |
Scale height, expressed as a percentage of the drawable's bound.
|
android:scaleWidth |
Scale width, expressed as a percentage of the drawable's bound.
|
Public constructors |
ScaleDrawable(Drawable drawable, int gravity, float scaleWidth, float scaleHeight)
Creates a new scale drawable with the specified gravity and scale
properties.
|
Public methods |
void
|
applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children.
|
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
|
getOpacity()
This method is deprecated.
This method is no longer used in graphics optimizations
|
void
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
|
Protected methods |
void
|
onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you vary based on
the bounds.
|
boolean
|
onLevelChange(int level)
Override this in your subclass to change appearance if you vary based
on level.
|
Inherited methods |
From class
android.graphics.drawable.DrawableWrapper
void
|
applyTheme(Resources.Theme t)
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.
|
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
|
getDrawable()
|
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
|
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
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
|
void
|
invalidateDrawable(Drawable who)
Called when the drawable needs to be redrawn.
|
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.
|
void
|
setAlpha(int alpha)
Specify an alpha value for the drawable.
|
void
|
setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable.
|
void
|
setDrawable(Drawable dr)
Sets the wrapped drawable.
|
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 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.
|
|
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:drawable
Reference to a drawable resource to draw with the specified scale.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
android:level
Specifies the initial drawable level in the range 0 to 10000.
May be an integer value, such as "100
".
android:scaleGravity
Specifies where the drawable is positioned after scaling. The default value is
left.
Must be one or more (separated by '|') of the following constant values.
Constant | Value | Description |
bottom | 50 | Push object to the bottom of its container, not changing its size. |
center | 11 | Place the object in the center of its container in both the vertical and horizontal axis, not changing its size. |
center_horizontal | 1 | Place object in the horizontal center of its container, not changing its size. |
center_vertical | 10 | Place object in the vertical center of its container, not changing its size. |
clip_horizontal | 8 | Additional option that can be set to have the left and/or right edges of
the child clipped to its container's bounds.
The clip will be based on the horizontal gravity: a left gravity will clip the right
edge, a right gravity will clip the left edge, and neither will clip both edges. |
clip_vertical | 80 | Additional option that can be set to have the top and/or bottom edges of
the child clipped to its container's bounds.
The clip will be based on the vertical gravity: a top gravity will clip the bottom
edge, a bottom gravity will clip the top edge, and neither will clip both edges. |
end | 800005 | Push object to the end of its container, not changing its size. |
fill | 77 | Grow the horizontal and vertical size of the object if needed so it completely fills its container. |
fill_horizontal | 7 | Grow the horizontal size of the object if needed so it completely fills its container. |
fill_vertical | 70 | Grow the vertical size of the object if needed so it completely fills its container. |
left | 3 | Push object to the left of its container, not changing its size. |
right | 5 | Push object to the right of its container, not changing its size. |
start | 800003 | Push object to the beginning of its container, not changing its size. |
top | 30 | Push object to the top of its container, not changing its size. |
android:scaleHeight
Scale height, expressed as a percentage of the drawable's bound. The value's
format is XX%. For instance: 100%, 12.5%, etc.
May be a string value, using '\\;' to escape characters such as
'\\n' or '\\uxxxx' for a unicode character;
android:scaleWidth
Scale width, expressed as a percentage of the drawable's bound. The value's
format is XX%. For instance: 100%, 12.5%, etc.
May be a string value, using '\\;' to escape characters such as
'\\n' or '\\uxxxx' for a unicode character;
Public constructors
ScaleDrawable
public ScaleDrawable (Drawable drawable,
int gravity,
float scaleWidth,
float scaleHeight)
Creates a new scale drawable with the specified gravity and scale
properties.
Parameters |
drawable |
Drawable : the drawable to scale |
gravity |
int : gravity constant (see Gravity used to position
the scaled drawable within the parent container |
scaleWidth |
float : width scaling factor [0...1] to use then the level is
at the maximum value, or -1 to not scale width |
scaleHeight |
float : height scaling factor [0...1] to use then the level
is at the maximum value, or -1 to not scale height |
Public methods
applyTheme
public void applyTheme (Resources.Theme t)
Applies the specified theme to this Drawable and its children.
Parameters |
t |
Resources.Theme : This value cannot be null . |
draw
public 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).
Parameters |
canvas |
Canvas : This value cannot be null . |
getOpacity
public int getOpacity ()
This method is deprecated.
This method is no longer used in graphics optimizations
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
PixelFormat
:
PixelFormat.UNKNOWN
,
PixelFormat.TRANSLUCENT
,
PixelFormat.TRANSPARENT
, or
PixelFormat.OPAQUE
.
An OPAQUE drawable is one that draws all all content within its bounds, completely
covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing
within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable
is a drawable in any other state, where the drawable will draw some, but not all,
of the content within its bounds and at least some content behind the drawable will
be visible. If the visibility of the drawable's contents cannot be determined, the
safest/best return value is TRANSLUCENT.
Generally a Drawable should be as conservative as possible with the
value it returns. For example, if it contains multiple child drawables
and only shows one of them at a time, if only one of the children is
TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be
returned. You can use the method resolveOpacity(int, int)
to perform a
standard reduction of two opacities to the appropriate single output.
Note that the returned value does not necessarily take into account a
custom alpha or color filter that has been applied by the client through
the setAlpha(int)
or setColorFilter(ColorFilter)
methods. Some subclasses,
such as BitmapDrawable
, ColorDrawable
, and GradientDrawable
,
do account for the value of setAlpha(int)
, but the general behavior is dependent
upon the implementation of the subclass.
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 . |
Protected methods
onBoundsChange
protected void onBoundsChange (Rect bounds)
Override this in your subclass to change appearance if you vary based on
the bounds.
Parameters |
bounds |
Rect : This value cannot be null . |
onLevelChange
protected boolean onLevelChange (int level)
Override this in your subclass to change appearance if you vary based
on level.
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. |
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-06-18 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"
}]
{"lastModified": "Last updated 2024-06-18 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-06-18 UTC."]]