FontsContract

public class FontsContract
extends Object

java.lang.Object
   ↳ android.provider.FontsContract


Utility class to deal with Font ContentProviders.

Summary

Nested classes

class FontsContract.Columns

Defines the constants used in a response from a Font Provider. 

class FontsContract.FontFamilyResult

Object returned from fetchFonts(Context, CancellationSignal, FontRequest)

class FontsContract.FontInfo

Object represent a font entry in the family returned from fetchFonts(Context, CancellationSignal, FontRequest)

class FontsContract.FontRequestCallback

Interface used to receive asynchronously fetched typefaces. 

Public methods

static Typeface buildTypeface(Context context, CancellationSignal cancellationSignal, FontInfo[] fonts)

Build a Typeface from an array of FontsContract.FontInfo Results that are marked as not ready will be skipped.

static FontsContract.FontFamilyResult fetchFonts(Context context, CancellationSignal cancellationSignal, FontRequest request)

Fetch fonts given a font request.

static void requestFonts(Context context, FontRequest request, Handler handler, CancellationSignal cancellationSignal, FontsContract.FontRequestCallback callback)

Create a typeface object given a font request.

Inherited methods

Public methods

buildTypeface

added in API level 26
Typeface buildTypeface (Context context, 
                CancellationSignal cancellationSignal, 
                FontInfo[] fonts)

Build a Typeface from an array of FontsContract.FontInfo Results that are marked as not ready will be skipped.

Parameters
context Context: A Context that will be used to fetch the font contents.

This value must never be null.

cancellationSignal CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown.

fonts FontInfo: An array of FontsContract.FontInfo to be used to create a Typeface.

This value must never be null.

Returns
Typeface A Typeface object. Returns null if typeface creation fails.

fetchFonts

added in API level 26
FontsContract.FontFamilyResult fetchFonts (Context context, 
                CancellationSignal cancellationSignal, 
                FontRequest request)

Fetch fonts given a font request.

Parameters
context Context: A Context to be used for fetching fonts.

This value must never be null.

cancellationSignal CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown when the query is executed.

request FontRequest: A FontRequest object that identifies the provider and query for the request.

This value must never be null.

Returns
FontsContract.FontFamilyResult FontsContract.FontFamilyResult

This value will never be null.

Throws
PackageManager.NameNotFoundException If requested package or authority was not found in system.

requestFonts

added in API level 26
void requestFonts (Context context, 
                FontRequest request, 
                Handler handler, 
                CancellationSignal cancellationSignal, 
                FontsContract.FontRequestCallback callback)

Create a typeface object given a font request. The font will be asynchronously fetched, therefore the result is delivered to the given callback. See FontRequest. Only one of the methods in callback will be invoked, depending on whether the request succeeds or fails. These calls will happen on the caller thread. Note that the result Typeface may be cached internally and the same instance will be returned the next time you call this method with the same request. If you want to bypass this cache, use fetchFonts(Context, CancellationSignal, FontRequest) and buildTypeface(Context, CancellationSignal, FontsContract.FontInfo[]) instead.

Parameters
context Context: A context to be used for fetching from font provider.

This value must never be null.

request FontRequest: A FontRequest object that identifies the provider and query for the request. May not be null.

handler Handler: A handler to be processed the font fetching.

This value must never be null.

cancellationSignal CancellationSignal: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown.

callback FontsContract.FontRequestCallback: A callback that will be triggered when results are obtained. May not be null.