me.grantland.widget

Class AutofitHelper

java.lang.Object

me.grantland.widget.AutofitHelper

public class AutofitHelper
extends java.lang.Object

A helper class to enable automatically resizing TextView`s textSize to fit within its bounds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutofitHelper.OnTextSizeChangeListener When an object of a type is attached to an AutofitHelper, its methods will be called when the textSize is changed.

Method Summary

Methods

Modifier and Type	Method and Description
AutofitHelper	addOnTextSizeChangeListener(AutofitHelper.OnTextSizeChangeListener listener) Adds an AutofitHelper.OnTextSizeChangeListener to the list of those whose methods are called whenever the TextView's textSize changes.
static AutofitHelper	create(android.widget.TextView view) Creates a new instance of AutofitHelper that wraps a TextView and enables automatically sizing the text to fit.
static AutofitHelper	create(android.widget.TextView view, android.util.AttributeSet attrs) Creates a new instance of AutofitHelper that wraps a TextView and enables automatically sizing the text to fit.
static AutofitHelper	create(android.widget.TextView view, android.util.AttributeSet attrs, int defStyle) Creates a new instance of AutofitHelper that wraps a TextView and enables automatically sizing the text to fit.
int	getMaxLines()
float	getMaxTextSize() Returns the maximum size (in pixels) of the text.
float	getMinTextSize() Returns the minimum size (in pixels) of the text.
float	getPrecision() Returns the amount of precision used to calculate the correct text size to fit within its bounds.
float	getTextSize() Returns the original text size of the View.
boolean	isEnabled() Returns whether or not automatically resizing text is enabled.
AutofitHelper	removeOnTextSizeChangeListener(AutofitHelper.OnTextSizeChangeListener listener) Removes the specified AutofitHelper.OnTextSizeChangeListener from the list of those whose methods are called whenever the TextView's textSize changes.
AutofitHelper	setEnabled(boolean enabled) Set the enabled state of automatically resizing text.
AutofitHelper	setMaxLines(int lines)
AutofitHelper	setMaxTextSize(float size) Set the maximum text size to the given value, interpreted as "scaled pixel" units.
AutofitHelper	setMaxTextSize(int unit, float size) Set the maximum text size to a given unit and value.
AutofitHelper	setMinTextSize(float size) Set the minimum text size to the given value, interpreted as "scaled pixel" units.
AutofitHelper	setMinTextSize(int unit, float size) Set the minimum text size to a given unit and value.
AutofitHelper	setPrecision(float precision) Set the amount of precision used to calculate the correct text size to fit within its bounds.
void	setTextSize(float size) Set the original text size of the View.
void	setTextSize(int unit, float size) Set the original text size of the View.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AutofitHelper create(android.widget.TextView view)

Creates a new instance of AutofitHelper that wraps a TextView and enables automatically sizing the text to fit.

create

public static AutofitHelper create(android.widget.TextView view,
                   android.util.AttributeSet attrs)

Creates a new instance of AutofitHelper that wraps a TextView and enables automatically sizing the text to fit.

create

public static AutofitHelper create(android.widget.TextView view,
                   android.util.AttributeSet attrs,
                   int defStyle)

Creates a new instance of AutofitHelper that wraps a TextView and enables automatically sizing the text to fit.

addOnTextSizeChangeListener

public AutofitHelper addOnTextSizeChangeListener(AutofitHelper.OnTextSizeChangeListener listener)

Adds an AutofitHelper.OnTextSizeChangeListener to the list of those whose methods are called whenever the TextView's textSize changes.

removeOnTextSizeChangeListener

public AutofitHelper removeOnTextSizeChangeListener(AutofitHelper.OnTextSizeChangeListener listener)

Removes the specified AutofitHelper.OnTextSizeChangeListener from the list of those whose methods are called whenever the TextView's textSize changes.

getPrecision

public float getPrecision()

Returns the amount of precision used to calculate the correct text size to fit within its bounds.

setPrecision

public AutofitHelper setPrecision(float precision)

Set the amount of precision used to calculate the correct text size to fit within its bounds. Lower precision is more precise and takes more time.

Parameters:

precision - The amount of precision.

getMinTextSize

public float getMinTextSize()

Returns the minimum size (in pixels) of the text.

setMinTextSize

public AutofitHelper setMinTextSize(float size)

Set the minimum text size to the given value, interpreted as "scaled pixel" units. This size is adjusted based on the current density and user font size preference.

Parameters:

size - The scaled pixel size.

setMinTextSize

public AutofitHelper setMinTextSize(int unit,
                           float size)

Set the minimum text size to a given unit and value. See TypedValue for the possible dimension units.

Parameters:

unit - The desired dimension unit.

size - The desired size in the given units.

getMaxTextSize

public float getMaxTextSize()

Returns the maximum size (in pixels) of the text.

setMaxTextSize

public AutofitHelper setMaxTextSize(float size)

Set the maximum text size to the given value, interpreted as "scaled pixel" units. This size is adjusted based on the current density and user font size preference.

Parameters:

size - The scaled pixel size.

setMaxTextSize

public AutofitHelper setMaxTextSize(int unit,
                           float size)

Set the maximum text size to a given unit and value. See TypedValue for the possible dimension units.

Parameters:

unit - The desired dimension unit.

size - The desired size in the given units.

getMaxLines

public int getMaxLines()

See Also:

TextView.getMaxLines()

setMaxLines

public AutofitHelper setMaxLines(int lines)

See Also:

TextView.setMaxLines(int)

isEnabled

public boolean isEnabled()

Returns whether or not automatically resizing text is enabled.

setEnabled

public AutofitHelper setEnabled(boolean enabled)

Set the enabled state of automatically resizing text.

getTextSize

public float getTextSize()

Returns the original text size of the View.

See Also:

TextView.getTextSize()

setTextSize

public void setTextSize(float size)

Set the original text size of the View.

See Also:

TextView.setTextSize(float)

setTextSize

public void setTextSize(int unit,
               float size)

Set the original text size of the View.

See Also:

TextView.setTextSize(int, float)