Summary: Ctors | Methods | Inherited Methods | [Expand All]

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, described in Resources.

Summary

Public Constructors
	NinePatchDrawable(Bitmap bitmap, byte[] chunk, Rect padding, String srcName)
	NinePatchDrawable(NinePatch patch)

Public Methods
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	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable mau change, requiring that it be re-created.
Drawable.ConstantState	getConstantState()
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)
Drawable	mutate() Make this drawable mutable.
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setColorFilter(ColorFilter cf) Specify an optional colorFilter 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.

[Expand]

Inherited Methods

From class android.graphics.drawable.Drawable

void	clearColorFilter()
final Rect	copyBounds() Return a copy of the drawable's bounds in a new Rect.
final void	copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
static Drawable	createFromPath(String pathName) Create a drawable from file path name.
static Drawable	createFromStream(InputStream is, String srcName) Create a drawable from an inputstream
static Drawable	createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document.
abstract 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).
final Rect	getBounds() Return the drawable's bounds Rect.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable mau change, requiring that it be re-created.
Drawable.ConstantState	getConstantState()
Drawable	getCurrent()
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
final int	getLevel() Retrieve the current level.
int	getMinimumHeight() Returns the minimum height suggested by this Drawable.
int	getMinimumWidth() Returns the minimum width suggested by this Drawable.
abstract int	getOpacity() Return the opacity/transparency of this Drawable.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
int[]	getState() Describes the current state, as a union of primitve states, such as state_focused, state_selected, etc.
Region	getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
void	invalidateSelf() Use the current Drawable.Callback implementation to have this Drawable redrawn.
boolean	isStateful() Indicates whether this view will change its appearance based on state.
final boolean	isVisible()
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you recognize the specified state.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
static int	resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities.
void	scheduleSelf(Runnable what, long when) Use the current Drawable.Callback implementation to have this Drawable scheduled.
abstract void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setBounds(Rect bounds) Specify a bounding rectangle for the Drawable.
void	setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable.
final void	setCallback(Drawable.Callback cb) Bind a Drawable.Callback object to this Drawable.
void	setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
abstract void	setColorFilter(ColorFilter cf) Specify an optional colorFilter for the drawable.
void	setColorFilter(int color, PorterDuff.Mode mode) Specify a color and porterduff mode to be the colorfilter for this 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).
final boolean	setLevel(int level) Specify the level for the drawable.
boolean	setState(int[] stateSet) Specify a set of states for the drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleSelf(Runnable what) Use the current Drawable.Callback implementation to have this Drawable unscheduled.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

Public Constructors

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

public NinePatchDrawable (NinePatch patch)

Public Methods

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	The canvas to draw into

public int getChangingConfigurations ()

Return a mask of the configuration parameters for which this drawable mau 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 ()

public int getIntrinsicHeight ()

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

public int getIntrinsicWidth ()

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

public 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

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

public 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

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

public int getOpacity ()

Returns a graphics.PixelFormat value of OPAQUE or TRANSLUCENT.

Returns

int The opacity class of the Drawable.

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

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

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)

Throws

XmlPullParserException
IOException

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

This drawable.

public void setAlpha (int alpha)

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

public void setColorFilter (ColorFilter cf)

Specify an optional colorFilter for the drawable. Pass null to remove any filters.

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. This can improve the look on those devices, but can also slow down the drawing a little.

Interfaces

Classes

Enums

NinePatchDrawable

Class Overview

Summary

Public Constructors

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

public NinePatchDrawable (NinePatch patch)

Public Methods

public void draw (Canvas canvas)

Parameters

public int getChangingConfigurations ()

Returns

public Drawable.ConstantState getConstantState ()

public int getIntrinsicHeight ()

public int getIntrinsicWidth ()

public int getMinimumHeight ()

Returns

public int getMinimumWidth ()

Returns

public int getOpacity ()

Returns

public boolean getPadding (Rect padding)

public Paint getPaint ()

public Region getTransparentRegion ()

Returns

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

Throws

public Drawable mutate ()

Returns

public void setAlpha (int alpha)

public void setColorFilter (ColorFilter cf)

public void setDither (boolean dither)