Summary: Constants | Ctors | Methods | Inherited Methods

DrawerArrowDrawable

Kotlin |Java

public class DrawerArrowDrawable
extends Drawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	androidx.appcompat.graphics.drawable.DrawerArrowDrawable

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)`
`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()`
`int`	`getIntrinsicWidth()`
`int`	`getOpacity()`
`final Paint`	`getPaint()` Returns the paint instance used for all drawing.
`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)`
`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)`
`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.

Inherited methods

From class


        
          android.graphics.drawable.Drawable

`void`	`applyTheme(Resources.Theme arg0)`
`boolean`	`canApplyTheme()`
`void`	`clearColorFilter()`
`final Rect`	`copyBounds()`
`final void`	`copyBounds(Rect arg0)`
`static Drawable`	`createFromPath(String arg0)`
`static Drawable`	`createFromResourceStream(Resources arg0, TypedValue arg1, InputStream arg2, String arg3, BitmapFactory.Options arg4)`
`static Drawable`	`createFromResourceStream(Resources arg0, TypedValue arg1, InputStream arg2, String arg3)`
`static Drawable`	`createFromStream(InputStream arg0, String arg1)`
`static Drawable`	`createFromXml(Resources arg0, XmlPullParser arg1)`
`static Drawable`	`createFromXml(Resources arg0, XmlPullParser arg1, Resources.Theme arg2)`
`static Drawable`	`createFromXmlInner(Resources arg0, XmlPullParser arg1, AttributeSet arg2, Resources.Theme arg3)`
`static Drawable`	`createFromXmlInner(Resources arg0, XmlPullParser arg1, AttributeSet arg2)`
`abstract void`	`draw(Canvas arg0)`
`int`	`getAlpha()`
`final Rect`	`getBounds()`
`Drawable.Callback`	`getCallback()`
`int`	`getChangingConfigurations()`
`ColorFilter`	`getColorFilter()`
`Drawable.ConstantState`	`getConstantState()`
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()`
`void`	`getHotspotBounds(Rect arg0)`
`int`	`getIntrinsicHeight()`
`int`	`getIntrinsicWidth()`
`int`	`getLayoutDirection()`
`final int`	`getLevel()`
`int`	`getMinimumHeight()`
`int`	`getMinimumWidth()`
`abstract int`	`getOpacity()`
`Insets`	`getOpticalInsets()`
`void`	`getOutline(Outline arg0)`
`boolean`	`getPadding(Rect arg0)`
`int[]`	`getState()`
`Region`	`getTransparentRegion()`
`void`	`inflate(Resources arg0, XmlPullParser arg1, AttributeSet arg2, Resources.Theme arg3)`
`void`	`inflate(Resources arg0, XmlPullParser arg1, AttributeSet arg2)`
`void`	`invalidateSelf()`
`boolean`	`isAutoMirrored()`
`boolean`	`isFilterBitmap()`
`boolean`	`isProjected()`
`boolean`	`isStateful()`
`final boolean`	`isVisible()`
`void`	`jumpToCurrentState()`
`Drawable`	`mutate()`
`void`	`onBoundsChange(Rect arg0)`
`boolean`	`onLayoutDirectionChanged(int arg0)`
`boolean`	`onLevelChange(int arg0)`
`boolean`	`onStateChange(int[] arg0)`
`static int`	`resolveOpacity(int arg0, int arg1)`
`void`	`scheduleSelf(Runnable arg0, long arg1)`
`abstract void`	`setAlpha(int arg0)`
`void`	`setAutoMirrored(boolean arg0)`
`void`	`setBounds(int arg0, int arg1, int arg2, int arg3)`
`void`	`setBounds(Rect arg0)`
`final void`	`setCallback(Drawable.Callback arg0)`
`void`	`setChangingConfigurations(int arg0)`
`void`	`setColorFilter(int arg0, PorterDuff.Mode arg1)`
`abstract void`	`setColorFilter(ColorFilter arg0)`
`void`	`setDither(boolean arg0)`
`void`	`setFilterBitmap(boolean arg0)`
`void`	`setHotspot(float arg0, float arg1)`
`void`	`setHotspotBounds(int arg0, int arg1, int arg2, int arg3)`
`final boolean`	`setLayoutDirection(int arg0)`
`final boolean`	`setLevel(int arg0)`
`boolean`	`setState(int[] arg0)`
`void`	`setTint(int arg0)`
`void`	`setTintBlendMode(BlendMode arg0)`
`void`	`setTintList(ColorStateList arg0)`
`void`	`setTintMode(PorterDuff.Mode arg0)`
`boolean`	`setVisible(boolean arg0, boolean arg1)`
`void`	`unscheduleSelf(Runnable arg0)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Constants

ARROW_DIRECTION_END

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.

See also:

Constant Value: 3 (0x00000003)

ARROW_DIRECTION_LEFT

public static final int ARROW_DIRECTION_LEFT

Direction to make the arrow point towards the left.

See also:

Constant Value: 0 (0x00000000)

ARROW_DIRECTION_RIGHT

public static final int ARROW_DIRECTION_RIGHT

Direction to make the arrow point towards the right.

See also:

Constant Value: 1 (0x00000001)

ARROW_DIRECTION_START

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.

See also:

Constant Value: 2 (0x00000002)

Public constructors

DrawerArrowDrawable

public DrawerArrowDrawable (Context context)

Parameters
`context`	`Context`: used to get the configuration for the drawable from

Public methods

draw

public void draw (Canvas canvas)

Parameters
`canvas`	`Canvas`

getArrowHeadLength

public float getArrowHeadLength ()

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

Returns
`float`

getArrowShaftLength

public float getArrowShaftLength ()

Returns the arrow shaft length in pixels.

Returns
`float`

getBarLength

public float getBarLength ()

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

Returns
`float`

getBarThickness

public float getBarThickness ()

Returns the thickness (stroke width) of the bars.

Returns
`float`

getColor

public int getColor ()

Returns the color of the drawable.

Returns
`int`

getDirection

public int getDirection ()

Returns the arrow direction.

Returns
`int`

getGapSize

public float getGapSize ()

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

Returns
`float`

See also:

getGapSize()

getIntrinsicHeight

public int getIntrinsicHeight ()

Returns
`int`

getIntrinsicWidth

public int getIntrinsicWidth ()

Returns
`int`

getOpacity

public int getOpacity ()

Returns
`int`

getPaint

public final Paint getPaint ()

Returns the paint instance used for all drawing.

Returns
`Paint`

getProgress

public float getProgress ()

Returns the current progress of the arrow.

Returns
`float`	Value is between 0.0 and 1.0 inclusive.

isSpinEnabled

public boolean isSpinEnabled ()

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

Returns
`boolean`

See also:

setSpinEnabled(boolean)

setAlpha

public void setAlpha (int alpha)

Parameters
`alpha`	`int`

setArrowHeadLength

public void setArrowHeadLength (float length)

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

Parameters
`length`	`float`: the length in pixels

setArrowShaftLength

public void setArrowShaftLength (float length)

Sets the arrow shaft length.

Parameters
`length`	`float`: the length in pixels

setBarLength

public void setBarLength (float length)

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

Parameters
`length`	`float`: the length in pixels

setBarThickness

public void setBarThickness (float width)

Sets the thickness (stroke size) for the bars.

Parameters
`width`	`float`: stroke width in pixels

setColor

public void setColor (int color)

Sets the color of the drawable.

Parameters
`color`	`int`

setColorFilter

public void setColorFilter (ColorFilter colorFilter)

Parameters
`colorFilter`	`ColorFilter`

setDirection

public void setDirection (int direction)

Set the arrow direction.

Parameters
`direction`	`int`

setGapSize

public void setGapSize (float gap)

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

Parameters
`gap`	`float`: the gap in pixels

See also:

getGapSize()

setProgress

public void setProgress (float progress)

Set the progress of the arrow.

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

Parameters
`progress`	`float` Value is between 0.0 and 1.0 inclusive.

setSpinEnabled

public void setSpinEnabled (boolean enabled)

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

Parameters
`enabled`	`boolean`: true if the bars should rotate.

See also:

isSpinEnabled()

setVerticalMirror

public void setVerticalMirror (boolean verticalMirror)

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

Parameters
`verticalMirror`	`boolean`