Text
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);
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 |
|---|
class Text.BuilderBuilder class for |
Public functions |
|
|---|---|
java-static Text? |
Returns Material Text object from the given LayoutElement (e.g. one retrieved from a container's content with |
ColorBuilders.ColorProp |
getColor()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 |
getText()Returns the text of this Text element. |
Int |
Returns the overflow of this Text element. |
Boolean |
isItalic()Returns whether the Text is in italic. |
Boolean |
Returns whether the Text is underlined. |
Public functions
fromLayoutElement
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
fun getColor(): ColorBuilders.ColorProp
Returns the color of this Text element.
getFontStyle
fun getFontStyle(): LayoutElementBuilders.FontStyle
Returns the font style of this Text element.
getLineHeight
fun getLineHeight(): Float
Returns the line height of this Text element.
getMaxLines
fun getMaxLines(): Int
Returns the max lines of text of this Text element.
getModifiers
fun getModifiers(): ModifiersBuilders.Modifiers
Returns the modifiers of this Text element.
getMultilineAlignment
fun getMultilineAlignment(): Int
Returns the multiline alignment of this Text element.
getText
fun getText(): TypeBuilders.StringProp
Returns the text of this Text element.