LayoutElementBuilders.FontStyle
@RequiresSchemaVersion(major = 1, minor = 0)
class LayoutElementBuilders.FontStyle
The styling of a font (e.g. font size, and metrics).
Summary
Nested types |
|---|
|
Builder for |
Public functions |
|
|---|---|
ColorBuilders.ColorProp? |
getColor()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? |
getSize()Gets the size of the font, in scaled pixels (sp). |
(Mutable)List<DimensionBuilders.SpProp!> |
Gets the available sizes 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. |
String |
toString() |
Public functions
getColor
fun getColor(): ColorBuilders.ColorProp?
Gets the text color. If not defined, defaults to white.
While this field is statically accessible from 1.0, it's only bindable since version 1.2 and renderers supporting version 1.2 will use the dynamic value (if set).
getItalic
fun getItalic(): TypeBuilders.BoolProp?
Gets whether the text should be rendered in a italic typeface. If not specified, defaults to "false".
getLetterSpacing
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.
getSize
fun getSize(): DimensionBuilders.SpProp?
Gets the size of the font, in scaled pixels (sp). If more than one size was originally added, it will return the last one.
getSizes
@ProtoLayoutExperimental
fun getSizes(): (Mutable)List<DimensionBuilders.SpProp!>
Gets the available sizes of the font, in scaled pixels (sp).
getUnderline
fun getUnderline(): TypeBuilders.BoolProp?
Gets whether the text should be rendered with an underline. If not specified, defaults to "false".
getVariant
@ProtoLayoutExperimental
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".
getWeight
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".