Added in API level 1

InsetDrawable


open class InsetDrawable : DrawableWrapper

A Drawable that insets another Drawable by a specified distance or fraction of the content bounds. This is used when a View needs a background that is smaller than the View's actual bounds.

It can be defined in an XML file with the <inset> element. 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:insetBottom
android:insetLeft
android:insetRight
android:insetTop
android:visible Provides initial visibility state of the drawable; the default value is false.
Public constructors
InsetDrawable(drawable: Drawable?, inset: Float)

Creates a new inset drawable with the specified inset.

InsetDrawable(drawable: Drawable?, insetLeftFraction: Float, insetTopFraction: Float, insetRightFraction: Float, insetBottomFraction: Float)

Creates a new inset drawable with the specified insets in fraction of the view bounds.

InsetDrawable(drawable: Drawable?, inset: Int)

Creates a new inset drawable with the specified inset.

InsetDrawable(drawable: Drawable?, insetLeft: Int, insetTop: Int, insetRight: Int, insetBottom: Int)

Creates a new inset drawable with the specified insets in pixels.

Public methods
open Unit

Applies the specified theme to this Drawable and its children.

open Int

open Int

open Int

open Insets

open Unit
getOutline(outline: Outline)

Called to get the drawable to populate the Outline that defines its drawing area.

open Boolean
getPadding(padding: Rect)

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

Inherited functions
Boolean canApplyTheme()

Unit 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()

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.

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 onLevelChange(level: Int)

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.

Unit clearColorFilter()

Removes the color filter for this drawable.

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

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.

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(bounds: Rect)

Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.

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

android:insetBottom

android:insetLeft

android:insetLeft

android:insetRight

android:insetRight

android:insetTop

android:insetTop

android:visible

android:visible
Provides initial visibility state of the drawable; the default value is false. See android.graphics.drawable.Drawable#setVisible.

May be a boolean value, such as "true" or "false".

Public constructors

InsetDrawable

Added in API level 26
InsetDrawable(
    drawable: Drawable?,
    inset: Float)

Creates a new inset drawable with the specified inset.

Parameters
drawable Drawable?: The drawable to inset. This value may be null.
inset Float: Inset in fraction (range: [0, 1)) of the inset content bounds.

InsetDrawable

Added in API level 26
InsetDrawable(
    drawable: Drawable?,
    insetLeftFraction: Float,
    insetTopFraction: Float,
    insetRightFraction: Float,
    insetBottomFraction: Float)

Creates a new inset drawable with the specified insets in fraction of the view bounds.

Parameters
drawable Drawable?: The drawable to inset. This value may be null.
insetLeftFraction Float: Left inset in fraction (range: [0, 1)) of the inset content bounds.
insetTopFraction Float: Top inset in fraction (range: [0, 1)) of the inset content bounds.
insetRightFraction Float: Right inset in fraction (range: [0, 1)) of the inset content bounds.
insetBottomFraction Float: Bottom inset in fraction (range: [0, 1)) of the inset content bounds.

InsetDrawable

Added in API level 1
InsetDrawable(
    drawable: Drawable?,
    inset: Int)

Creates a new inset drawable with the specified inset.

Parameters
drawable Drawable?: The drawable to inset. This value may be null.
inset Int: Inset in pixels around the drawable.

InsetDrawable

Added in API level 1
InsetDrawable(
    drawable: Drawable?,
    insetLeft: Int,
    insetTop: Int,
    insetRight: Int,
    insetBottom: Int)

Creates a new inset drawable with the specified insets in pixels.

Parameters
drawable Drawable?: The drawable to inset. This value may be null.
insetLeft Int: Left inset in pixels.
insetTop Int: Top inset in pixels.
insetRight Int: Right inset in pixels.
insetBottom Int: Bottom inset in pixels.

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.

getIntrinsicHeight

Added in API level 1
open fun getIntrinsicHeight(): Int
Return
Int the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth

Added in API level 1
open fun getIntrinsicWidth(): Int
Return
Int the intrinsic width, or -1 if no intrinsic width

getOpacity

Added in API level 1
open fun getOpacity(): Int

getOpticalInsets

Added in API level 29
open fun getOpticalInsets(): Insets
Return
Insets This value cannot be null.

getOutline

Added in API level 21
open fun getOutline(outline: Outline): Unit

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.

Parameters
outline Outline: This value cannot be null.

getPadding

Added in API level 1
open fun getPadding(padding: Rect): Boolean
Parameters
padding Rect: This value cannot be null.
Return
Boolean true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

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.