Android APIs
public class

ColorDrawable

extends Drawable
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.ColorDrawable

Class Overview

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
Attribute Name Related Method Description
android:color The color to use. 
Public Constructors
ColorDrawable()
Creates a new black ColorDrawable.
ColorDrawable(int color)
Creates a new ColorDrawable with the specified color.
Public Methods
void applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children.
void 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).
int getAlpha()
Returns the alpha value of this drawable's color.
int getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
int getColor()
Gets the drawable's color value.
Drawable.ConstantState getConstantState()
Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
int getOpacity()
Return the opacity/transparency of this Drawable.
void getOutline(Outline outline)
Called to get the drawable to populate the Outline that defines its drawing area.
void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme.
boolean isStateful()
Indicates whether this drawable will change its appearance based on state.
Drawable mutate()
A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.
void setAlpha(int alpha)
Sets the color's alpha value.
void setColor(int color)
Sets the drawable's color value.
void setColorFilter(ColorFilter colorFilter)
Sets the color filter applied to this color.
void setTintList(ColorStateList tint)
Specifies a tint for this drawable as a color state list.
void setTintMode(PorterDuff.Mode tintMode)
Specifies a tint blending mode for this drawable.
Protected Methods
boolean onStateChange(int[] stateSet)
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

XML Attributes

android:color

The color to use.

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

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol color.

Related Methods

Public Constructors

public ColorDrawable ()

Added in API level 1

Creates a new black ColorDrawable.

public ColorDrawable (int color)

Added in API level 1

Creates a new ColorDrawable with the specified color.

Parameters
color The color to draw.

Public Methods

public void applyTheme (Resources.Theme t)

Added in API level 21

Applies the specified theme to this Drawable and its children.

public void draw (Canvas canvas)

Added in API level 1

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Parameters
canvas The canvas to draw into

public int getAlpha ()

Added in API level 1

Returns the alpha value of this drawable's color.

Returns
  • A value between 0 and 255.

public int getChangingConfigurations ()

Added in API level 1

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.

Returns
  • Returns a mask of the changing configuration parameters, as defined by ActivityInfo.

public int getColor ()

Added in API level 11

Gets the drawable's color value.

Returns
  • int The color to draw.

public Drawable.ConstantState getConstantState ()

Added in API level 1

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

Returns
  • The ConstantState associated to that Drawable.

public int getOpacity ()

Added in API level 1

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.

Returns
  • int The opacity class of the Drawable.

public void getOutline (Outline outline)

Added in API level 21

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

This method is called by the default 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.

public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

Added in API level 21

Inflate this Drawable from an XML resource optionally styled by a theme.

Parameters
r Resources used to resolve attribute values
parser XML parser from which to inflate this Drawable
attrs Base set of attribute values
theme Theme to apply, may be null

public boolean isStateful ()

Added in API level 1

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.

Returns
  • True if this drawable changes its appearance based on state, false otherwise.

public Drawable mutate ()

Added in API level 3

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

Returns
  • This drawable.

public void setAlpha (int alpha)

Added in API level 1

Sets the color's alpha value.

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

public void setColor (int color)

Added in API level 11

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 The color to draw.

public void setColorFilter (ColorFilter colorFilter)

Added in API level 1

Sets the color filter applied to this color.

Only supported on version LOLLIPOP and above. Calling this method has no effect on earlier versions.

Parameters
colorFilter the color filter to apply, or null to remove the existing color filter

public void setTintList (ColorStateList tint)

Added in API level 21

Specifies a tint for this drawable as a color state list.

Setting a color filter via setColorFilter(ColorFilter) overrides tint.

Parameters
tint Color state list to use for tinting this drawable, or null to clear the tint

public void setTintMode (PorterDuff.Mode tintMode)

Added in API level 21

Specifies a tint blending mode for this drawable.

Setting a color filter via setColorFilter(ColorFilter) overrides tint.

Parameters
tintMode A Porter-Duff blending mode

Protected Methods

protected boolean onStateChange (int[] stateSet)

Added in API level 1

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

Returns
  • 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.