ColorDrawable

Kotlin |Java

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
`ColorDrawable()` Creates a new black ColorDrawable.
`ColorDrawable(color: Int)` Creates a new ColorDrawable with the specified color.

Public methods
open Unit	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
open Boolean	`canApplyTheme()`
open Unit	`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).
open Int	`getAlpha()` Returns the alpha value of this drawable's color.
open Int	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open Int	`getColor()` Gets the drawable's color value.
open ColorFilter?	`getColorFilter()` Returns the color filter applied to this color configured by `setColorFilter(android.graphics.ColorFilter)`
open Drawable.ConstantState?	`getConstantState()` Return a `ConstantState` instance that holds the shared state of this Drawable.
open Int	`getOpacity()` Return the opacity/transparency of this Drawable.
open Unit	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area.
open Boolean	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.R.attr#state_focused`.
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme.
open Boolean	`isStateful()` Indicates whether this drawable will change its appearance based on state.
open Drawable	`mutate()` 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	`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.

Protected methods
open Boolean	`onStateChange(stateSet: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.

Inherited functions

From class Drawable

`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`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).
`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.
`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.
`Drawable`	`getCurrent()`
`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.
`Unit`	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
`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.
`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.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`Int`	`getMinimumHeight()` 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.
`Int`	`getMinimumWidth()` 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.
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`Boolean`	`getPadding(padding: Rect)` 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).
`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`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See `android.util.LayoutDirection`.
`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()`
`Unit`	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
`Unit`	`onBoundsChange(bounds: Rect)` Override this in your subclass to change appearance if you vary based on the bounds.
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onLevelChange(level: Int)` Override this in your subclass to change appearance if you vary based on level.
`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`	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See `android.util.LayoutDirection`.
`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`	`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`	`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`	`setDither(dither: Boolean)` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
`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.
`Unit`	`setHotspot(x: Float, y: Float)` Specifies the hotspot's location within the drawable.
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
`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.
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)` 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.
`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.

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

Applies the specified theme to this Drawable and its children.

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

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`.

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.

See Also

android.graphics.drawable.ColorDrawable#setAlpha(int)

getChangingConfigurations

Added in API level 1

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

Return
`Int`	Value is either `0` or a combination of the following: `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` `android.content.pm.ActivityInfo#CONFIG_GRAMMATICAL_GENDER` `android.content.pm.ActivityInfo#CONFIG_FONT_WEIGHT_ADJUSTMENT` `android.content.pm.ActivityInfo#CONFIG_ASSETS_PATHS` `android.content.pm.ActivityInfo#CONFIG_RESOURCES_UNUSED`

Int

Value is either 0 or a combination of the following:

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`.

See Also

android.graphics.drawable.Drawable#getColorFilter()

getConstantState

Added in API level 1

open fun getConstantState(): Drawable.ConstantState?

Return a ConstantState instance that holds the shared state of this Drawable.

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 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`	int The opacity class of the Drawable. Value is one of the following: `android.graphics.PixelFormat#UNKNOWN` `android.graphics.PixelFormat#TRANSLUCENT` `android.graphics.PixelFormat#TRANSPARENT` `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

Indicates whether this drawable has at least one state spec explicitly specifying android.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 android.R.attr#state_focused to make sure the user knows which view is holding the focus.

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

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: 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
`java.io.IOException`
`org.xmlpull.v1.XmlPullParserException`

isStateful

Added in API level 1

open fun isStateful(): Boolean

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.

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

See Also

android.graphics.drawable.Drawable#setColorFilter(ColorFilter)

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

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

Protected methods

onStateChange

Added in API level 1

protected open fun onStateChange(stateSet: IntArray): Boolean

Override this in your subclass to change appearance if you recognize the specified state.

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.