Drawable
abstract class Drawable
kotlin.Any | |
↳ | android.graphics.drawable.Drawable |
A Drawable is a general abstraction for "something that can be drawn." Most often you will deal with Drawable as the type of resource retrieved for drawing things to the screen; the Drawable class provides a generic API for dealing with an underlying visual resource that may take a variety of forms. Unlike a android.view.View
, a Drawable does not have any facility to receive events or otherwise interact with the user.
In addition to simple drawing, Drawable provides a number of generic mechanisms for its client to interact with what is being drawn:
- The #setBounds method must be called to tell the Drawable where it is drawn and how large it should be. All Drawables should respect the requested size, often simply by scaling their imagery. A client can find the preferred size for some Drawables with the
getIntrinsicHeight
andgetIntrinsicWidth
methods. - The
getPadding
method can return from some Drawables information about how to frame content that is placed inside of them. For example, a Drawable that is intended to be the frame for a button widget would need to return padding that correctly places the label inside of itself. - The
setState
method allows the client to tell the Drawable in which state it is to be drawn, such as "focused", "selected", etc. Some drawables may modify their imagery based on the selected state. - The
setLevel
method allows the client to supply a single continuous controller that can modify the Drawable is displayed, such as a battery level or progress level. Some drawables may modify their imagery based on the current level. - A Drawable can perform animations by calling back to its client through the
Callback
interface. All clients should support this interface (viasetCallback
) so that animations will work. A simple way to do this is through the system facilities such asandroid.view.View#setBackground(Drawable)
andandroid.widget.ImageView
.
- Bitmap: the simplest Drawable, a PNG or JPEG image.
- Nine Patch: an extension to the PNG format allows it to specify information about how to stretch it and place things inside of it.
- Vector: a drawable defined in an XML file as a set of points, lines, and curves along with its associated color information. This type of drawable can be scaled without loss of display quality.
- Shape: contains simple drawing commands instead of a raw bitmap, allowing it to resize better in some cases.
- Layers: a compound drawable, which draws multiple underlying drawables on top of each other.
- States: a compound drawable that selects one of a set of drawables based on its state.
- Levels: a compound drawable that selects one of a set of drawables based on its level.
- Scale: a compound drawable with a single child drawable, whose overall size is modified based on the current level.
Custom drawables
All versions of Android allow the Drawable class to be extended and used at run time in place of framework-provided drawable classes. Starting in API 24
, custom drawables classes may also be used in XML.
Note: Custom drawable classes are only accessible from within your application package. Other applications will not be able to load them.
At a minimum, custom drawable classes must implement the abstract methods on Drawable and should override the Drawable#draw(Canvas)
method to draw content.
Custom drawables classes may be used in XML in multiple ways:
- Using the fully-qualified class name as the XML element name. For this method, the custom drawable class must be a public top-level class.
<com.myapp.MyCustomDrawable xmlns:android="http://schemas.android.com/apk/res/android" android:color="#ffff0000" />
- Using drawable as the XML element name and specifying the fully-qualified class name from the class attribute. This method may be used for both public top-level classes and public static inner classes.
<drawable xmlns:android="http://schemas.android.com/apk/res/android" class="com.myapp.MyTopLevelClass$InnerCustomDrawable" android:color="#ffff0000" />
Summary
Nested classes | |
---|---|
abstract |
Implement this interface if you want to create an animated drawable that extends |
abstract |
This abstract class is used by |
Public constructors | |
---|---|
Drawable() |
Public methods | |
---|---|
open Unit |
Applies the specified theme to this Drawable and its children. |
open Boolean | |
open Unit |
Removes the color filter for this drawable. |
Unit |
copyBounds(bounds: Rect) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). |
Rect |
Return a copy of the drawable's bounds in a new Rect. |
open static Drawable? |
createFromPath(pathName: String!) Create a drawable from file path name. |
open static 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. |
open static 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. |
open static Drawable? |
createFromStream(is: InputStream?, srcName: String?) Create a drawable from an inputstream |
open static Drawable |
createFromXml(r: Resources, parser: XmlPullParser) Create a drawable from an XML document. |
open static Drawable |
createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?) Create a drawable from an XML document using an optional |
open static Drawable |
createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Create from inside an XML document. |
open static Drawable |
createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?) Create a drawable from inside an XML document using an optional |
abstract Unit |
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. |
Rect |
Return the drawable's bounds Rect. |
open Drawable.Callback? |
Return the current |
open Int |
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. |
open ColorFilter? |
Returns the current color filter, or |
open Drawable.ConstantState? |
Return a |
open Drawable | |
open Rect |
Return the drawable's dirty bounds Rect. |
open Unit |
getHotspotBounds(outRect: Rect) Populates |
open Int |
Returns the drawable's intrinsic height. |
open Int |
Returns the drawable's intrinsic width. |
open Int |
Returns the resolved layout direction for this Drawable. |
Int |
getLevel() Retrieve the current level. |
open Int |
Returns the minimum height suggested by this Drawable. |
open Int |
Returns the minimum width suggested by this Drawable. |
abstract 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 |
getOutline(outline: Outline) Called to get the drawable to populate the Outline that defines its drawing area. |
open Boolean |
getPadding(padding: Rect) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. |
open IntArray |
getState() Describes the current state, as a union of primitive states, such as |
open Region? |
Returns a Region representing the part of the Drawable that is completely transparent. |
open Boolean |
Indicates whether this drawable has at least one state spec explicitly specifying |
open Unit |
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Inflate this Drawable from an XML resource. |
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 |
Use the current |
open Boolean |
Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. |
open Boolean | |
open Boolean |
Whether this drawable requests projection. |
open Boolean |
Indicates whether this drawable will change its appearance based on state. |
Boolean | |
open Unit |
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 Boolean |
onLayoutDirectionChanged(layoutDirection: Int) Called when the drawable's resolved layout direction changes. |
open static Int |
resolveOpacity(op1: Int, op2: Int) Return the appropriate opacity value for two source opacities. |
open Unit |
scheduleSelf(what: Runnable, when: Long) Use the current |
abstract Unit |
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 |
Specify a bounding rectangle for the Drawable. |
open Unit |
Specify a bounding rectangle for the Drawable. |
Unit |
setCallback(cb: Drawable.Callback?) Bind a |
open Unit |
setChangingConfigurations(configs: Int) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. |
abstract Unit |
setColorFilter(colorFilter: ColorFilter?) Specify an optional color filter for the drawable. |
open Unit |
setColorFilter(color: Int, mode: PorterDuff.Mode) Specify a color and Porter-Duff mode to be the color filter for this drawable. |
open Unit |
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 |
setFilterBitmap(filter: Boolean) Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. |
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. |
Boolean |
setLayoutDirection(layoutDirection: Int) Set the layout direction for this drawable. |
Boolean |
Specify the level for the drawable. |
open Boolean |
Specify a set of states for the drawable. |
open Unit |
Specifies tint color for this drawable. |
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 Unit |
setTintMode(tintMode: PorterDuff.Mode?) Specifies a tint blending mode for this drawable. |
open Boolean |
setVisible(visible: Boolean, restart: Boolean) Set whether this Drawable is visible. |
open Unit |
unscheduleSelf(what: Runnable) Use the current |
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. |
Public constructors
Drawable
Drawable()
Public methods
applyTheme
open fun applyTheme(t: Resources.Theme): Unit
Applies the specified theme to this Drawable and its children.
Parameters | |
---|---|
t |
Resources.Theme: the theme to apply This value cannot be null . |
clearColorFilter
open fun clearColorFilter(): Unit
Removes the color filter for this drawable.
copyBounds
fun copyBounds(bounds: Rect): Unit
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.
Parameters | |
---|---|
bounds |
Rect: Rect to receive the drawable's bounds (allocated by the caller). This value cannot be null . |
copyBounds
fun copyBounds(): Rect
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).
Return | |
---|---|
Rect |
A copy of the drawable's bounds This value cannot be null . |
createFromPath
open static fun createFromPath(pathName: String!): Drawable?
Create a drawable from file path name.
Return | |
---|---|
Drawable? |
This value may be null . |
createFromResourceStream
open static fun createFromResourceStream(
res: Resources?,
value: TypedValue?,
is: InputStream?,
srcName: String?
): Drawable?
Create a drawable from an inputstream, using the given resources and value to determine density information.
Parameters | |
---|---|
res |
Resources?: This value may be null . |
value |
TypedValue?: This value may be null . |
is |
InputStream?: This value may be null . |
srcName |
String?: This value may be null . |
Return | |
---|---|
Drawable? |
This value may be null . |
createFromResourceStream
open static funcreateFromResourceStream(
res: Resources?,
value: TypedValue?,
is: InputStream?,
srcName: String?,
opts: BitmapFactory.Options?
): Drawable?
Deprecated: Prefer the version without an Options object.
Create a drawable from an inputstream, using the given resources and value to determine density information.
Parameters | |
---|---|
res |
Resources?: This value may be null . |
value |
TypedValue?: This value may be null . |
is |
InputStream?: This value may be null . |
srcName |
String?: This value may be null . |
opts |
BitmapFactory.Options?: This value may be null . |
Return | |
---|---|
Drawable? |
This value may be null . |
createFromStream
open static fun createFromStream(
is: InputStream?,
srcName: String?
): Drawable?
Create a drawable from an inputstream
Parameters | |
---|---|
is |
InputStream?: This value may be null . |
srcName |
String?: This value may be null . |
Return | |
---|---|
Drawable? |
This value may be null . |
createFromXml
open static fun createFromXml(
r: Resources,
parser: XmlPullParser
): Drawable
Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
Parameters | |
---|---|
r |
Resources: This value cannot be null . |
parser |
XmlPullParser: This value cannot be null . |
Return | |
---|---|
Drawable |
This value cannot be null . |
createFromXml
open static fun createFromXml(
r: Resources,
parser: XmlPullParser,
theme: Resources.Theme?
): Drawable
Create a drawable from an XML document using an optional Theme
. For more information on how to create resources in XML, see Drawable Resources.
Parameters | |
---|---|
r |
Resources: This value cannot be null . |
parser |
XmlPullParser: This value cannot be null . |
theme |
Resources.Theme?: This value may be null . |
Return | |
---|---|
Drawable |
This value cannot be null . |
createFromXmlInner
open static fun createFromXmlInner(
r: Resources,
parser: XmlPullParser,
attrs: AttributeSet
): Drawable
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.
Parameters | |
---|---|
r |
Resources: This value cannot be null . |
parser |
XmlPullParser: This value cannot be null . |
attrs |
AttributeSet: This value cannot be null . |
createFromXmlInner
open static fun createFromXmlInner(
r: Resources,
parser: XmlPullParser,
attrs: AttributeSet,
theme: Resources.Theme?
): Drawable
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.
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 . |
draw
abstract fun draw(canvas: Canvas): Unit
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
Parameters | |
---|---|
canvas |
Canvas: The canvas to draw into This value cannot be null . |
getAlpha
open fun getAlpha(): Int
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.
Return | |
---|---|
Int |
Value is between 0 and 255 inclusive |
getBounds
fun getBounds(): Rect
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.
Return | |
---|---|
Rect |
The bounds of the drawable (which may change later, so caller beware). DO NOT ALTER the returned object as it may change the stored bounds of this drawable. This value cannot be null . |
getCallback
open fun getCallback(): Drawable.Callback?
Return the current Callback
implementation attached to this Drawable.
Return | |
---|---|
Drawable.Callback? |
A Callback instance or null if no callback was set. |
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.
See Also
getColorFilter
open fun getColorFilter(): ColorFilter?
Returns the current color filter, or null
if none set.
Return | |
---|---|
ColorFilter? |
the current color filter, or null if none set |
getConstantState
open fun getConstantState(): Drawable.ConstantState?
Return a ConstantState
instance that holds the shared state of this Drawable.
Return | |
---|---|
Drawable.ConstantState? |
The ConstantState associated to that Drawable. This value may be null . |
getCurrent
open fun getCurrent(): Drawable
Return | |
---|---|
Drawable |
The current drawable that will be used by this drawable. For simple drawables, this is just the drawable itself. For drawables that change state like StateListDrawable and LevelListDrawable this will be the child drawable currently in use. This value cannot be null . |
getDirtyBounds
open fun getDirtyBounds(): Rect
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.
Return | |
---|---|
Rect |
The dirty bounds of this drawable This value cannot be null . |
getHotspotBounds
open fun getHotspotBounds(outRect: Rect): Unit
Populates outRect
with the hotspot bounds.
Parameters | |
---|---|
outRect |
Rect: the rect to populate with the hotspot bounds This value cannot be null . |
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.
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.
Return | |
---|---|
Int |
the intrinsic width, or -1 if no intrinsic width |
getLayoutDirection
open fun getLayoutDirection(): Int
Returns the resolved layout direction for this Drawable.
Return | |
---|---|
Int |
One of android.view.View#LAYOUT_DIRECTION_LTR , android.view.View#LAYOUT_DIRECTION_RTL Value is android.view.View#LAYOUT_DIRECTION_LTR , or android.view.View#LAYOUT_DIRECTION_RTL |
See Also
getLevel
fun getLevel(): Int
Retrieve the current level.
Return | |
---|---|
Int |
int Current level, from 0 (minimum) to 10000 (maximum). Value is between 0 and 10000 inclusive |
getMinimumHeight
open fun getMinimumHeight(): Int
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.
Return | |
---|---|
Int |
The minimum height suggested by this Drawable. If this Drawable doesn't have a suggested minimum height, 0 is returned. |
getMinimumWidth
open fun getMinimumWidth(): Int
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.
Return | |
---|---|
Int |
The minimum width suggested by this Drawable. If this Drawable doesn't have a suggested minimum width, 0 is returned. |
getOpacity
abstract fungetOpacity(): Int
Deprecated: This method is no longer used in graphics optimizations
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 android.graphics.PixelFormat#UNKNOWN , android.graphics.PixelFormat#TRANSLUCENT , android.graphics.PixelFormat#TRANSPARENT , or android.graphics.PixelFormat#OPAQUE |
See Also
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
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).
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. |
getState
open fun getState(): IntArray
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.
Return | |
---|---|
IntArray |
An array of resource Ids describing the current state. 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? |
Returns null if the Drawables has no transparent region to report, else a Region holding the parts of the Drawable's bounds that are transparent. |
hasFocusStateSpecified
open fun hasFocusStateSpecified(): Boolean
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.
Return | |
---|---|
Boolean |
true if android.R.attr#state_focused is specified for this drawable. |
inflate
open fun inflate(
r: Resources,
parser: XmlPullParser,
attrs: AttributeSet
): Unit
Inflate this Drawable from an XML resource. Does not apply a theme.
Parameters | |
---|---|
r |
Resources: This value cannot be null . |
parser |
XmlPullParser: This value cannot be null . |
attrs |
AttributeSet: This value cannot be null . |
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: Resources used to resolve attribute values This value cannot be null . |
parser |
XmlPullParser: XML parser from which to inflate this Drawable This value cannot be null . |
attrs |
AttributeSet: Base set of attribute values This value cannot be null . |
theme |
Resources.Theme?: Theme to apply, may be null |
Exceptions | |
---|---|
org.xmlpull.v1.XmlPullParserException |
|
java.io.IOException |
invalidateSelf
open fun invalidateSelf(): Unit
Use the current Callback
implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
isAutoMirrored
open fun isAutoMirrored(): Boolean
Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See android.util.LayoutDirection
.
Return | |
---|---|
Boolean |
boolean Returns true if this Drawable will be automatically mirrored. |
isFilterBitmap
open fun isFilterBitmap(): Boolean
Return | |
---|---|
Boolean |
whether this drawable filters its bitmaps |
See Also
isProjected
open fun isProjected(): Boolean
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.
isStateful
open fun isStateful(): Boolean
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.
Return | |
---|---|
Boolean |
True if this drawable changes its appearance based on state, false otherwise. |
See Also
jumpToCurrentState
open fun jumpToCurrentState(): Unit
If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
mutate
open fun mutate(): Drawable
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.
Return | |
---|---|
Drawable |
This drawable. This value cannot be null . |
onLayoutDirectionChanged
open fun onLayoutDirectionChanged(layoutDirection: Int): Boolean
Called when the drawable's resolved layout direction changes.
Parameters | |
---|---|
layoutDirection |
Int: the new resolved layout direction Value is android.view.View#LAYOUT_DIRECTION_LTR , or android.view.View#LAYOUT_DIRECTION_RTL |
Return | |
---|---|
Boolean |
true if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, false otherwise |
See Also
resolveOpacity
open static fun resolveOpacity(
op1: Int,
op2: Int
): 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
.
Parameters | |
---|---|
op1 |
Int: One opacity value. Value is android.graphics.PixelFormat#UNKNOWN , android.graphics.PixelFormat#TRANSLUCENT , android.graphics.PixelFormat#TRANSPARENT , or android.graphics.PixelFormat#OPAQUE |
op2 |
Int: Another opacity value. Value is android.graphics.PixelFormat#UNKNOWN , android.graphics.PixelFormat#TRANSLUCENT , android.graphics.PixelFormat#TRANSPARENT , or android.graphics.PixelFormat#OPAQUE |
Return | |
---|---|
Int |
int The combined opacity value. Value is android.graphics.PixelFormat#UNKNOWN , android.graphics.PixelFormat#TRANSLUCENT , android.graphics.PixelFormat#TRANSPARENT , or android.graphics.PixelFormat#OPAQUE |
See Also
scheduleSelf
open fun scheduleSelf(
what: Runnable,
when: Long
): Unit
Use the current Callback
implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
Parameters | |
---|---|
what |
Runnable: The action being scheduled. This value cannot be null . |
when |
Long: The time (in milliseconds) to run. |
setAlpha
abstract fun setAlpha(alpha: Int): Unit
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
Parameters | |
---|---|
alpha |
Int: Value is between 0 and 255 inclusive |
setAutoMirrored
open fun setAutoMirrored(mirrored: Boolean): Unit
Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See android.util.LayoutDirection
.
Parameters | |
---|---|
mirrored |
Boolean: Set to true if the Drawable should be mirrored, false if not. |
setBounds
open fun setBounds(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
setBounds
open fun setBounds(bounds: Rect): Unit
Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
Parameters | |
---|---|
bounds |
Rect: This value cannot be null . |
setCallback
fun setCallback(cb: Drawable.Callback?): Unit
Bind a Callback
object to this Drawable. Required for clients that want to support animated drawables.
Parameters | |
---|---|
cb |
Drawable.Callback?: The client's Callback implementation. This value may be null . |
See Also
setChangingConfigurations
open fun setChangingConfigurations(configs: Int): Unit
Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
See Also
setColorFilter
abstract fun setColorFilter(colorFilter: ColorFilter?): Unit
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
.
Parameters | |
---|---|
colorFilter |
ColorFilter?: The color filter to apply, or null to remove the existing color filter |
setColorFilter
open funsetColorFilter(
color: Int,
mode: PorterDuff.Mode
): Unit
Deprecated: use setColorFilter(android.graphics.ColorFilter)
with an instance of android.graphics.BlendModeColorFilter
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
.
Parameters | |
---|---|
mode |
PorterDuff.Mode: This value cannot be null . |
See Also
setDither
open funsetDither(dither: Boolean): Unit
Deprecated: This property is ignored.
Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
setFilterBitmap
open fun setFilterBitmap(filter: Boolean): Unit
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.
setHotspot
open fun setHotspot(
x: Float,
y: Float
): Unit
Specifies the hotspot's location within the drawable.
Parameters | |
---|---|
x |
Float: The X coordinate of the center of the hotspot |
y |
Float: The Y coordinate of the center of the hotspot |
setHotspotBounds
open fun setHotspotBounds(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
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 |
setLayoutDirection
fun setLayoutDirection(layoutDirection: Int): Boolean
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.
Parameters | |
---|---|
layoutDirection |
Int: the resolved layout direction for the drawable, either android.view.View#LAYOUT_DIRECTION_LTR or android.view.View#LAYOUT_DIRECTION_RTL Value is android.view.View#LAYOUT_DIRECTION_LTR , or android.view.View#LAYOUT_DIRECTION_RTL |
Return | |
---|---|
Boolean |
true if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, false otherwise |
See Also
setLevel
fun setLevel(level: Int): Boolean
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.
Parameters | |
---|---|
level |
Int: The new level, from 0 (minimum) to 10000 (maximum). Value is between 0 and 10000 inclusive |
Return | |
---|---|
Boolean |
Returns true if this change in level has caused the appearance of the Drawable to change (hence requiring an invalidate), otherwise returns false. |
setState
open fun setState(stateSet: IntArray): Boolean
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.
Parameters | |
---|---|
stateSet |
IntArray: The new set of states to be displayed. This value cannot be null . |
Return | |
---|---|
Boolean |
Returns true if this change in state has caused the appearance of the Drawable to change (hence requiring an invalidate), otherwise returns false. |
setTint
open fun setTint(tintColor: Int): Unit
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.
Parameters | |
---|---|
tintColor |
Int: Color to use for tinting this drawable |
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?: BlendMode to apply to the drawable, a value of null sets the default blend mode value of BlendMode#SRC_IN |
setTintList
open fun setTintList(tint: ColorStateList?): Unit
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.
Parameters | |
---|---|
tint |
ColorStateList?: Color state list to use for tinting this drawable, or null to clear the tint |
setTintMode
open fun setTintMode(tintMode: PorterDuff.Mode?): 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 PorterDuff.Mode#SRC_IN
.
Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)
or setColorFilter(int,android.graphics.PorterDuff.Mode)
overrides tint.
Parameters | |
---|---|
tintMode |
PorterDuff.Mode?: A Porter-Duff blending mode to apply to the drawable, a value of null sets the default Porter-Diff blending mode value of PorterDuff.Mode#SRC_IN |
setVisible
open fun setVisible(
visible: Boolean,
restart: Boolean
): 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.
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. |
unscheduleSelf
open fun unscheduleSelf(what: Runnable): Unit
Use the current Callback
implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.
Parameters | |
---|---|
what |
Runnable: The runnable that you no longer want called. This value cannot be null . |
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 . |
onLevelChange
protected open fun onLevelChange(level: Int): Boolean
Override this in your subclass to change appearance if you vary based on level.
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
Override this in your subclass to change appearance if you recognize the specified state.
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. |