VectorDrawable - Android SDK

Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

Added in API level 21

public class

VectorDrawable

extends Drawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.VectorDrawable

Class Overview

This lets you create a drawable based on an XML vector graphic. It can be defined in an XML file with the <vector> element.

The vector drawable has the following elements:

<vector>

Used to define a vector drawable

android:name: Defines the name of this vector drawable.
android:width: Used to define the intrinsic width of the drawable. This support all the dimension units, normally specified with dp.
android:height: Used to define the intrinsic height the drawable. This support all the dimension units, normally specified with dp.
android:viewportWidth: Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
android:viewportHeight: Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
android:tint: The color to apply to the drawable as a tint. By default, no tint is applied.
android:tintMode: The Porter-Duff blending mode for the tint color. The default value is src_in.
android:autoMirrored: Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left).
android:alpha: The opacity of this drawable.

<group>

Defines a group of paths or subgroups, plus transformation information. The transformations are defined in the same coordinates as the viewport. And the transformations are applied in the order of scale, rotate then translate.

android:name: Defines the name of the group.
android:rotation: The degrees of rotation of the group.
android:pivotX: The X coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space.
android:pivotY: The Y coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space.
android:scaleX: The amount of scale on the X Coordinate.
android:scaleY: The amount of scale on the Y coordinate.
android:translateX: The amount of translation on the X coordinate. This is defined in the viewport space.
android:translateY: The amount of translation on the Y coordinate. This is defined in the viewport space.

<path>

Defines paths to be drawn.

android:name: Defines the name of the path.
android:pathData: Defines path data using exactly same format as "d" attribute in the SVG's path data. This is defined in the viewport space.
android:fillColor: Defines the color to fill the path (none if not present).
android:strokeColor: Defines the color to draw the path outline (none if not present).
android:strokeWidth: The width a path stroke.
android:strokeAlpha: The opacity of a path stroke.
android:fillAlpha: The opacity to fill the path with.
android:trimPathStart: The fraction of the path to trim from the start, in the range from 0 to 1.
android:trimPathEnd: The fraction of the path to trim from the end, in the range from 0 to 1.
android:trimPathOffset: Shift trim region (allows showed region to include the start and end), in the range from 0 to 1.
android:strokeLineCap: Sets the linecap for a stroked path: butt, round, square.
android:strokeLineJoin: Sets the lineJoin for a stroked path: miter,round,bevel.
android:strokeMiterLimit: Sets the Miter limit for a stroked path.

<clip-path>

Defines path to be the current clip. Note that the clip path only apply to the current group and its children.

android:name: Defines the name of the clip path.
android:pathData: Defines clip path using the same format as "d" attribute in the SVG's path data.

Here is a simple VectorDrawable in this vectordrawable.xml file.

 <vector xmlns:android="http://schemas.android.com/apk/res/android"
     android:height="64dp"
     android:width="64dp"
     android:viewportHeight="600"
     android:viewportWidth="600" >
     <group
         android:name="rotationGroup"
         android:pivotX="300.0"
         android:pivotY="300.0"
         android:rotation="45.0" >
         <path
             android:name="v"
             android:fillColor="#000000"
             android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
     </group>
 </vector>

Summary

Public Constructors
	VectorDrawable()

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() Gets the current alpha value for the drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
ColorFilter	getColorFilter() Returns the current color filter, or `null` if none set.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
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.
void	inflate(Resources res, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
Drawable	mutate() Make this drawable mutable.
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setColorFilter(ColorFilter colorFilter) Specify an optional color filter for the drawable.
void	setTintList(ColorStateList tint) Specifies tint color 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

void	applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children.
boolean	canApplyTheme()
void	clearColorFilter() Removes the color filter for this drawable.
final Rect	copyBounds() Return a copy of the drawable's bounds in a new Rect.
final void	copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
static Drawable	createFromPath(String pathName) Create a drawable from file path name.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information.
static Drawable	createFromStream(InputStream is, String srcName) Create a drawable from an inputstream
static Drawable	createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme) Create a drawable from an XML document using an optional `Resources.Theme`.
static Drawable	createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document.
static Drawable	createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Create a drawable from inside an XML document using an optional `Resources.Theme`.
abstract 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() Gets the current alpha value for the drawable.
final Rect	getBounds() Return the drawable's bounds Rect.
Drawable.Callback	getCallback() Return the current `Drawable.Callback` implementation attached to this Drawable.
int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
ColorFilter	getColorFilter() Returns the current color filter, or `null` if none set.
Drawable.ConstantState	getConstantState() Return a `Drawable.ConstantState` instance that holds the shared state of this Drawable.
Drawable	getCurrent()
Rect	getDirtyBounds() Return the drawable's dirty bounds Rect.
void	getHotspotBounds(Rect outRect) Populates `outRect` with the hotspot bounds.
int	getIntrinsicHeight() Return the intrinsic height of the underlying drawable object.
int	getIntrinsicWidth() Return the intrinsic width of the underlying drawable object.
int	getLayoutDirection() Returns the resolved layout direction for this Drawable.
final int	getLevel() Retrieve the current level.
int	getMinimumHeight() Returns the minimum height suggested by this Drawable.
int	getMinimumWidth() Returns the minimum width suggested by this Drawable.
abstract 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.
boolean	getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
int[]	getState() Describes the current state, as a union of primitve states, such as `state_focused`, `state_selected`, etc.
Region	getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme.
void	inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource.
void	invalidateSelf() Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
boolean	isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
boolean	isFilterBitmap()
boolean	isStateful() Indicates whether this drawable will change its appearance based on state.
final boolean	isVisible()
void	jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
Drawable	mutate() Make this drawable mutable.
void	onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds.
boolean	onLayoutDirectionChanged(int layoutDirection) Called when the drawable's resolved layout direction changes.
boolean	onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level.
boolean	onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state.
static int	resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities.
void	scheduleSelf(Runnable what, long when) Use the current `Drawable.Callback` implementation to have this Drawable scheduled.
abstract void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
void	setBounds(Rect bounds) Specify a bounding rectangle for the Drawable.
void	setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable.
final void	setCallback(Drawable.Callback cb) Bind a `Drawable.Callback` object to this Drawable.
void	setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
abstract void	setColorFilter(ColorFilter colorFilter) Specify an optional color filter for the drawable.
void	setColorFilter(int color, PorterDuff.Mode mode) Specify a color and Porter-Duff mode to be the color filter for this drawable.
void	setDither(boolean dither) This method was deprecated in API level 23. This property is ignored.
void	setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
void	setHotspot(float x, float y) Specifies the hotspot's location within the drawable.
void	setHotspotBounds(int left, int top, int right, int bottom) Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
final boolean	setLayoutDirection(int layoutDirection) Set the layout direction for this drawable.
final boolean	setLevel(int level) Specify the level for the drawable.
boolean	setState(int[] stateSet) Specify a set of states for the drawable.
void	setTint(int tintColor) Specifies tint color for this drawable.
void	setTintList(ColorStateList tint) Specifies tint color for this drawable as a color state list.
void	setTintMode(PorterDuff.Mode tintMode) Specifies a tint blending mode for this drawable.
boolean	setVisible(boolean visible, boolean restart) Set whether this Drawable is visible.
void	unscheduleSelf(Runnable what) Use the current `Drawable.Callback` implementation to have this Drawable unscheduled.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public VectorDrawable ()

Added in API level 21

Public Methods

public void applyTheme (Resources.Theme t)

Added in API level 21

Applies the specified theme to this Drawable and its children.

public boolean canApplyTheme ()

Added in API level 21

public void draw (Canvas canvas)

Added in API level 21

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 21

Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

public int getChangingConfigurations ()

Added in API level 21

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 ColorFilter getColorFilter ()

Added in API level 21

Returns the current color filter, or null if none set.

Returns

the current color filter, or null if none set

public Drawable.ConstantState getConstantState ()

Added in API level 21

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

Returns

The ConstantState associated to that Drawable.

public int getIntrinsicHeight ()

Added in API level 21

Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

public int getIntrinsicWidth ()

Added in API level 21

Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

public int getOpacity ()

Added in API level 21

Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: UNKNOWN, TRANSLUCENT, TRANSPARENT, or 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 The opacity class of the Drawable.

public void inflate (Resources res, 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

res	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

Throws

XmlPullParserException
IOException

public boolean isAutoMirrored ()

Added in API level 21

Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection.

Returns

boolean Returns true if this Drawable will be automatically mirrored.

public boolean isStateful ()

Added in API level 21

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 21

Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.

Returns

This drawable.

public void setAlpha (int alpha)

Added in API level 21

Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

public void setAutoMirrored (boolean mirrored)

Added in API level 21

Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection.

Parameters

mirrored	Set to true if the Drawable should be mirrored, false if not.

public void setColorFilter (ColorFilter colorFilter)

Added in API level 21

Specify an optional color filter for the drawable.

If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.

Pass null to remove any existing color filter.

Note: Setting a non-null color filter disables tint.

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 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, PorterDuff.Mode).

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) 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.

Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is SRC_IN.

Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

Parameters

tintMode	A Porter-Duff blending mode

Protected Methods

protected boolean onStateChange (int[] stateSet)

Added in API level 21

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.

Results

Interfaces

Classes

Enums

VectorDrawable

Class Overview

Summary

Public Constructors

public VectorDrawable ()

Public Methods

public void applyTheme (Resources.Theme t)

public boolean canApplyTheme ()

public void draw (Canvas canvas)

Parameters

public int getAlpha ()

public int getChangingConfigurations ()

Returns

public ColorFilter getColorFilter ()

Returns

public Drawable.ConstantState getConstantState ()

Returns

public int getIntrinsicHeight ()

public int getIntrinsicWidth ()

public int getOpacity ()

Returns

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

Parameters

Throws

public boolean isAutoMirrored ()

Returns

public boolean isStateful ()

Returns

public Drawable mutate ()

Returns

public void setAlpha (int alpha)

public void setAutoMirrored (boolean mirrored)

Parameters

public void setColorFilter (ColorFilter colorFilter)

Parameters

public void setTintList (ColorStateList tint)

Parameters

public void setTintMode (PorterDuff.Mode tintMode)

Parameters

Protected Methods

protected boolean onStateChange (int[] stateSet)

Returns