GuiTextField (Forge API 1.8.9-11.15.1.2318)

java.lang.Object
- net.minecraft.client.gui.Gui
- - net.minecraft.client.gui.GuiTextField

```
public class GuiTextField
extends Gui
```

Field Summary

Fields
Modifier and Type Field and Description

int height

int width
The width of this text field.

int xPosition

int yPosition
- Fields inherited from class net.minecraft.client.gui.Gui
  icons, optionsBackground, statIcons, zLevel

Fields
Modifier and Type	Field and Description
`int`	`height`
`int`	`width` The width of this text field.
`int`	`xPosition`
`int`	`yPosition`

Constructor Summary

Constructors
Constructor and Description
`GuiTextField(int componentId, FontRenderer fontrendererObj, int x, int y, int par5Width, int par6Height)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteFromCursor(int p_146175_1_)` delete the selected text, otherwsie deletes characters from either side of the cursor. params: delete num
`void`	`deleteWords(int p_146177_1_)` Deletes the specified number of words starting at the cursor position.
`void`	`drawTextBox()` Draws the textbox
`int`	`func_146197_a(int p_146197_1_, int p_146197_2_, boolean p_146197_3_)`
`void`	`func_175205_a(<any> p_175205_1_)`
`void`	`func_175207_a(GuiPageButtonList.GuiResponder p_175207_1_)`
`int`	`getCursorPosition()` returns the current position of the cursor
`boolean`	`getEnableBackgroundDrawing()` get enable drawing background and outline
`int`	`getId()`
`int`	`getMaxStringLength()` returns the maximum number of character that can be contained in this textbox
`int`	`getNthWordFromCursor(int p_146187_1_)` see @getNthNextWordFromPos() params: N, position
`int`	`getNthWordFromPos(int p_146183_1_, int p_146183_2_)` gets the position of the nth word.
`java.lang.String`	`getSelectedText()` returns the text between the cursor and selectionEnd
`int`	`getSelectionEnd()` the side of the selection that is not the cursor, may be the same as the cursor
`java.lang.String`	`getText()` Returns the contents of the textbox
`boolean`	`getVisible()` returns true if this textbox is visible
`int`	`getWidth()` returns the width of the textbox depending on if background drawing is enabled
`boolean`	`isFocused()` Getter for the focused field
`void`	`mouseClicked(int p_146192_1_, int p_146192_2_, int p_146192_3_)` Args: x, y, buttonClicked
`void`	`moveCursorBy(int p_146182_1_)` Moves the text cursor by a specified number of characters and clears the selection
`void`	`setCanLoseFocus(boolean p_146205_1_)` if true the textbox can lose focus by clicking elsewhere on the screen
`void`	`setCursorPosition(int p_146190_1_)` sets the position of the cursor to the provided index
`void`	`setCursorPositionEnd()` sets the cursors position to after the text
`void`	`setCursorPositionZero()` sets the cursors position to the beginning
`void`	`setDisabledTextColour(int p_146204_1_)`
`void`	`setEnableBackgroundDrawing(boolean p_146185_1_)` enable drawing background and outline
`void`	`setEnabled(boolean p_146184_1_)`
`void`	`setFocused(boolean p_146195_1_)` Sets focus to this gui element
`void`	`setMaxStringLength(int p_146203_1_)`
`void`	`setSelectionPos(int p_146199_1_)` Sets the position of the selection anchor (i.e. position the selection was started at)
`void`	`setText(java.lang.String p_146180_1_)` Sets the text of the textbox
`void`	`setTextColor(int p_146193_1_)` Sets the text colour for this textbox (disabled text will not use this colour)
`void`	`setVisible(boolean p_146189_1_)` Sets whether or not this textbox is visible
`boolean`	`textboxKeyTyped(char p_146201_1_, int p_146201_2_)` Call this method from your GuiScreen to process the keys into the textbox
`void`	`updateCursorCounter()` Increments the cursor counter
`void`	`writeText(java.lang.String p_146191_1_)` replaces selected text, or inserts text at the position on the cursor

Methods inherited from class net.minecraft.client.gui.Gui
drawCenteredString, drawGradientRect, drawHorizontalLine, drawModalRectWithCustomSizedTexture, drawRect, drawScaledCustomSizeModalRect, drawString, drawTexturedModalRect, drawTexturedModalRect, drawTexturedModalRect, drawVerticalLine

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

- Field Detail
  - xPosition
```
public int xPosition
```
  - yPosition
```
public int yPosition
```
  - width
```
public int width
```
    The width of this text field.
  - height
```
public int height
```
- Constructor Detail
  - GuiTextField
```
public GuiTextField(int componentId,
                    FontRenderer fontrendererObj,
                    int x,
                    int y,
                    int par5Width,
                    int par6Height)
```
- Method Detail
  - func_175207_a
```
public void func_175207_a(GuiPageButtonList.GuiResponder p_175207_1_)
```
  - updateCursorCounter
```
public void updateCursorCounter()
```
    Increments the cursor counter
  - setText
```
public void setText(java.lang.String p_146180_1_)
```
    Sets the text of the textbox
  - getText
```
public java.lang.String getText()
```
    Returns the contents of the textbox
  - getSelectedText
```
public java.lang.String getSelectedText()
```
    returns the text between the cursor and selectionEnd
  - func_175205_a
```
public void func_175205_a(<any> p_175205_1_)
```
  - writeText
```
public void writeText(java.lang.String p_146191_1_)
```
    replaces selected text, or inserts text at the position on the cursor
  - deleteWords
```
public void deleteWords(int p_146177_1_)
```
    Deletes the specified number of words starting at the cursor position. Negative numbers will delete words left of the cursor.
  - deleteFromCursor
```
public void deleteFromCursor(int p_146175_1_)
```
    delete the selected text, otherwsie deletes characters from either side of the cursor. params: delete num
  - getId
```
public int getId()
```
  - getNthWordFromCursor
```
public int getNthWordFromCursor(int p_146187_1_)
```
    see @getNthNextWordFromPos() params: N, position
  - getNthWordFromPos
```
public int getNthWordFromPos(int p_146183_1_,
                             int p_146183_2_)
```
    gets the position of the nth word. N may be negative, then it looks backwards. params: N, position
  - func_146197_a
```
public int func_146197_a(int p_146197_1_,
                         int p_146197_2_,
                         boolean p_146197_3_)
```
  - moveCursorBy
```
public void moveCursorBy(int p_146182_1_)
```
    Moves the text cursor by a specified number of characters and clears the selection
  - setCursorPosition
```
public void setCursorPosition(int p_146190_1_)
```
    sets the position of the cursor to the provided index
  - setCursorPositionZero
```
public void setCursorPositionZero()
```
    sets the cursors position to the beginning
  - setCursorPositionEnd
```
public void setCursorPositionEnd()
```
    sets the cursors position to after the text
  - textboxKeyTyped
```
public boolean textboxKeyTyped(char p_146201_1_,
                               int p_146201_2_)
```
    Call this method from your GuiScreen to process the keys into the textbox
  - mouseClicked
```
public void mouseClicked(int p_146192_1_,
                         int p_146192_2_,
                         int p_146192_3_)
```
    Args: x, y, buttonClicked
  - drawTextBox
```
public void drawTextBox()
```
    Draws the textbox
  - setMaxStringLength
```
public void setMaxStringLength(int p_146203_1_)
```
  - getMaxStringLength
```
public int getMaxStringLength()
```
    returns the maximum number of character that can be contained in this textbox
  - getCursorPosition
```
public int getCursorPosition()
```
    returns the current position of the cursor
  - getEnableBackgroundDrawing
```
public boolean getEnableBackgroundDrawing()
```
    get enable drawing background and outline
  - setEnableBackgroundDrawing
```
public void setEnableBackgroundDrawing(boolean p_146185_1_)
```
    enable drawing background and outline
  - setTextColor
```
public void setTextColor(int p_146193_1_)
```
    Sets the text colour for this textbox (disabled text will not use this colour)
  - setDisabledTextColour
```
public void setDisabledTextColour(int p_146204_1_)
```
  - setFocused
```
public void setFocused(boolean p_146195_1_)
```
    Sets focus to this gui element
  - isFocused
```
public boolean isFocused()
```
    Getter for the focused field
  - setEnabled
```
public void setEnabled(boolean p_146184_1_)
```
  - getSelectionEnd
```
public int getSelectionEnd()
```
    the side of the selection that is not the cursor, may be the same as the cursor
  - getWidth
```
public int getWidth()
```
    returns the width of the textbox depending on if background drawing is enabled
  - setSelectionPos
```
public void setSelectionPos(int p_146199_1_)
```
    Sets the position of the selection anchor (i.e. position the selection was started at)
  - setCanLoseFocus
```
public void setCanLoseFocus(boolean p_146205_1_)
```
    if true the textbox can lose focus by clicking elsewhere on the screen
  - getVisible
```
public boolean getVisible()
```
    returns true if this textbox is visible
  - setVisible
```
public void setVisible(boolean p_146189_1_)
```
    Sets whether or not this textbox is visible

Class GuiTextField

Field Summary

Fields inherited from class net.minecraft.client.gui.Gui

Constructor Summary

Method Summary

Methods inherited from class net.minecraft.client.gui.Gui

Methods inherited from class java.lang.Object

Field Detail

xPosition

yPosition

width

height

Constructor Detail

GuiTextField

Method Detail

func_175207_a

updateCursorCounter

setText

getText

getSelectedText

func_175205_a

writeText

deleteWords

deleteFromCursor

getId

getNthWordFromCursor

getNthWordFromPos

func_146197_a

moveCursorBy

setCursorPosition

setCursorPositionZero

setCursorPositionEnd

textboxKeyTyped

mouseClicked

drawTextBox

setMaxStringLength

getMaxStringLength

getCursorPosition

getEnableBackgroundDrawing

setEnableBackgroundDrawing

setTextColor

setDisabledTextColour

setFocused

isFocused

setEnabled

getSelectionEnd

getWidth

setSelectionPos

setCanLoseFocus

getVisible

setVisible