com.hootsuite.nachos.chip

Class ChipSpan

java.lang.Object

android.text.style.CharacterStyle

android.text.style.MetricAffectingSpan

android.text.style.ReplacementSpan

android.text.style.DynamicDrawableSpan

android.text.style.ImageSpan

com.hootsuite.nachos.chip.ChipSpan

All Implemented Interfaces:

android.text.style.UpdateAppearance, android.text.style.UpdateLayout, Chip

public class ChipSpan
extends android.text.style.ImageSpan
implements Chip

A Span that displays text and an optional icon inside of a material design chip. The chip's dimensions, colors etc. can be extensively customized through the various setter methods available in this class. The basic structure of the chip is the following: For chips with the icon on right:

                                  (chip vertical spacing / 2)
                  ----------------------------------------------------------
                |                                                            |
 (left margin)  |  (padding edge)   text   (padding between image)   icon    |   (right margin)
                |                                                            |
                  ----------------------------------------------------------
                                  (chip vertical spacing / 2)

      

For chips with the icon on the left (see setShowIconOnLeft(boolean)):

                                  (chip vertical spacing / 2)
                  ----------------------------------------------------------
                |                                                            |
 (left margin)  |   icon  (padding between image)   text   (padding edge)    |   (right margin)
                |                                                            |
                  ----------------------------------------------------------
                                  (chip vertical spacing / 2)
     

Field Summary

Fields inherited from class android.text.style.DynamicDrawableSpan

ALIGN_BASELINE, ALIGN_BOTTOM, mVerticalAlignment

Constructor Summary

Constructors

Constructor and Description
ChipSpan(android.content.Context context, java.lang.CharSequence text, android.graphics.drawable.Drawable icon, java.lang.Object data) Constructs a new ChipSpan.
ChipSpan(android.content.Context context, ChipSpan chipSpan) Copy constructor to recreate a ChipSpan from an existing one

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas canvas, java.lang.CharSequence text, int start, int end, float x, int top, int y, int bottom, android.graphics.Paint paint)
java.lang.Object	getData()
int	getSize(android.graphics.Paint paint, java.lang.CharSequence text, int start, int end, android.graphics.Paint.FontMetricsInt fm)
java.lang.CharSequence	getText()
int	getWidth()
void	invalidateCachedSize()
void	setBackgroundColor(android.content.res.ColorStateList backgroundColor) Sets the background color.
void	setChipHeight(int chipHeight) Sets the height of the chip.
void	setChipVerticalSpacing(int chipVerticalSpacing) Sets the vertical spacing to include in between chips.
void	setCornerRadius(int cornerRadius) Sets the chip background corner radius.
void	setIconBackgroundColor(int iconBackgroundColor) Sets the icon background color.
void	setLeftMargin(int leftMarginPx) Sets the left margin.
void	setMaxAvailableWidth(int maxAvailableWidth)
void	setRightMargin(int rightMarginPx) Sets the right margin.
void	setShowIconOnLeft(boolean showIconOnLeft) Sets where the icon (if an icon was provided in the constructor) will appear.
void	setState(int[] stateSet) Sets the UI state.
void	setTextColor(int color) Sets the color for the chip's text.
void	setTextSize(int size) Sets the font size for the chip's text.
java.lang.String	toString()

Methods inherited from class android.text.style.ImageSpan

getDrawable, getSource

Methods inherited from class android.text.style.DynamicDrawableSpan

getVerticalAlignment

Methods inherited from class android.text.style.ReplacementSpan

updateDrawState, updateMeasureState

Methods inherited from class android.text.style.MetricAffectingSpan

getUnderlying

Methods inherited from class android.text.style.CharacterStyle

wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

ChipSpan

public ChipSpan(android.content.Context context,
                java.lang.CharSequence text,
                android.graphics.drawable.Drawable icon,
                java.lang.Object data)

Constructs a new ChipSpan.

Parameters:

context - a Context that will be used to retrieve default configurations from resource files

text - the text for the ChipSpan to display

icon - an optional icon (can be null) for the ChipSpan to display

ChipSpan

public ChipSpan(android.content.Context context,
                ChipSpan chipSpan)

Copy constructor to recreate a ChipSpan from an existing one

Parameters:

context - a Context that will be used to retrieve default configurations from resource files

chipSpan - the ChipSpan to copy

Method Detail

getData

public java.lang.Object getData()

Specified by:

getData in interface Chip

Returns:

the data associated with this Chip or null if no data is associated with it

setChipHeight

public void setChipHeight(int chipHeight)

Sets the height of the chip. This height should not include any extra spacing (for extra vertical spacing call setChipVerticalSpacing(int)). The background of the chip will fill the full height provided here. If this method is never called, the chip will have the height of one full line of text by default. If -1 is passed here, the chip will revert to this default behavior.

Parameters:

chipHeight - the height to set in pixels

setChipVerticalSpacing

public void setChipVerticalSpacing(int chipVerticalSpacing)

Sets the vertical spacing to include in between chips. Half of the value set here will be placed as empty space above the chip and half the value will be placed as empty space below the chip. Therefore chips on consecutive lines will have the full value as vertical space in between them. This spacing is achieved by adjusting the font metrics used by the text view containing these chips; however it does not come into effect until at least one chip is created. Note that vertical spacing is dependent on having a fixed chip height (set in setChipHeight(int)). If a height is not specified in that method, the value set here will be ignored.

Parameters:

chipVerticalSpacing - the vertical spacing to set in pixels

setTextSize

public void setTextSize(int size)

Sets the font size for the chip's text. If this method is never called, the chip text will have the same font size as the text in the TextView containing this chip by default. If -1 is passed here, the chip will revert to this default behavior.

Parameters:

size - the font size to set in pixels

setTextColor

public void setTextColor(int color)

Sets the color for the chip's text.

Parameters:

color - the color to set (as a hexadecimal number in the form 0xAARRGGBB)

setShowIconOnLeft

public void setShowIconOnLeft(boolean showIconOnLeft)

Sets where the icon (if an icon was provided in the constructor) will appear.

Parameters:

showIconOnLeft - if true, the icon will appear on the left, otherwise the icon will appear on the right

setLeftMargin

public void setLeftMargin(int leftMarginPx)

Sets the left margin. This margin will appear as empty space (it will not share the chip's background color) to the left of the chip.

Parameters:

leftMarginPx - the left margin to set in pixels

setRightMargin

public void setRightMargin(int rightMarginPx)

Sets the right margin. This margin will appear as empty space (it will not share the chip's background color) to the right of the chip.

Parameters:

rightMarginPx - the right margin to set in pixels

setBackgroundColor

public void setBackgroundColor(android.content.res.ColorStateList backgroundColor)

Sets the background color. To configure which color in the ColorStateList is shown you can call setState(int[]). Passing null here will cause the chip to revert to it's default background.

Parameters:

backgroundColor - a ColorStateList containing backgrounds for different states.

See Also:

setState(int[])

setCornerRadius

public void setCornerRadius(int cornerRadius)

Sets the chip background corner radius.

Parameters:

cornerRadius - The corner radius value, in pixels.

setIconBackgroundColor

public void setIconBackgroundColor(int iconBackgroundColor)

Sets the icon background color. This is the color of the circle that gets drawn behind the icon passed to the ChipSpan(Context, CharSequence, Drawable, Object) constructor}

Parameters:

iconBackgroundColor - the icon background color to set (as a hexadecimal number in the form 0xAARRGGBB)

setMaxAvailableWidth

public void setMaxAvailableWidth(int maxAvailableWidth)

setState

public void setState(int[] stateSet)

Sets the UI state. This state will be reflected in the background color drawn for the chip.

Specified by:

setState in interface Chip

Parameters:

stateSet - one of the state constants in View

See Also:

setBackgroundColor(ColorStateList)

getText

public java.lang.CharSequence getText()

Specified by:

getText in interface Chip

Returns:

the text represented by this Chip

getWidth

public int getWidth()

Specified by:

getWidth in interface Chip

Returns:

the width of the Chip or -1 if the Chip hasn't been given the chance to calculate its width

getSize

public int getSize(android.graphics.Paint paint,
                   java.lang.CharSequence text,
                   int start,
                   int end,
                   android.graphics.Paint.FontMetricsInt fm)

Overrides:

getSize in class android.text.style.DynamicDrawableSpan

invalidateCachedSize

public void invalidateCachedSize()

draw

public void draw(android.graphics.Canvas canvas,
                 java.lang.CharSequence text,
                 int start,
                 int end,
                 float x,
                 int top,
                 int y,
                 int bottom,
                 android.graphics.Paint paint)

Overrides:

draw in class android.text.style.DynamicDrawableSpan

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object