All Implemented Interfaces:: kotlin.Cloneable


public class Text
extends Drawable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Byte`	`UNLIMITED`
`public final static Byte`	`WRAP`
`public final static Byte`	`LIMITED_WRAP`
`public final static Byte`	`SCROLLING_SINGLE_LINE`
`public final static Byte`	`LIMITED`
`private final Byte`	`mode`
`private Boolean`	`strikethrough`
`private Boolean`	`underline`
`private String`	`text`
`private Font`	`_font`
`private Font`	`font`
`private Font.Weight`	`fontWeight`
`private Boolean`	`italic`
`private Float`	`uFontSize`
`private Float`	`fontSize`
`private Vec2`	`visibleSize`
`private final Renderer`	`renderer`
`private final Framebuffer`	`framebuffer`
`private PolyColor`	`_color`
`private PolyColor`	`color`
`private Colors.Palette`	`_palette`
`private Colors.Palette`	`palette`
`private Boolean`	`needsRedraw`
`private Double`	`rotation`
`private Double`	`skewX`
`private Double`	`skewY`
`private Float`	`scaleX`
`private Float`	`scaleY`
`private Float`	`alpha`
`private Boolean`	`hasVisibleSize`
`private final Boolean`	`scrolling`
`private final Boolean`	`scrollingX`
`private final Boolean`	`scrollingY`
`private Boolean`	`shouldScroll`
`private final Vec2`	`screenAt`
`private Boolean`	`acceptsInput`
`private Boolean`	`isEnabled`
`private Byte`	`inputState`
`private final Boolean`	`focused`
`private final Boolean`	`focusable`
`private String`	`name`
`private final PolyUI`	`polyUI`
`private final <Error class: unknown class>`	`initialized`
`private final <Error class: unknown class><Component>`	`children`
`private Component`	`_parent`
`private Component`	`parent`
`private Align`	`alignment`
`private Float`	`x`
`private Float`	`y`
`private Vec2`	`at`
`private Float`	`width`
`private Float`	`height`
`private Vec2`	`size`
`private final Boolean`	`sizeValid`
`private Vec4`	`padding`
`private Byte`	`layoutFlags`
`private Boolean`	`rawResize`
`private Boolean`	`layoutIgnored`
`private final Boolean`	`createdWithSetPosition`
`private final Boolean`	`createdWithSetSize`
`private final Boolean`	`positioned`
`private Boolean`	`renders`
`private Boolean`	`clipped`
`private final <Error class: unknown class><ComponentOp>`	`operations`
`private final <Error class: unknown class>`	`isOperating`

Constructor Summary

Constructors
Constructor	Description
`Text(String text, Font font, Float fontSize, Vec2 at, Align alignment, Vec2 visibleSize, Boolean focusable, Boolean limited, Component children)`
`Text(Translator.Text text, Font font, Float fontSize, Vec2 at, Align alignment, Vec2 visibleSize, Boolean focusable, Boolean limited, Component children)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Byte`	`getMode()`	Mode that this text was created in.
`final Boolean`	`getStrikethrough()`
`final Unit`	`setStrikethrough(Boolean strikethrough)`
`final Boolean`	`getUnderline()`
`final Unit`	`setUnderline(Boolean underline)`
`String`	`getText()`
`Unit`	`setText(String text)`
`final Font`	`getFontOrNull()`
`final Unit`	`setFontInternal(@ApiStatus.Internal() Font _font)`
`final Font`	`getFont()`
`final Unit`	`setFont(Font font)`
`final Font.Weight`	`getFontWeight()`
`final Unit`	`setFontWeight(Font.Weight fontWeight)`
`final Boolean`	`getItalic()`
`final Unit`	`setItalic(Boolean italic)`
`final Float`	`getUFontSize()`	Tracker for the unscaled fontSize.
`final Unit`	`setUFontSize(Float uFontSize)`
`final Float`	`getFontSize()`	Internal, scaled font size.
`final Unit`	`setFontSize(@ApiStatus.Internal() Float fontSize)`
`Unit`	`rescale0(Float scaleX, Float scaleY, Boolean withChildren)`	raw rescale method that does not check rawResize and uses the given scale factors directly.
`Boolean`	`setup(PolyUI polyUI)`	give this a PolyUI reference.
`Unit`	`updateTextBounds(Renderer renderer)`
`Vec2`	`calculateSize()`	Use this function to calculate the size of this component.
`Unit`	`fixVisibleSize()`
`String`	`debugString()`	Override this function to add things to the debug display of this component.
`final static String`	`getModeName(Byte mode)`	Return the name of the given constant.

Methods inherited from class org.polyfrost.polyui.component.Drawable
clone, debugDraw, draw, get, getAlpha, getColor, getColorOrNull, getColorOrNull, getFramebuffer, getPalette, getRenderer, getRotation, getScaleX, getScaleY, getSkewX, getSkewY, getVisibleSize, isInside, needsRedraw, position, setAlpha, setColor, setColorInternal, setColorInternal, setNeedsRedraw, setPalette, setRotation, setScaleX, setScaleY, setSkewX, setSkewY, setVisibleSize
Methods inherited from class org.polyfrost.polyui.component.Scrollable
accept, getHasVisibleSize, getShouldScroll, isScrolling, isScrollingX, isScrollingY, popScroll, pushScroll, recalculate, resetScroll, screenAt, setHasVisibleSize, setShouldScroll, tryMakeScrolling
Methods inherited from class org.polyfrost.polyui.component.Inputtable
acceptsInput, addEventhandler, clearHandlers, getInputState, hasListenersFor, hasListenersFor, isEnabled, isFocusable, isFocused, on, setAcceptsInput, setEnabled, setInputState
Methods inherited from class org.polyfrost.polyui.component.Component
addChild, addChild, addOperation, addOperation, at, clipChildren, contains, contains, createdWithSetPosition, createdWithSetSize, extraToString, get, get, getAlignment, getAt, getChildren, getHeight, getInitialized, getLayoutFlags, getName, getOperations, getPadding, getParent, getParentOrNull, getPolyUI, getRenders, getSize, getWidth, getX, getY, intersects, isClipped, isLayoutIgnored, isOperating, isPositioned, isRawResize, isSizeValid, remove, removeChild, removeChild, removeOperation, rescale, set, set, setAlignment, setAt, setClipped, setHeight, setLayoutFlags, setLayoutIgnored, setName, setPadding, setParent, setRawResize, setRenders, setSize, setWidth, setX, setY, set_parent, size
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Text
```
Text(String text, Font font, Float fontSize, Vec2 at, Align alignment, Vec2 visibleSize, Boolean focusable, Boolean limited, Component children)
```
  - Text
```
Text(Translator.Text text, Font font, Float fontSize, Vec2 at, Align alignment, Vec2 visibleSize, Boolean focusable, Boolean limited, Component children)
```
- Method Detail
  - getMode
```
 final Byte getMode()
```
    Mode that this text was created in. Must be one of UNLIMITED, WRAP, SCROLLING_SINGLE_LINE, LIMITED_WRAP.
    
    Since:
    
    1.4.1
  - getStrikethrough
```
 final Boolean getStrikethrough()
```
    Since:
    
    1.0.6
  - setStrikethrough
```
 final Unit setStrikethrough(Boolean strikethrough)
```
    Since:
    
    1.0.6
  - getUnderline
```
 final Boolean getUnderline()
```
    Since:
    
    1.0.6
  - setUnderline
```
 final Unit setUnderline(Boolean underline)
```
    Since:
    
    1.0.6
  - getText
```
 String getText()
```
  - setText
```
 Unit setText(String text)
```
  - getFontOrNull
```
 final Font getFontOrNull()
```
  - setFontInternal
```
 final Unit setFontInternal(@ApiStatus.Internal() Font _font)
```
  - getFont
```
 final Font getFont()
```
  - setFont
```
 final Unit setFont(Font font)
```
  - getFontWeight
```
 final Font.Weight getFontWeight()
```
  - setFontWeight
```
 final Unit setFontWeight(Font.Weight fontWeight)
```
  - getItalic
```
 final Boolean getItalic()
```
  - setItalic
```
 final Unit setItalic(Boolean italic)
```
  - getUFontSize
```
 final Float getUFontSize()
```
    Tracker for the unscaled fontSize. You should set this instead of font size in most cases.
    
    Since:
    
    1.2.0
  - setUFontSize
```
 final Unit setUFontSize(Float uFontSize)
```
  - getFontSize
```
 final Float getFontSize()
```
    Internal, scaled font size. You probably should be using uFontSize instead, as this is an internal object.
  - setFontSize
```
 final Unit setFontSize(@ApiStatus.Internal() Float fontSize)
```
  - rescale0
```
 Unit rescale0(Float scaleX, Float scaleY, Boolean withChildren)
```
    raw rescale method that does not check rawResize and uses the given scale factors directly.
    
    Parameters:
    
    withChildren - if true, this method will also rescale its children.
  - setup
```
 Boolean setup(PolyUI polyUI)
```
    give this a PolyUI reference.
    You can also use this method to do some calculations (such as text widths) that are not dependent on other sizes, or operations that require access to PolyUI things, like PolyUI.settings or PolyUI.translator
    this method is called once, and only once.
  - updateTextBounds
```
 Unit updateTextBounds(Renderer renderer)
```
  - calculateSize
```
 Vec2 calculateSize()
```
    Use this function to calculate the size of this component. DO NOT include children in this calculation!
    This function is only called if no size is supplied to this component at initialization. A return value of null indicates this component is not able to infer its own size, as it is for example, a Block with no reference. A component such as Text on the other hand, is able to infer its own size.
    This function is only ever called if sizeValid is false.
  - fixVisibleSize
```
 Unit fixVisibleSize()
```
  - debugString
```
 String debugString()
```
    Override this function to add things to the debug display of this component.
    
    Since:
    
    1.1.1
  - getModeName
```
 final static String getModeName(Byte mode)
```
    Return the name of the given constant.

Class Text

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Text

Text

Method Detail

getMode

getStrikethrough

setStrikethrough

getUnderline

setUnderline

getText

setText

getFontOrNull

setFontInternal

getFont

setFont

getFontWeight

setFontWeight

getItalic

setItalic

getUFontSize

setUFontSize

getFontSize

setFontSize

rescale0

setup

updateTextBounds

calculateSize

fixVisibleSize

debugString

getModeName