java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.DrawableContainer |
Known Direct Subclasses |
Known Indirect Subclasses |
A helper class that contains several Drawable
s and selects which one to use.
You can subclass it to create your own DrawableContainers or directly use one its child classes.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DrawableContainer.DrawableContainerState | A ConstantState that can contain several Drawable s. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Applies the specified theme to this Drawable and its children.
| |||||||||||
Draw in its bounds (set via setBounds) respecting optional effects such
as alpha (set via setAlpha) and color filter (set via setColorFilter).
| |||||||||||
Gets the current alpha value for the drawable.
| |||||||||||
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
| |||||||||||
Return a
Drawable.ConstantState instance that holds the shared state of this Drawable. | |||||||||||
Return the intrinsic height of the underlying drawable object.
| |||||||||||
Return the intrinsic width of the underlying drawable object.
| |||||||||||
Returns the minimum height suggested by this Drawable.
| |||||||||||
Returns the minimum width suggested by this Drawable.
| |||||||||||
Return the opacity/transparency of this Drawable.
| |||||||||||
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
| |||||||||||
Called when the drawable needs to be redrawn.
| |||||||||||
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left.
| |||||||||||
Indicates whether this drawable will change its appearance based on
state.
| |||||||||||
If this Drawable does transition animations between states, ask that
it immediately jump to the current state and skip any active animations.
| |||||||||||
Make this drawable mutable.
| |||||||||||
A Drawable can call this to schedule the next frame of its
animation.
| |||||||||||
Specify an alpha value for the drawable.
| |||||||||||
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left).
| |||||||||||
Specify an optional color filter for the drawable.
| |||||||||||
Set to true to have the drawable dither its colors when drawn to a device
with fewer than 8-bits per color component.
| |||||||||||
Change the global fade duration when a new drawable is entering
the scene.
| |||||||||||
Change the global fade duration when a new drawable is leaving
the scene.
| |||||||||||
Specifies the hotspot's location within the drawable.
| |||||||||||
Sets the bounds to which the hotspot is constrained, if they should be
different from the drawable bounds.
| |||||||||||
Set whether this Drawable is visible.
| |||||||||||
A Drawable can call this to unschedule an action previously
scheduled with
scheduleDrawable(Drawable, Runnable, long) . |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this in your subclass to change appearance if you vary based on
the bounds.
| |||||||||||
Override this in your subclass to change appearance if you vary based
on level.
| |||||||||||
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
|
Applies the specified theme to this Drawable and its children.
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
canvas | The canvas to draw into |
---|
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.
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.
Configuration
.Return a Drawable.ConstantState
instance that holds the shared state of this Drawable.
StateListDrawable
and LevelListDrawable
this will be the child drawable
currently in use.
Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.
Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.
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 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.
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.
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).
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).
who | The drawable that is requesting the update. |
---|
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left. See LayoutDirection
.
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.
If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
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.
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.
who | The drawable being scheduled. |
---|---|
what | The action to execute. |
when | The time (in milliseconds) to run. The timebase is
uptimeMillis()
|
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left). See LayoutDirection
.
mirrored | Set to true if the Drawable should be mirrored, false if not. |
---|
Specify an optional color filter for the drawable. Pass null
to
remove any existing color filter.
cf | the color filter to apply, or null to remove the
existing color filter
|
---|
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.
Change the global fade duration when a new drawable is entering the scene.
ms | The amount of time to fade in milliseconds. |
---|
Change the global fade duration when a new drawable is leaving the scene.
ms | The amount of time to fade in milliseconds. |
---|
Specifies the hotspot's location within the drawable.
x | The X coordinate of the center of the hotspot |
---|---|
y | The Y coordinate of the center of the hotspot |
Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
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.
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. |
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.
who | The drawable being unscheduled. |
---|---|
what | The action being unscheduled. |
Override this in your subclass to change appearance if you vary based on the bounds.
Override this in your subclass to change appearance if you vary based on level.
Override this in your subclass to change appearance if you recognize the specified state.