universum.studios.android.font

Class Font

java.lang.Object

universum.studios.android.font.Font

public final class Font
extends Object

Font is a simple wrapper class around graphics Typeface object. Each Font instance is required to be created with a relative path to its corresponding .ttf font file that is placed within assets directory. A new Font instance may be created directly via Font(String) constructor, however it is encouraged to create new instances of Font via one of create(String), create(Context, int) or create(Context, AttributeSet, int, int) factory methods, because these methods ensure that already created fonts are reused across entire Android application which definitely improves performance as creation of a single Typeface object via Typeface.createFromAsset(AssetManager, String) is a costly operation.

This library supports only .ttf font files. Each font file is required to be placed within assets directory of the corresponding application. A base path to font files may be specified via setBasePath(String) which will be used by the Font class when building full path to a specific .ttf file whenever its Typeface needs to be created. When base path is used all paths to .ttf files specified via uiFont may be relative in association to that base path. Relative path to a specific true typeface font file may or may not have specified .ttf suffix. If the suffix is not specified, this class ads such suffix automatically.

Typeface object of a specific Font instance may be obtained via getTypeface(Context).

Since:

1.0

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
static String	FONT_DIR Sub-directory within an application assets folder where should be, by default, placed all custom font files.
static String	TTF_SUFFIX Suffix for original true Typeface fonts.

Constructor Summary

Constructors

Constructor and Description
Font(String filePath) Creates a new instance of Font with the specified path that points to a .ttf file within assets folder.

Method Summary

Modifier and Type	Method and Description
static void	clearCache() Clears the current cache with already created and cached Font instances.
static Font	create(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes) Creates a new instance of Font with the font path obtained from the given attrs set.
static Font	create(android.content.Context context, int style) Creates a new instance of Font with the font path obtained from the given style.
static Font	create(String filePath) Creates an instance of Font with the given file path.
String	getFilePath() Returns the path to the font file that is represented by this font instance.
android.graphics.Typeface	getTypeface(android.content.Context context) Returns instance of the Typeface which is created for the .ttf file of this font instance.
static void	setBasePath(String basePath) Specifies a base path at which are stored font .ttf files that are to be created via create(String) and cached by this Font class.
static void	setLogLevel(int level) Sets a logging level determining at which level should be visible messages logged by Font class into console via Log utility.

Methods inherited from class java.lang.Object

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

Field Detail

TTF_SUFFIX

public static final String TTF_SUFFIX

Suffix for original true Typeface fonts.

Constant value: .ttf

See Also:

Constant Field Values

FONT_DIR

public static final String FONT_DIR

Sub-directory within an application assets folder where should be, by default, placed all custom font files.

However, this directory may contain custom sub-directories in order to group related fonts together.

Constant value: font/

See Also:

setBasePath(String)

Constructor Detail

Font

public Font(@NonNull
            String filePath)

Creates a new instance of Font with the specified path that points to a .ttf file within assets folder.

Consider using create(String) instead which may return already created and cached instance of Font.

Note that empty or null paths are not allowed.

Only .ttf font files are supported!

Parameters:

filePath - Relative path to the .ttf file (with or without .ttf suffix) placed within an application assets directory which will be represented by the newly created Font instance.

Throws:

IllegalArgumentException - If the given filePath is empty.

Method Detail

setLogLevel

public static void setLogLevel(int level)

Sets a logging level determining at which level should be visible messages logged by Font class into console via Log utility.

Note that the current implementation of Font class logs only messages at Log.DEBUG level.

Default value: Log.ASSERT

Parameters:

level - The desired log level.

setBasePath

public static void setBasePath(@Nullable
                               String basePath)

Specifies a base path at which are stored font .ttf files that are to be created via create(String) and cached by this Font class.

The specified path is used to build a full path to a specific font file whenever its representing Typeface needs to be created via Typeface.createFromAsset(AssetManager, String).

Default value: FONT_DIR

Parameters:

basePath - The desired base path within Android assets folder. May be null to not use any base path, when in such case the uiFont attribute or path specified via create(String) should always contain a full path to a desired font file. May be null to indicate that the default path should be used.

create

@Nullable
public static Font create(@NonNull
                                    android.content.Context context,
                                    @Nullable
                                    android.util.AttributeSet attrs,
                                    @AttrRes
                                    int defStyleAttr,
                                    @StyleRes
                                    int defStyleRes)

Creates a new instance of Font with the font path obtained from the given attrs set.

Parameters:

context - Context used to process the given attributes set.

attrs - Attributes set which that is expected to have uiFont attribute specified with font path.

defStyleAttr - An attribute of the default style presented within the current theme which supplies default attributes for TypedArray.

defStyleRes - Resource id of the default style used when the defStyleAttr is 0 or the current theme does not have style for defStyleAttr specified.

Returns:

New or cached instance of Font or null if font path parsed from the given attributes set is invalid.

See Also:

create(String), create(Context, int)

create

@Nullable
public static Font create(@NonNull
                                    android.content.Context context,
                                    @StyleRes
                                    int style)

Creates a new instance of Font with the font path obtained from the given style.

Parameters:

context - Context used to process the given style.

style - Resource id of the desired style that is expected to have uiFont attribute specified with font path.

Returns:

New or cached instance of Font or null if font path parsed from the given style is invalid.

See Also:

create(String), create(Context, AttributeSet, int, int)

create

@NonNull
public static Font create(@NonNull
                                   String filePath)

Creates an instance of Font with the given file path.

Returns:

New or cached instance of Font for the specified path.

Throws:

IllegalArgumentException - If the given filePath is empty.

See Also:

create(Context, AttributeSet, int, int), create(Context, int), Font(String)

clearCache

public static void clearCache()

Clears the current cache with already created and cached Font instances.

Note that this will not invalidate those instances as they may be in use across the application.

getFilePath

@NonNull
public String getFilePath()

Returns the path to the font file that is represented by this font instance.

Returns:

Full path to the .ttf file within an application assets folder.

See Also:

create(String), setBasePath(String)

getTypeface

@NonNull
public android.graphics.Typeface getTypeface(@NonNull
                                                      android.content.Context context)

Returns instance of the Typeface which is created for the .ttf file of this font instance.

Subsequent calls to this method will return already created and cached Typeface object.

Parameters:

context - Valid context used to create requested TypeFace.

Returns:

Typeface associated with this font instance.

Throws:

IllegalArgumentException - If font file at the path specified for this font does not exist or it is not a valid .ttf file.

See Also:

Typeface.createFromAsset(android.content.res.AssetManager, String)