Added in API level 26

AdaptiveIconDrawable


open class AdaptiveIconDrawable : Drawable, Drawable.Callback

This class can also be created via XML inflation using <adaptive-icon> tag in addition to dynamic creation.

This drawable supports two drawable layers: foreground and background. The layers are clipped when rendering using the mask defined in the device configuration.

  • Both foreground and background layers should be sized at 108 x 108 dp.
  • The inner 72 x 72 dp of the icon appears within the masked viewport.
  • The outer 18 dp on each of the 4 sides of the layers is reserved for use by the system UI surfaces to create interesting visual effects, such as parallax or pulsing.
Such motion effect is achieved by internally setting the bounds of the foreground and background layer as following:
Rect(getBounds().left - getBounds().getWidth() * #getExtraInsetFraction(),
       getBounds().top - getBounds().getHeight() * #getExtraInsetFraction(),
       getBounds().right + getBounds().getWidth() * #getExtraInsetFraction(),
       getBounds().bottom + getBounds().getHeight() * #getExtraInsetFraction())
  

An alternate drawable can be specified using <monochrome> tag which can be drawn in place of the two (background and foreground) layers. This drawable is tinted according to the device or surface theme.

Summary

Public constructors
AdaptiveIconDrawable(backgroundDrawable: Drawable!, foregroundDrawable: Drawable!)

Constructor used to dynamically create this drawable.

AdaptiveIconDrawable(backgroundDrawable: Drawable?, foregroundDrawable: Drawable?, monochromeDrawable: Drawable?)

Constructor used to dynamically create this drawable.

Public methods
open Unit

Applies the specified theme to this Drawable and its children.

open Boolean

open Unit
draw(canvas: Canvas)

open Int

open Drawable!

Returns the foreground drawable managed by this class.

open Int

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

open Drawable.ConstantState?

open static Float

All four sides of the layers are padded with extra inset so as to provide extra content to reveal within the clip path when performing affine transformations on the layers.

open Drawable!

Returns the foreground drawable managed by this class.

open Unit

open Path!

When called before the bound is set, the returned path is identical to R.

open Int

open Int

open Drawable?

Returns the monochrome version of this drawable.

open Int

open Unit
getOutline(outline: Outline)

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

open Region?

Returns a Region representing the part of the Drawable that is completely transparent.

open Boolean

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

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

open Unit

Called when the drawable needs to be redrawn.

open Unit

open Boolean

open Boolean

open Unit

open Drawable

open Unit
scheduleDrawable(who: Drawable, what: Runnable, when: Long)

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

open Unit
setAlpha(alpha: Int)

open Unit

open Unit
setColorFilter(colorFilter: ColorFilter?)

open Unit
setDither(dither: Boolean)

open Unit

open Unit
setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)

open Unit
setOpacity(opacity: Int)

open Unit

Specifies a tint blending mode for this drawable.

open Unit

open Boolean
setVisible(visible: Boolean, restart: Boolean)

open Unit

A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable.

Protected methods
open Unit

open Boolean

open Boolean

Inherited functions
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.

ColorFilter? getColorFilter()

Returns the current color filter, or null if none set.

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.

Insets getOpticalInsets()

Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.

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

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.

Unit inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)

Inflate this Drawable from an XML resource. Does not apply a theme.

Boolean isFilterBitmap()

Boolean isVisible()

Boolean onLayoutDirectionChanged(layoutDirection: Int)

Called when the drawable's resolved layout direction changes.

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

Public constructors

AdaptiveIconDrawable

Added in API level 26
AdaptiveIconDrawable(
    backgroundDrawable: Drawable!,
    foregroundDrawable: Drawable!)

Constructor used to dynamically create this drawable.

Parameters
backgroundDrawable Drawable!: drawable that should be rendered in the background
foregroundDrawable Drawable!: drawable that should be rendered in the foreground

AdaptiveIconDrawable

Added in API level 33
AdaptiveIconDrawable(
    backgroundDrawable: Drawable?,
    foregroundDrawable: Drawable?,
    monochromeDrawable: Drawable?)

Constructor used to dynamically create this drawable.

Parameters
backgroundDrawable Drawable?: drawable that should be rendered in the background This value may be null.
foregroundDrawable Drawable?: drawable that should be rendered in the foreground This value may be null.
monochromeDrawable Drawable?: an alternate drawable which can be tinted per system theme color This value may be null.

Public methods

applyTheme

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

canApplyTheme

Added in API level 26
open fun canApplyTheme(): Boolean

draw

Added in API level 26
open fun draw(canvas: Canvas): Unit
Parameters
canvas Canvas: The canvas to draw into This value cannot be null.

getAlpha

Added in API level 26
open fun getAlpha(): Int
Return
Int Value is between 0 and 255 inclusive

getBackground

Added in API level 26
open fun getBackground(): Drawable!

Returns the foreground drawable managed by this class. The bound of this drawable is extended by getExtraInsetFraction() * getBounds().width on left/right sides and by getExtraInsetFraction() * getBounds().height on top/bottom sides.

Return
Drawable! the background drawable managed by this drawable

getConstantState

Added in API level 26
open fun getConstantState(): Drawable.ConstantState?
Return
Drawable.ConstantState? The ConstantState associated to that Drawable. This value may be null.

getExtraInsetFraction

Added in API level 26
open static fun getExtraInsetFraction(): Float

All four sides of the layers are padded with extra inset so as to provide extra content to reveal within the clip path when performing affine transformations on the layers.

See Also

getForeground

Added in API level 26
open fun getForeground(): Drawable!

Returns the foreground drawable managed by this class. The bound of this drawable is extended by getExtraInsetFraction() * getBounds().width on left/right sides and by getExtraInsetFraction() * getBounds().height on top/bottom sides.

Return
Drawable! the foreground drawable managed by this drawable

getHotspotBounds

Added in API level 26
open fun getHotspotBounds(outRect: Rect): Unit
Parameters
outRect Rect: the rect to populate with the hotspot bounds This value cannot be null.

getIconMask

Added in API level 26
open fun getIconMask(): Path!

When called before the bound is set, the returned path is identical to R.string.config_icon_mask. After the bound is set, the returned path's computed bound is same as the #getBounds().

Return
Path! the mask path object used to clip the drawable

getIntrinsicHeight

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

getIntrinsicWidth

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

getMonochrome

Added in API level 33
open fun getMonochrome(): Drawable?

Returns the monochrome version of this drawable. Callers can use a tinted version of this drawable instead of the original drawable on surfaces stressing user theming.

Return
Drawable? the monochrome drawable This value may be null.

getOutline

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

getTransparentRegion

Added in API level 26
open fun getTransparentRegion(): Region?

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.

Return
Region? This value may be null.

hasFocusStateSpecified

Added in API level 31
open fun hasFocusStateSpecified(): Boolean
Return
Boolean true if android.R.attr#state_focused is specified for this drawable.

inflate

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

invalidateDrawable

Added in API level 26
open fun invalidateDrawable(who: Drawable): Unit

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

Parameters
who Drawable: This value cannot be null.

invalidateSelf

Added in API level 26
open fun invalidateSelf(): Unit

isAutoMirrored

Added in API level 26
open fun isAutoMirrored(): Boolean
Return
Boolean boolean Returns true if this Drawable will be automatically mirrored.

isStateful

Added in API level 26
open fun isStateful(): Boolean
Return
Boolean True if this drawable changes its appearance based on state, false otherwise.

jumpToCurrentState

Added in API level 26
open fun jumpToCurrentState(): Unit

mutate

Added in API level 26
open fun mutate(): Drawable
Return
Drawable This drawable. This value cannot be null.

scheduleDrawable

Added in API level 26
open fun scheduleDrawable(
    who: Drawable,
    what: Runnable,
    when: Long
): Unit

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.

Parameters
who Drawable: This value cannot be null.
what Runnable: This value cannot be null.
when Long: The time (in milliseconds) to run. The timebase is android.os.SystemClock#uptimeMillis

setAlpha

Added in API level 26
open fun setAlpha(alpha: Int): Unit
Parameters
alpha Int: Value is between 0 and 255 inclusive

setAutoMirrored

Added in API level 26
open fun setAutoMirrored(mirrored: Boolean): Unit
Parameters
mirrored Boolean: Set to true if the Drawable should be mirrored, false if not.

setColorFilter

Added in API level 26
open fun setColorFilter(colorFilter: ColorFilter?): Unit
Parameters
colorFilter ColorFilter?: The color filter to apply, or null to remove the existing color filter

setDither

Added in API level 26
open fun setDither(dither: Boolean): Unit

setHotspot

Added in API level 26
open fun setHotspot(
    x: Float,
    y: Float
): Unit
Parameters
x Float: The X coordinate of the center of the hotspot
y Float: The Y coordinate of the center of the hotspot

setHotspotBounds

Added in API level 26
open fun setHotspotBounds(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit
Parameters
left Int: position in pixels of the left bound
top Int: position in pixels of the top bound
right Int: position in pixels of the right bound
bottom Int: position in pixels of the bottom bound

setOpacity

Added in API level 26
open fun setOpacity(opacity: Int): Unit

setTintBlendMode

Added in API level 29
open fun setTintBlendMode(blendMode: BlendMode!): Unit

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)

Parameters
blendMode BlendMode!: This value cannot be null.

setTintList

Added in API level 26
open fun setTintList(tint: ColorStateList?): Unit
Parameters
tint ColorStateList?: Color state list to use for tinting this drawable, or null to clear the tint

setVisible

Added in API level 26
open fun setVisible(
    visible: Boolean,
    restart: Boolean
): Boolean
Parameters
visible Boolean: Set to true if visible, false if not.
restart Boolean: You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.
Return
Boolean boolean Returns true if the new visibility is different than its previous state.

unscheduleDrawable

Added in API level 26
open fun unscheduleDrawable(
    who: Drawable,
    what: Runnable
): Unit

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.

Parameters
who Drawable: This value cannot be null.
what Runnable: This value cannot be null.

Protected methods

onBoundsChange

Added in API level 26
protected open fun onBoundsChange(bounds: Rect): Unit
Parameters
bounds Rect: This value cannot be null.

onLevelChange

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

onStateChange

Added in API level 26
protected open fun onStateChange(state: IntArray): Boolean
Parameters
state IntArray: This value cannot be null.
Return
Boolean Returns true if the state 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 state.