ColorStateListDrawable
open class ColorStateListDrawable : Drawable, Drawable.Callback
kotlin.Any | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.ColorStateListDrawable |
A Drawable that manages a ColorDrawable
to make it stateful and backed by a ColorStateList
.
Summary
Public constructors | |
---|---|
ColorStateListDrawable(colorStateList: ColorStateList) |
Public methods | |
---|---|
open Unit |
Applies the specified theme to this Drawable and its children. |
open Boolean | |
open Unit |
Remove the alpha override, reverting to the alpha defined on each color in the |
open Unit |
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). |
open Int |
getAlpha() Gets the current alpha value for the drawable. |
open Int | |
open ColorFilter? |
Returns the current color filter, or |
open ColorStateList |
Returns the ColorStateList backing this Drawable, or a new ColorStateList of the default ColorDrawable color if one hasn't been defined yet. |
open Drawable.ConstantState |
Return a |
open Drawable | |
open Int |
Return the opacity/transparency of this Drawable. |
open Boolean | |
open Unit |
invalidateDrawable(who: Drawable) Called when the drawable needs to be redrawn. |
open Boolean | |
open Drawable |
mutate() Make this drawable mutable. |
open Unit |
scheduleDrawable(who: Drawable, what: Runnable, when: Long) A Drawable can call this to schedule the next frame of its animation. |
open Unit |
Specify an alpha value for the drawable. |
open Unit |
setColorFilter(colorFilter: ColorFilter?) Specify an optional color filter for the drawable. |
open Unit |
setColorStateList(colorStateList: ColorStateList) Replace this Drawable's ColorStateList. |
open Unit |
setTintBlendMode(blendMode: BlendMode!) Specifies a tint blending mode for this drawable. |
open Unit |
setTintList(tint: ColorStateList?) Specifies tint color for this drawable as a color state list. |
open Unit |
unscheduleDrawable(who: Drawable, what: Runnable) A Drawable can call this to unschedule an action previously scheduled with |
Protected methods | |
---|---|
open Unit |
onBoundsChange(bounds: Rect) |
open Boolean |
onStateChange(state: IntArray) |
Inherited functions | |
---|---|
Public constructors
ColorStateListDrawable
ColorStateListDrawable(colorStateList: ColorStateList)
Parameters | |
---|---|
colorStateList |
ColorStateList: This value cannot be null . |
Public methods
applyTheme
open fun applyTheme(t: Resources.Theme): Unit
Applies the specified theme to this Drawable and its children.
Parameters | |
---|---|
t |
Resources.Theme: This value cannot be null . |
clearAlpha
open fun clearAlpha(): Unit
Remove the alpha override, reverting to the alpha defined on each color in the ColorStateList
.
draw
open fun draw(canvas: Canvas): Unit
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: This value cannot be null . |
getAlpha
open fun getAlpha(): Int
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 | |
---|---|
Int |
Value is between 0 and 255 inclusive |
getChangingConfigurations
open fun getChangingConfigurations(): Int
getColorFilter
open fun getColorFilter(): ColorFilter?
Returns the current color filter, or null
if none set.
Return | |
---|---|
ColorFilter? |
This value may be null . |
getColorStateList
open fun getColorStateList(): ColorStateList
Returns the ColorStateList backing this Drawable, or a new ColorStateList of the default ColorDrawable color if one hasn't been defined yet.
Return | |
---|---|
ColorStateList |
a ColorStateList This value cannot be null . |
getConstantState
open fun getConstantState(): Drawable.ConstantState
Return a ConstantState
instance that holds the shared state of this Drawable.
Return | |
---|---|
Drawable.ConstantState |
This value cannot be null . |
getCurrent
open fun getCurrent(): Drawable
Return | |
---|---|
Drawable |
This value cannot be null . |
getOpacity
open fun getOpacity(): Int
Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in android.graphics.PixelFormat
: android.graphics.PixelFormat#UNKNOWN
, android.graphics.PixelFormat#TRANSLUCENT
, android.graphics.PixelFormat#TRANSPARENT
, or android.graphics.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
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
or #setColorFilter methods. Some subclasses, such as BitmapDrawable
, ColorDrawable
, and GradientDrawable
, do account for the value of setAlpha
, but the general behavior is dependent upon the implementation of the subclass.
Return | |
---|---|
Int |
Value is android.graphics.PixelFormat#UNKNOWN , android.graphics.PixelFormat#TRANSLUCENT , android.graphics.PixelFormat#TRANSPARENT , or android.graphics.PixelFormat#OPAQUE |
hasFocusStateSpecified
open fun hasFocusStateSpecified(): Boolean
Return | |
---|---|
Boolean |
true if android.R.attr#state_focused is specified for this drawable. |
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 . |
isStateful
open fun isStateful(): Boolean
Return | |
---|---|
Boolean |
True if this drawable changes its appearance based on state, false otherwise. |
mutate
open fun mutate(): Drawable
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.
Return | |
---|---|
Drawable |
This value cannot be null . |
scheduleDrawable
open fun scheduleDrawable(
who: Drawable,
what: Runnable,
when: Long
): Unit
A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call android.os.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 android.os.SystemClock#uptimeMillis |
setAlpha
open fun setAlpha(alpha: Int): Unit
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 |
setColorFilter
open fun setColorFilter(colorFilter: ColorFilter?): Unit
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?: This value may be null . |
setColorStateList
open fun setColorStateList(colorStateList: ColorStateList): Unit
Replace this Drawable's ColorStateList. It is not copied, so changes will propagate on the next call to setState(int[])
.
Parameters | |
---|---|
colorStateList |
ColorStateList: A color state list to attach. This value cannot be null . |
setTintBlendMode
open fun setTintBlendMode(blendMode: BlendMode!): Unit
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
open fun setTintList(tint: ColorStateList?): Unit
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?: This value may be null . |
unscheduleDrawable
open fun unscheduleDrawable(
who: Drawable,
what: Runnable
): Unit
A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable
. An implementation can generally simply call android.os.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 open fun onBoundsChange(bounds: Rect): Unit
Parameters | |
---|---|
bounds |
Rect: This value cannot be null . |
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. |