All Implemented Interfaces:: kotlin.Cloneable


public class Text
extends Component

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final TextProperties`	`properties`
`private Float`	`fontSize`
`private final Vec2<Unit>`	`stringSize`
`private final ArrayList<Line>`	`lines`
`private final Boolean`	`full`
`private final Font`	`font`
`private String`	`string`
`private Translator.Text`	`initialText`
`private final TextAlign`	`textAlign`
`private transient PolyColor.Animated`	`color`
`private transient Drawable`	`parent`
`private transient Layout`	`layout`
`private transient Boolean`	`consumesHover`
`private Boolean`	`disabled`
`private Vec2<Unit>`	`size`
`private final transient HashMap<Event, Function2<Drawable, Event, Boolean>>`	`eventHandlers`
`private transient String`	`simpleName`
`private transient Renderer`	`renderer`
`private transient PolyUI`	`polyUI`
`private Boolean`	`acceptsInput`
`private final transient Byte`	`initStage`
`private final transient Boolean`	`mouseOver`
`private Boolean`	`renders`
`private Float`	`x`
`private Float`	`y`
`private Float`	`width`
`private Float`	`height`
`private Boolean`	`exists`
`private transient Float`	`trueX`
`private transient Float`	`trueY`
`private final Unit.Type`	`atType`
`private final Unit.Type`	`sizeType`
`private final Boolean`	`isDynamic`
`private Double`	`rotation`
`private Double`	`skewX`
`private Double`	`skewY`
`private Float`	`scaleX`
`private Float`	`scaleY`
`private Float`	`alpha`
`private transient Float`	`acx`
`private transient Float`	`acy`
`private final Vec2<Unit>`	`at`
`private final Boolean`	`rawResize`

Constructor Summary

Constructors
Constructor	Description
`Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput, Function1<EventDSL<Text>, Unit> events)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(String txt, Vec2<Unit> at, Vec2<Unit> size)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(String txt, Vec2<Unit> at)`	Internally txt is stored as a PolyText object, which supports localization and object substitution
`Text(TextProperties properties, Translator.Text text, Unit fontSize, Vec2<Unit> at)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput, Function1<EventDSL<Text>, Unit> events)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size)`
`Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at)`
`Text(Translator.Text initialText, Vec2<Unit> at)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final TextProperties`	`getProperties()`
`final Float`	`getFontSize()`
`final Unit`	`setFontSize(Float fontSize)`
`final Vec2<Unit>`	`getStringSize()`
`final ArrayList<Line>`	`getLines()`
`final Boolean`	`getFull()`
`final Font`	`getFont()`
`final String`	`getString()`
`final Unit`	`setString(String string)`
`final Translator.Text`	`getInitialText()`
`final Unit`	`setInitialText(Translator.Text initialText)`
`final TextAlign`	`getTextAlign()`
`Float`	`trueX()`	Note that this method will return the x if this method is called before the component is added to a layout.
`Float`	`trueY()`	Note that this method will return the y if this method is called before the component is added to a layout.
`Unit`	`render()`	draw script for this drawable.
`final Line`	`get(Integer index)`
`Unit`	`reset()`	Use this function to reset your drawable's PolyText if it is using one.
`final Triple<Line, Integer, Integer>`	`getLineByIndex(Integer index)`
`Unit`	`rescale(Float scaleX, Float scaleY)`	Method that is called when the physical size of the total window area changes.
`Unit`	`setup(Renderer renderer, PolyUI polyUI)`	give this a renderer reference and a PolyUI reference.
`Unit`	`calculateBounds()`	Calculate the position and size of this drawable.
`Vec2<Unit>`	`calculateSize()`	Implement this function to return the size of this drawable, if no size is specified during construction.

Methods inherited from class org.polyfrost.polyui.component.Component
accept, addKeyframes, addOperation, canBeRemoved, debugRender, draggable, every, getColor, getConsumesHover, getDisabled, getLayout, getParent, getSize, onColorsChanged, onFontsChanged, preRender, recolor, setColor, setConsumesHover, setDisabled, setLayout, setParent, setProperties, setSize, toString, wantRedraw
Methods inherited from class org.polyfrost.polyui.component.Drawable
addEventHandler, addEventhandler, animateBy, animateTo, clone, debugPrint, doDynamicSize, events, fadeBy, fadeTo, getAcceptsInput, getAcx, getAcy, getAlpha, getAt, getAtType, getContainingLayout, getEventHandlers, getExists, getHeight, getInitStage, getMouseOver, getPolyUI, getRawResize, getRenderer, getRenders, getRotation, getScaleX, getScaleY, getSimpleName, getSizeType, getSkewX, getSkewY, getTrueX, getTrueY, getWidth, getX, getY, intersects, isDynamic, isInside, isInside, moveBy, moveTo, onInitComplete, onParentInitComplete, postRender, removeOperation, resize, rotateBy, rotateTo, scaleBy, scaleTo, setAcceptsInput, setAcx, setAcy, setAlpha, setExists, setHeight, setPolyUI, setRenderer, setRenders, setRotation, setScaleX, setScaleY, setSimpleName, setSkewX, setSkewY, setTrueX, setTrueY, setWidth, setX, setY, skewBy, skewTo
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Text
```
Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput, Function1<EventDSL<Text>, Unit> events)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(String txt, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(String txt, Vec2<Unit> at, Vec2<Unit> size)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(String txt, Vec2<Unit> at)
```
    Internally txt is stored as a PolyText object, which supports localization and object substitution
  - Text
```
Text(TextProperties properties, Translator.Text text, Unit fontSize, Vec2<Unit> at)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput, Function1<EventDSL<Text>, Unit> events)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize, Boolean acceptInput)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign, Boolean rawResize)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize, TextAlign textAlign)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size, Unit fontSize)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at, Vec2<Unit> size)
```
  - Text
```
Text(TextProperties properties, Translator.Text initialText, Vec2<Unit> at)
```
  - Text
```
Text(Translator.Text initialText, Vec2<Unit> at)
```
- Method Detail
  - getProperties
```
 final TextProperties getProperties()
```
  - getFontSize
```
 final Float getFontSize()
```
  - setFontSize
```
 final Unit setFontSize(Float fontSize)
```
  - getStringSize
```
 final Vec2<Unit> getStringSize()
```
  - getLines
```
 final ArrayList<Line> getLines()
```
  - getFull
```
 final Boolean getFull()
```
  - getFont
```
 final Font getFont()
```
  - getString
```
 final String getString()
```
  - setString
```
 final Unit setString(String string)
```
  - getInitialText
```
 final Translator.Text getInitialText()
```
  - setInitialText
```
 final Unit setInitialText(Translator.Text initialText)
```
  - getTextAlign
```
 final TextAlign getTextAlign()
```
  - trueX
```
 Float trueX()
```
    Note that this method will return the x if this method is called before the component is added to a layout.
  - trueY
```
 Float trueY()
```
    Note that this method will return the y if this method is called before the component is added to a layout.
  - render
```
 Unit render()
```
    draw script for this drawable.
  - get
```
 final Line get(Integer index)
```
  - reset
```
 Unit reset()
```
    Use this function to reset your drawable's PolyText if it is using one.
  - getLineByIndex
```
 final Triple<Line, Integer, Integer> getLineByIndex(Integer index)
```
    Returns:
    
    the Line that encapsulates this character, the index of the character relative to the start of the line, and the index of this line
    
    Since:
    
    0.18.5
  - rescale
```
 Unit rescale(Float scaleX, Float scaleY)
```
    Method that is called when the physical size of the total window area changes.
  - setup
```
 Unit setup(Renderer renderer, PolyUI polyUI)
```
    give this a renderer reference and a PolyUI reference.
    You can also use this method to do some calculations (such as text widths) that are not dependent on other sizes.
    If you need a method that has access to component's sizes, see here or here (if you are operating on yourself only).
    this method is called once, and only once.
  - calculateBounds
```
 Unit calculateBounds()
```
    Calculate the position and size of this drawable. Make sure to call doDynamicSize in this method to avoid issues with sizing.
    This method is called once the layout is populated for children and component, and when a recalculation is requested.
    The value of layout's bounds will be updated after this method is called, so do not use layout's bounds as an updated value in this method.
  - calculateSize
```
 Vec2<Unit> calculateSize()
```
    Implement this function to return the size of this drawable, if no size is specified during construction.
    This should be so that if the drawable can determine its own size (for example, it is an image), then the size parameter in the constructor can be omitted using:
    size: Vec2<org.polyfrost.polyui.unit.Unit>? = null; and this method needs to be implemented!
    Otherwise, the size parameter in the constructor must be specified.

Class Text

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.polyfrost.polyui.component.Component

Methods inherited from class org.polyfrost.polyui.component.Drawable

Methods inherited from class java.lang.Object

Constructor Detail

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Text

Method Detail

getProperties

getFontSize

setFontSize

getStringSize

getLines

getFull

getFont

getString

setString

getInitialText

setInitialText

getTextAlign

trueX

trueY

render

get

reset

getLineByIndex

rescale

setup

calculateBounds

calculateSize