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.
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 | |
open Int |
getAlpha() |
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 |
getHotspotBounds(outRect: Rect) |
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 |
invalidateDrawable(who: Drawable) Called when the drawable needs to be redrawn. |
open Unit | |
open Boolean | |
open Boolean | |
open Unit | |
open Drawable |
mutate() |
open Unit |
scheduleDrawable(who: Drawable, what: Runnable, when: Long) A Drawable can call this to schedule the next frame of its animation. |
open Unit | |
open Unit |
setAutoMirrored(mirrored: Boolean) |
open Unit |
setColorFilter(colorFilter: ColorFilter?) |
open Unit | |
open Unit |
setHotspot(x: Float, y: Float) |
open Unit |
setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int) |
open Unit |
setOpacity(opacity: Int) |
open Unit |
setTintBlendMode(blendMode: BlendMode!) Specifies a tint blending mode for this drawable. |
open Unit |
setTintList(tint: ColorStateList?) |
open Boolean |
setVisible(visible: Boolean, restart: Boolean) |
open Unit |
unscheduleDrawable(who: Drawable, what: Runnable) A Drawable can call this to unschedule an action previously scheduled with |
Protected methods | |
---|---|
open Unit |
onBoundsChange(bounds: Rect) |
open Boolean |
onLevelChange(level: Int) |
open Boolean |
onStateChange(state: IntArray) |
Inherited functions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public constructors
AdaptiveIconDrawable
AdaptiveIconDrawable(
backgroundDrawable: Drawable!,
foregroundDrawable: Drawable!)
Constructor used to dynamically create this drawable.
AdaptiveIconDrawable
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
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
open fun draw(canvas: Canvas): Unit
Parameters | |
---|---|
canvas |
Canvas: The canvas to draw into This value cannot be null . |
getAlpha
open fun getAlpha(): Int
Return | |
---|---|
Int |
Value is between 0 and 255 inclusive |
getBackground
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 |
getChangingConfigurations
open fun getChangingConfigurations(): Int
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.
getConstantState
open fun getConstantState(): Drawable.ConstantState?
Return | |
---|---|
Drawable.ConstantState? |
The ConstantState associated to that Drawable. This value may be null . |
getExtraInsetFraction
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
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
open fun getHotspotBounds(outRect: Rect): Unit
Parameters | |
---|---|
outRect |
Rect: the rect to populate with the hotspot bounds This value cannot be null . |
getIconMask
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
open fun getIntrinsicHeight(): Int
Return | |
---|---|
Int |
the intrinsic height, or -1 if no intrinsic height |
getIntrinsicWidth
open fun getIntrinsicWidth(): Int
Return | |
---|---|
Int |
the intrinsic width, or -1 if no intrinsic width |
getMonochrome
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 . |
getOpacity
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 |
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 . |
getTransparentRegion
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
open fun hasFocusStateSpecified(): Boolean
Return | |
---|---|
Boolean |
true if android.R.attr#state_focused is specified for this drawable. |
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.
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
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 . |
isAutoMirrored
open fun isAutoMirrored(): Boolean
Return | |
---|---|
Boolean |
boolean Returns true if this Drawable will be automatically mirrored. |
isStateful
open fun isStateful(): Boolean
Return | |
---|---|
Boolean |
True if this drawable changes its appearance based on state, false otherwise. |
mutate
open fun mutate(): Drawable
Return | |
---|---|
Drawable |
This drawable. This value cannot be null . |
scheduleDrawable
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
open fun setAlpha(alpha: Int): Unit
Parameters | |
---|---|
alpha |
Int: Value is between 0 and 255 inclusive |
setAutoMirrored
open fun setAutoMirrored(mirrored: Boolean): Unit
Parameters | |
---|---|
mirrored |
Boolean: Set to true if the Drawable should be mirrored, false if not. |
setColorFilter
open fun setColorFilter(colorFilter: ColorFilter?): Unit
Parameters | |
---|---|
colorFilter |
ColorFilter?: The color filter to apply, or null to remove the existing color filter |
setHotspotBounds
open fun setHotspotBounds(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
setTintBlendMode
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
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
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
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.
Protected methods
onBoundsChange
protected open fun onBoundsChange(bounds: Rect): Unit
Parameters | |
---|---|
bounds |
Rect: This value cannot be null . |
onLevelChange
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
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. |