com.ashokvarma.bottomnavigation

Class ShapeBadgeItem

java.lang.Object

com.ashokvarma.bottomnavigation.ShapeBadgeItem

public class ShapeBadgeItem
extends java.lang.Object

Class description

Since:

23 Jun 2017

See Also:

BadgeItem

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHAPE_HEART
static int	SHAPE_OVAL
static int	SHAPE_RECTANGLE
static int	SHAPE_STAR_3_VERTICES
static int	SHAPE_STAR_4_VERTICES
static int	SHAPE_STAR_5_VERTICES
static int	SHAPE_STAR_6_VERTICES

Constructor Summary

Constructors

Constructor and Description
ShapeBadgeItem()

Method Summary

Modifier and Type	Method and Description
T	hide()
T	hide(boolean animate)
boolean	isHidden()
T	setAnimationDuration(int animationDuration)
ShapeBadgeItem	setEdgeMarginInDp(android.content.Context context, int edgeMarginInDp)
ShapeBadgeItem	setEdgeMarginInPixels(int edgeMarginInPx)
T	setGravity(int gravity)
T	setHideOnSelect(boolean hideOnSelect)
ShapeBadgeItem	setShape(int shape)
ShapeBadgeItem	setShapeColor(int color)
ShapeBadgeItem	setShapeColor(java.lang.String colorCode)
ShapeBadgeItem	setShapeColorResource(int colorResource)
ShapeBadgeItem	setSizeInDp(android.content.Context context, int heightInDp, int widthInDp)
ShapeBadgeItem	setSizeInPixels(int heightInPx, int widthInPx)
T	show()
T	show(boolean animate)
T	toggle()
T	toggle(boolean animate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHAPE_OVAL

public static final int SHAPE_OVAL

See Also:

Constant Field Values

SHAPE_RECTANGLE

public static final int SHAPE_RECTANGLE

See Also:

Constant Field Values

SHAPE_HEART

public static final int SHAPE_HEART

See Also:

Constant Field Values

SHAPE_STAR_3_VERTICES

public static final int SHAPE_STAR_3_VERTICES

See Also:

Constant Field Values

SHAPE_STAR_4_VERTICES

public static final int SHAPE_STAR_4_VERTICES

See Also:

Constant Field Values

SHAPE_STAR_5_VERTICES

public static final int SHAPE_STAR_5_VERTICES

See Also:

Constant Field Values

SHAPE_STAR_6_VERTICES

public static final int SHAPE_STAR_6_VERTICES

See Also:

Constant Field Values

Constructor Detail

ShapeBadgeItem

public ShapeBadgeItem()

Method Detail

setShape

public ShapeBadgeItem setShape(int shape)

Parameters:

shape - new shape that needs to be drawn

Returns:

this, to allow builder pattern

setShapeColorResource

public ShapeBadgeItem setShapeColorResource(int colorResource)

Parameters:

colorResource - resource for background color

Returns:

this, to allow builder pattern

setShapeColor

public ShapeBadgeItem setShapeColor(java.lang.String colorCode)

Parameters:

colorCode - color code for background color

Returns:

this, to allow builder pattern

setShapeColor

public ShapeBadgeItem setShapeColor(int color)

Parameters:

color - background color

Returns:

this, to allow builder pattern

setSizeInDp

public ShapeBadgeItem setSizeInDp(android.content.Context context,
                                  int heightInDp,
                                  int widthInDp)

Parameters:

context - to convert dp to pixel

heightInDp - dp size for height of badge item

widthInDp - dp size for width of badge item

Returns:

this, to allow builder pattern

setSizeInPixels

public ShapeBadgeItem setSizeInPixels(int heightInPx,
                                      int widthInPx)

Parameters:

heightInPx - pixel size for height of badge item

widthInPx - pixel size for width of badge item

Returns:

this, to allow builder pattern

setEdgeMarginInDp

public ShapeBadgeItem setEdgeMarginInDp(android.content.Context context,
                                        int edgeMarginInDp)

Parameters:

context - to convert dp to pixel

edgeMarginInDp - dp size for margin of badge item

Returns:

this, to allow builder pattern

setEdgeMarginInPixels

public ShapeBadgeItem setEdgeMarginInPixels(int edgeMarginInPx)

Parameters:

edgeMarginInPx - pixel size for margin of badge item

Returns:

this, to allow builder pattern

setGravity

public T setGravity(int gravity)

Parameters:

gravity - gravity of badge (TOP|LEFT ..etc)

Returns:

this, to allow builder pattern

setHideOnSelect

public T setHideOnSelect(boolean hideOnSelect)

Parameters:

hideOnSelect - if true hides badge on tab selection

Returns:

this, to allow builder pattern

setAnimationDuration

public T setAnimationDuration(int animationDuration)

Parameters:

animationDuration - hide and show animation time

Returns:

this, to allow builder pattern

toggle

public T toggle()

Returns:

this, to allow builder pattern

toggle

public T toggle(boolean animate)

Parameters:

animate - whether to animate the change

Returns:

this, to allow builder pattern

show

public T show()

Returns:

this, to allow builder pattern

show

public T show(boolean animate)

Parameters:

animate - whether to animate the change

Returns:

this, to allow builder pattern

hide

public T hide()

Returns:

this, to allow builder pattern

hide

public T hide(boolean animate)

Parameters:

animate - whether to animate the change

Returns:

this, to allow builder pattern

isHidden

public boolean isHidden()

Returns:

if the badge is hidden