Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#inhmethods)
# NinePatchDrawable
*** ** * ** ***
`
public
class
NinePatchDrawable
`
`
`
`
extends https://developer.android.com/reference/android/graphics/drawable/Drawable
`
`
`
|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.graphics.drawable.Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable) ||
| | ↳ | android.graphics.drawable.NinePatchDrawable |
*** ** * ** ***
A resizeable bitmap, with stretchable areas that you define. This type of image
is defined in a .png file with a special format.
### Developer Guides
For more information about how to use a NinePatchDrawable, read the
[Canvas and Drawables](https://developer.android.com/guide/topics/graphics/2d-graphics#nine-patch) developer guide. For information about creating a NinePatch image
file using the draw9patch tool, see the
[Draw 9-patch](https://developer.android.com/guide/developing/tools/draw9patch) tool guide.
## Summary
| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.content.res.Resources,%20android.graphics.Bitmap,%20byte[],%20android.graphics.Rect,%20java.lang.String)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/graphics/Bitmap bitmap, byte[] chunk, https://developer.android.com/reference/android/graphics/Rect padding, https://developer.android.com/reference/java/lang/String srcName) ` Create drawable from raw nine-patch data, setting initial target density based on the display metrics of the resources. |
| ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.content.res.Resources,%20android.graphics.NinePatch)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/graphics/NinePatch patch) ` Create drawable from existing nine-patch, setting initial target density based on the display metrics of the resources. |
| ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.graphics.Bitmap,%20byte[],%20android.graphics.Rect,%20java.lang.String)(https://developer.android.com/reference/android/graphics/Bitmap bitmap, byte[] chunk, https://developer.android.com/reference/android/graphics/Rect padding, https://developer.android.com/reference/java/lang/String srcName) ` *This constructor is deprecated. Use `https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.content.res.Resources,%20android.graphics.Bitmap,%20byte[],%20android.graphics.Rect,%20java.lang.String)` to ensure that the drawable has correctly set its target density.* |
| ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.graphics.NinePatch)(https://developer.android.com/reference/android/graphics/NinePatch patch) ` *This constructor is deprecated. Use `https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.content.res.Resources,%20android.graphics.NinePatch)` to ensure that the drawable has correctly set its target density.* |
| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t) ` Applies the specified theme to this Drawable and its children. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#canApplyTheme()() ` |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/Canvas canvas) ` Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getAlpha()() ` Gets the current alpha value for the drawable. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getChangingConfigurations()() ` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getConstantState()() ` Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getIntrinsicHeight()() ` Returns the drawable's intrinsic height. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getIntrinsicWidth()() ` Returns the drawable's intrinsic width. |
| ` int` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getOpacity()() ` *This method is deprecated. This method is no longer used in graphics optimizations* |
| ` https://developer.android.com/reference/android/graphics/Insets` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getOpticalInsets()() ` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline) ` Called to get the drawable to populate the Outline that defines its drawing area. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getPadding(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect padding) ` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. |
| ` https://developer.android.com/reference/android/graphics/Paint` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getPaint()() ` |
| ` https://developer.android.com/reference/android/graphics/Region` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#getTransparentRegion()() ` Returns a Region representing the part of the Drawable that is completely transparent. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#hasFocusStateSpecified()() ` Indicates whether this drawable has at least one state spec explicitly specifying `https://developer.android.com/reference/android/R.attr#state_focused`. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme) ` Inflate this Drawable from an XML resource optionally styled by a theme. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#isAutoMirrored()() ` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#isFilterBitmap()() ` |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#isStateful()() ` Indicates whether this drawable will change its appearance based on state. |
| ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#mutate()() ` Make this drawable mutable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setAlpha(int)(int alpha) ` Specify an alpha value for the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setAutoMirrored(boolean)(boolean mirrored) ` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setColorFilter(android.graphics.ColorFilter)(https://developer.android.com/reference/android/graphics/ColorFilter colorFilter) ` Specify an optional color filter for the drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setDither(boolean)(boolean dither) ` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setFilterBitmap(boolean)(boolean filter) ` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setTargetDensity(android.util.DisplayMetrics)(https://developer.android.com/reference/android/util/DisplayMetrics metrics) ` Set the density scale at which this drawable will be rendered. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setTargetDensity(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/Canvas canvas) ` Set the density scale at which this drawable will be rendered. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setTargetDensity(int)(int density) ` Set the density at which this drawable will be rendered. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setTintBlendMode(android.graphics.BlendMode)(https://developer.android.com/reference/android/graphics/BlendMode blendMode) ` Specifies a tint blending mode for this drawable. |
| ` void` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#setTintList(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList tint) ` Specifies tint color for this drawable as a color state list. |
| ### Protected methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#onStateChange(int[])(int[] stateSet) ` Override this in your subclass to change appearance if you recognize the specified state. |
| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/android/graphics/drawable/Drawable ` |---|---| | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#applyTheme(android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources.Theme t) ` Applies the specified theme to this Drawable and its children. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#canApplyTheme()() ` | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#clearColorFilter()() ` Removes the color filter for this drawable. | | ` final https://developer.android.com/reference/android/graphics/Rect` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#copyBounds()() ` Return a copy of the drawable's bounds in a new Rect. | | ` final void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#copyBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds) ` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromPath(java.lang.String)(https://developer.android.com/reference/java/lang/String pathName) ` Create a drawable from file path name. | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromResourceStream(android.content.res.Resources,%20android.util.TypedValue,%20java.io.InputStream,%20java.lang.String,%20android.graphics.BitmapFactory.Options)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/util/TypedValue value, https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName, https://developer.android.com/reference/android/graphics/BitmapFactory.Options opts) ` *This method was deprecated in API level 28. Prefer the version without an Options object.* | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromResourceStream(android.content.res.Resources,%20android.util.TypedValue,%20java.io.InputStream,%20java.lang.String)(https://developer.android.com/reference/android/content/res/Resources res, https://developer.android.com/reference/android/util/TypedValue value, https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName) ` Create a drawable from an inputstream, using the given resources and value to determine density information. | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromStream(java.io.InputStream,%20java.lang.String)(https://developer.android.com/reference/java/io/InputStream is, https://developer.android.com/reference/java/lang/String srcName) ` Create a drawable from an inputstream | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXml(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser) ` Create a drawable from an XML document. | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXml(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/content/res/Resources.Theme theme) ` Create a drawable from an XML document using an optional `https://developer.android.com/reference/android/content/res/Resources.Theme`. | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXmlInner(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme) ` Create a drawable from inside an XML document using an optional `https://developer.android.com/reference/android/content/res/Resources.Theme`. | | ` static https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#createFromXmlInner(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs) ` Create from inside an XML document. | | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#draw(android.graphics.Canvas)(https://developer.android.com/reference/android/graphics/Canvas canvas) ` Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getAlpha()() ` Gets the current alpha value for the drawable. | | ` final https://developer.android.com/reference/android/graphics/Rect` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getBounds()() ` Return the drawable's bounds Rect. | | ` https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getCallback()() ` Return the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation attached to this Drawable. | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getChangingConfigurations()() ` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. | | ` https://developer.android.com/reference/android/graphics/ColorFilter` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getColorFilter()() ` Returns the current color filter, or `null` if none set. | | ` https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getConstantState()() ` Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable. | | ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getCurrent()() ` | | ` https://developer.android.com/reference/android/graphics/Rect` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getDirtyBounds()() ` Return the drawable's dirty bounds Rect. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getHotspotBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect outRect) ` Populates `outRect` with the hotspot bounds. | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getIntrinsicHeight()() ` Returns the drawable's intrinsic height. | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getIntrinsicWidth()() ` Returns the drawable's intrinsic width. | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getLayoutDirection()() ` Returns the resolved layout direction for this Drawable. | | ` final int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getLevel()() ` Retrieve the current level. | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getMinimumHeight()() ` Returns the minimum height suggested by this Drawable. | | ` int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getMinimumWidth()() ` Returns the minimum width suggested by this Drawable. | | ` abstract int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getOpacity()() ` *This method was deprecated in API level 29. This method is no longer used in graphics optimizations* | | ` https://developer.android.com/reference/android/graphics/Insets` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getOpticalInsets()() ` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getOutline(android.graphics.Outline)(https://developer.android.com/reference/android/graphics/Outline outline) ` Called to get the drawable to populate the Outline that defines its drawing area. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getPadding(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect padding) ` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. | | ` int[]` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getState()() ` Describes the current state, as a union of primitive states, such as `https://developer.android.com/reference/android/R.attr#state_focused`, `https://developer.android.com/reference/android/R.attr#state_selected`, etc. | | ` https://developer.android.com/reference/android/graphics/Region` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#getTransparentRegion()() ` Returns a Region representing the part of the Drawable that is completely transparent. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#hasFocusStateSpecified()() ` Indicates whether this drawable has at least one state spec explicitly specifying `https://developer.android.com/reference/android/R.attr#state_focused`. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet,%20android.content.res.Resources.Theme)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs, https://developer.android.com/reference/android/content/res/Resources.Theme theme) ` Inflate this Drawable from an XML resource optionally styled by a theme. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#inflate(android.content.res.Resources,%20org.xmlpull.v1.XmlPullParser,%20android.util.AttributeSet)(https://developer.android.com/reference/android/content/res/Resources r, https://developer.android.com/reference/org/xmlpull/v1/XmlPullParser parser, https://developer.android.com/reference/android/util/AttributeSet attrs) ` Inflate this Drawable from an XML resource. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#invalidateSelf()() ` Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable redrawn. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#isAutoMirrored()() ` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#isFilterBitmap()() ` | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#isProjected()() ` Whether this drawable requests projection. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#isStateful()() ` Indicates whether this drawable will change its appearance based on state. | | ` final boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#isVisible()() ` | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#jumpToCurrentState()() ` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. | | ` https://developer.android.com/reference/android/graphics/drawable/Drawable` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#mutate()() ` Make this drawable mutable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#onBoundsChange(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds) ` Override this in your subclass to change appearance if you vary based on the bounds. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#onLayoutDirectionChanged(int)(int layoutDirection) ` Called when the drawable's resolved layout direction changes. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#onLevelChange(int)(int level) ` Override this in your subclass to change appearance if you vary based on level. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#onStateChange(int[])(int[] state) ` Override this in your subclass to change appearance if you recognize the specified state. | | ` static int` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#resolveOpacity(int,%20int)(int op1, int op2) ` Return the appropriate opacity value for two source opacities. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#scheduleSelf(java.lang.Runnable,%20long)(https://developer.android.com/reference/java/lang/Runnable what, long when) ` Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable scheduled. | | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)(int alpha) ` Specify an alpha value for the drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setAutoMirrored(boolean)(boolean mirrored) ` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom) ` Specify a bounding rectangle for the Drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setBounds(android.graphics.Rect)(https://developer.android.com/reference/android/graphics/Rect bounds) ` Specify a bounding rectangle for the Drawable. | | ` final void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setCallback(android.graphics.drawable.Drawable.Callback)(https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback cb) ` Bind a `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` object to this Drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setChangingConfigurations(int)(int configs) ` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)(int color, https://developer.android.com/reference/android/graphics/PorterDuff.Mode mode) ` *This method was deprecated in API level 29. use `https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` with an instance of `https://developer.android.com/reference/android/graphics/BlendModeColorFilter`* | | ` abstract void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)(https://developer.android.com/reference/android/graphics/ColorFilter colorFilter) ` Specify an optional color filter for the drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setDither(boolean)(boolean dither) ` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setFilterBitmap(boolean)(boolean filter) ` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setHotspot(float,%20float)(float x, float y) ` Specifies the hotspot's location within the drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setHotspotBounds(int,%20int,%20int,%20int)(int left, int top, int right, int bottom) ` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds. | | ` final boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setLayoutDirection(int)(int layoutDirection) ` Set the layout direction for this drawable. | | ` final boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setLevel(int)(int level) ` Specify the level for the drawable. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setState(int[])(int[] stateSet) ` Specify a set of states for the drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setTint(int)(int tintColor) ` Specifies tint color for this drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintBlendMode(android.graphics.BlendMode)(https://developer.android.com/reference/android/graphics/BlendMode blendMode) ` Specifies a tint blending mode for this drawable. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintList(android.content.res.ColorStateList)(https://developer.android.com/reference/android/content/res/ColorStateList tint) ` Specifies tint color for this drawable as a color state list. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintMode(android.graphics.PorterDuff.Mode)(https://developer.android.com/reference/android/graphics/PorterDuff.Mode tintMode) ` Specifies a tint blending mode for this drawable. | | ` boolean` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#setVisible(boolean,%20boolean)(boolean visible, boolean restart) ` Set whether this Drawable is visible. | | ` void` | ` https://developer.android.com/reference/android/graphics/drawable/Drawable#unscheduleSelf(java.lang.Runnable)(https://developer.android.com/reference/java/lang/Runnable what) ` Use the current `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback` implementation to have this Drawable unscheduled. | ||
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
## Public constructors
### NinePatchDrawable
Added in [API level 4](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public NinePatchDrawable (Resources res,
Bitmap bitmap,
byte[] chunk,
Rect padding,
String srcName)
```
Create drawable from raw nine-patch data, setting initial target density
based on the display metrics of the resources.
| Parameters ||
|---|---|
| `res` | `Resources`
|
| `bitmap` | `Bitmap`
|
| `chunk` | `byte`
|
| `padding` | `Rect`
|
| `srcName` | `String`
|
### NinePatchDrawable
Added in [API level 4](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public NinePatchDrawable (Resources res,
NinePatch patch)
```
Create drawable from existing nine-patch, setting initial target density
based on the display metrics of the resources.
| Parameters ||
|---|---|
| `res` | `Resources`: This value may be `null`.
|
| `patch` | `NinePatch`: This value cannot be `null`.
|
### NinePatchDrawable
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public NinePatchDrawable (Bitmap bitmap,
byte[] chunk,
Rect padding,
String srcName)
```
**This constructor is deprecated.**
Use `https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.content.res.Resources,%20android.graphics.Bitmap,%20byte[],%20android.graphics.Rect,%20java.lang.String)`
to ensure that the drawable has correctly set its target density.
Create drawable from raw nine-patch data, not dealing with density.
| Parameters ||
|---|---|
| `bitmap` | `Bitmap`
|
| `chunk` | `byte`
|
| `padding` | `Rect`
|
| `srcName` | `String`
|
### NinePatchDrawable
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public NinePatchDrawable (NinePatch patch)
```
**This constructor is deprecated.**
Use `https://developer.android.com/reference/android/graphics/drawable/NinePatchDrawable#NinePatchDrawable(android.content.res.Resources,%20android.graphics.NinePatch)`
to ensure that the drawable has correctly set its target
density.
Create drawable from existing nine-patch, not dealing with density.
| Parameters ||
|---|---|
| `patch` | `NinePatch`: This value cannot be `null`.
|
## Public methods
### applyTheme
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void applyTheme (Resources.Theme t)
```
Applies the specified theme to this Drawable and its children.
| Parameters ||
|---|---|
| `t` | `Resources.Theme`: This value cannot be `null`.
|
### canApplyTheme
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean canApplyTheme ()
```
| Returns ||
|---|---|
| `boolean` |
|
### draw
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void 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).
| Parameters ||
|---|---|
| `canvas` | `Canvas`: The canvas to draw into. This value cannot be `null`.
|
### getAlpha
Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getAlpha ()
```
Gets the current alpha value for the drawable. 0 means fully transparent,
255 means fully opaque. This method is implemented by
Drawable subclasses and the value returned is specific to how that class treats alpha.
The default return value is 255 if the class does not override this method to return a value
specific to its use of alpha.
| Returns ||
|---|---|
| `int` | Value is between 0 and 255 inclusive
|
### getChangingConfigurations
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getChangingConfigurations ()
```
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created. The default implementation
returns whatever was provided through
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setChangingConfigurations(int)` or 0 by default. Subclasses
may extend this to or in the changing configurations of any other
drawables they hold.
| Returns ||
|---|---|
| `int` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_MCC` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_MNC` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_LOCALE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_TOUCHSCREEN` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_KEYBOARD` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_KEYBOARD_HIDDEN` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_NAVIGATION` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_ORIENTATION` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_SCREEN_LAYOUT` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_UI_MODE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_SCREEN_SIZE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_SMALLEST_SCREEN_SIZE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_DENSITY` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_LAYOUT_DIRECTION` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_COLOR_MODE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_FONT_SCALE` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_GRAMMATICAL_GENDER` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_FONT_WEIGHT_ADJUSTMENT` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_ASSETS_PATHS` - `https://developer.android.com/reference/android/content/pm/ActivityInfo#CONFIG_RESOURCES_UNUSED` |
### getConstantState
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable.ConstantState getConstantState ()
```
Return a `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` instance that holds the shared state of this Drawable.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable.ConstantState` | The ConstantState associated to that Drawable. This value may be `null`.
|
### getIntrinsicHeight
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getIntrinsicHeight ()
```
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.
| Returns ||
|---|---|
| `int` | the intrinsic height, or -1 if no intrinsic height
|
### getIntrinsicWidth
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getIntrinsicWidth ()
```
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.
| Returns ||
|---|---|
| `int` | the intrinsic width, or -1 if no intrinsic width
|
### getOpacity
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getOpacity ()
```
**This method is 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
`https://developer.android.com/reference/android/graphics/PixelFormat`:
`https://developer.android.com/reference/android/graphics/PixelFormat#UNKNOWN`,
`https://developer.android.com/reference/android/graphics/PixelFormat#TRANSLUCENT`,
`https://developer.android.com/reference/android/graphics/PixelFormat#TRANSPARENT`, or
`https://developer.android.com/reference/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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#resolveOpacity(int,%20int)` 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 `https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)` or `https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` methods. Some subclasses,
such as `https://developer.android.com/reference/android/graphics/drawable/BitmapDrawable`, `https://developer.android.com/reference/android/graphics/drawable/ColorDrawable`, and `https://developer.android.com/reference/android/graphics/drawable/GradientDrawable`,
do account for the value of `https://developer.android.com/reference/android/graphics/drawable/Drawable#setAlpha(int)`, but the general behavior is dependent
upon the implementation of the subclass.
| Returns ||
|---|---|
| `int` | int The opacity class of the Drawable. Value is one of the following: - `https://developer.android.com/reference/android/graphics/PixelFormat#UNKNOWN` - `https://developer.android.com/reference/android/graphics/PixelFormat#TRANSLUCENT` - `https://developer.android.com/reference/android/graphics/PixelFormat#TRANSPARENT` - `https://developer.android.com/reference/android/graphics/PixelFormat#OPAQUE` |
### getOpticalInsets
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Insets getOpticalInsets ()
```
Return in insets the layout insets suggested by this Drawable for use with alignment
operations during layout.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Insets` | This value cannot be `null`.
|
### getOutline
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void getOutline (Outline outline)
```
Called to get the drawable to populate the Outline that defines its drawing area.
This method is called by the default `https://developer.android.com/reference/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
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean getPadding (Rect padding)
```
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`.
|
| Returns ||
|---|---|
| `boolean` | true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.
|
### getPaint
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Paint getPaint ()
```
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Paint` | This value cannot be `null`.
|
### getTransparentRegion
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Region getTransparentRegion ()
```
Returns a Region representing the part of the Drawable that is completely
transparent. This can be used to perform drawing operations, identifying
which parts of the target will not change when rendering the Drawable.
The default implementation returns null, indicating no transparent
region; subclasses can optionally override this to return an actual
Region if they want to supply this optimization information, but it is
not required that they do so.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/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
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean hasFocusStateSpecified ()
```
Indicates whether this drawable has at least one state spec explicitly
specifying `https://developer.android.com/reference/android/R.attr#state_focused`.
Note: A View uses a `https://developer.android.com/reference/android/graphics/drawable/Drawable` instance as its background and it
changes its appearance based on a state. On keyboard devices, it should
specify its `https://developer.android.com/reference/android/R.attr#state_focused` to make sure the user
knows which view is holding the focus.
| Returns ||
|---|---|
| `boolean` | `true` if `https://developer.android.com/reference/android/R.attr#state_focused` is specified for this drawable.
|
### inflate
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void inflate (Resources r,
XmlPullParser parser,
AttributeSet attrs,
Resources.Theme theme)
```
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
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/io/IOException` | |
| `https://developer.android.com/reference/org/xmlpull/v1/XmlPullParserException` | |
### isAutoMirrored
Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isAutoMirrored ()
```
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left. See `https://developer.android.com/reference/android/util/LayoutDirection`.
| Returns ||
|---|---|
| `boolean` | boolean Returns true if this Drawable will be automatically mirrored.
|
### isFilterBitmap
Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isFilterBitmap ()
```
| Returns ||
|---|---|
| `boolean` | whether this drawable filters its bitmaps
|
### isStateful
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isStateful ()
```
Indicates whether this drawable will change its appearance based on
state. Clients can use this to determine whether it is necessary to
calculate their state and call setState.
| Returns ||
|---|---|
| `boolean` | True if this drawable changes its appearance based on state, false otherwise.
|
### mutate
Added in [API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Drawable mutate ()
```
Make this drawable mutable. This operation cannot be reversed. A mutable
drawable is guaranteed to not share its state with any other drawable.
This is especially useful when you need to modify properties of drawables
loaded from resources. By default, all drawables instances loaded from
the same resource share a common state; if you modify the state of one
instance, all the other instances will receive the same modification.
Calling this method on a mutable Drawable will have no effect.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/drawable/Drawable` | This drawable. This value cannot be `null`.
|
### setAlpha
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setAlpha (int alpha)
```
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
Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setAutoMirrored (boolean mirrored)
```
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left). See `https://developer.android.com/reference/android/util/LayoutDirection`.
| Parameters ||
|---|---|
| `mirrored` | `boolean`: Set to true if the Drawable should be mirrored, false if not.
|
### setColorFilter
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setColorFilter (ColorFilter colorFilter)
```
Specify an optional color filter for the drawable.
If a Drawable has a ColorFilter, each output pixel of the Drawable's
drawing contents will be modified by the color filter before it is
blended onto the render target of a Canvas.
Pass `null` to remove any existing color filter.
**Note:** Setting a non-`null` color
filter disables `https://developer.android.com/reference/android/graphics/drawable/Drawable#setTintList(android.content.res.ColorStateList)`.
| Parameters ||
|---|---|
| `colorFilter` | `ColorFilter`: This value may be `null`.
|
### setDither
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setDither (boolean dither)
```
Set to true to have the drawable dither its colors when drawn to a
device with fewer than 8-bits per color component.
| Parameters ||
|---|---|
| `dither` | `boolean`
|
### setFilterBitmap
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setFilterBitmap (boolean filter)
```
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.
| Parameters ||
|---|---|
| `filter` | `boolean`
|
### setTargetDensity
Added in [API level 4](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setTargetDensity (DisplayMetrics metrics)
```
Set the density scale at which this drawable will be rendered.
| Parameters ||
|---|---|
| `metrics` | `DisplayMetrics`: The DisplayMetrics indicating the density scale for this drawable. This value cannot be `null`.
|
**See also:**
- `https://developer.android.com/reference/android/graphics/Bitmap#setDensity(int)`
- `https://developer.android.com/reference/android/graphics/Bitmap#getDensity()`
### setTargetDensity
Added in [API level 4](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setTargetDensity (Canvas canvas)
```
Set the density scale at which this drawable will be rendered. This
method assumes the drawable will be rendered at the same density as the
specified canvas.
| Parameters ||
|---|---|
| `canvas` | `Canvas`: The Canvas from which the density scale must be obtained. This value cannot be `null`.
|
**See also:**
- `https://developer.android.com/reference/android/graphics/Bitmap#setDensity(int)`
- `https://developer.android.com/reference/android/graphics/Bitmap#getDensity()`
### setTargetDensity
Added in [API level 4](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setTargetDensity (int density)
```
Set the density at which this drawable will be rendered.
| Parameters ||
|---|---|
| `density` | `int`: The density scale for this drawable.
|
**See also:**
- `https://developer.android.com/reference/android/graphics/Bitmap#setDensity(int)`
- `https://developer.android.com/reference/android/graphics/Bitmap#getDensity()`
### setTintBlendMode
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setTintBlendMode (BlendMode blendMode)
```
Specifies a tint blending mode for this drawable.
Defines how this drawable's tint color should be blended into the drawable
before it is drawn to screen. Default tint mode is `https://developer.android.com/reference/android/graphics/BlendMode#SRC_IN`.
**Note:** Setting a color filter via
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)`
| Parameters ||
|---|---|
| `blendMode` | `BlendMode`: This value may be `null`.
|
### setTintList
Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void setTintList (ColorStateList tint)
```
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
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)`.
**Note:** Setting a color filter via
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(android.graphics.ColorFilter)` or
`https://developer.android.com/reference/android/graphics/drawable/Drawable#setColorFilter(int,%20android.graphics.PorterDuff.Mode)` overrides tint.
| Parameters ||
|---|---|
| `tint` | `ColorStateList`: This value may be `null`.
|
## Protected methods
### onStateChange
Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
protected boolean onStateChange (int[] stateSet)
```
Override this in your subclass to change appearance if you recognize the
specified state.
| Parameters ||
|---|---|
| `stateSet` | `int`: This value cannot be `null`.
|
| Returns ||
|---|---|
| `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.
|