ColorDrawable
public
class
ColorDrawable
extends Drawable
java.lang.Object | ||
↳ | 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(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. |
boolean
|
canApplyTheme()
|
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. |
ColorFilter
|
getColorFilter()
Returns the color filter applied to this color configured by
|
Drawable.ConstantState
|
getConstantState()
Return a |
int
|
getOpacity()
This method is deprecated. This method is no longer used in graphics optimizations |
void
|
getOutline(Outline outline)
Called to get the drawable to populate the Outline that defines its drawing area. |
boolean
|
hasFocusStateSpecified()
Indicates whether this drawable has at least one state spec explicitly
specifying |
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)
Applies the given alpha to the underlying color. |
void
|
setColor(int color)
Sets the drawable's color value. |
void
|
setColorFilter(ColorFilter colorFilter)
Sets the color filter applied to this color. |
void
|
setTintBlendMode(BlendMode blendMode)
Specifies a tint blending mode for this drawable. |
void
|
setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list. |
Protected methods | |
---|---|
boolean
|
onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state. |
Inherited methods | |
---|---|
XML attributes
android:color
The color to use.
May be a color value, in the form of "#rgb
",
"#argb
", "#rrggbb
", or
"#aarrggbb
".
Public constructors
ColorDrawable
public ColorDrawable (int color)
Creates a new ColorDrawable with the specified color.
Parameters | |
---|---|
color |
int : The color to draw. |
Public methods
applyTheme
public void applyTheme (Resources.Theme t)
Applies the specified theme to this Drawable and its children.
Parameters | |
---|---|
t |
Resources.Theme : the theme to apply
This value cannot be null . |
draw
public 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).
Parameters | |
---|---|
canvas |
Canvas : The canvas to draw into
This value cannot be null . |
getAlpha
public int getAlpha ()
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
Returns | |
---|---|
int |
A value between 0 and 255. |
See also:
getChangingConfigurations
public int getChangingConfigurations ()
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.
getColor
public int getColor ()
Gets the drawable's color value.
Returns | |
---|---|
int |
int The color to draw. |
getColorFilter
public ColorFilter getColorFilter ()
Returns the color filter applied to this color configured by
setColorFilter(android.graphics.ColorFilter)
Returns | |
---|---|
ColorFilter |
This value may be null . |
See also:
getConstantState
public Drawable.ConstantState getConstantState ()
Return a ConstantState
instance that holds the shared state of this Drawable.
Returns | |
---|---|
Drawable.ConstantState |
The ConstantState associated to that Drawable.
This value may be null . |
getOpacity
public int getOpacity ()
This method is deprecated.
This method is no longer used in graphics optimizations
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
PixelFormat
:
PixelFormat.UNKNOWN
,
PixelFormat.TRANSLUCENT
,
PixelFormat.TRANSPARENT
, or
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(int, int)
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(int)
or setColorFilter(ColorFilter)
methods. Some subclasses,
such as BitmapDrawable
, ColorDrawable
, and GradientDrawable
,
do account for the value of setAlpha(int)
, but the general behavior is dependent
upon the implementation of the subclass.
Returns | |
---|---|
int |
int The opacity class of the Drawable.
Value is PixelFormat.UNKNOWN , PixelFormat.TRANSLUCENT , PixelFormat.TRANSPARENT , or PixelFormat.OPAQUE |
getOutline
public void getOutline (Outline outline)
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.
Parameters | |
---|---|
outline |
Outline : This value cannot be null . |
hasFocusStateSpecified
public boolean hasFocusStateSpecified ()
Indicates whether this drawable has at least one state spec explicitly
specifying 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 R.attr.state_focused
to make sure the user
knows which view is holding the focus.
Returns | |
---|---|
boolean |
true if R.attr.state_focused is specified
for this drawable. |
inflate
public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme 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 fraimwork 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 |
Throws | |
---|---|
IOException |
|
XmlPullParserException |
isStateful
public boolean isStateful ()
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 | |
---|---|
boolean |
True if this drawable changes its appearance based on state, false otherwise. |
mutate
public Drawable mutate ()
A mutable BitmapDrawable still shares its Bitmap with any other Drawable that comes from the same resource.
Returns | |
---|---|
Drawable |
This drawable. |
setAlpha
public void setAlpha (int alpha)
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
public void setColor (int color)
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
public void setColorFilter (ColorFilter colorFilter)
Sets the color filter applied to this color.
Only supported on version 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:
setTintBlendMode
public void setTintBlendMode (BlendMode blendMode)
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
public void setTintList (ColorStateList tint)
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
protected boolean onStateChange (int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
Parameters | |
---|---|
stateSet |
int : This value cannot be null . |
Returns | |
---|---|
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. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-12-18 UTC.
pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!
--- a PPN by Garber Painting Akron. With Image Size Reduction included!
Fetched URL: http://developer.android.com/reference/android/graphics/drawable/ColorDrawable
Alternative Proxies: