GuiTextField (Forge 1.11.2 API v13.20.1.2386 mappings snapshot

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, OPTIONS_BACKGROUND, STAT_ICONS, 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 num)` Deletes the given number of characters from the current cursor's position, unless there is currently a selection, in which case the selection is deleted instead.
`void`	`deleteWords(int num)` Deletes the given number of words from the current cursor's position, unless there is currently a selection, in which case the selection is deleted instead.
`void`	`drawTextBox()` Draws the textbox
`int`	`getCursorPosition()` returns the current position of the cursor
`boolean`	`getEnableBackgroundDrawing()` Gets whether the background and outline of this text box should be drawn (true if so).
`int`	`getId()`
`int`	`getMaxStringLength()` returns the maximum number of character that can be contained in this textbox
`int`	`getNthWordFromCursor(int numWords)` Gets the starting index of the word at the specified number of words away from the cursor position.
`int`	`getNthWordFromPos(int n, int pos)` Gets the starting index of the word at a distance of the specified number of words away from the given position.
`int`	`getNthWordFromPosWS(int n, int pos, boolean skipWs)` Like getNthWordFromPos (which wraps this), but adds option for skipping consecutive spaces
`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 mouseX, int mouseY, int mouseButton)` Called when mouse is clicked, regardless as to whether it is over this button or not.
`void`	`moveCursorBy(int num)` Moves the text cursor by a specified number of characters and clears the selection
`void`	`setCanLoseFocus(boolean canLoseFocusIn)` Sets whether this text box loses focus when something other than it is clicked.
`void`	`setCursorPosition(int pos)` Sets the current position of the cursor.
`void`	`setCursorPositionEnd()` Moves the cursor to the very end of this text box.
`void`	`setCursorPositionZero()` Moves the cursor to the very start of this text box.
`void`	`setDisabledTextColour(int color)` Sets the color to use for text in this text box when this text box is disabled.
`void`	`setEnableBackgroundDrawing(boolean enableBackgroundDrawingIn)` Sets whether or not the background and outline of this text box should be drawn.
`void`	`setEnabled(boolean enabled)` Sets whether this text box is enabled.
`void`	`setFocused(boolean isFocusedIn)` Sets focus to this gui element
`void`	`setGuiResponder(GuiPageButtonList.GuiResponder guiResponderIn)` Sets the GuiResponder associated with this text box.
`void`	`setMaxStringLength(int length)` Sets the maximum length for the text in this text box.
`void`	`setResponderEntryValue(int idIn, java.lang.String textIn)` Notifies this text box's responder that the text has changed.
`void`	`setSelectionPos(int position)` Sets the position of the selection anchor (the selection anchor and the cursor position mark the edges of the selection).
`void`	`setText(java.lang.String textIn)` Sets the text of the textbox, and moves the cursor to the end.
`void`	`setTextColor(int color)` Sets the color to use when drawing this text box's text.
`void`	`setValidator(<any> theValidator)`
`void`	`setVisible(boolean isVisible)` Sets whether or not this textbox is visible
`boolean`	`textboxKeyTyped(char typedChar, int keyCode)` Call this method from your GuiScreen to process the keys into the textbox
`void`	`updateCursorCounter()` Increments the cursor counter
`void`	`writeText(java.lang.String textToWrite)` Adds the given text after the cursor, or replaces the currently selected text if there is a selection.

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
  - setGuiResponder
```
public void setGuiResponder(GuiPageButtonList.GuiResponder guiResponderIn)
```
    Sets the GuiResponder associated with this text box.
  - updateCursorCounter
```
public void updateCursorCounter()
```
    Increments the cursor counter
  - setText
```
public void setText(java.lang.String textIn)
```
    Sets the text of the textbox, and moves the cursor to the end.
  - 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
  - setValidator
```
public void setValidator(<any> theValidator)
```
  - writeText
```
public void writeText(java.lang.String textToWrite)
```
    Adds the given text after the cursor, or replaces the currently selected text if there is a selection.
  - setResponderEntryValue
```
public void setResponderEntryValue(int idIn,
                                   java.lang.String textIn)
```
    Notifies this text box's responder that the text has changed.
    
    Parameters:
    
    idIn - The ID of the text box being updated (should usually be the value of getId())
    
    textIn - The new text of the text box (should usually be the value of getText())
  - deleteWords
```
public void deleteWords(int num)
```
    Deletes the given number of words from the current cursor's position, unless there is currently a selection, in which case the selection is deleted instead.
  - deleteFromCursor
```
public void deleteFromCursor(int num)
```
    Deletes the given number of characters from the current cursor's position, unless there is currently a selection, in which case the selection is deleted instead.
  - getId
```
public int getId()
```
  - getNthWordFromCursor
```
public int getNthWordFromCursor(int numWords)
```
    Gets the starting index of the word at the specified number of words away from the cursor position.
  - getNthWordFromPos
```
public int getNthWordFromPos(int n,
                             int pos)
```
    Gets the starting index of the word at a distance of the specified number of words away from the given position.
  - getNthWordFromPosWS
```
public int getNthWordFromPosWS(int n,
                               int pos,
                               boolean skipWs)
```
    Like getNthWordFromPos (which wraps this), but adds option for skipping consecutive spaces
  - moveCursorBy
```
public void moveCursorBy(int num)
```
    Moves the text cursor by a specified number of characters and clears the selection
  - setCursorPosition
```
public void setCursorPosition(int pos)
```
    Sets the current position of the cursor.
  - setCursorPositionZero
```
public void setCursorPositionZero()
```
    Moves the cursor to the very start of this text box.
  - setCursorPositionEnd
```
public void setCursorPositionEnd()
```
    Moves the cursor to the very end of this text box.
  - textboxKeyTyped
```
public boolean textboxKeyTyped(char typedChar,
                               int keyCode)
```
    Call this method from your GuiScreen to process the keys into the textbox
  - mouseClicked
```
public void mouseClicked(int mouseX,
                         int mouseY,
                         int mouseButton)
```
    Called when mouse is clicked, regardless as to whether it is over this button or not.
  - drawTextBox
```
public void drawTextBox()
```
    Draws the textbox
  - setMaxStringLength
```
public void setMaxStringLength(int length)
```
    Sets the maximum length for the text in this text box. If the current text is longer than this length, the current text will be trimmed.
  - 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()
```
    Gets whether the background and outline of this text box should be drawn (true if so).
  - setEnableBackgroundDrawing
```
public void setEnableBackgroundDrawing(boolean enableBackgroundDrawingIn)
```
    Sets whether or not the background and outline of this text box should be drawn.
  - setTextColor
```
public void setTextColor(int color)
```
    Sets the color to use when drawing this text box's text. A different color is used if this text box is disabled.
  - setDisabledTextColour
```
public void setDisabledTextColour(int color)
```
    Sets the color to use for text in this text box when this text box is disabled.
  - setFocused
```
public void setFocused(boolean isFocusedIn)
```
    Sets focus to this gui element
  - isFocused
```
public boolean isFocused()
```
    Getter for the focused field
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether this text box is enabled. Disabled text boxes cannot be typed in.
  - 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 position)
```
    Sets the position of the selection anchor (the selection anchor and the cursor position mark the edges of the selection). If the anchor is set beyond the bounds of the current text, it will be put back inside.
  - setCanLoseFocus
```
public void setCanLoseFocus(boolean canLoseFocusIn)
```
    Sets whether this text box loses focus when something other than it is clicked.
  - getVisible
```
public boolean getVisible()
```
    returns true if this textbox is visible
  - setVisible
```
public void setVisible(boolean isVisible)
```
    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

setGuiResponder

updateCursorCounter

setText

getText

getSelectedText

setValidator

writeText

setResponderEntryValue

deleteWords

deleteFromCursor

getId

getNthWordFromCursor

getNthWordFromPos

getNthWordFromPosWS

moveCursorBy

setCursorPosition

setCursorPositionZero

setCursorPositionEnd

textboxKeyTyped

mouseClicked

drawTextBox

setMaxStringLength

getMaxStringLength

getCursorPosition

getEnableBackgroundDrawing

setEnableBackgroundDrawing

setTextColor

setDisabledTextColour

setFocused

isFocused

setEnabled

getSelectionEnd

getWidth

setSelectionPos

setCanLoseFocus

getVisible

setVisible