Added in API level 1

NinePatchDrawable

---

Kotlin |Java

open class NinePatchDrawable : Drawable

kotlin.Any
↳	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 developer guide. For information about creating a NinePatch image file using the draw9patch tool, see the Draw 9-patch tool guide.

Summary

Public constructors
NinePatchDrawable(res: Resources!, bitmap: Bitmap!, chunk: ByteArray!, padding: Rect!, srcName: String!) Create drawable from raw nine-patch data, setting initial target density based on the display metrics of the resources.
NinePatchDrawable(res: Resources?, patch: NinePatch) Create drawable from existing nine-patch, setting initial target density based on the display metrics of the resources.
NinePatchDrawable(bitmap: Bitmap!, chunk: ByteArray!, padding: Rect!, srcName: String!) Create drawable from raw nine-patch data, not dealing with density.
NinePatchDrawable(patch: NinePatch) Create drawable from existing nine-patch, not dealing with density.

Public methods
open Unit	applyTheme(t: Resources.Theme) Applies the specified theme to this Drawable and its children.
open Boolean	canApplyTheme()
open Unit	draw(canvas: Canvas)
open Int	getAlpha()
open Int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open Drawable.ConstantState?	getConstantState()
open Int	getIntrinsicHeight()
open Int	getIntrinsicWidth()
open Int	getOpacity()
open Insets	getOpticalInsets()
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 Paint	getPaint()
open Region?	getTransparentRegion()
open Boolean	hasFocusStateSpecified()
open Unit	inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)
open Boolean	isAutoMirrored()
open Boolean	isFilterBitmap()
open Boolean	isStateful()
open Drawable	mutate()
open Unit	setAlpha(alpha: Int)
open Unit	setAutoMirrored(mirrored: Boolean)
open Unit	setColorFilter(colorFilter: ColorFilter?) Specify an optional color filter for the drawable.
open Unit	setDither(dither: Boolean)
open Unit	setFilterBitmap(filter: Boolean)
open Unit	setTargetDensity(canvas: Canvas) Set the density scale at which this drawable will be rendered.
open Unit	setTargetDensity(metrics: DisplayMetrics) Set the density scale at which this drawable will be rendered.
open Unit	setTargetDensity(density: Int) Set the density at which this drawable will be rendered.
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.

Protected methods
open Boolean	onStateChange(stateSet: IntArray)

Inherited functions

From class Drawable Unit clearColorFilter() Removes the color filter for this drawable. Rect copyBounds() Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect). Unit copyBounds(bounds: Rect) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called. Drawable? createFromPath(pathName: String!) Create a drawable from file path name. Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?) Create a drawable from an inputstream, using the given resources and value to determine density information. Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?) Create a drawable from an inputstream, using the given resources and value to determine density information. Drawable? createFromStream(is: InputStream?, srcName: String?) Create a drawable from an inputstream Drawable createFromXml(r: Resources, parser: XmlPullParser) Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources. Drawable createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?) Create a drawable from an XML document using an optional Theme. For more information on how to create resources in XML, see Drawable Resources. Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable. Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?) Create a drawable from inside an XML document using an optional Theme. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable. Rect getBounds() Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable. Drawable.Callback? getCallback() Return the current Callback implementation attached to this Drawable. ColorFilter? getColorFilter() Returns the current color filter, or null if none set. Drawable getCurrent() Rect getDirtyBounds() Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation. Unit getHotspotBounds(outRect: Rect) Populates outRect with the hotspot bounds. Int getLayoutDirection() Returns the resolved layout direction for this Drawable. Int getLevel() Retrieve the current level. Int getMinimumHeight() Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding. Int getMinimumWidth() Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding. IntArray getState() Describes the current state, as a union of primitive states, such as android.R.attr#state_focused, android.R.attr#state_selected, etc. Some drawables may modify their imagery based on the selected state. Unit inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Inflate this Drawable from an XML resource. Does not apply a theme. Unit invalidateSelf() Use the current Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable. Boolean isProjected() 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. Boolean isVisible() Unit jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. Unit onBoundsChange(bounds: Rect) Override this in your subclass to change appearance if you vary based on the bounds. Boolean onLayoutDirectionChanged(layoutDirection: Int) Called when the drawable's resolved layout direction changes. Boolean onLevelChange(level: Int) Override this in your subclass to change appearance if you vary based on level. Int resolveOpacity(op1: Int, op2: Int) Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing getOpacity. Unit scheduleSelf(what: Runnable, when: Long) Use the current Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable. Unit setBounds(bounds: Rect) Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called. Unit setBounds(left: Int, top: Int, right: Int, bottom: Int) Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called. Unit setCallback(cb: Drawable.Callback?) Bind a Callback object to this Drawable. Required for clients that want to support animated drawables. Unit setChangingConfigurations(configs: Int) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. Unit setColorFilter(color: Int, mode: PorterDuff.Mode) Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for setColorFilter(android.graphics.ColorFilter) which constructs a PorterDuffColorFilter. Note: Setting a color filter disables tint. Unit setHotspot(x: Float, y: Float) Specifies the hotspot's location within the drawable. 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. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own. Boolean setLevel(level: Int) Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function. Boolean setState(stateSet: IntArray) Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [android.R.attr#state_focused, android.R.attr#state_pressed]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time. Unit setTint(tintColor: Int) Specifies tint color for this drawable. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to setColorFilter(int,android.graphics.PorterDuff.Mode). To clear the tint, pass null to setTintList(android.content.res.ColorStateList). Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint. Unit setTintMode(tintMode: PorterDuff.Mode?) Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is PorterDuff.Mode.SRC_IN. Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint. Boolean setVisible(visible: Boolean, restart: 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. Unit unscheduleSelf(what: Runnable) Use the current Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

Public constructors

NinePatchDrawable

Added in API level 4

NinePatchDrawable(
    res: Resources!, 
    bitmap: Bitmap!, 
    chunk: ByteArray!, 
    padding: Rect!, 
    srcName: String!)

Create drawable from raw nine-patch data, setting initial target density based on the display metrics of the resources.

NinePatchDrawable

Added in API level 4

NinePatchDrawable(
    res: Resources?, 
    patch: NinePatch)

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

NinePatchDrawable(
    bitmap: Bitmap!, 
    chunk: ByteArray!, 
    padding: Rect!, 
    srcName: String!)

Deprecated: Use NinePatchDrawable(android.content.res.Resources,android.graphics.Bitmap,byte[],android.graphics.Rect,java.lang.String) to ensure that the drawable has correctly set its target density.

Create drawable from raw nine-patch data, not dealing with density.

NinePatchDrawable

Added in API level 1

NinePatchDrawable(patch: NinePatch)

Deprecated: Use NinePatchDrawable(android.content.res.Resources,android.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

open fun applyTheme(t: Resources.Theme): Unit

Applies the specified theme to this Drawable and its children.

Parameters
t	Resources.Theme: This value cannot be null.

canApplyTheme

Added in API level 21

open fun canApplyTheme(): Boolean

draw

Added in API level 1

open fun draw(canvas: Canvas): Unit

Parameters
canvas	Canvas: The canvas to draw into This value cannot be null.

getAlpha

Added in API level 19

open fun getAlpha(): Int

Return
Int	Value is between 0 and 255 inclusive

getChangingConfigurations

Added in API level 1

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.

Return

Int

Value is either 0 or a combination of android.content.pm.ActivityInfo#CONFIG_MCC, android.content.pm.ActivityInfo#CONFIG_MNC, android.content.pm.ActivityInfo#CONFIG_LOCALE, android.content.pm.ActivityInfo#CONFIG_TOUCHSCREEN, android.content.pm.ActivityInfo#CONFIG_KEYBOARD, android.content.pm.ActivityInfo#CONFIG_KEYBOARD_HIDDEN, android.content.pm.ActivityInfo#CONFIG_NAVIGATION, android.content.pm.ActivityInfo#CONFIG_ORIENTATION, android.content.pm.ActivityInfo#CONFIG_SCREEN_LAYOUT, android.content.pm.ActivityInfo#CONFIG_UI_MODE, android.content.pm.ActivityInfo#CONFIG_SCREEN_SIZE, android.content.pm.ActivityInfo#CONFIG_SMALLEST_SCREEN_SIZE, android.content.pm.ActivityInfo#CONFIG_DENSITY, android.content.pm.ActivityInfo#CONFIG_LAYOUT_DIRECTION, android.content.pm.ActivityInfo#CONFIG_COLOR_MODE, android.content.pm.ActivityInfo#CONFIG_FONT_SCALE, android.content.pm.ActivityInfo#CONFIG_GRAMMATICAL_GENDER, android.content.pm.ActivityInfo#CONFIG_ASSETS_PATHS, and android.content.pm.ActivityInfo#CONFIG_RESOURCES_UNUSED

getConstantState

Added in API level 1

open fun getConstantState(): Drawable.ConstantState?

Return
Drawable.ConstantState?	The ConstantState associated to that Drawable. This value may be null.

getIntrinsicHeight

Added in API level 1

open fun getIntrinsicHeight(): Int

Return
Int	the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth

Added in API level 1

open fun getIntrinsicWidth(): Int

Return
Int	the intrinsic width, or -1 if no intrinsic width

getOpacity

Added in API level 1

open fun getOpacity(): Int

Return
Int	int The opacity class of the Drawable. Value is android.graphics.PixelFormat#UNKNOWN, android.graphics.PixelFormat#TRANSLUCENT, android.graphics.PixelFormat#TRANSPARENT, or android.graphics.PixelFormat#OPAQUE

getOpticalInsets

Added in API level 29

open fun getOpticalInsets(): Insets

Return
Insets	This value cannot be null.

getOutline

Added in API level 21

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

Added in API level 1

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.

getPaint

Added in API level 1

open fun getPaint(): Paint

Return
Paint	This value cannot be null.

getTransparentRegion

Added in API level 1

open fun getTransparentRegion(): Region?

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

Added in API level 31

open fun hasFocusStateSpecified(): Boolean

Return
Boolean	true if android.R.attr#state_focused is specified for this drawable.

inflate

Added in API level 21

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

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

isAutoMirrored

Added in API level 19

open fun isAutoMirrored(): Boolean

Return
Boolean	boolean Returns true if this Drawable will be automatically mirrored.

isFilterBitmap

Added in API level 23

open fun isFilterBitmap(): Boolean

Return
Boolean	whether this drawable filters its bitmaps

isStateful

Added in API level 1

open fun isStateful(): Boolean

Return
Boolean	True if this drawable changes its appearance based on state, false otherwise.

mutate

Added in API level 3

open fun mutate(): Drawable

Return
Drawable	This drawable. This value cannot be null.

setAlpha

Added in API level 1

open fun setAlpha(alpha: Int): Unit

Parameters
alpha	Int: Value is between 0 and 255 inclusive

setAutoMirrored

Added in API level 19

open fun setAutoMirrored(mirrored: Boolean): Unit

Parameters
mirrored	Boolean: Set to true if the Drawable should be mirrored, false if not.

setColorFilter

Added in API level 1

open 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?: This value may be null.

setDither

Added in API level 1

open fun setDither(dither: Boolean): Unit

setFilterBitmap

Added in API level 1

open fun setFilterBitmap(filter: Boolean): Unit

setTargetDensity

Added in API level 4

open fun setTargetDensity(canvas: Canvas): Unit

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

• android.graphics.Bitmap#setDensity(int)
• android.graphics.Bitmap#getDensity()

setTargetDensity

Added in API level 4

open fun setTargetDensity(metrics: DisplayMetrics): Unit

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

• android.graphics.Bitmap#setDensity(int)
• android.graphics.Bitmap#getDensity()

setTargetDensity

Added in API level 4

open fun setTargetDensity(density: Int): Unit

Set the density at which this drawable will be rendered.

Parameters
density	Int: The density scale for this drawable.

See Also

• android.graphics.Bitmap#setDensity(int)
• android.graphics.Bitmap#getDensity()

setTintBlendMode

Added in API level 29

open fun setTintBlendMode(blendMode: BlendMode?): Unit

Specifies a tint blending mode for this drawable.

Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is BlendMode.SRC_IN.

Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)

Parameters
blendMode	BlendMode?: This value may be null.

setTintList

Added in API level 21

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?: This value may be null.

Protected methods

onStateChange

Added in API level 1

protected open fun onStateChange(stateSet: IntArray): Boolean

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