Added in API level 1

ColorDrawable


open class ColorDrawable : Drawable
kotlin.Any
   ↳ android.graphics.drawable.Drawable
   ↳ android.graphics.drawable.ColorDrawable

A specialized Drawable that fills the Canvas with a specified color. Note that a ColorDrawable ignores the ColorFilter.

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

Summary

XML attributes
android:color The color to use.
Public constructors

Creates a new black ColorDrawable.

Creates a new ColorDrawable with the specified color.

Public methods
open Unit

open Boolean

open Unit
draw(canvas: Canvas)

open Int

Returns the alpha value of this drawable's color.

open Int

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

open Int

Gets the drawable's color value.

open ColorFilter?

Returns the color filter applied to this color configured by setColorFilter(android.graphics.ColorFilter)

open Drawable.ConstantState?

open Int

open Unit
getOutline(outline: Outline)

Called to get the drawable to populate the Outline that defines its drawing area.

open Boolean

open Unit
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)

open Boolean

open Drawable

A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.

open Unit
setAlpha(alpha: Int)

Applies the given alpha to the underlying color.

open Unit
setColor(color: Int)

Sets the drawable's color value.

open Unit
setColorFilter(colorFilter: ColorFilter?)

Sets the color filter applied to this color.

open Unit

Specifies a tint blending mode for this drawable.

open Unit

Protected methods
open Boolean

Inherited functions

XML attributes

android:color

android:color
The color to use.

May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb".

Public constructors

ColorDrawable

Added in API level 1
ColorDrawable()

Creates a new black ColorDrawable.

ColorDrawable

Added in API level 1
ColorDrawable(color: Int)

Creates a new ColorDrawable with the specified color.

Parameters
color Int: The color to draw.

Public methods

applyTheme

Added in API level 21
open fun applyTheme(t: Resources.Theme): Unit
Parameters
t Resources.Theme: the theme to apply This value cannot be null.

canApplyTheme

Added in API level 21
open fun canApplyTheme(): Boolean

draw

Added in API level 1
open fun draw(canvas: Canvas): Unit
Parameters
canvas Canvas: The canvas to draw into This value cannot be null.

getAlpha

Added in API level 1
open fun getAlpha(): Int

Returns the alpha value of this drawable's color. Note this may not be the same alpha value provided in Drawable#setAlpha(int). Instead this will return the alpha of the color combined with the alpha provided by setAlpha

Return
Int A value between 0 and 255.

getColor

Added in API level 11
open fun getColor(): Int

Gets the drawable's color value.

Return
Int int The color to draw.

getColorFilter

Added in API level 21
open fun getColorFilter(): ColorFilter?

Returns the color filter applied to this color configured by setColorFilter(android.graphics.ColorFilter)

Return
ColorFilter? This value may be null.

getConstantState

Added in API level 1
open fun getConstantState(): Drawable.ConstantState?
Return
Drawable.ConstantState? The ConstantState associated to that Drawable. This value may be null.

getOpacity

Added in API level 1
open fun getOpacity(): Int
Return
Int int The opacity class of the Drawable. Value is android.graphics.PixelFormat#UNKNOWN, android.graphics.PixelFormat#TRANSLUCENT, android.graphics.PixelFormat#TRANSPARENT, or android.graphics.PixelFormat#OPAQUE

getOutline

Added in API level 21
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.

hasFocusStateSpecified

Added in API level 31
open fun hasFocusStateSpecified(): Boolean
Return
Boolean true if android.R.attr#state_focused is specified for this drawable.

inflate

Added in API level 21
open fun inflate(
    r: Resources,
    parser: XmlPullParser,
    attrs: AttributeSet,
    theme: Resources.Theme?
): Unit
Parameters
r Resources: Resources used to resolve attribute values This value cannot be null.
parser XmlPullParser: XML parser from which to inflate this Drawable This value cannot be null.
attrs AttributeSet: Base set of attribute values This value cannot be null.
theme Resources.Theme?: Theme to apply, may be null
Exceptions
org.xmlpull.v1.XmlPullParserException
java.io.IOException

isStateful

Added in API level 1
open fun isStateful(): Boolean
Return
Boolean True if this drawable changes its appearance based on state, false otherwise.

mutate

Added in API level 3
open fun mutate(): Drawable

A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.

Return
Drawable This drawable.

setAlpha

Added in API level 1
open fun setAlpha(alpha: Int): Unit

Applies the given alpha to the underlying color. Note if the color already has an alpha applied to it, this will apply this alpha to the existing value instead of overwriting it.

Parameters
alpha Int: The alpha value to set, between 0 and 255.

setColor

Added in API level 11
open fun setColor(color: Int): Unit

Sets the drawable's color value. This action will clobber the results of prior calls to setAlpha(int) on this object, which side-affected the underlying color.

Parameters
color Int: The color to draw.

setColorFilter

Added in API level 1
open fun setColorFilter(colorFilter: ColorFilter?): Unit

Sets the color filter applied to this color.

Only supported on version android.os.Build.VERSION_CODES#LOLLIPOP and above. Calling this method has no effect on earlier versions.

Parameters
colorFilter ColorFilter?: The color filter to apply, or null to remove the existing color filter

setTintBlendMode

Added in API level 29
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

Added in API level 21
open fun setTintList(tint: ColorStateList?): Unit
Parameters
tint ColorStateList?: Color state list to use for tinting this drawable, or null to clear the tint

Protected methods

onStateChange

Added in API level 1
protected open fun onStateChange(stateSet: IntArray): Boolean
Parameters
state 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.