FontsContractCompat

Added in 1.1.0

class FontsContractCompat

Utility class to deal with Font ContentProviders.

Summary

Nested types

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

Object returned from fetchFonts.

Object represent a font entry in the family returned from fetchFonts.

Interface used to receive asynchronously fetched typefaces.

Public functions
java-static Typeface?
buildTypeface(
    context: Context,
    cancellationSignal: CancellationSignal?,
    fonts: Array<FontsContractCompat.FontInfo!>
)

Build a Typeface from an array of FontInfo Results that are marked as not ready will be skipped.
java-static FontsContractCompat.FontFamilyResult
fetchFonts(
    context: Context,
    cancellationSignal: CancellationSignal?,
    request: FontRequest
)

Fetch fonts given a font request.
java-static Unit
requestFont(
    context: Context,
    request: FontRequest,
    callback: FontsContractCompat.FontRequestCallback,
    handler: Handler
)

This function is deprecated.

due to the non-standard pattern of taking a handler for a non-UI thread - leading to both easily passing an incorrect handler and requiring all callers spin up an extra thread.
java-static Unit
requestFont(
    context: Context,
    request: FontRequest,
    style: Int,
    loadingExecutor: Executor?,
    callbackExecutor: Executor,
    callback: FontsContractCompat.FontRequestCallback
)

Request a font async as specified with FontRequest Loading may take several seconds, and the loadingExecutor passed should be available to run blocking requests for several seconds.
java-static Unit
requestFontWithFallbackChain(
    context: Context,
    requests: (Mutable)List<FontRequest!>,
    style: Int,
    loadingExecutor: Executor?,
    callbackExecutor: Executor,
    callback: FontsContractCompat.FontRequestCallback
)

Request a font async as specified with FontRequest Loading may take several seconds, and the loadingExecutor passed should be available to run blocking requests for several seconds.

Public functions

buildTypeface

Added in 1.1.0
java-static fun buildTypeface(
    context: Context,
    cancellationSignal: CancellationSignal?,
    fonts: Array<FontsContractCompat.FontInfo!>
): Typeface?

Build a Typeface from an array of 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.
cancellationSignal: CancellationSignal?

A signal to cancel the operation in progress, or null if none. If the operation is canceled, then will be thrown.
fonts: Array<FontsContractCompat.FontInfo!>

An array of FontInfo to be used to create a Typeface.
Returns
Typeface?

A Typeface object. Returns null if typeface creation fails.

fetchFonts

Added in 1.1.0
java-static fun fetchFonts(
    context: Context,
    cancellationSignal: CancellationSignal?,
    request: FontRequest
): FontsContractCompat.FontFamilyResult

Fetch fonts given a font request.

Parameters
context: Context

A Context to be used for fetching fonts.
cancellationSignal: CancellationSignal?

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

A FontRequest object that identifies the provider and query for the request.
Returns
FontsContractCompat.FontFamilyResult

FontFamilyResult
Throws
android.content.pm.PackageManager.NameNotFoundException

If requested package or authority was not found in the system.

requestFont

Added in 1.1.0
Deprecated in 1.15.0
java-static fun requestFont(
    context: Context,
    request: FontRequest,
    callback: FontsContractCompat.FontRequestCallback,
    handler: Handler
): Unit

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 main thread.

Parameters
context: Context

A context to be used for fetching from font provider.
request: FontRequest

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

A callback that will be triggered when results are obtained. May not be null.
handler: Handler

A handler for running font fetch tasks on.
See also
requestFont

requestFont

Added in 1.15.0
java-static fun requestFont(
    context: Context,
    request: FontRequest,
    style: Int,
    loadingExecutor: Executor?,
    callbackExecutor: Executor,
    callback: FontsContractCompat.FontRequestCallback
): Unit

Request a font async as specified with FontRequest Loading may take several seconds, and the loadingExecutor passed should be available to run blocking requests for several seconds. Results will be returned via callbackExecutor.

Parameters
context: Context

A context to be used for fetching from font provider
request: FontRequest

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

Typeface Style such as NORMAL, BOLDITALIC, BOLD_ITALIC.
loadingExecutor: Executor?

executor to load font on. Loading may take several _seconds_. If null, a default executor shared with other null-requests will be used.
callbackExecutor: Executor

Used to dispatch callback
callback: FontsContractCompat.FontRequestCallback

A callback that will be triggered when results are obtained.

requestFontWithFallbackChain

Added in 1.15.0
java-static fun requestFontWithFallbackChain(
    context: Context,
    requests: (Mutable)List<FontRequest!>,
    style: Int,
    loadingExecutor: Executor?,
    callbackExecutor: Executor,
    callback: FontsContractCompat.FontRequestCallback
): Unit

Request a font async as specified with FontRequest Loading may take several seconds, and the loadingExecutor passed should be available to run blocking requests for several seconds. Results will be returned via callbackExecutor.

Parameters
context: Context

A context to be used for fetching from font provider
requests: (Mutable)List<FontRequest!>

An array of FontRequest objects that identify the provider and query for the request, followed by any fallbacks. Fallbacks are used in the order specified. Note that the performance implications of font fallback scale with the number of fonts involved, so the length of this parameter should be kept to a minimum; we recommend no more than 2 (that is, the primary font and a single downloadable custom fallback).
style: Int

Typeface Style such as NORMAL, BOLDITALIC, BOLD_ITALIC.
loadingExecutor: Executor?

executor to load font on. Loading may take several _seconds_. If null, a default executor shared with other null-requests will be used.
callbackExecutor: Executor

Used to dispatch callback
callback: FontsContractCompat.FontRequestCallback

A callback that will be triggered when results are obtained.