ScaleDrawable

Kotlin |Java

open class ScaleDrawable : DrawableWrapper

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.DrawableWrapper
		↳	android.graphics.drawable.ScaleDrawable

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.

The default level may be specified from XML using the android:level property. When this property is not specified, the default level is 0, which corresponds to zero height and/or width depending on the values specified for android.R.styleable#ScaleDrawable_scaleWidth scaleWidth and android.R.styleable#ScaleDrawable_scaleHeight scaleHeight. At run time, the level may be set via setLevel(int).

A scale drawable may be defined in an XML file with the <scale> element. For more information, see the guide to Drawable Resources.

Summary

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!, gravity: Int, scaleWidth: Float, scaleHeight: Float)` Creates a new scale drawable with the specified gravity and scale properties.

Public methods
open Unit	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
open Unit	`draw(canvas: Canvas)`
open Int	`getOpacity()`
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme.

Protected methods
open Unit	`onBoundsChange(bounds: Rect)`
open Boolean	`onLevelChange(level: Int)`

Inherited functions

From class DrawableWrapper

`Boolean`	`canApplyTheme()`
`Int`	`getAlpha()`
`Int`	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. The default implementation returns whatever was provided through `setChangingConfigurations(int)` or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.
`ColorFilter?`	`getColorFilter()`
`Drawable.ConstantState?`	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
`Drawable?`	`getDrawable()`
`Unit`	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
`Int`	`getIntrinsicHeight()`
`Int`	`getIntrinsicWidth()`
`Insets`	`getOpticalInsets()`
`Unit`	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area. This method is called by the default `android.view.ViewOutlineProvider` to define the outline of the View. The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.
`Boolean`	`getPadding(padding: Rect)` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).
`Boolean`	`hasFocusStateSpecified()`
`Unit`	`invalidateDrawable(who: Drawable)` Called when the drawable needs to be redrawn. A view at this point should invalidate itself (or at least the part of itself where the drawable appears).
`Boolean`	`isStateful()`
`Unit`	`jumpToCurrentState()`
`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.
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onStateChange(state: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)` A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call `android.os.Handler#postAtTime(Runnable, Object, long)` with the parameters (what, who, when) to perform the scheduling.
`Unit`	`setAlpha(alpha: Int)`
`Unit`	`setColorFilter(colorFilter: ColorFilter?)` Specify an optional color filter for the drawable. If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas. Pass `null` to remove any existing color filter. Note: Setting a non-`null` color filter disables `tint`.
`Unit`	`setDrawable(dr: Drawable?)` Sets the wrapped drawable.
`Unit`	`setHotspot(x: Float, y: Float)`
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setTintBlendMode(blendMode: BlendMode!)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `BlendMode#SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)`
`Unit`	`setTintList(tint: ColorStateList?)` Specifies tint color for this drawable as a color state list. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)`
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)` A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable`. An implementation can generally simply call `android.os.Handler#removeCallbacks(Runnable, Object)` with the parameters (what, who) to unschedule the drawable.

From class Drawable

`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`Unit`	`copyBounds(bounds: Rect)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
`Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
`Drawable?`	`createFromPath(pathName: String!)` Create a drawable from file path name.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromStream(is: InputStream?, srcName: String?)` Create a drawable from an inputstream
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser)` Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)` Create a drawable from an XML document using an optional `Theme`. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Create a drawable from inside an XML document using an optional `Theme`. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns `null` if the tag is not a valid drawable.
`Rect`	`getBounds()` Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
`Drawable.Callback?`	`getCallback()` Return the current `Callback` implementation attached to this Drawable.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`Int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`IntArray`	`getState()` Describes the current state, as a union of primitive states, such as `android.R.attr#state_focused`, `android.R.attr#state_selected`, etc. Some drawables may modify their imagery based on the selected state.
`Region?`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Inflate this Drawable from an XML resource. Does not apply a theme.
`Unit`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See `android.util.LayoutDirection`.
`Boolean`	`isFilterBitmap()`
`Boolean`	`isProjected()` Whether this drawable requests projection. Indicates that the `android.graphics.RenderNode` this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.
`Boolean`	`isVisible()`
`Int`	`resolveOpacity(op1: Int, op2: Int)` Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing `getOpacity`.
`Unit`	`scheduleSelf(what: Runnable, when: Long)` Use the current `Callback` implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
`Unit`	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See `android.util.LayoutDirection`.
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setBounds(bounds: Rect)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setCallback(cb: Drawable.Callback?)` Bind a `Callback` object to this Drawable. Required for clients that want to support animated drawables.
`Unit`	`setChangingConfigurations(configs: Int)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`Unit`	`setColorFilter(color: Int, mode: PorterDuff.Mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for `setColorFilter(android.graphics.ColorFilter)` which constructs a `PorterDuffColorFilter`. Note: Setting a color filter disables `tint`.
`Unit`	`setDither(dither: Boolean)` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
`Unit`	`setFilterBitmap(filter: Boolean)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored.
`Boolean`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
`Boolean`	`setLevel(level: Int)` Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function.
`Boolean`	`setState(stateSet: IntArray)` Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [`android.R.attr#state_focused`, `android.R.attr#state_pressed`]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
`Unit`	`setTint(tintColor: Int)` Specifies tint color for this drawable. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. To clear the tint, pass `null` to `setTintList(android.content.res.ColorStateList)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintMode(tintMode: PorterDuff.Mode?)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `PorterDuff.Mode#SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`unscheduleSelf(what: Runnable)` Use the current `Callback` implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:drawable

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

android:level

Specifies the initial drawable level in the range 0 to 10000.

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

android:scaleGravity

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

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

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

Added in API level 1

ScaleDrawable(
    drawable: Drawable!, 
    gravity: Int, 
    scaleWidth: Float, 
    scaleHeight: Float)

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

Added in API level 21

open fun applyTheme(t: Resources.Theme): Unit

Applies the specified theme to this Drawable and its children.

Parameters
`t`	Resources.Theme: This value cannot be `null`.

draw

Added in API level 1

open fun draw(canvas: Canvas): Unit

Parameters
`canvas`	Canvas: This value cannot be `null`.

getOpacity

Added in API level 1

open fun getOpacity(): Int

Return
`Int`	int The opacity class of the Drawable. Value is `android.graphics.PixelFormat#UNKNOWN`, `android.graphics.PixelFormat#TRANSLUCENT`, `android.graphics.PixelFormat#TRANSPARENT`, or `android.graphics.PixelFormat#OPAQUE`

inflate

Added in API level 21

open fun inflate(
    r: Resources, 
    parser: XmlPullParser, 
    attrs: AttributeSet, 
    theme: Resources.Theme?
): Unit

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

Exceptions
`org.xmlpull.v1.XmlPullParserException`
`java.io.IOException`

Protected methods

onBoundsChange

Added in API level 1

protected open fun onBoundsChange(bounds: Rect): Unit

Parameters
`bounds`	Rect: This value cannot be `null`.

onLevelChange

Added in API level 1

protected open fun onLevelChange(level: Int): Boolean

Return
`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.