Typeface
  public
  
  
  
  class
  Typeface
  
    extends Object
  
  
  
  
  
  
| java.lang.Object | |
| ↳ | android.graphics.Typeface | 
The Typeface class specifies the typeface and intrinsic style of a font. This is used in the paint, along with optionally Paint settings like textSize, textSkewX, textScaleX to specify how text appears when drawn (and measured).
Summary
| Nested classes | |
|---|---|
| 
        
        
        
        
        class | Typeface.BuilderA builder class for creating new Typeface instance. | 
| 
        
        
        
        
        class | Typeface.CustomFallbackBuilderA builder class for creating new Typeface instance. | 
| Constants | |
|---|---|
| int | BOLD
 | 
| int | BOLD_ITALIC
 | 
| int | ITALIC
 | 
| int | NORMAL
 | 
| Fields | |
|---|---|
| 
    public
    static
    final
    Typeface | DEFAULTThe default NORMAL typeface object | 
| 
    public
    static
    final
    Typeface | DEFAULT_BOLDThe default BOLD typeface object. | 
| 
    public
    static
    final
    Typeface | MONOSPACEThe NORMAL style of the default monospace typeface. | 
| 
    public
    static
    final
    Typeface | SANS_SERIFThe NORMAL style of the default sans serif typeface. | 
| 
    public
    static
    final
    Typeface | SERIFThe NORMAL style of the default serif typeface. | 
| Public methods | |
|---|---|
| 
        
        
        static
        
        
        Typeface | 
      create(Typeface family, int weight, boolean italic)
      Creates a typeface object that best matches the specified existing typeface and the specified weight and italic style Below are numerical values and corresponding common weight names. | 
| 
        
        
        static
        
        
        Typeface | 
      create(Typeface family, int style)
      Create a typeface object that best matches the specified existing typeface and the specified Style. | 
| 
        
        
        static
        
        
        Typeface | 
      create(String familyName, int style)
      Create a typeface object given a family name, and option style information. | 
| 
        
        
        static
        
        
        Typeface | 
      createFromAsset(AssetManager mgr, String path)
      Create a new typeface from the specified font data. | 
| 
        
        
        static
        
        
        Typeface | 
      createFromFile(File file)
      Create a new typeface from the specified font file. | 
| 
        
        
        static
        
        
        Typeface | 
      createFromFile(String path)
      Create a new typeface from the specified font file. | 
| 
        
        
        static
        
        
        Typeface | 
      defaultFromStyle(int style)
      Returns one of the default typeface objects, based on the specified style | 
| 
        
        
        
        
        
        boolean | 
      equals(Object o)
      Indicates whether some other object is "equal to" this one. | 
| 
        
        
        
        
        
        int | 
      getStyle()
      Returns the typeface's intrinsic style attributes | 
| 
        
        
        
        final
        
        String | 
      getSystemFontFamilyName()
      Returns the system font family name if the typeface was created from a system font family, otherwise returns null. | 
| 
        
        
        
        
        
        int | 
      getWeight()
      Returns the typeface's weight value | 
| 
        
        
        
        
        
        int | 
      hashCode()
      Returns a hash code value for the object. | 
| 
        
        
        
        final
        
        boolean | 
      isBold()
      Returns true if getStyle() has the BOLD bit set. | 
| 
        
        
        
        final
        
        boolean | 
      isItalic()
      Returns true if getStyle() has the ITALIC bit set. | 
| Inherited methods | |
|---|---|
Constants
Fields
DEFAULT
public static final Typeface DEFAULT
The default NORMAL typeface object
DEFAULT_BOLD
public static final Typeface DEFAULT_BOLD
The default BOLD typeface object. Note: this may be not actually be bold, depending on what fonts are installed. Call getStyle() to know for sure.
MONOSPACE
public static final Typeface MONOSPACE
The NORMAL style of the default monospace typeface.
SANS_SERIF
public static final Typeface SANS_SERIF
The NORMAL style of the default sans serif typeface.
SERIF
public static final Typeface SERIF
The NORMAL style of the default serif typeface.
Public methods
create
public static Typeface create (Typeface family, int weight, boolean italic)
Creates a typeface object that best matches the specified existing typeface and the specified weight and italic style
Below are numerical values and corresponding common weight names.
| Value | Common weight name | 
|---|---|
| 100 | Thin | 
| 200 | Extra Light | 
| 300 | Light | 
| 400 | Normal | 
| 500 | Medium | 
| 600 | Semi Bold | 
| 700 | Bold | 
| 800 | Extra Bold | 
| 900 | Black | 
This method is thread safe.
| Parameters | |
|---|---|
| family | Typeface: An existingTypefaceobject. In case ofnull, the default
               typeface is used instead. | 
| weight | int: The desired weight to be drawn.
 Value is between 1 and 1000 inclusive | 
| italic | boolean:trueif italic style is desired to be drawn. Otherwise,false | 
| Returns | |
|---|---|
| Typeface | A Typefaceobject for drawing specified weight and italic style. Never
         returnsnull | 
See also:
create
public static Typeface create (Typeface family, int style)
Create a typeface object that best matches the specified existing typeface and the specified Style. Use this call if you want to pick a new style from the same family of an existing typeface object. If family is null, this selects from the default font's family.
This method is not thread safe on API 27 or before. This method is thread safe on API 28 or after.
| Parameters | |
|---|---|
| family | Typeface: An existingTypefaceobject. In case ofnull, the default
               typeface is used instead. | 
| style | int: The style (normal, bold, italic) of the typeface.
               e.g. NORMAL, BOLD, ITALIC, BOLD_ITALIC
 Value isNORMAL,BOLD,ITALIC, orBOLD_ITALIC | 
| Returns | |
|---|---|
| Typeface | The best matching typeface. | 
create
public static Typeface create (String familyName, int style)
Create a typeface object given a family name, and option style information. If null is passed for the name, then the "default" font will be chosen. The resulting typeface object can be queried (getStyle()) to discover what its "real" style characteristics are.
| Parameters | |
|---|---|
| familyName | String: May be null. The name of the font family. | 
| style | int: The style (normal, bold, italic) of the typeface.
               e.g. NORMAL, BOLD, ITALIC, BOLD_ITALIC
 Value isNORMAL,BOLD,ITALIC, orBOLD_ITALIC | 
| Returns | |
|---|---|
| Typeface | The best matching typeface. | 
createFromAsset
public static Typeface createFromAsset (AssetManager mgr, String path)
Create a new typeface from the specified font data.
| Parameters | |
|---|---|
| mgr | AssetManager: The application's asset manager | 
| path | String: The file name of the font data in the assets directory | 
| Returns | |
|---|---|
| Typeface | The new typeface. | 
createFromFile
public static Typeface createFromFile (File file)
Create a new typeface from the specified font file.
| Parameters | |
|---|---|
| file | File: The path to the font data.
 This value may benull. | 
| Returns | |
|---|---|
| Typeface | The new typeface. | 
createFromFile
public static Typeface createFromFile (String path)
Create a new typeface from the specified font file.
| Parameters | |
|---|---|
| path | String: The full path to the font data.
 This value may benull. | 
| Returns | |
|---|---|
| Typeface | The new typeface. | 
defaultFromStyle
public static Typeface defaultFromStyle (int style)
Returns one of the default typeface objects, based on the specified style
| Parameters | |
|---|---|
| style | int: Value isNORMAL,BOLD,ITALIC, orBOLD_ITALIC | 
| Returns | |
|---|---|
| Typeface | the default typeface that corresponds to the style | 
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
 The equals method implements an equivalence relation
 on non-null object references:
 
- It is reflexive: for any non-null reference value
     x,x.equals(x)should returntrue.
- It is symmetric: for any non-null reference values
     xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue.
- It is transitive: for any non-null reference values
     x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
- It is consistent: for any non-null reference values
     xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified.
- For any non-null reference value x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
| o | Object: the reference object with which to compare. | 
| Returns | |
|---|---|
| boolean | trueif this object is the same as the obj
          argument;falseotherwise. | 
getStyle
public int getStyle ()
Returns the typeface's intrinsic style attributes
| Returns | |
|---|---|
| int | Value is NORMAL,BOLD,ITALIC, orBOLD_ITALIC | 
getSystemFontFamilyName
public final String getSystemFontFamilyName ()
Returns the system font family name if the typeface was created from a system font family, otherwise returns null.
| Returns | |
|---|---|
| String | |
getWeight
public int getWeight ()
Returns the typeface's weight value
| Returns | |
|---|---|
| int | Value is between 0 and 1000 inclusive | 
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
 supported for the benefit of hash tables such as those provided by
 HashMap.
 
 The general contract of hashCode is:
 
- Whenever it is invoked on the same object more than once during
     an execution of a Java application, the hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result.
- It is not required that if two objects are unequal
     according to the equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Returns | |
|---|---|
| int | a hash code value for this object. | 
isBold
public final boolean isBold ()
Returns true if getStyle() has the BOLD bit set.
| Returns | |
|---|---|
| boolean | |
isItalic
public final boolean isItalic ()
Returns true if getStyle() has the ITALIC bit set.
| Returns | |
|---|---|
| boolean | |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
