Android APIs
public class

NinePatchDrawable

extends Drawable
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.NinePatchDrawable

Class Overview

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(Bitmap bitmap, byte[] chunk, Rect padding, String srcName)
This constructor was deprecated in API level 4. Use NinePatchDrawable(Resources, Bitmap, byte[], Rect, String) to ensure that the drawable has correctly set its target density.
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.
NinePatchDrawable(NinePatch patch)
This constructor was deprecated in API level 4. Use NinePatchDrawable(Resources, NinePatch) to ensure that the drawable has correctly set its target density.
NinePatchDrawable(Resources res, NinePatch patch)
Create drawable from existing nine-patch, setting initial target density based on the display metrics of the resources.
Public Methods
void applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children.
boolean canApplyTheme()
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).
int getAlpha()
Gets the current alpha value for the drawable.
int getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
Drawable.ConstantState getConstantState()
Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
int getIntrinsicHeight()
Retrieves the height of the source .png file (before resizing).
int getIntrinsicWidth()
Retrieves the width of the source .png file (before resizing).
int getMinimumHeight()
Returns the minimum height suggested by this Drawable.
int getMinimumWidth()
Returns the minimum width suggested by this Drawable.
int getOpacity()
Returns a graphics.PixelFormat value of OPAQUE or TRANSLUCENT.
boolean getPadding(Rect padding)
Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
Paint getPaint()
Region getTransparentRegion()
Returns a Region representing the part of the Drawable that is completely transparent.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
boolean isAutoMirrored()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean isStateful()
Indicates whether this drawable will change its appearance based on state.
Drawable mutate()
Make this drawable mutable.
void setAlpha(int alpha)
Specify an alpha value for the drawable.
void setAutoMirrored(boolean mirrored)
Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void setColorFilter(ColorFilter cf)
Specify an optional color filter for the drawable.
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.
void setFilterBitmap(boolean filter)
Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps).
void setTargetDensity(int density)
Set the density at which this drawable will be rendered.
void setTargetDensity(DisplayMetrics metrics)
Set the density scale at which this drawable will be rendered.
void setTargetDensity(Canvas canvas)
Set the density scale at which this drawable will be rendered.
void setTint(ColorStateList tint, PorterDuff.Mode tintMode)
Specifies a tint and blending mode for this drawable.
Protected Methods
boolean onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
[Expand]
Inherited Methods
From class android.graphics.drawable.Drawable
From class java.lang.Object

Public Constructors

public NinePatchDrawable (Bitmap bitmap, byte[] chunk, Rect padding, String srcName)

Added in API level 1

This constructor was deprecated in API level 4.
Use NinePatchDrawable(Resources, Bitmap, byte[], Rect, String) to ensure that the drawable has correctly set its target density.

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

public NinePatchDrawable (Resources res, Bitmap bitmap, byte[] chunk, Rect padding, String srcName)

Added in API level 4

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

public NinePatchDrawable (NinePatch patch)

Added in API level 1

This constructor was deprecated in API level 4.
Use NinePatchDrawable(Resources, NinePatch) to ensure that the drawable has correctly set its target density.

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

public NinePatchDrawable (Resources res, NinePatch patch)

Added in API level 4

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

Public Methods

public void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

public boolean canApplyTheme ()

public void draw (Canvas canvas)

Added in API level 1

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Parameters
canvas The canvas to draw into

public int getAlpha ()

Added in API level 19

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.

public int getChangingConfigurations ()

Added in API level 1

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.

Returns
  • Returns a mask of the changing configuration parameters, as defined by Configuration.

public Drawable.ConstantState getConstantState ()

Added in API level 1

Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

Returns
  • The ConstantState associated to that Drawable.

public int getIntrinsicHeight ()

Added in API level 1

Retrieves the height of the source .png file (before resizing).

public int getIntrinsicWidth ()

Added in API level 1

Retrieves the width of the source .png file (before resizing).

public int getMinimumHeight ()

Added in API level 1

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.

Returns
  • The minimum height suggested by this Drawable. If this Drawable doesn't have a suggested minimum height, 0 is returned.

public int getMinimumWidth ()

Added in API level 1

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.

Returns
  • The minimum width suggested by this Drawable. If this Drawable doesn't have a suggested minimum width, 0 is returned.

public int getOpacity ()

Added in API level 1

Returns a graphics.PixelFormat value of OPAQUE or TRANSLUCENT.

Returns
  • int The opacity class of the Drawable.

public boolean getPadding (Rect padding)

Added in API level 1

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

Returns
  • true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

public Paint getPaint ()

Added in API level 1

public Region getTransparentRegion ()

Added in API level 1

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

public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Inflate this Drawable from an XML resource optionally styled by a theme.

Parameters
r Resources used to resolve attribute values
parser XML parser from which to inflate this Drawable
attrs Base set of attribute values
theme Theme to apply, may be null
Throws
XmlPullParserException
IOException

public boolean isAutoMirrored ()

Added in API level 19

Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection.

Returns
  • boolean Returns true if this Drawable will be automatically mirrored.

public boolean isStateful ()

Added in API level 1

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
  • True if this drawable changes its appearance based on state, false otherwise.

public Drawable mutate ()

Added in API level 3

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
  • This drawable.

public void setAlpha (int alpha)

Added in API level 1

Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

public void setAutoMirrored (boolean mirrored)

Added in API level 19

Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection.

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

public void setColorFilter (ColorFilter cf)

Added in API level 1

Specify an optional color filter for the drawable. Pass null to remove any existing color filter.

Parameters
cf the color filter to apply, or null to remove the existing color filter

public void setDither (boolean dither)

Added in API level 1

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. This can improve the look on those devices, but can also slow down the drawing a little.

public void setFilterBitmap (boolean filter)

Added in API level 1

Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps). If the drawable does not use bitmaps, this call is ignored. This can improve the look when scaled or rotated, but also slows down the drawing.

public void setTargetDensity (int density)

Added in API level 4

Set the density at which this drawable will be rendered.

Parameters
density The density scale for this drawable.
See Also

public void setTargetDensity (DisplayMetrics metrics)

Added in API level 4

Set the density scale at which this drawable will be rendered.

Parameters
metrics The DisplayMetrics indicating the density scale for this drawable.
See Also

public void setTargetDensity (Canvas canvas)

Added in API level 4

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 The Canvas from which the density scale must be obtained.
See Also

public void setTint (ColorStateList tint, PorterDuff.Mode tintMode)

Specifies a tint and blending mode for this drawable.

Setting a color filter via setColorFilter(ColorFilter) overrides tint.

Parameters
tint Color state list to use for tinting this drawable, or null to clear the tint
tintMode A Porter-Duff blending mode

Protected Methods

protected boolean onStateChange (int[] stateSet)

Added in API level 1

Override this in your subclass to change appearance if you recognize the specified state.

Returns
  • 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.