Android

android.graphics.drawable.ColorDrawable

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

A ColorDrawable is a specialized drawable that fills the Canvas with a specified color, and with respect to the clip region. Note that a ColorDrawable ignores the ColorFilter. It also ignores the Bounds, meaning it will draw everywhere in the current clip, even if setBounds(...) was called with a smaller area.

Summary

Public Constructors

            ColorDrawable()
Creates a new black ColorDrawable.
            ColorDrawable(int color)
Creates a new ColorDrawable with the specified color.

Public Methods

          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 mau change, requiring that it be re-created.
          Drawable.ConstantState  getConstantState()
          int  getOpacity()
Return the opacity/transparency of this Drawable.
          void  inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
          void  setAlpha(int alpha)
Sets the color's alpha value.
          void  setColorFilter(ColorFilter colorFilter)
Setting a color filter on a ColorDrawable has no effect.
Methods inherited from class android.graphics.drawable.Drawable
Methods inherited from class java.lang.Object

Details

Public Constructors

public ColorDrawable()

Creates a new black ColorDrawable.

public ColorDrawable(int color)

Creates a new ColorDrawable with the specified color.

Parameters

color The color to draw.

Public Methods

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 The canvas to draw into

public int getAlpha()

Returns the alpha value of this drawable's color.

Returns

  • A value between 0 and 255.

public int getChangingConfigurations()

Return a mask of the configuration parameters for which this drawable mau 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 Configuration.

public Drawable.ConstantState getConstantState()

public int getOpacity()

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 inflate(Resources r, XmlPullParser parser, AttributeSet attrs)

Throws

XmlPullParserException
IOException

public void setAlpha(int alpha)

Sets the color's alpha value.

Parameters

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

public void setColorFilter(ColorFilter colorFilter)

Setting a color filter on a ColorDrawable has no effect.

Parameters

colorFilter Ignore.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48