com.mikepenz.iconics

Class IconicsDrawable

java.lang.Object

android.graphics.drawable.Drawable

com.mikepenz.iconics.IconicsDrawable

public class IconicsDrawable
extends android.graphics.drawable.Drawable

A custom Drawable which can display icons from icon fonts.

Nested Class Summary

Nested classes/interfaces inherited from class android.graphics.drawable.Drawable

android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANDROID_ACTIONBAR_ICON_SIZE_DP
static int	ANDROID_ACTIONBAR_ICON_SIZE_PADDING_DP

Constructor Summary

Constructors

Modifier	Constructor and Description
	IconicsDrawable(android.content.Context context)
	IconicsDrawable(android.content.Context context, java.lang.Character icon)
	IconicsDrawable(android.content.Context context, IIcon icon)
protected	IconicsDrawable(android.content.Context context, ITypeface typeface, IIcon icon)
	IconicsDrawable(android.content.Context context, java.lang.String icon)

Method Summary

Modifier and Type	Method and Description
IconicsDrawable	actionBar() Sets the size and the Padding to the correct values to be used for the actionBar / toolBar
IconicsDrawable	actionBarSize() Deprecated. use actionBar() instead
IconicsDrawable	alpha(int alpha) Sets the opacity
IconicsDrawable	backgroundColor(int backgroundColor) set background color
IconicsDrawable	backgroundColorRes(int backgroundColorRes) set background color from res
void	clearColorFilter()
IconicsDrawable	clone() clones the icon
IconicsDrawable	color(int color) Set the color of the drawable.
IconicsDrawable	colorFilter(android.graphics.ColorFilter cf) Set the colorFilter
IconicsDrawable	colorRes(int colorRes) Set the color of the drawable.
IconicsDrawable	contourColor(int contourColor) Set contour color for the.
IconicsDrawable	contourColorRes(int contourColorRes) Set contour color from color res.
IconicsDrawable	contourWidthDp(int contourWidthDp) Set contour width from dp for the icon
IconicsDrawable	contourWidthPx(int contourWidth) Set contour width for the icon.
IconicsDrawable	contourWidthRes(int contourWidthRes) Set contour width from an dimen res for the icon
void	draw(android.graphics.Canvas canvas)
IconicsDrawable	drawContour(boolean drawContour) Enable/disable contour drawing.
int	getAlpha()
int	getBackgroundColor() Returns the icon background color
int	getColor() Returns the icon color
int	getCompatAlpha() just a helper method to get the alpha value
int	getContourColor() Returns the icon contour color
IIcon	getIcon()
int	getIntrinsicHeight()
int	getIntrinsicWidth()
int	getOpacity()
java.lang.String	getPlainIcon()
IconicsDrawable	icon(java.lang.Character icon) Loads and draws given.
IconicsDrawable	icon(IIcon icon) Loads and draws given.
protected IconicsDrawable	icon(ITypeface typeface, IIcon icon) Loads and draws given.
IconicsDrawable	icon(java.lang.String icon) Loads and draws given text
IconicsDrawable	iconOffsetXDp(int iconOffsetXDp) set the icon offset for X as dp
IconicsDrawable	iconOffsetXPx(int iconOffsetX) set the icon offset for X
IconicsDrawable	iconOffsetXRes(int iconOffsetXRes) set the icon offset for X from resource
IconicsDrawable	iconOffsetYDp(int iconOffsetYDp) set the icon offset for Y as dp
IconicsDrawable	iconOffsetYPx(int iconOffsetY) set the icon offset for Y
IconicsDrawable	iconOffsetYRes(int iconOffsetYRes) set the icon offset for Y from resource
IconicsDrawable	iconText(java.lang.String icon) Loads and draws given text
boolean	isStateful()
protected void	onBoundsChange(android.graphics.Rect bounds)
protected boolean	onStateChange(int[] stateSet)
IconicsDrawable	paddingDp(int iconPadding) Set the padding in dp for the drawable
IconicsDrawable	paddingPx(int iconPadding) Set a padding for the.
IconicsDrawable	paddingRes(int dimenRes) Set the padding of the drawable from res
IconicsDrawable	respectFontBounds(boolean respectBounds) Set if it should respect the original bounds of the icon.
IconicsDrawable	roundedCornersDp(int roundedCornerDp) set rounded corner from dp
IconicsDrawable	roundedCornersPx(int roundedCornerPx) set rounded corner from px
IconicsDrawable	roundedCornersRes(int roundedCornerRes) set rounded corner from res
IconicsDrawable	roundedCornersRxDp(int roundedCornerRxDp) set rounded corner from dp
IconicsDrawable	roundedCornersRxPx(int roundedCornerRxPx) set rounded corner from px
IconicsDrawable	roundedCornersRxRes(int roundedCornerRxRes) set rounded corner from res
IconicsDrawable	roundedCornersRyDp(int roundedCornerRyDp) set rounded corner from dp
IconicsDrawable	roundedCornersRyPx(int roundedCornerRyPx) set rounded corner from px
IconicsDrawable	roundedCornersRyRes(int roundedCornerRyRes) set rounded corner from res
void	setAlpha(int alpha)
void	setColorFilter(android.graphics.ColorFilter cf)
boolean	setState(int[] stateSet)
void	setTint(int tintColor)
void	setTintList(android.content.res.ColorStateList tint)
void	setTintMode(android.graphics.PorterDuff.Mode tintMode)
IconicsDrawable	sizeDp(int size) Set the size of the drawable.
IconicsDrawable	sizeDpX(int sizeX) Set the size of the drawable.
IconicsDrawable	sizeDpY(int sizeY) Set the size of the drawable.
IconicsDrawable	sizePx(int size) Set the size of the drawable.
IconicsDrawable	sizePxX(int sizeX) Set the size of the drawable.
IconicsDrawable	sizePxY(int sizeY) Set the size of the drawable.
IconicsDrawable	sizeRes(int dimenRes) Set the size of the drawable.
IconicsDrawable	sizeResX(int dimenResX) Set the size of the drawable.
IconicsDrawable	sizeResY(int dimenResY) Set the size of the drawable.
IconicsDrawable	style(android.graphics.Paint.Style style) Sets the style
android.graphics.Bitmap	toBitmap() Creates a BitMap to use in Widgets or anywhere else
IconicsDrawable	typeface(android.graphics.Typeface typeface) sets the typeface of the drawable NOTE THIS WILL OVERWRITE THE ICONFONT!

Methods inherited from class android.graphics.drawable.Drawable

applyTheme, canApplyTheme, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getBounds, getCallback, getChangingConfigurations, getColorFilter, getConstantState, getCurrent, getDirtyBounds, getHotspotBounds, getLayoutDirection, getLevel, getMinimumHeight, getMinimumWidth, getOutline, getPadding, getState, getTransparentRegion, inflate, inflate, invalidateSelf, isAutoMirrored, isFilterBitmap, isVisible, jumpToCurrentState, mutate, onLayoutDirectionChanged, onLevelChange, resolveOpacity, scheduleSelf, setAutoMirrored, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setDither, setFilterBitmap, setHotspot, setHotspotBounds, setLayoutDirection, setLevel, setVisible, unscheduleSelf

Methods inherited from class java.lang.Object

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

Field Detail

ANDROID_ACTIONBAR_ICON_SIZE_DP

public static final int ANDROID_ACTIONBAR_ICON_SIZE_DP

See Also:

Constant Field Values

ANDROID_ACTIONBAR_ICON_SIZE_PADDING_DP

public static final int ANDROID_ACTIONBAR_ICON_SIZE_PADDING_DP

See Also:

Constant Field Values

Constructor Detail

IconicsDrawable

public IconicsDrawable(android.content.Context context)

IconicsDrawable

public IconicsDrawable(android.content.Context context,
                       java.lang.Character icon)

IconicsDrawable

public IconicsDrawable(android.content.Context context,
                       java.lang.String icon)

IconicsDrawable

public IconicsDrawable(android.content.Context context,
                       IIcon icon)

IconicsDrawable

protected IconicsDrawable(android.content.Context context,
                          ITypeface typeface,
                          IIcon icon)

Method Detail

icon

public IconicsDrawable icon(java.lang.String icon)

Loads and draws given text

Parameters:

icon -

Returns:

The current IconExtDrawable for chaining.

icon

public IconicsDrawable icon(java.lang.Character icon)

Loads and draws given.

Parameters:

icon -

Returns:

The current IconExtDrawable for chaining.

iconText

public IconicsDrawable iconText(java.lang.String icon)

Loads and draws given text

Parameters:

icon -

Returns:

The current IconExtDrawable for chaining.

icon

public IconicsDrawable icon(IIcon icon)

Loads and draws given.

Parameters:

icon -

Returns:

The current IconExtDrawable for chaining.

icon

protected IconicsDrawable icon(ITypeface typeface,
                               IIcon icon)

Loads and draws given.

Parameters:

typeface -

icon -

Returns:

The current IconExtDrawable for chaining.

respectFontBounds

public IconicsDrawable respectFontBounds(boolean respectBounds)

Set if it should respect the original bounds of the icon. (DEFAULT is false) This will break the "padding" functionality, but keep the padding defined by the font itself Check it out with the oct_arrow_down and oct_arrow_small_down of the Octicons font

Parameters:

respectBounds - set to true if it should respect the original bounds

color

public IconicsDrawable color(int color)

Set the color of the drawable.

Parameters:

color - The color, usually from android.graphics.Color or 0xFF012345.

Returns:

The current IconExtDrawable for chaining.

colorRes

public IconicsDrawable colorRes(@ColorRes
                                int colorRes)

Set the color of the drawable.

Parameters:

colorRes - The color resource, from your R file.

Returns:

The current IconExtDrawable for chaining.

getColor

public int getColor()

Returns the icon color

getContourColor

public int getContourColor()

Returns the icon contour color

getBackgroundColor

public int getBackgroundColor()

Returns the icon background color

iconOffsetXRes

public IconicsDrawable iconOffsetXRes(@DimenRes
                                      int iconOffsetXRes)

set the icon offset for X from resource

Parameters:

iconOffsetXRes -

Returns:

iconOffsetXDp

public IconicsDrawable iconOffsetXDp(@Dimension(unit=0)
                                     int iconOffsetXDp)

set the icon offset for X as dp

Parameters:

iconOffsetXDp -

Returns:

iconOffsetXPx

public IconicsDrawable iconOffsetXPx(@Dimension(unit=1)
                                     int iconOffsetX)

set the icon offset for X

Parameters:

iconOffsetX -

Returns:

iconOffsetYRes

public IconicsDrawable iconOffsetYRes(@DimenRes
                                      int iconOffsetYRes)

set the icon offset for Y from resource

Parameters:

iconOffsetYRes -

Returns:

iconOffsetYDp

public IconicsDrawable iconOffsetYDp(@Dimension(unit=0)
                                     int iconOffsetYDp)

set the icon offset for Y as dp

Parameters:

iconOffsetYDp -

Returns:

iconOffsetYPx

public IconicsDrawable iconOffsetYPx(@Dimension(unit=1)
                                     int iconOffsetY)

set the icon offset for Y

Parameters:

iconOffsetY -

Returns:

paddingRes

public IconicsDrawable paddingRes(@DimenRes
                                  int dimenRes)

Set the padding of the drawable from res

Parameters:

dimenRes -

Returns:

The current IconExtDrawable for chaining.

paddingDp

public IconicsDrawable paddingDp(@Dimension(unit=0)
                                 int iconPadding)

Set the padding in dp for the drawable

Parameters:

iconPadding -

Returns:

The current IconExtDrawable for chaining.

paddingPx

public IconicsDrawable paddingPx(@Dimension(unit=1)
                                 int iconPadding)

Set a padding for the.

Parameters:

iconPadding -

Returns:

The current IconExtDrawable for chaining.

actionBarSize

@Deprecated
public IconicsDrawable actionBarSize()

Deprecated. use actionBar() instead

Set the size of this icon to the standard Android ActionBar.

Returns:

The current IconExtDrawable for chaining.

actionBar

public IconicsDrawable actionBar()

Sets the size and the Padding to the correct values to be used for the actionBar / toolBar

Returns:

sizeRes

public IconicsDrawable sizeRes(@DimenRes
                               int dimenRes)

Set the size of the drawable.

Parameters:

dimenRes - The dimension resource.

Returns:

The current IconExtDrawable for chaining.

sizeDp

public IconicsDrawable sizeDp(@Dimension(unit=0)
                              int size)

Set the size of the drawable.

Parameters:

size - The size in density-independent pixels (dp).

Returns:

The current IconExtDrawable for chaining.

sizePx

public IconicsDrawable sizePx(@Dimension(unit=1)
                              int size)

Set the size of the drawable.

Parameters:

size - The size in pixels (px).

Returns:

The current IconExtDrawable for chaining.

sizeResX

public IconicsDrawable sizeResX(@DimenRes
                                int dimenResX)

Set the size of the drawable.

Parameters:

dimenResX - The dimension resource.

Returns:

The current IconExtDrawable for chaining.

sizeDpX

public IconicsDrawable sizeDpX(@Dimension(unit=0)
                               int sizeX)

Set the size of the drawable.

Parameters:

sizeX - The size in density-independent pixels (dp).

Returns:

The current IconExtDrawable for chaining.

sizePxX

public IconicsDrawable sizePxX(@Dimension(unit=1)
                               int sizeX)

Set the size of the drawable.

Parameters:

sizeX - The size in pixels (px).

Returns:

The current IconExtDrawable for chaining.

sizeResY

public IconicsDrawable sizeResY(@DimenRes
                                int dimenResY)

Set the size of the drawable.

Parameters:

dimenResY - The dimension resource.

Returns:

The current IconExtDrawable for chaining.

sizeDpY

public IconicsDrawable sizeDpY(@Dimension(unit=0)
                               int sizeY)

Set the size of the drawable.

Parameters:

sizeY - The size in density-independent pixels (dp).

Returns:

The current IconExtDrawable for chaining.

sizePxY

public IconicsDrawable sizePxY(@Dimension(unit=1)
                               int sizeY)

Set the size of the drawable.

Parameters:

sizeY - The size in pixels (px).

Returns:

The current IconExtDrawable for chaining.

contourColor

public IconicsDrawable contourColor(int contourColor)

Set contour color for the.

Parameters:

contourColor -

Returns:

The current IconExtDrawable for chaining.

contourColorRes

public IconicsDrawable contourColorRes(@ColorRes
                                       int contourColorRes)

Set contour color from color res.

Parameters:

contourColorRes -

Returns:

The current IconExtDrawable for chaining.

backgroundColor

public IconicsDrawable backgroundColor(int backgroundColor)

set background color

Parameters:

backgroundColor -

Returns:

backgroundColorRes

public IconicsDrawable backgroundColorRes(@ColorRes
                                          int backgroundColorRes)

set background color from res

Parameters:

backgroundColorRes -

Returns:

roundedCornersRxRes

public IconicsDrawable roundedCornersRxRes(@DimenRes
                                           int roundedCornerRxRes)

set rounded corner from res

Parameters:

roundedCornerRxRes -

Returns:

roundedCornersRxDp

public IconicsDrawable roundedCornersRxDp(@Dimension(unit=0)
                                          int roundedCornerRxDp)

set rounded corner from dp

Parameters:

roundedCornerRxDp -

Returns:

roundedCornersRxPx

public IconicsDrawable roundedCornersRxPx(@Dimension(unit=1)
                                          int roundedCornerRxPx)

set rounded corner from px

Parameters:

roundedCornerRxPx -

Returns:

roundedCornersRyRes

public IconicsDrawable roundedCornersRyRes(@DimenRes
                                           int roundedCornerRyRes)

set rounded corner from res

Parameters:

roundedCornerRyRes -

Returns:

roundedCornersRyDp

public IconicsDrawable roundedCornersRyDp(@Dimension(unit=0)
                                          int roundedCornerRyDp)

set rounded corner from dp

Parameters:

roundedCornerRyDp -

Returns:

roundedCornersRyPx

public IconicsDrawable roundedCornersRyPx(@Dimension(unit=1)
                                          int roundedCornerRyPx)

set rounded corner from px

Parameters:

roundedCornerRyPx -

Returns:

roundedCornersRes

public IconicsDrawable roundedCornersRes(@DimenRes
                                         int roundedCornerRes)

set rounded corner from res

Parameters:

roundedCornerRes -

Returns:

roundedCornersDp

public IconicsDrawable roundedCornersDp(@Dimension(unit=0)
                                        int roundedCornerDp)

set rounded corner from dp

Parameters:

roundedCornerDp -

Returns:

roundedCornersPx

public IconicsDrawable roundedCornersPx(@Dimension(unit=1)
                                        int roundedCornerPx)

set rounded corner from px

Parameters:

roundedCornerPx -

Returns:

contourWidthRes

public IconicsDrawable contourWidthRes(@DimenRes
                                       int contourWidthRes)

Set contour width from an dimen res for the icon

Parameters:

contourWidthRes -

Returns:

The current IconExtDrawable for chaining.

contourWidthDp

public IconicsDrawable contourWidthDp(@Dimension(unit=0)
                                      int contourWidthDp)

Set contour width from dp for the icon

Parameters:

contourWidthDp -

Returns:

The current IconExtDrawable for chaining.

contourWidthPx

public IconicsDrawable contourWidthPx(@Dimension(unit=1)
                                      int contourWidth)

Set contour width for the icon.

Parameters:

contourWidth -

Returns:

The current IconExtDrawable for chaining.

drawContour

public IconicsDrawable drawContour(boolean drawContour)

Enable/disable contour drawing.

Parameters:

drawContour -

Returns:

The current IconExtDrawable for chaining.

colorFilter

public IconicsDrawable colorFilter(android.graphics.ColorFilter cf)

Set the colorFilter

Parameters:

cf -

Returns:

The current IconExtDrawable for chaining.

alpha

public IconicsDrawable alpha(int alpha)

Sets the opacity

Parameters:

alpha -

Returns:

The current IconExtDrawable for chaining.

style

public IconicsDrawable style(android.graphics.Paint.Style style)

Sets the style

Parameters:

style -

Returns:

The current IconExtDrawable for chaining.

typeface

public IconicsDrawable typeface(android.graphics.Typeface typeface)

sets the typeface of the drawable NOTE THIS WILL OVERWRITE THE ICONFONT!

Parameters:

typeface -

Returns:

draw

public void draw(android.graphics.Canvas canvas)

Specified by:

draw in class android.graphics.drawable.Drawable

setTint

public void setTint(int tintColor)

Overrides:

setTint in class android.graphics.drawable.Drawable

setTintList

public void setTintList(android.content.res.ColorStateList tint)

Overrides:

setTintList in class android.graphics.drawable.Drawable

setTintMode

public void setTintMode(@NonNull
                        android.graphics.PorterDuff.Mode tintMode)

Overrides:

setTintMode in class android.graphics.drawable.Drawable

onBoundsChange

protected void onBoundsChange(android.graphics.Rect bounds)

Overrides:

onBoundsChange in class android.graphics.drawable.Drawable

isStateful

public boolean isStateful()

Overrides:

isStateful in class android.graphics.drawable.Drawable

setState

public boolean setState(int[] stateSet)

Overrides:

setState in class android.graphics.drawable.Drawable

onStateChange

protected boolean onStateChange(int[] stateSet)

Overrides:

onStateChange in class android.graphics.drawable.Drawable

getIntrinsicWidth

public int getIntrinsicWidth()

Overrides:

getIntrinsicWidth in class android.graphics.drawable.Drawable

getIntrinsicHeight

public int getIntrinsicHeight()

Overrides:

getIntrinsicHeight in class android.graphics.drawable.Drawable

getOpacity

public int getOpacity()

Specified by:

getOpacity in class android.graphics.drawable.Drawable

setAlpha

public void setAlpha(int alpha)

Specified by:

setAlpha in class android.graphics.drawable.Drawable

getAlpha

public int getAlpha()

Overrides:

getAlpha in class android.graphics.drawable.Drawable

getIcon

public IIcon getIcon()

Returns:

the IIcon which is used inside this IconicsDrawable

getPlainIcon

public java.lang.String getPlainIcon()

Returns:

the PlainIcon which is used inside this IconicsDrawable

getCompatAlpha

public int getCompatAlpha()

just a helper method to get the alpha value

Returns:

setColorFilter

public void setColorFilter(android.graphics.ColorFilter cf)

Specified by:

setColorFilter in class android.graphics.drawable.Drawable

clearColorFilter

public void clearColorFilter()

Overrides:

clearColorFilter in class android.graphics.drawable.Drawable

toBitmap

public android.graphics.Bitmap toBitmap()

Creates a BitMap to use in Widgets or anywhere else

Returns:

bitmap to set

clone

public IconicsDrawable clone()

clones the icon

Overrides:

clone in class java.lang.Object

Returns: