All Implemented Interfaces:: kotlin.Cloneable , org.polyfrost.polyui.component.Focusable


public class TextInput
extends Component implements Focusable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`TextInput.ChangedEvent`

Field Summary

Fields
Modifier and Type	Field	Description
`private final TextInputProperties`	`properties`
`private transient Text`	`text`
`private String`	`txt`
`private final transient Boolean`	`focused`
`private final String`	`selection`
`private final transient Boolean`	`errored`
`private transient String`	`lastValid`
`private final Translator.Text`	`placeholder`
`private transient Color.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
`TextInput(TextInputProperties properties, Vec2<Unit> at, Vec2<Unit> size, Translator.Text placeholder, PolyImage image, Translator.Text title, Translator.Text hint, Translator.Text initialText, Unit fontSize, Function1<EventDSL<TextInput>, Unit> events)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`TextInputProperties`	`getProperties()`
`final Text`	`getText()`
`final Unit`	`setText(Text text)`
`final String`	`getTxt()`
`final Unit`	`setTxt(String txt)`
`final Boolean`	`getFocused()`
`final String`	`getSelection()`
`final Boolean`	`getErrored()`	represents if TextInputProperties.sanitizationFunction returned false (text no good)
`final String`	`getLastValid()`
`final Unit`	`setLastValid(String lastValid)`
`final Translator.Text`	`getPlaceholder()`
`Unit`	`preRender(Long deltaTimeNanos)`	pre-render functions, such as applying transforms.
`Unit`	`render()`	draw script for this drawable.
`Boolean`	`accept(Event event)`	called when this drawable receives an event.
`Boolean`	`accept(FocusedEvent event)`	Accept a FocusedEvent and handle it.
`final Unit`	`caretPos()`
`final Unit`	`selectWordAroundCaret()`
`Unit`	`rescale(Float scaleX, Float scaleY)`	Method that is called when the physical size of the total window area changes.
`final Unit`	`toLastSpace()`
`final Unit`	`dropToLastSpace()`
`final Unit`	`toNextSpace()`
`final Unit`	`back()`
`final Unit`	`forward()`
`Unit`	`onColorsChanged(Colors colors)`	Function that is called when the colors attached to this drawable change.
`Unit`	`reset()`	Use this function to reset your drawable's PolyText if it is using one.
`final Unit`	`clearSelection()`
`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.
`Unit`	`onInitComplete()`	This function is called when initialization of a drawable is complete, so it has been fully calculated.
`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
addKeyframes, addOperation, canBeRemoved, debugRender, draggable, every, getColor, getConsumesHover, getDisabled, getLayout, getParent, getSize, onFontsChanged, recolor, setColor, setConsumesHover, setDisabled, setLayout, setParent, setProperties, setSize, toString, trueX, trueY, 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, 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 org.polyfrost.polyui.component.Focusable
accept
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TextInput
```
TextInput(TextInputProperties properties, Vec2<Unit> at, Vec2<Unit> size, Translator.Text placeholder, PolyImage image, Translator.Text title, Translator.Text hint, Translator.Text initialText, Unit fontSize, Function1<EventDSL<TextInput>, Unit> events)
```
- Method Detail
  - getProperties
```
 TextInputProperties getProperties()
```
  - getText
```
 final Text getText()
```
  - setText
```
 final Unit setText(Text text)
```
  - getTxt
```
 final String getTxt()
```
  - setTxt
```
 final Unit setTxt(String txt)
```
  - getFocused
```
 final Boolean getFocused()
```
  - getSelection
```
 final String getSelection()
```
  - getErrored
```
 final Boolean getErrored()
```
    represents if TextInputProperties.sanitizationFunction returned false (text no good)
  - getLastValid
```
 final String getLastValid()
```
  - setLastValid
```
 final Unit setLastValid(String lastValid)
```
  - getPlaceholder
```
 final Translator.Text getPlaceholder()
```
  - preRender
```
 Unit preRender(Long deltaTimeNanos)
```
    pre-render functions, such as applying transforms. In this method, you should set needsRedraw to true if you have something to redraw for the next frame.
    
    Parameters:
    
    deltaTimeNanos - the time in nanoseconds since the last frame.
  - render
```
 Unit render()
```
    draw script for this drawable.
  - accept
```
 Boolean accept(Event event)
```
    called when this drawable receives an event.
    make sure to call Drawable.accept!
  - accept
```
 Boolean accept(FocusedEvent event)
```
    Accept a FocusedEvent and handle it.
  - caretPos
```
 final Unit caretPos()
```
  - selectWordAroundCaret
```
 final Unit selectWordAroundCaret()
```
  - rescale
```
 Unit rescale(Float scaleX, Float scaleY)
```
    Method that is called when the physical size of the total window area changes.
  - toLastSpace
```
 final Unit toLastSpace()
```
  - dropToLastSpace
```
 final Unit dropToLastSpace()
```
  - toNextSpace
```
 final Unit toNextSpace()
```
  - back
```
 final Unit back()
```
  - forward
```
 final Unit forward()
```
  - onColorsChanged
```
 Unit onColorsChanged(Colors colors)
```
    Function that is called when the colors attached to this drawable change.
    If this is a layout, the colors will change, and all its children and components will be notified and updated accordingly.
    Make sure to call super.onColorsChanged() if you override this!
  - reset
```
 Unit reset()
```
    Use this function to reset your drawable's PolyText if it is using one.
  - clearSelection
```
 final Unit clearSelection()
```
  - 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.
  - onInitComplete
```
 Unit onInitComplete()
```
    This function is called when initialization of a drawable is complete, so it has been fully calculated.
    This function is called once, and only once.
  - 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 TextInput

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 org.polyfrost.polyui.component.Focusable

Methods inherited from class java.lang.Object

Constructor Detail

TextInput

Method Detail

getProperties

getText

setText

getTxt

setTxt

getFocused

getSelection

getErrored

getLastValid

setLastValid

getPlaceholder

preRender

render

accept

accept

caretPos

selectWordAroundCaret

rescale

toLastSpace

dropToLastSpace

toNextSpace

back

forward

onColorsChanged

reset

clearSelection

setup

calculateBounds

onInitComplete

calculateSize