DrawableContainer
open class DrawableContainer : Drawable, Drawable.Callback
Known Direct Subclasses
| AnimationDrawable |
An object used to create frame-by-frame animations, defined by a series of Drawable objects, which can be used as a View object's background.
|
| LevelListDrawable |
A resource that manages a number of alternate Drawables, each assigned a maximum numerical value.
|
| StateListDrawable |
Lets you assign a number of graphic images to a single Drawable and swap out the visible item by a string ID value.
|
|
Known Indirect Subclasses
| AnimatedStateListDrawable |
Drawable containing a set of Drawable keyframes where the currently displayed keyframe is chosen based on the current state set.
|
|
A helper class that contains several Drawables and selects which one to use. You can subclass it to create your own DrawableContainers or directly use one its child classes.
Summary
| Nested classes |
| abstract |
A ConstantState that can contain several Drawables.
|
| Public methods |
| open Unit |
|
| open Boolean |
|
| open Unit |
|
| open Int |
|
| open Int |
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
|
| open Drawable.ConstantState? |
|
| open Drawable |
|
| open Unit |
|
| open Int |
|
| open Int |
|
| open Int |
|
| open Int |
|
| open Int |
|
| open Insets |
|
| open Unit |
Called to get the drawable to populate the Outline that defines its drawing area.
|
| open Boolean |
|
| open Boolean |
|
| open Unit |
Called when the drawable needs to be redrawn.
|
| open Boolean |
|
| open Boolean |
|
| open Unit |
|
| open Drawable |
|
| open Boolean |
Called when the drawable's resolved layout direction changes.
|
| open Unit |
A Drawable can call this to schedule the next frame of its animation.
|
| open Boolean |
Sets the currently displayed drawable by index.
|
| open Unit |
|
| open Unit |
|
| open Unit |
|
| open Unit |
|
| open Unit |
Change the global fade duration when a new drawable is entering the scene.
|
| open Unit |
Change the global fade duration when a new drawable is leaving the scene.
|
| open Unit |
|
| open Unit |
|
| open Unit |
Specifies a tint blending mode for this drawable.
|
| open Unit |
|
| open Boolean |
|
| open Unit |
A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable.
|
| Inherited functions |
From class Drawable
Unit |
clearColorFilter()
Removes the color filter for this drawable.
|
Unit |
copyBounds(bounds: Rect)
Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
|
Rect |
copyBounds()
Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
|
Drawable? |
createFromPath(pathName: String!)
Create a drawable from file path name.
|
Drawable? |
createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)
Create a drawable from an inputstream, using the given resources and value to determine density information.
|
Drawable? |
createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)
Create a drawable from an inputstream, using the given resources and value to determine density information.
|
Drawable? |
createFromStream(is: InputStream?, srcName: String?)
Create a drawable from an inputstream
|
Drawable |
createFromXml(r: Resources, parser: XmlPullParser)
Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
|
Drawable |
createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)
Create a drawable from an XML document using an optional Theme. For more information on how to create resources in XML, see Drawable Resources.
|
Drawable |
createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)
Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
|
Drawable |
createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)
Create a drawable from inside an XML document using an optional Theme. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
|
Rect |
getBounds()
Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
|
Drawable.Callback? |
getCallback()
Return the current Callback implementation attached to this Drawable.
|
ColorFilter? |
getColorFilter()
Returns the current color filter, or null if none set.
|
Rect |
getDirtyBounds()
Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed).
By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
|
Int |
getLayoutDirection()
Returns the resolved layout direction for this Drawable.
|
Int |
getLevel()
Retrieve the current level.
|
IntArray |
getState()
Describes the current state, as a union of primitive states, such as android.R.attr#state_focused, android.R.attr#state_selected, etc. Some drawables may modify their imagery based on the selected state.
|
Region? |
getTransparentRegion()
Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
|
Unit |
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)
Inflate this Drawable from an XML resource. Does not apply a theme.
|
Unit |
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.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.
|
Unit |
invalidateSelf()
Use the current Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
|
Boolean |
isFilterBitmap()
|
Boolean |
isProjected()
Whether this drawable requests projection. Indicates that the android.graphics.RenderNode this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.
|
Boolean |
isVisible()
|
Int |
resolveOpacity(op1: Int, op2: Int)
Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned.
This is to help in implementing getOpacity.
|
Unit |
scheduleSelf(what: Runnable, when: Long)
Use the current Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
|
Unit |
setBounds(left: Int, top: Int, right: Int, bottom: Int)
Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
|
Unit |
setBounds(bounds: Rect)
Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
|
Unit |
setCallback(cb: Drawable.Callback?)
Bind a Callback object to this Drawable. Required for clients that want to support animated drawables.
|
Unit |
setChangingConfigurations(configs: Int)
Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
|
Unit |
setColorFilter(color: Int, mode: PorterDuff.Mode)
Specify a color and Porter-Duff mode to be the color filter for this drawable.
Convenience for setColorFilter(android.graphics.ColorFilter) which constructs a PorterDuffColorFilter.
Note: Setting a color filter disables tint.
|
Unit |
setFilterBitmap(filter: Boolean)
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.
|
Boolean |
setLayoutDirection(layoutDirection: Int)
Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
|
Boolean |
setLevel(level: Int)
Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level.
If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function.
|
Boolean |
setState(stateSet: IntArray)
Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [android.R.attr#state_focused, android.R.attr#state_pressed].
If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function.
Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
|
Unit |
setTint(tintColor: Int)
Specifies tint color for this drawable.
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).
To clear the tint, pass null to setTintList(android.content.res.ColorStateList).
Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint.
|
Unit |
setTintMode(tintMode: PorterDuff.Mode?)
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 PorterDuff.Mode#SRC_IN.
Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint.
|
Unit |
unscheduleSelf(what: Runnable)
Use the current Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.
|
|
Public constructors
DrawableContainer
DrawableContainer()
Public methods
applyTheme
open fun applyTheme(theme: Resources.Theme): Unit
| Parameters |
t |
the theme to apply This value cannot be null. |
canApplyTheme
open fun canApplyTheme(): Boolean
draw
open fun draw(canvas: Canvas): Unit
| Parameters |
canvas |
Canvas: The canvas to draw into This value cannot be null. |
getAlpha
open fun getAlpha(): Int
| Return |
Int |
Value is between 0 and 255 inclusive |
getChangingConfigurations
open fun getChangingConfigurations(): Int
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.
| Return |
Int |
Value is either 0 or a combination of android.content.pm.ActivityInfo#CONFIG_MCC, android.content.pm.ActivityInfo#CONFIG_MNC, android.content.pm.ActivityInfo#CONFIG_LOCALE, android.content.pm.ActivityInfo#CONFIG_TOUCHSCREEN, android.content.pm.ActivityInfo#CONFIG_KEYBOARD, android.content.pm.ActivityInfo#CONFIG_KEYBOARD_HIDDEN, android.content.pm.ActivityInfo#CONFIG_NAVIGATION, android.content.pm.ActivityInfo#CONFIG_ORIENTATION, android.content.pm.ActivityInfo#CONFIG_SCREEN_LAYOUT, android.content.pm.ActivityInfo#CONFIG_UI_MODE, android.content.pm.ActivityInfo#CONFIG_SCREEN_SIZE, android.content.pm.ActivityInfo#CONFIG_SMALLEST_SCREEN_SIZE, android.content.pm.ActivityInfo#CONFIG_DENSITY, android.content.pm.ActivityInfo#CONFIG_LAYOUT_DIRECTION, android.content.pm.ActivityInfo#CONFIG_COLOR_MODE, android.content.pm.ActivityInfo#CONFIG_FONT_SCALE, and android.content.pm.ActivityInfo#CONFIG_GRAMMATICAL_GENDER |
getCurrent
open fun getCurrent(): Drawable
| Return |
Drawable |
The current drawable that will be used by this drawable. For simple drawables, this is just the drawable itself. For drawables that change state like StateListDrawable and LevelListDrawable this will be the child drawable currently in use. This value cannot be null. |
getHotspotBounds
open fun getHotspotBounds(outRect: Rect): Unit
| Parameters |
outRect |
Rect: the rect to populate with the hotspot bounds This value cannot be null. |
getIntrinsicHeight
open fun getIntrinsicHeight(): Int
| Return |
Int |
the intrinsic height, or -1 if no intrinsic height |
getIntrinsicWidth
open fun getIntrinsicWidth(): Int
| Return |
Int |
the intrinsic width, or -1 if no intrinsic width |
getMinimumHeight
open fun getMinimumHeight(): Int
| Return |
Int |
The minimum height suggested by this Drawable. If this Drawable doesn't have a suggested minimum height, 0 is returned. |
getMinimumWidth
open fun getMinimumWidth(): Int
| Return |
Int |
The minimum width suggested by this Drawable. If this Drawable doesn't have a suggested minimum width, 0 is returned. |
getOpacity
open fun getOpacity(): Int
getOpticalInsets
open fun getOpticalInsets(): Insets
| Return |
Insets |
This value cannot be null. |
getOutline
open fun getOutline(outline: Outline): Unit
Called to get the drawable to populate the Outline that defines its drawing area.
This method is called by the default android.view.ViewOutlineProvider to define the outline of the View.
The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.
| Parameters |
outline |
Outline: This value cannot be null. |
getPadding
open fun getPadding(padding: Rect): Boolean
| Parameters |
padding |
Rect: This value cannot be null. |
| Return |
Boolean |
true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0. |
hasFocusStateSpecified
open fun hasFocusStateSpecified(): Boolean
invalidateDrawable
open fun invalidateDrawable(who: Drawable): Unit
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
open fun isAutoMirrored(): Boolean
| Return |
Boolean |
boolean Returns true if this Drawable will be automatically mirrored. |
isStateful
open fun isStateful(): Boolean
| Return |
Boolean |
True if this drawable changes its appearance based on state, false otherwise. |
jumpToCurrentState
open fun jumpToCurrentState(): Unit
mutate
open fun mutate(): Drawable
| Return |
Drawable |
This drawable. This value cannot be null. |
onLayoutDirectionChanged
open fun onLayoutDirectionChanged(layoutDirection: Int): Boolean
Called when the drawable's resolved layout direction changes.
| Return |
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 |
selectDrawable
open fun selectDrawable(index: Int): Boolean
Sets the currently displayed drawable by index.
If an invalid index is specified, the current drawable will be set to null and the index will be set to -1.
| Parameters |
index |
Int: the index of the drawable to display |
| Return |
Boolean |
true if the drawable changed, false otherwise |
setAlpha
open fun setAlpha(alpha: Int): Unit
| Parameters |
alpha |
Int: Value is between 0 and 255 inclusive |
setAutoMirrored
open fun setAutoMirrored(mirrored: Boolean): Unit
| Parameters |
mirrored |
Boolean: Set to true if the Drawable should be mirrored, false if not. |
setColorFilter
open fun setColorFilter(colorFilter: ColorFilter?): Unit
| Parameters |
colorFilter |
ColorFilter?: The color filter to apply, or null to remove the existing color filter |
setEnterFadeDuration
open fun setEnterFadeDuration(ms: Int): Unit
Change the global fade duration when a new drawable is entering the scene.
| Parameters |
ms |
Int: The amount of time to fade in milliseconds. |
setExitFadeDuration
open fun setExitFadeDuration(ms: Int): Unit
Change the global fade duration when a new drawable is leaving the scene.
| Parameters |
ms |
Int: The amount of time to fade in milliseconds. |
setHotspot
open fun setHotspot(
x: Float,
y: Float
): Unit
| Parameters |
x |
Float: The X coordinate of the center of the hotspot |
y |
Float: The Y coordinate of the center of the hotspot |
setHotspotBounds
open fun setHotspotBounds(
left: Int,
top: Int,
right: Int,
bottom: Int
): Unit
| 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 |
setTintList
open fun setTintList(tint: ColorStateList?): Unit
| Parameters |
tint |
ColorStateList?: Color state list to use for tinting this drawable, or null to clear the tint |
setVisible
open fun setVisible(
visible: Boolean,
restart: Boolean
): Boolean
| 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. |
| Return |
Boolean |
boolean Returns true if the new visibility is different than its previous state. |
Protected methods
onBoundsChange
protected open fun onBoundsChange(bounds: Rect): Unit
| Parameters |
bounds |
Rect: This value cannot be null. |
onLevelChange
protected open fun onLevelChange(level: Int): Boolean
| Return |
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 open fun onStateChange(state: IntArray): Boolean
| Parameters |
state |
IntArray: This value cannot be null. |
| Return |
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. |
