AdaptiveIconDrawable

Kotlin |Java

open class AdaptiveIconDrawable : Drawable, Drawable.Callback

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.AdaptiveIconDrawable

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	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
open Boolean	`canApplyTheme()`
open 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).
open Int	`getAlpha()` Gets the current alpha value for the drawable.
open Drawable!	`getBackground()` Returns the foreground drawable managed by this class.
open Int	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open Drawable.ConstantState?	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
open static Float	`getExtraInsetFraction()` 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!	`getForeground()` Returns the foreground drawable managed by this class.
open Unit	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
open Path!	`getIconMask()` When called before the bound is set, the returned path is identical to R.
open Int	`getIntrinsicHeight()` Returns the drawable's intrinsic height.
open Int	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
open Drawable?	`getMonochrome()` Returns the monochrome version of this drawable.
open Int	`getOpacity()` Return the opacity/transparency of this Drawable.
open Unit	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area.
open Region?	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent.
open Boolean	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.R.attr#state_focused`.
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	`invalidateDrawable(who: Drawable)` Called when the drawable needs to be redrawn.
open Unit	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn.
open Boolean	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
open Boolean	`isProjected()`
open Boolean	`isStateful()` Indicates whether this drawable will change its appearance based on state.
open Unit	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
open Drawable	`mutate()` Make this drawable mutable.
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)` Specify an alpha value for the drawable.
open Unit	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
open Unit	`setColorFilter(colorFilter: ColorFilter?)` Specify an optional color filter for the drawable.
open 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.
open Unit	`setHotspot(x: Float, y: Float)` Specifies the hotspot's location within the drawable.
open 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.
open Unit	`setOpacity(opacity: Int)`
open Unit	`setTintBlendMode(blendMode: BlendMode!)` Specifies a tint blending mode for this drawable.
open Unit	`setTintList(tint: ColorStateList?)` Specifies tint color for this drawable as a color state list.
open Boolean	`setVisible(visible: Boolean, restart: Boolean)` Set whether this Drawable is visible.
open Unit	`unscheduleDrawable(who: Drawable, what: Runnable)` A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable`.

Protected methods
open Unit	`onBoundsChange(bounds: Rect)` Override this in your subclass to change appearance if you vary based on the bounds.
open Boolean	`onLevelChange(level: Int)` Override this in your subclass to change appearance if you vary based on level.
open Boolean	`onStateChange(state: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.

Inherited functions

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

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

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

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
`java.io.IOException`
`org.xmlpull.v1.XmlPullParserException`

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`

Parameters
`x`	Float: The X coordinate of the center of the hotspot
`y`	Float: The Y coordinate of the center of the hotspot

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

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.

AdaptiveIconDrawable

Summary

Public constructors

AdaptiveIconDrawable

AdaptiveIconDrawable

Public methods

applyTheme

canApplyTheme

draw

getAlpha

getBackground

getChangingConfigurations

getConstantState

getExtraInsetFraction

getForeground

getHotspotBounds

getIconMask

getIntrinsicHeight

getIntrinsicWidth

getMonochrome

getOpacity

getOutline

getTransparentRegion

hasFocusStateSpecified

inflate

invalidateDrawable

invalidateSelf

isAutoMirrored

isProjected

isStateful

jumpToCurrentState

mutate

scheduleDrawable

setAlpha

setAutoMirrored

setColorFilter

setDither

setHotspot

setHotspotBounds

setOpacity

setTintBlendMode

setTintList

setVisible

unscheduleDrawable

Protected methods

onBoundsChange

onLevelChange

onStateChange