class Text : LayoutElementBuilders.LayoutElement

ProtoLayout component Text that represents text object holding any information.

There are pre-built typography styles that can be obtained from constants in .

When accessing the contents of a container for testing, note that this element can't be simply casted back to the original type, i.e.: 

Text text = new Text...
Box box = new Box.Builder().addContent(text).build();

Text myText = (Text) box.getContents().get(0);
will fail.

To be able to get Text object from any layout element, fromLayoutElement method should be used, i.e.: 

Text myText = Text.fromLayoutElement(box.getContents().get(0));

Summary

Nested types

Builder class for Text.

Public functions
java-static Text?

Returns Material Text object from the given LayoutElement (e.g. one retrieved from a container's content with container.getContents().get(index)) if that element can be converted to Material Text.
ColorBuilders.ColorProp

Returns the color of this Text element.
LayoutElementBuilders.FontStyle

Returns the font style of this Text element.
Float

Returns the line height of this Text element.
Int

Returns the max lines of text of this Text element.
ModifiersBuilders.Modifiers

Returns the modifiers of this Text element.
Int

Returns the multiline alignment of this Text element.
Int

Returns the overflow of this Text element.
TypeBuilders.StringProp

Returns the text of this Text element.
Int

Returns the overflow of this Text element.
Boolean

Returns whether the Text is in italic.
Boolean

Returns whether the Text is underlined.

Public functions

fromLayoutElement

Added in 1.0.0
java-static fun fromLayoutElement(element: LayoutElementBuilders.LayoutElement): Text?

Returns Material Text object from the given LayoutElement (e.g. one retrieved from a container's content with container.getContents().get(index)) if that element can be converted to Material Text. Otherwise, it will return null.

getColor

Added in 1.0.0
fun getColor(): ColorBuilders.ColorProp

Returns the color of this Text element.

getFontStyle

Added in 1.0.0
fun getFontStyle(): LayoutElementBuilders.FontStyle

Returns the font style of this Text element.

getLineHeight

Added in 1.0.0
fun getLineHeight(): Float

Returns the line height of this Text element.

getMaxLines

Added in 1.0.0
fun getMaxLines(): Int

Returns the max lines of text of this Text element.

getModifiers

Added in 1.0.0
fun getModifiers(): ModifiersBuilders.Modifiers

Returns the modifiers of this Text element.

getMultilineAlignment

Added in 1.0.0
fun getMultilineAlignment(): Int

Returns the multiline alignment of this Text element.

getOverflow

Added in 1.0.0
fun getOverflow(): Int

Returns the overflow of this Text element.

getText

Added in 1.0.0
fun getText(): TypeBuilders.StringProp

Returns the text of this Text element.

getWeight

Added in 1.0.0
fun getWeight(): Int

Returns the overflow of this Text element.

isItalic

Added in 1.0.0
fun isItalic(): Boolean

Returns whether the Text is in italic.

isUnderline

Added in 1.0.0
fun isUnderline(): Boolean

Returns whether the Text is underlined.