Android - An Open Handset Alliance Project

android.graphics.drawable
public class

android.graphics.drawable.BitmapDrawable

java.lang.Object
	android.graphics.drawable.Drawable
		android.graphics.drawable.BitmapDrawable

Summary

Public Constructors

					BitmapDrawable(Bitmap bitmap)
					BitmapDrawable(String filepath)
					BitmapDrawable(InputStream is)

Public Methods

	void	clearShadow()
		Clears any existing shadow.
	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	Bitmap	getBitmap()
final	ConstantState	getConstantState()
	int	getGravity()
		Get the gravity used to position/stretch the bitmap within its bounds.
	int	getIntrinsicHeight()
		Return the intrinsic height of the underlying drawable object.
	int	getIntrinsicWidth()
		Return the intrinsic width of the underlying drawable object.
	int	getOpacity()
		Return the opacity/transparency of this Drawable.
final	Paint	getPaint()
	void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
	void	setAlpha(int alpha)
		Specify an alpha value for the drawable.
	void	setAntiAlias(boolean aa)
	void	setColorFilter(ColorFilter cf)
		Specify an optional colorFilter for the drawable.
	void	setDither(boolean dither)
	void	setFilterBitmap(boolean filter)
	void	setGravity(int gravity)
		Set the gravity used to position/stretch the bitmap within its bounds.
	void	setShadow(float radius, int dx, int dy, int color)
		Creates a shadow layer for the bitmap.

Protected Methods

				void	onBoundsChange(Rect bounds)
					Override this in your subclass to change appearance if you recognize the specified state.

Methods inherited 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.
			ConstantState	getConstantState()
			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()
			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.
	final	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(Callback cb)
				Bind a Drawable.Callback object to this Drawable.
abstract			void	setColorFilter(ColorFilter cf)
				Specify an optional colorFilter for the drawable.
			void	setColorFilter(int color, Mode mode)
				Specify a color and porterduff mode to be the colorfilter for this drawable.
			void	setDither(boolean dither)
	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Constructors

public BitmapDrawable(Bitmap bitmap)

public BitmapDrawable(String filepath)

public BitmapDrawable(InputStream is)

Public Methods

public void clearShadow()

Clears any existing shadow.

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 final Bitmap getBitmap()

public final ConstantState getConstantState()

public int getGravity()

Get the gravity used to position/stretch the bitmap within its bounds. See android.view.Gravity

Returns

the gravity applied to the bitmap

public int getIntrinsicHeight()

Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

public int getIntrinsicWidth()

Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

public int getOpacity()

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: UNKNOWN, TRANSLUCENT, TRANSPARENT, or OPAQUE.

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 resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output.

Note that the returned value does not take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods.

public final Paint getPaint()

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

Throws

XmlPullParserException
IOException

public void setAlpha(int alpha)

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

public void setAntiAlias(boolean aa)

public void setColorFilter(ColorFilter cf)

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

public void setDither(boolean dither)

public void setFilterBitmap(boolean filter)

public void setGravity(int gravity)

Set the gravity used to position/stretch the bitmap within its bounds. See android.view.Gravity

Parameters

gravity	the gravity

public void setShadow(float radius, int dx, int dy, int color)

Creates a shadow layer for the bitmap. To clear the shadow, call clearShadow().

Parameters

radius	Radius of the blur to apply to the shadow. A value < 0 indicates no shadow
dx	X offset for the shadow, relative to the bitmap
dy	Y offset for the shadow, relative to the bitmap
color	The color/alpha of the shadow. A vallue of 0 indicates no shadow.

Protected Methods

protected void onBoundsChange(Rect bounds)

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

Android - An Open Handset Alliance Project

Documentation

Goodies

android.graphics.drawable.BitmapDrawable

Summary

Public Constructors

Public Methods

Protected Methods

Methods inherited from class android.graphics.drawable.Drawable

Methods inherited from class java.lang.Object

Details

Public Constructors

public BitmapDrawable(Bitmap bitmap)

public BitmapDrawable(String filepath)

public BitmapDrawable(InputStream is)

Public Methods

public void clearShadow()

public void draw(Canvas canvas)

Parameters

public final Bitmap getBitmap()

public final ConstantState getConstantState()

public int getGravity()

Returns

public int getIntrinsicHeight()

public int getIntrinsicWidth()

public int getOpacity()

public final Paint getPaint()

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

Throws

public void setAlpha(int alpha)

public void setAntiAlias(boolean aa)

public void setColorFilter(ColorFilter cf)

public void setDither(boolean dither)

public void setFilterBitmap(boolean filter)

public void setGravity(int gravity)

Parameters

public void setShadow(float radius, int dx, int dy, int color)

Parameters

Protected Methods

protected void onBoundsChange(Rect bounds)


e.g. "intent" or "activity"