WTextField (LibGui 4.0.0-alpha.1+21w11a API)

java.lang.Object
- io.github.cottonmc.cotton.gui.widget.WWidget
- - io.github.cottonmc.cotton.gui.widget.WTextField

```
public class WTextField
extends WWidget
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected @Nullable BackgroundPainter`	`backgroundPainter`
`protected int`	`cursor`
`protected boolean`	`editable`
`protected int`	`enabledColor`
`protected int`	`maxLength`
`static int`	`OFFSET_X_TEXT`
`protected java.util.function.Consumer<java.lang.String>`	`onChanged`
`protected int`	`select` If not -1, select is the "anchor point" of a selection.
`protected @Nullable net.minecraft.text.Text`	`suggestion`
`protected java.lang.String`	`text`
`protected java.util.function.Predicate<java.lang.String>`	`textPredicate`
`protected int`	`uneditableColor`

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget
height, host, parent, width, x, y

Constructor Summary

Constructors
Constructor and Description

WTextField()

WTextField(net.minecraft.text.Text suggestion)

Constructors
Constructor and Description
`WTextField()`
`WTextField(net.minecraft.text.Text suggestion)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canFocus()` Tests whether this widget can have the focus in the GUI.
`boolean`	`canResize()` Checks whether this widget can be resized using `WWidget.setSize(int, int)`.
`static int`	`getCaretOffset(java.lang.String s, int pos)` From a caret position, finds out what the x-offset to draw the caret is.
`static int`	`getCaretPos(java.lang.String s, int x)` From an X offset past the left edge of a TextRenderer.draw, finds out what the closest caret position (division between letters) is.
`int`	`getCursor()`
`int`	`getMaxLength()`
`@Nullable java.lang.String`	`getSelection()`
`@Nullable net.minecraft.text.Text`	`getSuggestion()`
`java.lang.String`	`getText()`
`void`	`insertText(int ofs, java.lang.String s)`
`boolean`	`isEditable()`
`void`	`onCharTyped(char ch)` Notifies this widget that a character has been typed.
`InputResult`	`onClick(int x, int y, int button)` Notifies this widget that the mouse has been pressed and released, both while inside its bounds.
`void`	`onFocusGained()` Notifies this widget that it has gained focus
`void`	`onKeyPressed(int ch, int key, int modifiers)` Notifies this widget that a key has been pressed.
`void`	`paint(net.minecraft.client.util.math.MatrixStack matrices, int x, int y, int mouseX, int mouseY)` Paints this widget.
`protected void`	`renderTextField(net.minecraft.client.util.math.MatrixStack matrices, int x, int y)`
`WTextField`	`setBackgroundPainter(BackgroundPainter painter)`
`WTextField`	`setChangedListener(java.util.function.Consumer<java.lang.String> listener)`
`void`	`setCursorPos(int location)`
`WTextField`	`setDisabledColor(int col)`
`WTextField`	`setEditable(boolean editable)`
`WTextField`	`setEnabledColor(int col)`
`WTextField`	`setMaxLength(int max)`
`void`	`setSize(int x, int y)` Sets the size of this widget.
`WTextField`	`setSuggestion(@Nullable java.lang.String suggestion)`
`WTextField`	`setSuggestion(@Nullable net.minecraft.text.Text suggestion)`
`void`	`setText(java.lang.String s)`
`WTextField`	`setTextPredicate(java.util.function.Predicate<java.lang.String> predicate_1)`

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget
addPainters, addTooltip, createPeers, cycleFocus, getAbsoluteX, getAbsoluteY, getHeight, getHost, getParent, getWidth, getX, getY, hit, isActivationKey, isFocused, isWithinBounds, onFocusLost, onHidden, onKeyReleased, onMouseDown, onMouseDrag, onMouseMove, onMouseScroll, onMouseUp, onShown, releaseFocus, renderTooltip, requestFocus, setHost, setLocation, setParent, tick, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OFFSET_X_TEXT
```
public static final int OFFSET_X_TEXT
```
    See Also:
    
    Constant Field Values
  - text
```
protected java.lang.String text
```
  - maxLength
```
protected int maxLength
```
  - editable
```
protected boolean editable
```
  - enabledColor
```
protected int enabledColor
```
  - uneditableColor
```
protected int uneditableColor
```
  - suggestion
```
@Nullable
protected @Nullable net.minecraft.text.Text suggestion
```
  - cursor
```
protected int cursor
```
  - select
```
protected int select
```
    If not -1, select is the "anchor point" of a selection. That is, if you hit shift+left with no existing selection, the selection will be anchored to where you were, but the cursor will move left, expanding the selection as you continue to move left. If you move to the right, eventually you'll overtake the anchor, drop the anchor at the same place and start expanding the selection rightwards instead.
  - onChanged
```
protected java.util.function.Consumer<java.lang.String> onChanged
```
  - textPredicate
```
protected java.util.function.Predicate<java.lang.String> textPredicate
```
  - backgroundPainter
```
@Environment(value=CLIENT)
 @Nullable
protected @Nullable BackgroundPainter backgroundPainter
```
- Constructor Detail
  - WTextField
```
public WTextField()
```
  - WTextField
```
public WTextField(net.minecraft.text.Text suggestion)
```
- Method Detail
  - setText
```
public void setText(java.lang.String s)
```
  - getText
```
public java.lang.String getText()
```
  - canResize
```
public boolean canResize()
```
    Description copied from class: WWidget
    
    Checks whether this widget can be resized using WWidget.setSize(int, int).
    
    Overrides:
    
    canResize in class WWidget
    
    Returns:
    
    true if this widget can be resized, false otherwise
  - setSize
```
public void setSize(int x,
                    int y)
```
    Description copied from class: WWidget
    
    Sets the size of this widget.
    Overriding methods may restrict one of the dimensions to be a constant value, for example super.setSize(x, 20).
    
    Overrides:
    
    setSize in class WWidget
    
    Parameters:
    
    x - the new width
    
    y - the new height
  - setCursorPos
```
public void setCursorPos(int location)
```
  - getMaxLength
```
public int getMaxLength()
```
  - getCursor
```
public int getCursor()
```
  - getSelection
```
@Nullable
public @Nullable java.lang.String getSelection()
```
  - isEditable
```
public boolean isEditable()
```
  - renderTextField
```
@Environment(value=CLIENT)
protected void renderTextField(net.minecraft.client.util.math.MatrixStack matrices,
                                                           int x,
                                                           int y)
```
  - setTextPredicate
```
public WTextField setTextPredicate(java.util.function.Predicate<java.lang.String> predicate_1)
```
  - setChangedListener
```
public WTextField setChangedListener(java.util.function.Consumer<java.lang.String> listener)
```
  - setMaxLength
```
public WTextField setMaxLength(int max)
```
  - setEnabledColor
```
public WTextField setEnabledColor(int col)
```
  - setDisabledColor
```
public WTextField setDisabledColor(int col)
```
  - setEditable
```
public WTextField setEditable(boolean editable)
```
  - getSuggestion
```
@Nullable
public @Nullable net.minecraft.text.Text getSuggestion()
```
  - setSuggestion
```
public WTextField setSuggestion(@Nullable
                                @Nullable java.lang.String suggestion)
```
  - setSuggestion
```
public WTextField setSuggestion(@Nullable
                                @Nullable net.minecraft.text.Text suggestion)
```
  - setBackgroundPainter
```
@Environment(value=CLIENT)
public WTextField setBackgroundPainter(BackgroundPainter painter)
```
  - canFocus
```
public boolean canFocus()
```
    Description copied from class: WWidget
    
    Tests whether this widget can have the focus in the GUI.
    
    Overrides:
    
    canFocus in class WWidget
    
    Returns:
    
    true if this widget can be focused, false otherwise
  - onFocusGained
```
public void onFocusGained()
```
    Description copied from class: WWidget
    
    Notifies this widget that it has gained focus
    
    Overrides:
    
    onFocusGained in class WWidget
  - paint
```
@Environment(value=CLIENT)
public void paint(net.minecraft.client.util.math.MatrixStack matrices,
                                              int x,
                                              int y,
                                              int mouseX,
                                              int mouseY)
```
    Description copied from class: WWidget
    
    Paints this widget.
    
    Overrides:
    
    paint in class WWidget
    
    Parameters:
    
    matrices - the rendering matrix stack
    
    x - this widget's X coordinate on the screen
    
    y - this widget's Y coordinate on the screen
    
    mouseX - the X coordinate of the cursor
    
    mouseY - the X coordinate of the cursor
  - onClick
```
@Environment(value=CLIENT)
public InputResult onClick(int x,
                                                       int y,
                                                       int button)
```
    Description copied from class: WWidget
    
    Notifies this widget that the mouse has been pressed and released, both while inside its bounds.
    
    Overrides:
    
    onClick in class WWidget
    
    Parameters:
    
    x - The X coordinate of the event, in widget-space (0 is the left edge of this widget)
    
    y - The Y coordinate of the event, in widget-space (0 is the top edge of this widget)
    
    button - The mouse button that was used. Button numbering is consistent with LWJGL Mouse (0=left, 1=right, 2=mousewheel click)
    
    Returns:
    
    InputResult.PROCESSED if the event is handled, InputResult.IGNORED otherwise.
  - onCharTyped
```
@Environment(value=CLIENT)
public void onCharTyped(char ch)
```
    Description copied from class: WWidget
    
    Notifies this widget that a character has been typed. This method is subject to key repeat, and may be called for characters that do not directly have a corresponding keyboard key.
    
    Overrides:
    
    onCharTyped in class WWidget
    
    Parameters:
    
    ch - the character typed
  - insertText
```
public void insertText(int ofs,
                       java.lang.String s)
```
  - onKeyPressed
```
@Environment(value=CLIENT)
public void onKeyPressed(int ch,
                                                     int key,
                                                     int modifiers)
```
    Description copied from class: WWidget
    
    Notifies this widget that a key has been pressed.
    
    Overrides:
    
    onKeyPressed in class WWidget
    
    key - the GLFW scancode of the key
  - getCaretPos
```
@Environment(value=CLIENT)
public static int getCaretPos(java.lang.String s,
                                                          int x)
```
    From an X offset past the left edge of a TextRenderer.draw, finds out what the closest caret position (division between letters) is.
    
    Parameters:
    
    s -
    
    x -
    
    Returns:
  - getCaretOffset
```
@Environment(value=CLIENT)
public static int getCaretOffset(java.lang.String s,
                                                             int pos)
```
    From a caret position, finds out what the x-offset to draw the caret is.
    
    Parameters:
    
    s -
    
    pos -
    
    Returns:

Class WTextField

Field Summary

Fields inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

Constructor Summary

Method Summary

Methods inherited from class io.github.cottonmc.cotton.gui.widget.WWidget

Methods inherited from class java.lang.Object

Field Detail

OFFSET_X_TEXT

text

maxLength

editable

enabledColor

uneditableColor

suggestion

cursor

select

onChanged

textPredicate

backgroundPainter

Constructor Detail

WTextField

WTextField

Method Detail

setText

getText

canResize

setSize

setCursorPos

getMaxLength

getCursor

getSelection

isEditable

renderTextField

setTextPredicate

setChangedListener

setMaxLength

setEnabledColor

setDisabledColor

setEditable

getSuggestion

setSuggestion

setSuggestion

setBackgroundPainter

canFocus

onFocusGained

paint

onClick

onCharTyped

insertText

onKeyPressed

getCaretPos

getCaretOffset