LayoutElementBuilders.FontStyle

Added in 1.0.0
Deprecated in 1.2.0

class LayoutElementBuilders.FontStyle

The styling of a font (e.g. font size, and metrics).

Summary

Nested types

Builder for FontStyle

Public functions
ColorBuilders.ColorProp?

Gets the text color.
TypeBuilders.BoolProp?

Gets whether the text should be rendered in a italic typeface.
DimensionBuilders.EmProp?

Gets the text letter-spacing.
DimensionBuilders.SpProp?

Gets the size of the font, in scaled pixels (sp).
TypeBuilders.BoolProp?

Gets whether the text should be rendered with an underline.
LayoutElementBuilders.FontVariantProp?

Gets the variant of a font.
LayoutElementBuilders.FontWeightProp?

Gets the weight of the font.

Public functions

getColor

Added in 1.0.0
Deprecated in 1.2.0
fun getColor(): ColorBuilders.ColorProp?

Gets the text color. If not defined, defaults to white. Intended for testing purposes only.

getItalic

Added in 1.0.0
Deprecated in 1.2.0
fun getItalic(): TypeBuilders.BoolProp?

Gets whether the text should be rendered in a italic typeface. If not specified, defaults to "false". Intended for testing purposes only.

getLetterSpacing

Added in 1.0.0
Deprecated in 1.2.0
fun getLetterSpacing(): DimensionBuilders.EmProp?

Gets the text letter-spacing. Positive numbers increase the space between letters while negative numbers tighten the space. If not specified, defaults to 0. Intended for testing purposes only.

getSize

Added in 1.0.0
Deprecated in 1.2.0
fun getSize(): DimensionBuilders.SpProp?

Gets the size of the font, in scaled pixels (sp). If not specified, defaults to the size of the system's "body" font. Intended for testing purposes only.

getUnderline

Added in 1.0.0
Deprecated in 1.2.0
fun getUnderline(): TypeBuilders.BoolProp?

Gets whether the text should be rendered with an underline. If not specified, defaults to "false". Intended for testing purposes only.

getVariant

Added in 1.0.0
Deprecated in 1.2.0
@TilesExperimental
fun getVariant(): LayoutElementBuilders.FontVariantProp?

Gets the variant of a font. Some renderers may use different fonts for title and body text, which can be selected using this field. If not specified, defaults to "body". Intended for testing purposes only.

getWeight

Added in 1.0.0
Deprecated in 1.2.0
fun getWeight(): LayoutElementBuilders.FontWeightProp?

Gets the weight of the font. If the provided value is not supported on a platform, the nearest supported value will be used. If not defined, or when set to an invalid value, defaults to "normal". Intended for testing purposes only.