Build 1.0_r1(from source)

android.graphics.drawable
Class GradientDrawable

java.lang.Object
  extended by android.graphics.drawable.Drawable
      extended by android.graphics.drawable.GradientDrawable

public class GradientDrawable
extends Drawable

A simple color gradient for buttons, backgrounds, etc. See Gradient in the Resources topic to learn how to specify this type as an XML resource.


Nested Class Summary
(package private) static class GradientDrawable.GradientState
           
static class GradientDrawable.Orientation
          Controls how the gradient is oriented relative to the drawable's bounds
 
Nested classes/interfaces inherited from class android.graphics.drawable.Drawable
Drawable.Callback, Drawable.ConstantState
 
Field Summary
static int LINE
          Shape is a line
static int LINEAR_GRADIENT
          Gradient is linear (default.)
static int OVAL
          Shape is an ellipse
static int RADIAL_GRADIENT
          Gradient is circular.
static int RECTANGLE
          Shape is a rectangle, possibly with rounded corners
static int RING
          Shape is a ring.
static int SWEEP_GRADIENT
          Gradient is a sweep.
 
Fields inherited from class android.graphics.drawable.Drawable
mCallback
 
Constructor Summary
GradientDrawable()
           
GradientDrawable(GradientDrawable.Orientation orientation, int[] colors)
          Create a new gradient drawable given an orientation and an array of colors for the gradient.
 
Method Summary
 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 getChangingConfigurations()
          Return a mask of the configuration parameters for which this drawable mau change, requiring that it be re-created.
 Drawable.ConstantState getConstantState()
           
 int getIntrinsicHeight()
          Return the intrinsic height of the underlying drawable object.
 int getIntrinsicWidth()
          Return the intrinsic width of the underlying drawable object.
 int getOpacity()
          Return the opacity/transparency of this Drawable.
 boolean getPadding(Rect padding)
          Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
 void inflate(Resources r, XmlPullParser parser, AttributeSet attrs)
           
protected  void onBoundsChange(Rect r)
          Override this in your subclass to change appearance if you recognize the specified state.
protected  boolean onLevelChange(int level)
          Override this in your subclass to change appearance if you vary based on level.
 void setAlpha(int alpha)
          Specify an alpha value for the drawable.
 void setColor(int argb)
           
 void setColorFilter(ColorFilter cf)
          Specify an optional colorFilter for the drawable.
 void setCornerRadii(float[] radii)
          Specify radii for each of the 4 corners.
 void setCornerRadius(float radius)
          Specify radius for the corners of the gradient.
 void setDither(boolean dither)
          Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
 void setGradientCenter(float x, float y)
           
 void setGradientRadius(float gradientRadius)
           
 void setGradientType(int gradient)
           
 void setShape(int shape)
           
 void setSize(int width, int height)
           
 void setStroke(int width, int color)
          Set the stroke width and color for the drawable.
 void setStroke(int width, int color, float dashWidth, float dashGap)
           
 void setUseLevel(boolean useLevel)
           
 
Methods inherited from class android.graphics.drawable.Drawable
clearColorFilter, copyBounds, copyBounds, createFromPath, createFromStream, createFromXml, createFromXmlInner, getBounds, getCurrent, getLevel, getMinimumHeight, getMinimumWidth, getState, getTransparentRegion, inflateWithAttributes, invalidateSelf, isStateful, isVisible, onStateChange, resolveOpacity, scheduleSelf, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setFilterBitmap, setLevel, setState, setVisible, unscheduleSelf
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RECTANGLE

public static final int RECTANGLE
Shape is a rectangle, possibly with rounded corners

See Also:
Constant Field Values

OVAL

public static final int OVAL
Shape is an ellipse

See Also:
Constant Field Values

LINE

public static final int LINE
Shape is a line

See Also:
Constant Field Values

RING

public static final int RING
Shape is a ring.

See Also:
Constant Field Values

LINEAR_GRADIENT

public static final int LINEAR_GRADIENT
Gradient is linear (default.)

See Also:
Constant Field Values

RADIAL_GRADIENT

public static final int RADIAL_GRADIENT
Gradient is circular.

See Also:
Constant Field Values

SWEEP_GRADIENT

public static final int SWEEP_GRADIENT
Gradient is a sweep.

See Also:
Constant Field Values
Constructor Detail

GradientDrawable

public GradientDrawable()

GradientDrawable

public GradientDrawable(GradientDrawable.Orientation orientation,
                        int[] colors)
Create a new gradient drawable given an orientation and an array of colors for the gradient.

Method Detail

getPadding

public boolean getPadding(Rect padding)
Description copied from class: Drawable
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). Returns true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

Overrides:
getPadding in class Drawable

setCornerRadii

public void setCornerRadii(float[] radii)
Specify radii for each of the 4 corners. For each corner, the array contains 2 values, [X_radius, Y_radius]. The corners are ordered top-left, top-right, bottom-right, bottom-left


setCornerRadius

public void setCornerRadius(float radius)
Specify radius for the corners of the gradient. If this is > 0, then the drawable is drawn in a round-rectangle, rather than a rectangle.


setStroke

public void setStroke(int width,
                      int color)
Set the stroke width and color for the drawable. If width is zero, then no stroke is drawn.


setStroke

public void setStroke(int width,
                      int color,
                      float dashWidth,
                      float dashGap)

setSize

public void setSize(int width,
                    int height)

setShape

public void setShape(int shape)

setGradientType

public void setGradientType(int gradient)

setGradientCenter

public void setGradientCenter(float x,
                              float y)

setGradientRadius

public void setGradientRadius(float gradientRadius)

setUseLevel

public void setUseLevel(boolean useLevel)

draw

public void draw(Canvas canvas)
Description copied from class: Drawable
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

Specified by:
draw in class Drawable
Parameters:
canvas - The canvas to draw into

setColor

public void setColor(int argb)

getChangingConfigurations

public int getChangingConfigurations()
Description copied from class: Drawable
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 Drawable.setChangingConfigurations(int) or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.

Overrides:
getChangingConfigurations in class Drawable
Returns:
Returns a mask of the changing configuration parameters, as defined by Configuration.
See Also:
Configuration

setAlpha

public void setAlpha(int alpha)
Description copied from class: Drawable
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

Specified by:
setAlpha in class Drawable

setDither

public void setDither(boolean dither)
Description copied from class: Drawable
Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. This can improve the look on those devices, but can also slow down the drawing a little.

Overrides:
setDither in class Drawable

setColorFilter

public void setColorFilter(ColorFilter cf)
Description copied from class: Drawable
Specify an optional colorFilter for the drawable. Pass null to remove any filters.

Specified by:
setColorFilter in class Drawable

getOpacity

public int getOpacity()
Description copied from class: Drawable
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.

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 Drawable.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 Drawable.setAlpha(int) or Drawable.setColorFilter(android.graphics.ColorFilter) methods.

Specified by:
getOpacity in class Drawable
Returns:
int The opacity class of the Drawable.
See Also:
PixelFormat

onBoundsChange

protected void onBoundsChange(Rect r)
Description copied from class: Drawable
Override this in your subclass to change appearance if you recognize the specified state.

Overrides:
onBoundsChange in class Drawable

onLevelChange

protected boolean onLevelChange(int level)
Description copied from class: Drawable
Override this in your subclass to change appearance if you vary based on level.

Overrides:
onLevelChange in class Drawable
Returns:
Returns true if the level 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 level.

inflate

public void inflate(Resources r,
                    XmlPullParser parser,
                    AttributeSet attrs)
             throws XmlPullParserException,
                    IOException
Overrides:
inflate in class Drawable
Throws:
XmlPullParserException
IOException

getIntrinsicWidth

public int getIntrinsicWidth()
Description copied from class: Drawable
Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

Overrides:
getIntrinsicWidth in class Drawable

getIntrinsicHeight

public int getIntrinsicHeight()
Description copied from class: Drawable
Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

Overrides:
getIntrinsicHeight in class Drawable

getConstantState

public Drawable.ConstantState getConstantState()
Overrides:
getConstantState in class Drawable

Build 1.0_r1(from source)

Please submit a feedback, bug or feature