Skip to content

Most visited

Recently visited

navigation
Added in API level 1

NinePatchDrawable

public class NinePatchDrawable
extends Drawable

java.lang.Object
   ↳ 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(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.

void getOutline(Outline outline)

Called to get the drawable to populate the Outline that defines its drawing area.

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 isFilterBitmap()
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 colorFilter)

Specify an optional color filter for the drawable.

void setDither(boolean dither)

This method is deprecated. This property is ignored.

void setFilterBitmap(boolean filter)

Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.

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 setTintList(ColorStateList tint)

Specifies tint color for this drawable as a color state list.

void setTintMode(PorterDuff.Mode tintMode)

Specifies a tint 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.

Inherited methods

From class android.graphics.drawable.Drawable
From class java.lang.Object

Public constructors

NinePatchDrawable

Added in API level 1
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.

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 4
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 1
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.

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

Parameters
patch NinePatch

NinePatchDrawable

Added in API level 4
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
patch NinePatch

Public methods

applyTheme

Added in API level 21
void applyTheme (Resources.Theme t)

Applies the specified theme to this Drawable and its children.

Parameters
t Resources.Theme

canApplyTheme

Added in API level 21
boolean canApplyTheme ()

Returns
boolean

draw

Added in API level 1
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

getAlpha

Added in API level 19
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

getChangingConfigurations

Added in API level 1
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 setChangingConfigurations(int) or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.

Returns
int Returns a mask of the changing configuration parameters, as defined by ActivityInfo.

getConstantState

Added in API level 1
Drawable.ConstantState getConstantState ()

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

Returns
Drawable.ConstantState The ConstantState associated to that Drawable.

getIntrinsicHeight

Added in API level 1
int getIntrinsicHeight ()

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

Returns
int

getIntrinsicWidth

Added in API level 1
int getIntrinsicWidth ()

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

Returns
int

getMinimumHeight

Added in API level 1
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.

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

getMinimumWidth

Added in API level 1
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.

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

getOpacity

Added in API level 1
int getOpacity ()

Returns a graphics.PixelFormat value of OPAQUE or TRANSLUCENT.

Returns
int int The opacity class of the Drawable.

getOutline

Added in API level 21
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 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

getPadding

Added in API level 1
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
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
Paint getPaint ()

Returns
Paint

getTransparentRegion

Added in API level 1
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
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.

inflate

Added in API level 21
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: Resources used to resolve attribute values
parser XmlPullParser: XML parser from which to inflate this Drawable
attrs AttributeSet: Base set of attribute values
theme Resources.Theme: Theme to apply, may be null
Throws
XmlPullParserException
IOException

isAutoMirrored

Added in API level 19
boolean isAutoMirrored ()

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

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

isFilterBitmap

Added in API level 23
boolean isFilterBitmap ()

Returns
boolean whether this drawable filters its bitmaps

isStateful

Added in API level 1
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
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
Drawable This drawable.

setAlpha

Added in API level 1
void setAlpha (int alpha)

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

Parameters
alpha int

setAutoMirrored

Added in API level 19
void setAutoMirrored (boolean mirrored)

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

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

setColorFilter

Added in API level 1
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 tint.

Parameters
colorFilter ColorFilter: The color filter to apply, or null to remove the existing color filter

setDither

Added in API level 1
void setDither (boolean dither)

This method is deprecated.
This property is ignored.

Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.

Parameters
dither boolean

setFilterBitmap

Added in API level 1
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
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:

setTargetDensity

Added in API level 4
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.

See also:

setTargetDensity

Added in API level 4
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.

See also:

setTintList

Added in API level 21
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 setColorFilter(int, PorterDuff.Mode).

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tint ColorStateList: Color state list to use for tinting this drawable, or null to clear the tint

setTintMode

Added in API level 21
void setTintMode (PorterDuff.Mode tintMode)

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

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters
tintMode PorterDuff.Mode: A Porter-Duff blending mode

Protected methods

onStateChange

Added in API level 1
boolean onStateChange (int[] stateSet)

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

Parameters
stateSet int
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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.