BadgeDrawable

public class BadgeDrawable
extends Drawable

java.lang.Object
↳	android.graphics.drawable.Drawable
	↳	com.google.android.material.badge.BadgeDrawable

BadgeDrawable contains all the layout and draw logic for a badge.

You can use BadgeDrawable to display dynamic information such as a number of pending requests in a BottomNavigationView. To create an instance of BadgeDrawable, use create(Context) or ERROR(/#createFromResources(Context, int)). How to add and display a BadgeDrawable on top of its anchor view depends on the API level:

For API 18+ (APIs supported by ViewOverlay)

Add BadgeDrawable as a ViewOverlay to the desired anchor view using BadgeUtils#attachBadgeDrawable(BadgeDrawable, View, FrameLayout) (This helper class is currently package private).
Update the BadgeDrawable BadgeDrawable's coordinates (center and bounds) based on its anchor view using updateBadgeCoordinates(View, ViewGroup).

 BadgeDrawable badgeDrawable = BadgeDrawable.create(context);
 BadgeUtils.attachBadgeDrawable(badgeDrawable, anchor, null);

For Pre API-18

Set BadgeDrawable as the foreground of the anchor view's FrameLayout ancestor using BadgeUtils#attachBadgeDrawable(BadgeDrawable, View, FrameLayout) (This helper class is currently package private).
Update the BadgeDrawable BadgeDrawable's coordinates (center and bounds) based on its anchor view (relative to its FrameLayout ancestor's coordinate space), using updateBadgeCoordinates(View, ViewGroup).

 BadgeDrawable badgeDrawable = BadgeDrawable.create(context);
 BadgeUtils.attachBadgeDrawable(badgeDrawable, anchor, anchorFrameLayoutParent);

By default, BadgeDrawable is aligned to the top and end edges of its anchor view (with some offsets). Call #setBadgeGravity(int) to change it to one of the other supported modes.

Note: This is still under development and may not support the full range of customization Material Android components generally support (e.g. themed attributes).

Summary

Nested classes
`@interface`	`BadgeDrawable.BadgeGravity` Position the badge can be set to.

XML attributes
`Badge_backgroundColor`
`Badge_badgeTextColor`
`Badge_maxCharacterCount`
`Badge_number`

Constants
`int`	`BOTTOM_END` The badge is positioned along the bottom and end edges of its anchor view
`int`	`BOTTOM_START` The badge is positioned along the bottom and start edges of its anchor view
`int`	`TOP_END` The badge is positioned along the top and end edges of its anchor view
`int`	`TOP_START` The badge is positioned along the top and start edges of its anchor view

Public methods
`void`	`clearNumber()` Resets any badge number so that a numberless badge will be displayed.
`static BadgeDrawable`	`create(Context context)` Creates an instance of BadgeDrawable with default values.
`static BadgeDrawable`	`createFromResource(Context context, int id)` Returns a BadgeDrawable from the given XML resource.
`void`	`draw(Canvas canvas)`
`int`	`getAlpha()`
`int`	`getBackgroundColor()` Returns this badge's background color.
`int`	`getBadgeGravity()`
`int`	`getBadgeTextColor()` Returns this badge's text color.
`CharSequence`	`getContentDescription()`
`int`	`getHorizontalOffset()` Returns how much (in pixels) this badge is being horizontally offset towards the center of its anchor.
`int`	`getIntrinsicHeight()` Returns the height at which the badge would like to be laid out.
`int`	`getIntrinsicWidth()` Returns the width at which the badge would like to be laid out.
`int`	`getMaxCharacterCount()` Returns this badge's max character count.
`int`	`getNumber()` Returns this badge's number.
`int`	`getOpacity()`
`BadgeDrawable.SavedState`	`getSavedState()`
`int`	`getVerticalOffset()` Returns how much (in pixels) this badge is being vertically moved towards the center of its anchor.
`boolean`	`hasNumber()` Returns whether this badge will display a number.
`boolean`	`isStateful()`
`boolean`	`onStateChange(int[] state)`
`void`	`setAlpha(int alpha)`
`void`	`setBackgroundColor(int backgroundColor)` Sets this badge's background color.
`void`	`setBadgeGravity(int gravity)` Sets this badge's gravity with respect to its anchor view.
`void`	`setBadgeTextColor(int badgeTextColor)` Sets this badge's text color.
`void`	`setColorFilter(ColorFilter colorFilter)`
`void`	`setContentDescriptionExceedsMaxBadgeNumberStringResource(int stringsResource)`
`void`	`setContentDescriptionNumberless(CharSequence charSequence)`
`void`	`setContentDescriptionQuantityStringsResource(int stringsResource)`
`void`	`setHorizontalOffset(int px)` Sets how much (in pixels) to horizontally move this badge towards the center of its anchor.
`void`	`setMaxCharacterCount(int maxCharacterCount)` Sets this badge's max character count.
`void`	`setNumber(int number)` Sets this badge's number.
`void`	`setVerticalOffset(int px)` Sets how much (in pixels) to vertically move this badge towards the center of its anchor.
`void`	`setVisible(boolean visible)` Convenience wrapper method for `setVisible(boolean, boolean)` with the `restart` parameter hardcoded to false.
`void`	`updateBadgeCoordinates(View anchorView, ViewGroup customBadgeParent)` Calculates and updates this badge's center coordinates based on its anchor's bounds.

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

XML attributes

Badge_backgroundColor

Related methods:

setBackgroundColor(int)

Badge_badgeTextColor

Related methods:

setBadgeTextColor(int)

Badge_maxCharacterCount

Related methods:

setMaxCharacterCount(int)

Badge_number

Related methods:

setNumber(int)

Constants

BOTTOM_END

int BOTTOM_END

The badge is positioned along the bottom and end edges of its anchor view

Constant Value: 8388693 (0x00800055)

BOTTOM_START

int BOTTOM_START

The badge is positioned along the bottom and start edges of its anchor view

Constant Value: 8388691 (0x00800053)

TOP_END

int TOP_END

The badge is positioned along the top and end edges of its anchor view

Constant Value: 8388661 (0x00800035)

TOP_START

int TOP_START

The badge is positioned along the top and start edges of its anchor view

Constant Value: 8388659 (0x00800033)

Public methods

clearNumber

void clearNumber ()

Resets any badge number so that a numberless badge will be displayed.

create

BadgeDrawable create (Context context)

Creates an instance of BadgeDrawable with default values.

Parameters
`context`	`Context`

Returns
`BadgeDrawable`

createFromResource

BadgeDrawable createFromResource (Context context, 
                int id)

Returns a BadgeDrawable from the given XML resource. All attributes from Badge and a custom style attribute are supported. A badge resource may look like:

<badge
     xmlns:app="http://schemas.android.com/apk/res-auto"
     style="@style/Widget.MaterialComponents.Badge"
     app:maxCharacterCount="2"/>

Parameters
`context`	`Context`
`id`	`int`

Returns
`BadgeDrawable`

draw

void draw (Canvas canvas)

Parameters
`canvas`	`Canvas`

getAlpha

int getAlpha ()

Returns
`int`

getBackgroundColor

int getBackgroundColor ()

Returns this badge's background color.

Related XML Attributes:

Badge_backgroundColor

Returns
`int`

See also:

setBackgroundColor(int)

getBadgeGravity

int getBadgeGravity ()

Returns
`int`

getBadgeTextColor

int getBadgeTextColor ()

Returns this badge's text color.

Related XML Attributes:

Badge_badgeTextColor

Returns
`int`

See also:

setBadgeTextColor(int)

getContentDescription

CharSequence getContentDescription ()

Returns
`CharSequence`

getHorizontalOffset

int getHorizontalOffset ()

Returns how much (in pixels) this badge is being horizontally offset towards the center of its anchor.

Returns
`int`

getIntrinsicHeight

int getIntrinsicHeight ()

Returns the height at which the badge would like to be laid out.

Returns
`int`

getIntrinsicWidth

int getIntrinsicWidth ()

Returns the width at which the badge would like to be laid out.

Returns
`int`

getMaxCharacterCount

int getMaxCharacterCount ()

Returns this badge's max character count.

Related XML Attributes:

Badge_maxCharacterCount

Returns
`int`

See also:

setMaxCharacterCount(int)

getNumber

int getNumber ()

Returns this badge's number. Only non-negative integer numbers will be returned because the setter clamps negative values to 0.

WARNING: Do not call this method if you are planning to compare to BADGE_NUMBER_NONE

Related XML Attributes:

Badge_number

Returns
`int`

See also:

setNumber(int)

getOpacity

int getOpacity ()

Returns
`int`

getSavedState

BadgeDrawable.SavedState getSavedState ()

Returns
`BadgeDrawable.SavedState`

getVerticalOffset

int getVerticalOffset ()

Returns how much (in pixels) this badge is being vertically moved towards the center of its anchor.

Returns
`int`

hasNumber

boolean hasNumber ()

Returns whether this badge will display a number.

Returns
`boolean`

isStateful

boolean isStateful ()

Returns
`boolean`

onStateChange

boolean onStateChange (int[] state)

Parameters
`state`	`int`

Returns
`boolean`

setAlpha

void setAlpha (int alpha)

Parameters
`alpha`	`int`

setBackgroundColor

void setBackgroundColor (int backgroundColor)

Sets this badge's background color.

Related XML Attributes:

Badge_backgroundColor

Parameters
`backgroundColor`	`int`: This badge's background color.

setBadgeGravity

void setBadgeGravity (int gravity)

Sets this badge's gravity with respect to its anchor view.

Parameters
`gravity`	`int`: Constant representing one of 4 possible `BadgeDrawable.BadgeGravity` values.

setBadgeTextColor

void setBadgeTextColor (int badgeTextColor)

Sets this badge's text color.

Related XML Attributes:

Badge_badgeTextColor

Parameters
`badgeTextColor`	`int`: This badge's text color.

setColorFilter

void setColorFilter (ColorFilter colorFilter)

Parameters
`colorFilter`	`ColorFilter`

setContentDescriptionExceedsMaxBadgeNumberStringResource

void setContentDescriptionExceedsMaxBadgeNumberStringResource (int stringsResource)

Parameters
`stringsResource`	`int`

setContentDescriptionNumberless

void setContentDescriptionNumberless (CharSequence charSequence)

Parameters
`charSequence`	`CharSequence`

setContentDescriptionQuantityStringsResource

void setContentDescriptionQuantityStringsResource (int stringsResource)

Parameters
`stringsResource`	`int`

setHorizontalOffset

void setHorizontalOffset (int px)

Sets how much (in pixels) to horizontally move this badge towards the center of its anchor.

Parameters
`px`	`int`: badge's horizontal offset

setMaxCharacterCount

void setMaxCharacterCount (int maxCharacterCount)

Sets this badge's max character count.

Related XML Attributes:

Badge_maxCharacterCount

Parameters
`maxCharacterCount`	`int`: This badge's max character count.

setNumber

void setNumber (int number)

Sets this badge's number. Only non-negative integer numbers are supported. If the number is negative, it will be clamped to 0. The specified value will be displayed, unless its number of digits exceeds maxCharacterCount in which case a truncated version will be shown.

Related XML Attributes:

Badge_number

Parameters
`number`	`int`: This badge's number.

setVerticalOffset

void setVerticalOffset (int px)

Sets how much (in pixels) to vertically move this badge towards the center of its anchor.

Parameters
`px`	`int`: badge's vertical offset

setVisible

void setVisible (boolean visible)

Convenience wrapper method for setVisible(boolean, boolean) with the restart parameter hardcoded to false.

Parameters
`visible`	`boolean`

updateBadgeCoordinates

void updateBadgeCoordinates (View anchorView, 
                ViewGroup customBadgeParent)

Calculates and updates this badge's center coordinates based on its anchor's bounds. Internally also updates this BadgeDrawable's bounds, because they are dependent on the center coordinates. For pre API-18, coordinates will be calculated relative to customBadgeParent because the BadgeDrawable will be set as the parent's foreground.

Parameters
`anchorView`	`View`: This badge's anchor.
`customBadgeParent`	`ViewGroup`: An optional parent view that will set this BadgeDrawable as its foreground.

Annotations
- BadgeDrawable.BadgeGravity
Classes
- BadgeDrawable

BadgeDrawable

Summary

Nested classes

XML attributes

Constants

Public methods

Inherited methods

XML attributes

Badge_backgroundColor

Badge_badgeTextColor

Badge_maxCharacterCount

Badge_number

Constants

BOTTOM_END

BOTTOM_START

TOP_END

TOP_START

Public methods

clearNumber

create

createFromResource

draw

getAlpha

getBackgroundColor

getBadgeGravity

getBadgeTextColor

getContentDescription

getHorizontalOffset

getIntrinsicHeight

getIntrinsicWidth

getMaxCharacterCount

getNumber

getOpacity

getSavedState

getVerticalOffset

hasNumber

isStateful

onStateChange

setAlpha

setBackgroundColor

setBadgeGravity

setBadgeTextColor

setColorFilter

setContentDescriptionExceedsMaxBadgeNumberStringResource

setContentDescriptionNumberless

setContentDescriptionQuantityStringsResource

setHorizontalOffset

setMaxCharacterCount

setNumber

setVerticalOffset

setVisible

updateBadgeCoordinates

Annotations

Classes