LayerDrawable
public
class
LayerDrawable
extends Drawable
implements
Drawable.Callback
java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.LayerDrawable |
A Drawable that manages an array of other Drawables. These are drawn in array order, so the element with the largest index will be drawn on top.
It can be defined in an XML file with the <layer-list>
element.
Each Drawable in the layer is defined in a nested <item>
.
For more information, see the guide to Drawable Resources.
Summary
XML attributes | ||
---|---|---|
android:bottom |
Bottom inset to apply to the layer. | |
android:drawable |
Drawable used to render the layer. | |
android:end |
End inset to apply to the layer. | |
android:gravity |
Gravity used to align the layer within its container. | |
android:height |
Height of the layer. | |
android:id |
Identifier of the layer. | |
android:left |
Left inset to apply to the layer. | |
android:paddingBottom |
Explicit bottom padding. | |
android:paddingEnd |
Explicit end padding. | |
android:paddingLeft |
Explicit left padding. | |
android:paddingMode |
Indicates how layer padding should affect the bounds of subsequent layers. | |
android:paddingRight |
Explicit right padding. | |
android:paddingStart |
Explicit start padding. | |
android:paddingTop |
Explicit top padding. | |
android:right |
Right inset to apply to the layer. | |
android:start |
Start inset to apply to the layer. | |
android:top |
Top inset to apply to the layer. | |
android:width |
Width of the layer. |
Constants | |
---|---|
int |
INSET_UNDEFINED
Value used for undefined start and end insets. |
int |
PADDING_MODE_NEST
Padding mode used to nest each layer inside the padding of the previous layer. |
int |
PADDING_MODE_STACK
Padding mode used to stack each layer directly atop the previous layer. |
Public constructors | |
---|---|
LayerDrawable(Drawable[] layers)
Creates a new layer drawable with the list of specified layers. |
Public methods | |
---|---|
int
|
addLayer(Drawable dr)
Adds a new layer containing the specified |
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). |
Drawable
|
findDrawableByLayerId(int id)
Looks for a layer with the given ID and returns its |
int
|
findIndexByLayerId(int id)
Returns the layer with the specified |
int
|
getAlpha()
Gets the current alpha value for the drawable. |
int
|
getBottomPadding()
Returns the bottom padding in pixels. |
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
|
getDrawable(int index)
Returns the drawable for the layer at the specified index. |
int
|
getEndPadding()
Returns the end padding in pixels. |
void
|
getHotspotBounds(Rect outRect)
Populates |
int
|
getId(int index)
Returns the ID of the specified layer. |
int
|
getIntrinsicHeight()
Returns the drawable's intrinsic height. |
int
|
getIntrinsicWidth()
Returns the drawable's intrinsic width. |
int
|
getLayerGravity(int index)
|
int
|
getLayerHeight(int index)
|
int
|
getLayerInsetBottom(int index)
|
int
|
getLayerInsetEnd(int index)
|
int
|
getLayerInsetLeft(int index)
|
int
|
getLayerInsetRight(int index)
|
int
|
getLayerInsetStart(int index)
|
int
|
getLayerInsetTop(int index)
|
int
|
getLayerWidth(int index)
|
int
|
getLeftPadding()
Returns the left padding in pixels. |
int
|
getNumberOfLayers()
Returns the number of layers contained within this layer drawable. |
int
|
getOpacity()
This method is deprecated. This method is no longer used in graphics optimizations |
void
|
getOutline(Outline outline)
Populates |
boolean
|
getPadding(Rect padding)
Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. |
int
|
getPaddingMode()
|
int
|
getRightPadding()
Returns the right padding in pixels. |
int
|
getStartPadding()
Returns the start padding in pixels. |
int
|
getTopPadding()
Returns the top padding in pixels. |
boolean
|
hasFocusStateSpecified()
Indicates whether this drawable has at least one state spec explicitly
specifying |
void
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme. |
void
|
invalidateDrawable(Drawable who)
Called when the drawable needs to be redrawn. |
boolean
|
isAutoMirrored()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. |
boolean
|
isStateful()
Indicates whether this drawable will change its appearance based on state. |
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. |
boolean
|
onLayoutDirectionChanged(int layoutDirection)
Called when the drawable's resolved layout direction changes. |
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
|
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
|
setDrawable(int index, Drawable drawable)
Sets the drawable for the layer at the specified index. |
boolean
|
setDrawableByLayerId(int id, Drawable drawable)
Replaces the |
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. |
void
|
setId(int index, int id)
Sets the ID of a layer. |
void
|
setLayerGravity(int index, int gravity)
Sets the gravity used to position or stretch the specified layer within its container. |
void
|
setLayerHeight(int index, int h)
|
void
|
setLayerInset(int index, int l, int t, int r, int b)
Specifies the insets in pixels for the drawable at the specified index. |
void
|
setLayerInsetBottom(int index, int b)
|
void
|
setLayerInsetEnd(int index, int e)
|
void
|
setLayerInsetLeft(int index, int l)
|
void
|
setLayerInsetRelative(int index, int s, int t, int e, int b)
Specifies the relative insets in pixels for the drawable at the specified index. |
void
|
setLayerInsetRight(int index, int r)
|
void
|
setLayerInsetStart(int index, int s)
|
void
|
setLayerInsetTop(int index, int t)
|
void
|
setLayerSize(int index, int w, int h)
Sets an explicit size for the specified layer. |
void
|
setLayerWidth(int index, int w)
|
void
|
setOpacity(int opacity)
Sets the opacity of this drawable directly instead of collecting the states from the layers. |
void
|
setPadding(int left, int top, int right, int bottom)
Sets the absolute padding. |
void
|
setPaddingMode(int mode)
Specifies how layer padding should affect the bounds of subsequent layers. |
void
|
setPaddingRelative(int start, int top, int end, int bottom)
Sets the relative padding. |
void
|
setTintBlendMode(BlendMode blendMode)
Specifies a tint blending mode for this drawable. |
void
|
setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list. |
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 |
Protected methods | |
---|---|
void
|
onBoundsChange(Rect bounds)
Override this in your subclass to change appearance if you vary based on the bounds. |
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. |
Inherited methods | |
---|---|
XML attributes
android:bottom
Bottom inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:drawable
Drawable used to render the layer.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:end
End inset to apply to the layer. Overrides left
or
right
depending on layout direction.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:gravity
Gravity used to align the layer within its container. If no value
is specified, the default behavior depends on whether an explicit
width or height has been set, If no dimension is set, gravity in
that direction defaults to fill_horizontal
or
fill_vertical
; otherwise, it defaults to left
or
top
.
Must be one or more (separated by '|') of the following constant values.
Constant | Value | Description |
---|---|---|
bottom | 50 | Push object to the bottom of its container, not changing its size. |
center | 11 | Place the object in the center of its container in both the vertical and horizontal axis, not changing its size. |
center_horizontal | 1 | Place object in the horizontal center of its container, not changing its size. |
center_vertical | 10 | Place object in the vertical center of its container, not changing its size. |
clip_horizontal | 8 | Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges. |
clip_vertical | 80 | Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges. |
end | 800005 | Push object to the end of its container, not changing its size. |
fill | 77 | Grow the horizontal and vertical size of the object if needed so it completely fills its container. |
fill_horizontal | 7 | Grow the horizontal size of the object if needed so it completely fills its container. |
fill_vertical | 70 | Grow the vertical size of the object if needed so it completely fills its container. |
left | 3 | Push object to the left of its container, not changing its size. |
right | 5 | Push object to the right of its container, not changing its size. |
start | 800003 | Push object to the beginning of its container, not changing its size. |
top | 30 | Push object to the top of its container, not changing its size. |
Related methods:
android:height
Height of the layer. Defaults to the layer's intrinsic height.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:id
Identifier of the layer. This can be used to retrieve the layer from a drawable container.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:left
Left inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:paddingBottom
Explicit bottom padding. Overrides child padding.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:paddingEnd
Explicit end padding. Overrides child padding. Takes precedence over absolute padding (for example, right when layout direction is LTR).
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:paddingLeft
Explicit left padding. Overrides child padding.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:paddingMode
Indicates how layer padding should affect the bounds of subsequent layers. The default padding mode value is nest.
Must be one of the following constant values.
Constant | Value | Description |
---|---|---|
nest | 0 | Nest each layer inside the padding of the previous layer. |
stack | 1 | Stack each layer directly atop the previous layer. |
Related methods:
android:paddingRight
Explicit right padding. Overrides child padding.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:paddingStart
Explicit start padding. Overrides child padding. Takes precedence over absolute padding (for example, left when layout direction is LTR).
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:paddingTop
Explicit top padding. Overrides child padding.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:right
Right inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:start
Start inset to apply to the layer. Overrides left
or
right
depending on layout direction.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:top
Top inset to apply to the layer.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
android:width
Width of the layer. Defaults to the layer's intrinsic width.
May be a dimension value, which is a floating point number appended with a
unit such as "14.5sp
".
Available units are: px (pixels), dp (density-independent pixels),
sp (scaled pixels based on preferred font size), in (inches), and
mm (millimeters).
Related methods:
Constants
INSET_UNDEFINED
public static final int INSET_UNDEFINED
Value used for undefined start and end insets.
Constant Value: -2147483648 (0x80000000)
PADDING_MODE_NEST
public static final int PADDING_MODE_NEST
Padding mode used to nest each layer inside the padding of the previous layer.
See also:
Constant Value: 0 (0x00000000)
PADDING_MODE_STACK
public static final int PADDING_MODE_STACK
Padding mode used to stack each layer directly atop the previous layer.
See also:
Constant Value: 1 (0x00000001)
Public constructors
LayerDrawable
public LayerDrawable (Drawable[] layers)
Creates a new layer drawable with the list of specified layers.
Parameters | |
---|---|
layers |
Drawable : a list of drawables to use as layers in this new drawable,
must be non-null |
Public methods
addLayer
public int addLayer (Drawable dr)
Adds a new layer containing the specified drawable
to the end of
the layer list and returns its index.
Parameters | |
---|---|
dr |
Drawable : The drawable to add as a new layer. |
Returns | |
---|---|
int |
The index of the new layer. |
applyTheme
public void applyTheme (Resources.Theme t)
Applies the specified theme to this Drawable and its children.
Parameters | |
---|---|
t |
Resources.Theme : This value cannot be null . |
draw
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 |
Canvas : The canvas to draw into
This value cannot be null . |
findDrawableByLayerId
public Drawable findDrawableByLayerId (int id)
Looks for a layer with the given ID and returns its Drawable
.
If multiple layers are found for the given ID, returns the
Drawable
for the matching layer at the highest index.
Parameters | |
---|---|
id |
int : The layer ID to search for. |
Returns | |
---|---|
Drawable |
The Drawable for the highest-indexed layer that has the
given ID, or null if not found. |
findIndexByLayerId
public int findIndexByLayerId (int id)
Returns the layer with the specified id
.
If multiple layers have the same ID, returns the layer with the lowest index.
Parameters | |
---|---|
id |
int : The ID of the layer to return. |
Returns | |
---|---|
int |
The index of the layer with the specified ID. |
getAlpha
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.
Returns | |
---|---|
int |
Value is between 0 and 255 inclusive |
getBottomPadding
public int getBottomPadding ()
Returns the bottom padding in pixels.
A return value of -1
means there is no explicit padding set for
this dimension. As a result, the value for this dimension returned by
getPadding(android.graphics.Rect)
will be computed from the child layers
according to the padding mode (see getPaddingMode()
.
Returns | |
---|---|
int |
the bottom padding in pixels, or -1 if not explicitly specified |
getChangingConfigurations
public 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.
getConstantState
public Drawable.ConstantState getConstantState ()
Return a ConstantState
instance that holds the shared state of this Drawable.
Returns | |
---|---|
Drawable.ConstantState |
The ConstantState associated to that Drawable.
This value may be null . |
getDrawable
public Drawable getDrawable (int index)
Returns the drawable for the layer at the specified index.
Related XML Attributes:
Parameters | |
---|---|
index |
int : The index of the layer, must be in the range
0...getNumberOfLayers()-1 . |
Returns | |
---|---|
Drawable |
The Drawable at the specified layer index. |
See also:
getEndPadding
public int getEndPadding ()
Returns the end padding in pixels.
A return value of -1
means there is no explicit padding set for
this dimension. As a result, the value for this dimension returned by
getPadding(android.graphics.Rect)
will be computed from the child layers
according to the padding mode (see getPaddingMode()
.
Returns | |
---|---|
int |
the end padding in pixels, or -1 if not explicitly specified |
getHotspotBounds
public void getHotspotBounds (Rect outRect)
Populates outRect
with the hotspot bounds.
Parameters | |
---|---|
outRect |
Rect : the rect to populate with the hotspot bounds
This value cannot be null . |
getId
public int getId (int index)
Returns the ID of the specified layer.
Related XML Attributes:
Parameters | |
---|---|
index |
int : The index of the layer, must be in the range
0...getNumberOfLayers()-1 . |
Returns | |
---|---|
int |
The id of the layer or View.NO_ID if the
layer has no id. |
See also:
getIntrinsicHeight
public int getIntrinsicHeight ()
Returns the drawable's intrinsic height.
Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.
Returns | |
---|---|
int |
the intrinsic height, or -1 if no intrinsic height |
getIntrinsicWidth
public int getIntrinsicWidth ()
Returns the drawable's intrinsic width.
Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.
Returns | |
---|---|
int |
the intrinsic width, or -1 if no intrinsic width |
getLayerGravity
public int getLayerGravity (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
the gravity used to position or stretch the specified layer within its container |
See also:
getLayerHeight
public int getLayerHeight (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the drawable to adjust |
Returns | |
---|---|
int |
the explicit height of the layer, or -1 if not specified |
See also:
getLayerInsetBottom
public int getLayerInsetBottom (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
number of pixels to inset from the bottom bound |
getLayerInsetEnd
public int getLayerInsetEnd (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
number of pixels to inset from the end bound |
getLayerInsetLeft
public int getLayerInsetLeft (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
number of pixels to inset from the left bound |
getLayerInsetRight
public int getLayerInsetRight (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
number of pixels to inset from the right bound |
getLayerInsetStart
public int getLayerInsetStart (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
the number of pixels to inset from the start bound, or
INSET_UNDEFINED if not specified |
getLayerInsetTop
public int getLayerInsetTop (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer |
Returns | |
---|---|
int |
number of pixels to inset from the top bound |
getLayerWidth
public int getLayerWidth (int index)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the drawable to adjust |
Returns | |
---|---|
int |
the explicit width of the layer, or -1 if not specified |
See also:
getLeftPadding
public int getLeftPadding ()
Returns the left padding in pixels.
A return value of -1
means there is no explicit padding set for
this dimension. As a result, the value for this dimension returned by
getPadding(android.graphics.Rect)
will be computed from the child layers
according to the padding mode (see getPaddingMode()
.
Returns | |
---|---|
int |
the left padding in pixels, or -1 if not explicitly specified |
getNumberOfLayers
public int getNumberOfLayers ()
Returns the number of layers contained within this layer drawable.
Returns | |
---|---|
int |
The number of layers. |
getOpacity
public int getOpacity ()
This method is deprecated.
This method is no longer used in graphics optimizations
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
PixelFormat
:
PixelFormat.UNKNOWN
,
PixelFormat.TRANSLUCENT
,
PixelFormat.TRANSPARENT
, or
PixelFormat.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 |
int The opacity class of the Drawable.
Value is PixelFormat.UNKNOWN , PixelFormat.TRANSLUCENT , PixelFormat.TRANSPARENT , or PixelFormat.OPAQUE |
getOutline
public void getOutline (Outline outline)
Populates outline
with the first available (non-empty) layer outline.
Parameters | |
---|---|
outline |
Outline : Outline in which to place the first available layer outline
This value cannot be null . |
getPadding
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).
Parameters | |
---|---|
padding |
Rect : This value cannot be null . |
Returns | |
---|---|
boolean |
true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0. |
getPaddingMode
public int getPaddingMode ()
Related XML Attributes:
Returns | |
---|---|
int |
the current padding mode |
See also:
getRightPadding
public int getRightPadding ()
Returns the right padding in pixels.
A return value of -1
means there is no explicit padding set for
this dimension. As a result, the value for this dimension returned by
getPadding(android.graphics.Rect)
will be computed from the child layers
according to the padding mode (see getPaddingMode()
.
Returns | |
---|---|
int |
the right padding in pixels, or -1 if not explicitly specified |
getStartPadding
public int getStartPadding ()
Returns the start padding in pixels.
A return value of -1
means there is no explicit padding set for
this dimension. As a result, the value for this dimension returned by
getPadding(android.graphics.Rect)
will be computed from the child layers
according to the padding mode (see getPaddingMode()
.
Returns | |
---|---|
int |
the start padding in pixels, or -1 if not explicitly specified |
getTopPadding
public int getTopPadding ()
Returns the top padding in pixels.
A return value of -1
means there is no explicit padding set for
this dimension. As a result, the value for this dimension returned by
getPadding(android.graphics.Rect)
will be computed from the child layers
according to the padding mode (see getPaddingMode()
.
Returns | |
---|---|
int |
the top padding in pixels, or -1 if not explicitly specified |
hasFocusStateSpecified
public boolean hasFocusStateSpecified ()
Indicates whether this drawable has at least one state spec explicitly
specifying R.attr.state_focused
.
Note: A View uses a Drawable
instance as its background and it
changes its appearance based on a state. On keyboard devices, it should
specify its R.attr.state_focused
to make sure the user
knows which view is holding the focus.
Returns | |
---|---|
boolean |
true if R.attr.state_focused is specified
for this drawable. |
inflate
public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.
Parameters | |
---|---|
r |
Resources : This value cannot be null . |
parser |
XmlPullParser : This value cannot be null . |
attrs |
AttributeSet : This value cannot be null . |
theme |
Resources.Theme : This value may be null . |
Throws | |
---|---|
IOException |
|
XmlPullParserException |
invalidateDrawable
public void invalidateDrawable (Drawable who)
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 |
Drawable : This value cannot be null . |
isAutoMirrored
public 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. |
isStateful
public 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. |
jumpToCurrentState
public void jumpToCurrentState ()
If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
mutate
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 | |
---|---|
Drawable |
This drawable.
This value cannot be null . |
onLayoutDirectionChanged
public boolean onLayoutDirectionChanged (int layoutDirection)
Called when the drawable's resolved layout direction changes.
Parameters | |
---|---|
layoutDirection |
int : Value is View.LAYOUT_DIRECTION_LTR , or View.LAYOUT_DIRECTION_RTL |
Returns | |
---|---|
boolean |
true if the layout direction change has caused the
appearance of the drawable to change such that it needs to be
re-drawn, false otherwise |
scheduleDrawable
public void scheduleDrawable (Drawable who, Runnable what, long when)
A Drawable can call this to schedule the next frame of its
animation. An implementation can generally simply call
Handler.postAtTime(Runnable, Object, long)
with
the parameters (what, who, when) to perform the
scheduling.
Parameters | |
---|---|
who |
Drawable : This value cannot be null . |
what |
Runnable : This value cannot be null . |
when |
long : The time (in milliseconds) to run. The timebase is
SystemClock.uptimeMillis() |
setAlpha
public void setAlpha (int alpha)
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
Parameters | |
---|---|
alpha |
int : Value is between 0 and 255 inclusive |
setAutoMirrored
public 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
public 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
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.
Parameters | |
---|---|
dither |
boolean |
setDrawable
public void setDrawable (int index, Drawable drawable)
Sets the drawable for the layer at the specified index.
Related XML Attributes:
Parameters | |
---|---|
index |
int : The index of the layer to modify, must be in the range
0...getNumberOfLayers()-1 . |
drawable |
Drawable : The drawable to set for the layer. |
See also:
setDrawableByLayerId
public boolean setDrawableByLayerId (int id, Drawable drawable)
Replaces the Drawable
for the layer with the given id.
Parameters | |
---|---|
id |
int : The layer ID to search for. |
drawable |
Drawable : The replacement Drawable . |
Returns | |
---|---|
boolean |
Whether the Drawable was replaced (could return false if
the id was not found). |
setHotspot
public void setHotspot (float x, float y)
Specifies the hotspot's location within the drawable.
Parameters | |
---|---|
x |
float : The X coordinate of the center of the hotspot |
y |
float : The Y coordinate of the center of the hotspot |
setHotspotBounds
public 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.
Parameters | |
---|---|
left |
int : position in pixels of the left bound |
top |
int : position in pixels of the top bound |
right |
int : position in pixels of the right bound |
bottom |
int : position in pixels of the bottom bound |
setId
public void setId (int index, int id)
Sets the ID of a layer.
Related XML Attributes:
Parameters | |
---|---|
index |
int : The index of the layer to modify, must be in the range
0...getNumberOfLayers()-1 . |
id |
int : The id to assign to the layer. |
See also:
setLayerGravity
public void setLayerGravity (int index, int gravity)
Sets the gravity used to position or stretch the specified layer within
its container. Gravity is applied after any layer insets (see
setLayerInset(int, int, int, int, int)
) or padding (see
setPaddingMode(int)
).
If gravity is specified as Gravity#NO_GRAVITY
, the default
behavior depends on whether an explicit width or height has been set
(see setLayerSize(int, int, int)
), If a dimension is not set,
gravity in that direction defaults to Gravity#FILL_HORIZONTAL
or
Gravity#FILL_VERTICAL
; otherwise, gravity in that direction
defaults to Gravity#LEFT
or Gravity#TOP
.
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the drawable to adjust |
gravity |
int : the gravity to set for the layer |
See also:
setLayerHeight
public void setLayerHeight (int index, int h)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
h |
int : height in pixels, or -1 to use the intrinsic height |
setLayerInset
public void setLayerInset (int index, int l, int t, int r, int b)
Specifies the insets in pixels for the drawable at the specified index.
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the drawable to adjust |
l |
int : number of pixels to add to the left bound |
t |
int : number of pixels to add to the top bound |
r |
int : number of pixels to subtract from the right bound |
b |
int : number of pixels to subtract from the bottom bound |
setLayerInsetBottom
public void setLayerInsetBottom (int index, int b)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
b |
int : number of pixels to inset from the bottom bound |
setLayerInsetEnd
public void setLayerInsetEnd (int index, int e)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
e |
int : number of pixels to inset from the end bound, or
INSET_UNDEFINED if not specified |
setLayerInsetLeft
public void setLayerInsetLeft (int index, int l)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
l |
int : number of pixels to inset from the left bound |
setLayerInsetRelative
public void setLayerInsetRelative (int index, int s, int t, int e, int b)
Specifies the relative insets in pixels for the drawable at the specified index.
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
s |
int : number of pixels to inset from the start bound |
t |
int : number of pixels to inset from the top bound |
e |
int : number of pixels to inset from the end bound |
b |
int : number of pixels to inset from the bottom bound |
setLayerInsetRight
public void setLayerInsetRight (int index, int r)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
r |
int : number of pixels to inset from the right bound |
setLayerInsetStart
public void setLayerInsetStart (int index, int s)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
s |
int : number of pixels to inset from the start bound |
setLayerInsetTop
public void setLayerInsetTop (int index, int t)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
t |
int : number of pixels to inset from the top bound |
setLayerSize
public void setLayerSize (int index, int w, int h)
Sets an explicit size for the specified layer.
Note: Setting an explicit layer size changes the
default layer gravity behavior. See setLayerGravity(int, int)
for more information.
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
w |
int : width in pixels, or -1 to use the intrinsic width |
h |
int : height in pixels, or -1 to use the intrinsic height |
See also:
setLayerWidth
public void setLayerWidth (int index, int w)
Related XML Attributes:
Parameters | |
---|---|
index |
int : the index of the layer to adjust |
w |
int : width in pixels, or -1 to use the intrinsic width |
setOpacity
public void setOpacity (int opacity)
Sets the opacity of this drawable directly instead of collecting the states from the layers.
Parameters | |
---|---|
opacity |
int : The opacity to use, or PixelFormat.UNKNOWN for the default behavior |
setPadding
public void setPadding (int left, int top, int right, int bottom)
Sets the absolute padding.
If padding in a dimension is specified as -1
, the resolved
padding will use the value computed according to the padding mode (see
setPaddingMode(int)
).
Calling this method clears any relative padding values previously set
using setPaddingRelative(int, int, int, int)
.
Related XML Attributes:
Parameters | |
---|---|
left |
int : the left padding in pixels, or -1 to use computed padding |
top |
int : the top padding in pixels, or -1 to use computed padding |
right |
int : the right padding in pixels, or -1 to use computed padding |
bottom |
int : the bottom padding in pixels, or -1 to use computed
padding |
See also:
setPaddingMode
public void setPaddingMode (int mode)
Specifies how layer padding should affect the bounds of subsequent
layers. The default value is PADDING_MODE_NEST
.
Related XML Attributes:
Parameters | |
---|---|
mode |
int : padding mode, one of:
|
See also:
setPaddingRelative
public void setPaddingRelative (int start, int top, int end, int bottom)
Sets the relative padding.
If padding in a dimension is specified as -1
, the resolved
padding will use the value computed according to the padding mode (see
setPaddingMode(int)
).
Calling this method clears any absolute padding values previously set
using setPadding(int, int, int, int)
.
Related XML Attributes:
Parameters | |
---|---|
start |
int : the start padding in pixels, or -1 to use computed padding |
top |
int : the top padding in pixels, or -1 to use computed padding |
end |
int : the end padding in pixels, or -1 to use computed padding |
bottom |
int : the bottom padding in pixels, or -1 to use computed
padding |
See also:
setTintBlendMode
public void setTintBlendMode (BlendMode blendMode)
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 BlendMode#SRC_IN
.
Note: Setting a color filter via
setColorFilter(android.graphics.ColorFilter)
Parameters | |
---|---|
blendMode |
BlendMode : This value cannot be null . |
setTintList
public 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, android.graphics.PorterDuff.Mode)
.
Note: Setting a color filter via
setColorFilter(android.graphics.ColorFilter)
or
setColorFilter(int, android.graphics.PorterDuff.Mode)
overrides tint.
Parameters | |
---|---|
tint |
ColorStateList : Color state list to use for tinting this drawable, or
null to clear the tint |
setVisible
public boolean setVisible (boolean visible, boolean restart)
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 |
boolean : Set to true if visible, false if not. |
restart |
boolean : 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 |
boolean Returns true if the new visibility is different than its previous state. |
unscheduleDrawable
public void unscheduleDrawable (Drawable who, Runnable what)
A Drawable can call this to unschedule an action previously
scheduled with scheduleDrawable(Drawable, Runnable, long)
. An implementation can
generally simply call
Handler.removeCallbacks(Runnable, Object)
with
the parameters (what, who) to unschedule the drawable.
Parameters | |
---|---|
who |
Drawable : This value cannot be null . |
what |
Runnable : This value cannot be null . |
Protected methods
onBoundsChange
protected void onBoundsChange (Rect bounds)
Override this in your subclass to change appearance if you vary based on the bounds.
Parameters | |
---|---|
bounds |
Rect : This value cannot be null . |
onLevelChange
protected boolean onLevelChange (int level)
Override this in your subclass to change appearance if you vary based on level.
Parameters | |
---|---|
level |
int |
Returns | |
---|---|
boolean |
Returns true if the level 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 level. |
onStateChange
protected boolean onStateChange (int[] state)
Override this in your subclass to change appearance if you recognize the specified state.
Parameters | |
---|---|
state |
int : This value cannot be null . |
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. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.