DrawerArrowDrawable - Android SDK

Classes
- DrawerArrowDrawable

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

public class

DrawerArrowDrawable

extends Drawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	android.support.v7.graphics.drawable.DrawerArrowDrawable

Class Overview

A drawable that can draw a "Drawer hamburger" menu or an arrow and animate between them.

The progress between the two states is controlled via setProgress(float).

Summary

Constants
int	ARROW_DIRECTION_END	Direction to make the arrow point to the end.
int	ARROW_DIRECTION_LEFT	Direction to make the arrow point towards the left.
int	ARROW_DIRECTION_RIGHT	Direction to make the arrow point towards the right.
int	ARROW_DIRECTION_START	Direction to make the arrow point towards the start.

Public Constructors
	DrawerArrowDrawable(Context context)

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).
float	getArrowHeadLength() Returns the length of the arrow head (from tip to edge, perpendicular to the shaft), in pixels.
float	getArrowShaftLength() Returns the arrow shaft length in pixels.
float	getBarLength() The length of the bars when they are parallel to each other.
float	getBarThickness() Returns the thickness (stroke width) of the bars.
int	getColor() Returns the color of the drawable.
int	getDirection() Returns the arrow direction.
float	getGapSize() Returns the max gap between the bars when they are parallel to each other.
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.
float	getProgress() Returns the current progress of the arrow.
boolean	isSpinEnabled() Returns whether the bars should rotate or not during the transition.
void	setAlpha(int alpha) Specify an alpha value for the drawable.
void	setArrowHeadLength(float length) Sets the length of the arrow head (from tip to edge, perpendicular to the shaft).
void	setArrowShaftLength(float length) Sets the arrow shaft length.
void	setBarLength(float length) Sets the length of the bars when they are parallel to each other.
void	setBarThickness(float width) Sets the thickness (stroke size) for the bars.
void	setColor(int color) Sets the color of the drawable.
void	setColorFilter(ColorFilter colorFilter) Specify an optional color filter for the drawable.
void	setDirection(int direction) Set the arrow direction.
void	setGapSize(float gap) Sets the max gap between the bars when they are parallel to each other.
void	setProgress(float progress) Set the progress of the arrow.
void	setSpinEnabled(boolean enabled) Returns whether the bars should rotate or not during the transition.
void	setVerticalMirror(boolean verticalMirror) If set, canvas is flipped when progress reached to end and going back to start.

[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.

Constants

public static final int ARROW_DIRECTION_END

Direction to make the arrow point to the end.

When used in a view with a RTL layout direction, this is the same as ARROW_DIRECTION_LEFT, otherwise it is the same as ARROW_DIRECTION_RIGHT.

public static final int ARROW_DIRECTION_LEFT

Direction to make the arrow point towards the left.

public static final int ARROW_DIRECTION_RIGHT

Direction to make the arrow point towards the right.

public static final int ARROW_DIRECTION_START

Direction to make the arrow point towards the start.

When used in a view with a RTL layout direction, this is the same as ARROW_DIRECTION_RIGHT, otherwise it is the same as ARROW_DIRECTION_LEFT.

Public Constructors

public DrawerArrowDrawable (Context context)

Parameters

context	used to get the configuration for the drawable from

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 float getArrowHeadLength ()

Returns the length of the arrow head (from tip to edge, perpendicular to the shaft), in pixels.

public float getArrowShaftLength ()

Returns the arrow shaft length in pixels.

public float getBarLength ()

The length of the bars when they are parallel to each other.

public float getBarThickness ()

Returns the thickness (stroke width) of the bars.

public int getColor ()

Returns the color of the drawable.

public int getDirection ()

Returns the arrow direction.

public float getGapSize ()

Returns the max gap between the bars when they are parallel to each other.

public int getIntrinsicHeight ()

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

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

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 float getProgress ()

Returns the current progress of the arrow.

public boolean isSpinEnabled ()

Returns whether the bars should rotate or not during the transition.

public void setAlpha (int alpha)

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

public void setArrowHeadLength (float length)

Sets the length of the arrow head (from tip to edge, perpendicular to the shaft).

Parameters

length	the length in pixels

public void setArrowShaftLength (float length)

Sets the arrow shaft length.

Parameters

length	the length in pixels

public void setBarLength (float length)

Sets the length of the bars when they are parallel to each other.

Parameters

length	the length in pixels

public void setBarThickness (float width)

Sets the thickness (stroke size) for the bars.

Parameters

width	stroke width in pixels

public void setColor (int color)

Sets the color of the drawable.

public void setColorFilter (ColorFilter colorFilter)

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 setDirection (int direction)

Set the arrow direction.

public void setGapSize (float gap)

Sets the max gap between the bars when they are parallel to each other.

Parameters

gap	the gap in pixels

public void setProgress (float progress)

Set the progress of the arrow.

A value of 0.0 indicates that the arrow should be drawn in it's starting position. A value of 1.0 indicates that the arrow should be drawn in it's ending position.

public void setSpinEnabled (boolean enabled)

Returns whether the bars should rotate or not during the transition.

Parameters

enabled	true if the bars should rotate.

public void setVerticalMirror (boolean verticalMirror)

If set, canvas is flipped when progress reached to end and going back to start.

Results

Classes

DrawerArrowDrawable

Class Overview

Summary

Constants

public static final int ARROW_DIRECTION_END

See Also

public static final int ARROW_DIRECTION_LEFT

See Also

public static final int ARROW_DIRECTION_RIGHT

See Also

public static final int ARROW_DIRECTION_START

See Also

Public Constructors

public DrawerArrowDrawable (Context context)

Parameters

Public Methods

public void draw (Canvas canvas)

Parameters

public float getArrowHeadLength ()

public float getArrowShaftLength ()

public float getBarLength ()

public float getBarThickness ()

public int getColor ()

public int getDirection ()

public float getGapSize ()

See Also

public int getIntrinsicHeight ()

public int getIntrinsicWidth ()

public int getOpacity ()

Returns

public float getProgress ()

public boolean isSpinEnabled ()

See Also

public void setAlpha (int alpha)

public void setArrowHeadLength (float length)

Parameters

public void setArrowShaftLength (float length)

Parameters

public void setBarLength (float length)

Parameters

public void setBarThickness (float width)

Parameters

public void setColor (int color)

public void setColorFilter (ColorFilter colorFilter)

Parameters

public void setDirection (int direction)

public void setGapSize (float gap)

Parameters

See Also

public void setProgress (float progress)

public void setSpinEnabled (boolean enabled)

Parameters

See Also

public void setVerticalMirror (boolean verticalMirror)