Typeface.CustomFallbackBuilder
public
static
final
class
Typeface.CustomFallbackBuilder
extends Object
java.lang.Object | |
↳ | android.graphics.Typeface.CustomFallbackBuilder |
A builder class for creating new Typeface instance. There are two font fallback mechanisms, custom font fallback and system font fallback. The custom font fallback is a simple ordered list. The text renderer tries to see if it can render a character with the first font and if that font does not support the character, try next one and so on. It will keep trying until end of the custom fallback chain. The maximum length of the custom fallback chain is 64. The system font fallback is a system pre-defined fallback chain. The system fallback is processed only when no matching font is found in the custom font fallback.
Examples, 1) Create Typeface from single ttf file.
Font font = new Font.Builder("your_font_file.ttf").build();
FontFamily family = new FontFamily.Builder(font).build();
Typeface typeface = new Typeface.CustomFallbackBuilder(family).build();
Font regularFont = new Font.Builder("regular.ttf").build();
Font boldFont = new Font.Builder("bold.ttf").build();
FontFamily family = new FontFamily.Builder(regularFont)
.addFont(boldFont).build();
Typeface typeface = new Typeface.CustomFallbackBuilder(family)
.setWeight(Font.FONT_WEIGHT_BOLD) // Set bold style as the default style.
// If the font family doesn't have bold style font,
// system will select the closest font.
.build();
Font font = new Font.Builder("your_font_file.ttf").build();
FontFamily family = new FontFamily.Builder(font).build();
Typeface typeface = new Typeface.CustomFallbackBuilder(family)
.setSystemFallback("serif") // Set serif font family as the fallback.
.build();
Font font = new Font.Builder("English.ttf").build();
FontFamily family = new FontFamily.Builder(font).build();
Font fallbackFont = new Font.Builder("Arabic.ttf").build();
FontFamily fallbackFamily = new FontFamily.Builder(fallbackFont).build();
Typeface typeface = new Typeface.CustomFallbackBuilder(family)
.addCustomFallback(fallbackFamily) // Specify fallback family.
.setSystemFallback("serif") // Set serif font family as the fallback.
.build();
Summary
Public constructors | |
---|---|
CustomFallbackBuilder(FontFamily family)
Constructs a builder with a font family. |
Public methods | |
---|---|
Typeface.CustomFallbackBuilder
|
addCustomFallback(FontFamily family)
Append a font family to the end of the custom font fallback. |
Typeface
|
build()
Create the Typeface based on the configured values. |
static
int
|
getMaxCustomFallbackCount()
Returns the maximum capacity of custom fallback families. |
Typeface.CustomFallbackBuilder
|
setStyle(FontStyle style)
Sets a font style of the Typeface. |
Typeface.CustomFallbackBuilder
|
setSystemFallback(String familyName)
Sets a system fallback by name. |
Inherited methods | |
---|---|
Public constructors
CustomFallbackBuilder
public CustomFallbackBuilder (FontFamily family)
Constructs a builder with a font family.
Parameters | |
---|---|
family |
FontFamily : a family object
This value cannot be null . |
Public methods
addCustomFallback
public Typeface.CustomFallbackBuilder addCustomFallback (FontFamily family)
Append a font family to the end of the custom font fallback. You can set up to 64 custom fallback families including the first font family you passed to the constructor. For more information about fallback, see class description.
Parameters | |
---|---|
family |
FontFamily : a fallback family
This value cannot be null . |
Returns | |
---|---|
Typeface.CustomFallbackBuilder |
This value cannot be null . |
Throws | |
---|---|
IllegalArgumentException |
if you give more than 64 custom fallback families |
build
public Typeface build ()
Create the Typeface based on the configured values.
Returns | |
---|---|
Typeface |
the Typeface object
This value cannot be null . |
getMaxCustomFallbackCount
public static int getMaxCustomFallbackCount ()
Returns the maximum capacity of custom fallback families. This includes the first font family passed to the constructor. It is guaranteed that the value will be greater than or equal to 64.
Returns | |
---|---|
int |
the maximum number of font families for the custom fallback Value is 64 or greater |
setStyle
public Typeface.CustomFallbackBuilder setStyle (FontStyle style)
Sets a font style of the Typeface. If the font family doesn't have a font of given style, system will select the closest font from font family. For example, if a font family has fonts of 300 weight and 700 weight then setWeight(400) is called, system will select the font of 300 weight.
Parameters | |
---|---|
style |
FontStyle : a font style
This value cannot be null . |
Returns | |
---|---|
Typeface.CustomFallbackBuilder |
This value cannot be null . |
setSystemFallback
public Typeface.CustomFallbackBuilder setSystemFallback (String familyName)
Sets a system fallback by name. You can specify generic font family names or OEM specific family names. If the system don't have a specified fallback, the default fallback is used instead. For more information about generic font families, see CSS specification For more information about fallback, see class description.
Parameters | |
---|---|
familyName |
String : a family name to be used for fallback if the provided fonts can not be
used
This value cannot be null . |
Returns | |
---|---|
Typeface.CustomFallbackBuilder |
This value cannot be null . |