RoundedBitmapDrawable - Android SDK

Classes

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

public abstract class

RoundedBitmapDrawable

extends Drawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	android.support.v4.graphics.drawable.RoundedBitmapDrawable

Class Overview

A Drawable that wraps a bitmap and can be drawn with rounded corners. You can create a RoundedBitmapDrawable from a file path, an input stream, or from a Bitmap object.

Also see the Bitmap class, which handles the management and transformation of raw bitmap graphics, and should be used when drawing to a Canvas.

Summary

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	getAlpha() Gets the current alpha value for the drawable.
final Bitmap	getBitmap() Returns the bitmap used by this drawable to render.
ColorFilter	getColorFilter() Returns the current color filter, or `null` if none set.
float	getCornerRadius()
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() Returns the paint used to render this drawable.
boolean	hasAntiAlias() Indicates whether anti-aliasing is enabled for this drawable.
boolean	hasMipMap() Indicates whether the mipmap hint is enabled on this drawable's bitmap.
boolean	isCircular()
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAntiAlias(boolean aa) Enables or disables anti-aliasing for this drawable.
void	setCircular(boolean circular) Sets the image shape to circular.
void	setColorFilter(ColorFilter cf) Specify an optional color filter for the drawable.
void	setCornerRadius(float cornerRadius) Sets the corner radius to be applied when drawing the bitmap.
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	setGravity(int gravity) Set the gravity used to position/stretch the bitmap within its bounds.
void	setMipMap(boolean mipMap) Enables or disables the mipmap hint for this drawable's bitmap.
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.

Protected Methods
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.

[Expand]

Inherited Methods

From class android.graphics.drawable.Drawable

void	applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	clearColorFilter() Removes the color filter for this drawable.
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	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromStream(InputStream is, String srcName) Create a drawable from an inputstream
static Drawable	createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme) Create a drawable from an XML document using an optional `Resources.Theme`.
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.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Create a drawable from inside an XML document using an optional `Resources.Theme`.
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).
int	getAlpha() Gets the current alpha value for the drawable.
final Rect	getBounds() Return the drawable's bounds Rect.
Drawable.Callback	getCallback() Return the current `Drawable.Callback` implementation attached to this Drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
ColorFilter	getColorFilter() Returns the current color filter, or `null` if none set.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getCurrent()
Rect	getDirtyBounds() Return the drawable's dirty bounds Rect.
void	getHotspotBounds(Rect outRect) Populates `outRect` with the hotspot bounds.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
int	getLayoutDirection() Returns the resolved layout direction for this Drawable.
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.
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.
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, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource.
void	invalidateSelf() Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
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.
final boolean	isVisible()
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
boolean	onLayoutDirectionChanged(int layoutDirection) Called when the drawable's resolved layout direction changes.
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	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
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 colorFilter) Specify an optional color filter for the drawable.
void	setColorFilter(int color, PorterDuff.Mode mode) Specify a color and Porter-Duff mode to be the color filter for this drawable.
void	setDither(boolean dither) This method was deprecated in API level 23. 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	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
void	setHotspotBounds(int left, int top, int right, int bottom) Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
final boolean	setLayoutDirection(int layoutDirection) Set the layout direction for this drawable.
final boolean	setLevel(int level) Specify the level for the drawable.
boolean	setState(int[] stateSet) Specify a set of states for the drawable.
void	setTint(int tintColor) Specifies tint color for this drawable.
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.
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() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that 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() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method 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.

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

public final Bitmap getBitmap ()

Returns the bitmap used by this drawable to render. May be null.

public ColorFilter getColorFilter ()

Returns the current color filter, or null if none set.

Returns

the current color filter, or null if none set

public float getCornerRadius ()

Returns

The corner radius applied when drawing the bitmap.

public int getGravity ()

Get the gravity used to position/stretch the bitmap within its bounds.

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.

An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT.

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 necessarily take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods. Some subclasses, such as BitmapDrawable, ColorDrawable, and GradientDrawable, do account for the value of setAlpha(int), but the general behavior is dependent upon the implementation of the subclass.

Returns

int The opacity class of the Drawable.

public final Paint getPaint ()

Returns the paint used to render this drawable.

public boolean hasAntiAlias ()

Indicates whether anti-aliasing is enabled for this drawable.

Returns

True if anti-aliasing is enabled, false otherwise.

public boolean hasMipMap ()

Indicates whether the mipmap hint is enabled on this drawable's bitmap.

Returns

True if the mipmap hint is set, false otherwise. If the bitmap is null, this method always returns false.

public boolean isCircular ()

Returns

true if the image is circular, else false.

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)

Enables or disables anti-aliasing for this drawable. Anti-aliasing affects the edges of the bitmap only so it applies only when the drawable is rotated.

Parameters

aa	True if the bitmap should be anti-aliased, false otherwise.

public void setCircular (boolean circular)

Sets the image shape to circular.

This overwrites any calls made to setCornerRadius(float) so far.

public void setColorFilter (ColorFilter cf)

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

cf	The color filter to apply, or `null` to remove the existing color filter

public void setCornerRadius (float cornerRadius)

Sets the corner radius to be applied when drawing the bitmap.

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

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

public void setGravity (int gravity)

Set the gravity used to position/stretch the bitmap within its bounds.

Parameters

gravity	the gravity

public void setMipMap (boolean mipMap)

Enables or disables the mipmap hint for this drawable's bitmap. See setHasMipMap(boolean) for more information. If the bitmap is null, or the current API version does not support setting a mipmap hint, calling this method has no effect.

Parameters

mipMap	True if the bitmap should use mipmaps, false otherwise.

public void setTargetDensity (int density)

Set the density at which this drawable will be rendered.

Parameters

density	The density scale for this drawable.

public void setTargetDensity (DisplayMetrics metrics)

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

Parameters

metrics	The DisplayMetrics indicating the density scale for this drawable.

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

Protected Methods

protected void onBoundsChange (Rect bounds)

Override this in your subclass to change appearance if you vary based on the bounds.

Results

Classes

RoundedBitmapDrawable

Class Overview

Summary

Public Methods

public void draw (Canvas canvas)

Parameters

public int getAlpha ()

public final Bitmap getBitmap ()

public ColorFilter getColorFilter ()

Returns

public float getCornerRadius ()

Returns

public int getGravity ()

Returns

See Also

public int getIntrinsicHeight ()

public int getIntrinsicWidth ()

public int getOpacity ()

Returns

public final Paint getPaint ()

public boolean hasAntiAlias ()

Returns

See Also

public boolean hasMipMap ()

Returns

See Also

public boolean isCircular ()

Returns

public void setAlpha (int alpha)

public void setAntiAlias (boolean aa)

Parameters

See Also

public void setCircular (boolean circular)

public void setColorFilter (ColorFilter cf)

Parameters

public void setCornerRadius (float cornerRadius)

public void setDither (boolean dither)

public void setFilterBitmap (boolean filter)

public void setGravity (int gravity)

Parameters

See Also

public void setMipMap (boolean mipMap)

Parameters

See Also

public void setTargetDensity (int density)

Parameters

See Also

public void setTargetDensity (DisplayMetrics metrics)

Parameters

See Also

public void setTargetDensity (Canvas canvas)

Parameters

See Also

Protected Methods

protected void onBoundsChange (Rect bounds)