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.
The inset values are added to the padding of the view. For instance, if a view has a padding of 10 pixels on all sides and an InsetDrawable with an inset of 5 pixels is set as its background, the effective padding of the view will be 15 pixels on all sides.
Note: When using fractional insets (floats), the intrinsic size calculation is influenced by insets on opposite sides. For example, applying a fractional inset to only the bottom of a drawable may also affect the drawable's top padding. For insets that should only affect a single side, using dimension-based insets (integers) will provide that behavior.
Summary
| Public constructors |
|
Creates a new inset drawable with the specified inset.
|
|
Creates a new inset drawable with the specified insets in fraction of the view bounds.
|
|
Creates a new inset drawable with the specified inset.
|
|
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 |
Returns the drawable's intrinsic height.
|
| open Int |
Returns the drawable's intrinsic width.
|
| open Int |
Return the opacity/transparency of this Drawable.
|
| open Insets |
Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
|
| open Unit |
Called to get the drawable to populate the Outline that defines its drawing area.
|
| open Boolean |
Returns in padding the insets for this drawable.
|
| open Unit |
Inflate this Drawable from an XML resource optionally styled by a theme.
|
| Protected methods |
| open Unit |
Override this in your subclass to change appearance if you vary based on the bounds.
|
| Inherited functions |
From class DrawableWrapper
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()
Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.
|
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()
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()
|
Unit |
getHotspotBounds(outRect: Rect)
Populates outRect with the hotspot bounds.
|
Boolean |
hasFocusStateSpecified()
Indicates whether this drawable has at least one state spec explicitly specifying android.R.attr#state_focused.
Note: A View uses a Drawable instance as its background and it changes its appearance based on a state. On keyboard devices, it should specify its android.R.attr#state_focused to make sure the user knows which view is holding the focus.
|
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()
Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.
|
Unit |
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. 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)
Override this in your subclass to change appearance if you vary based on level.
|
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)
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
|
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)
Specifies the hotspot's location within the drawable.
|
Unit |
setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)
Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
|
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)
Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
|
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.
|
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
Public constructors
InsetDrawable
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
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
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
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
open fun applyTheme(t: Resources.Theme): Unit
Applies the specified theme to this Drawable and its children.
getIntrinsicHeight
open fun getIntrinsicHeight(): Int
Returns the drawable's intrinsic height.
Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.
The intrinsic height is calculated based on the combination of both top and bottom fractional insets. For example, applying a fractional inset to only the bottom of a drawable will also influence the final size calculation for the top.
| Return |
Int |
the intrinsic height, or -1 if no intrinsic height |
getIntrinsicWidth
open fun getIntrinsicWidth(): Int
Returns the drawable's intrinsic width.
Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.
The intrinsic width is calculated based on the combination of both left and right fractional insets. This means a fractional inset on one side will influence the final size calculation for both sides.
| Return |
Int |
the intrinsic width, or -1 if no intrinsic width |
getOpacity
open fun getOpacity(): Int
Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in android.graphics.PixelFormat: android.graphics.PixelFormat#UNKNOWN, android.graphics.PixelFormat#TRANSLUCENT, android.graphics.PixelFormat#TRANSPARENT, or android.graphics.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 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 or #setColorFilter methods. Some subclasses, such as BitmapDrawable, ColorDrawable, and GradientDrawable, do account for the value of setAlpha, but the general behavior is dependent upon the implementation of the subclass.
| Return |
Int |
int The opacity class of the Drawable.
Value is one of the following:
|
getOpticalInsets
open fun getOpticalInsets(): Insets
Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
| Return |
Insets |
This value cannot be null. |
getOutline
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
open fun getPadding(padding: Rect): Boolean
Returns in padding the insets for this drawable.
The returned padding is the sum of the wrapped drawable's padding and the insets of this InsetDrawable. This means that if the inset value is 0, the resulting padding will be the same as the wrapped drawable's padding.
| Parameters |
padding |
Rect: The Rect to receive the padding. |
| Return |
Boolean |
True if this drawable has a non-zero padding or non-zero insets, else false. |
inflate
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.
| Exceptions |
java.io.IOException |
|
org.xmlpull.v1.XmlPullParserException |
|
Protected methods
onBoundsChange
protected open fun onBoundsChange(bounds: Rect): Unit
Override this in your subclass to change appearance if you vary based on the bounds.
| Parameters |
bounds |
Rect: This value cannot be null. |
