public class

InsetDrawable

extends Drawable
implements Drawable.Callback
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.InsetDrawable

Class Overview

A Drawable that insets another Drawable by a specified distance. This is used when a View needs a background that is smaller than the View's actual bounds.

It can be defined in an XML file with the <inset> element.

Summary

XML Attributes
Attribute Name Related Method Description
android:drawable Reference to a drawable resource to use for the frame. 
android:insetBottom  
android:insetLeft  
android:insetRight  
android:insetTop  
android:visible Provides initial visibility state of the drawable; the default value is false. 
Public Constructors
InsetDrawable(Drawable drawable, int inset)
InsetDrawable(Drawable drawable, int insetLeft, int insetTop, int insetRight, int insetBottom)
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()
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.
boolean getPadding(Rect padding)
Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
void invalidateDrawable(Drawable who)
Called when the drawable needs to be redrawn.
boolean isStateful()
Indicates whether this view will change its appearance based on state.
Drawable mutate()
Make this drawable mutable.
void scheduleDrawable(Drawable who, Runnable what, long when)
A Drawable can call this to schedule the next frame of its animation.
void setAlpha(int alpha)
Specify an alpha value for the drawable.
void setColorFilter(ColorFilter cf)
Specify an optional colorFilter for the drawable.
boolean setVisible(boolean visible, boolean restart)
Set whether this Drawable is visible.
void unscheduleDrawable(Drawable who, Runnable what)
A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable(Drawable, Runnable, long).
Protected Methods
void onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you recognize the specified state.
boolean onStateChange(int[] state)
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
From interface android.graphics.drawable.Drawable.Callback

XML Attributes

android:drawable

Since: API Level

Reference to a drawable resource to use for the frame. If not given, the drawable must be defined by the first child tag.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol drawable.

Related Methods

android:insetBottom

Since: API Level

Related Methods

android:insetLeft

Since: API Level

Related Methods

android:insetRight

Since: API Level

Related Methods

android:insetTop

Since: API Level

Related Methods

android:visible

Since: API Level

Provides initial visibility state of the drawable; the default value is false. See setVisible(boolean, boolean).

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol visible.

Related Methods

Public Constructors

public InsetDrawable (Drawable drawable, int inset)

Since: API Level 1

public InsetDrawable (Drawable drawable, int insetLeft, int insetTop, int insetRight, int insetBottom)

Since: API Level 1

Public Methods

public void draw (Canvas canvas)

Since: 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 getChangingConfigurations ()

Since: API Level 1

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

Since: API Level 1

public int getIntrinsicHeight ()

Since: API Level 1

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

Since: API Level 1

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

Since: API Level 1

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.

Returns
  • int The opacity class of the Drawable.

public boolean getPadding (Rect padding)

Since: 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 void inflate (Resources r, XmlPullParser parser, AttributeSet attrs)

Since: API Level 1

Throws
XmlPullParserException
IOException

public void invalidateDrawable (Drawable who)

Since: API Level 1

Called when the drawable needs to be redrawn. A view at this point should invalidate itself (or at least the part of itself where the drawable appears).

Parameters
who The drawable that is requesting the update.

public boolean isStateful ()

Since: API Level 1

Indicates whether this view 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 view changes its appearance based on state, false otherwise.

public Drawable mutate ()

Since: 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 scheduleDrawable (Drawable who, Runnable what, long when)

Since: API Level 1

A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call postAtTime(Runnable, Object, long) with the parameters (what, who, when) to perform the scheduling.

Parameters
who The drawable being scheduled.
what The action to execute.
when The time (in milliseconds) to run. The timebase is uptimeMillis()

public void setAlpha (int alpha)

Since: API Level 1

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

public void setColorFilter (ColorFilter cf)

Since: API Level 1

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

public boolean setVisible (boolean visible, boolean restart)

Since: API Level 1

Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.

Parameters
visible Set to true if visible, false if not.
restart You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.
Returns
  • boolean Returns true if the new visibility is different than its previous state.

public void unscheduleDrawable (Drawable who, Runnable what)

Since: API Level 1

A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable(Drawable, Runnable, long). An implementation can generally simply call removeCallbacks(Runnable, Object) with the parameters (what, who) to unschedule the drawable.

Parameters
who The drawable being unscheduled.
what The action being unscheduled.

Protected Methods

protected void onBoundsChange (Rect bounds)

Since: API Level 1

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

protected boolean onStateChange (int[] state)

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