UITextField (MalisisCore 1.7.10-0.10.4 API)

java.lang.Object
- net.malisis.core.client.gui.component.UIComponent<UITextField>
- - net.malisis.core.client.gui.component.interaction.UITextField

All Implemented Interfaces:

IScrollable, ITransformable, ITransformable.Alpha, ITransformable.Position<UITextField>, ITransformable.Size<UITextField>

Direct Known Subclasses:

UIPasswordField
```
public class UITextField
extends UIComponent<UITextField>
implements IScrollable
```
UITextField.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class UITextField.CursorPosition
The Class CursorPosition.
- Nested classes/interfaces inherited from interface net.malisis.core.renderer.animation.transformation.ITransformable
  ITransformable.Alpha, ITransformable.Brightness, ITransformable.Color, ITransformable.Position<T>, ITransformable.Rotate, ITransformable.Scale, ITransformable.Size<T>, ITransformable.Translate

Nested Classes
Modifier and Type	Class and Description
`protected class`	`UITextField.CursorPosition` The Class CursorPosition.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoSelectOnFocus` Whether this `UITextField` should auto select the text when gaining focus.
`protected int`	`charOffset` Number of character offset out of this `UITextField` when drawn.
`protected UITextField.CursorPosition`	`cursorPosition` Current cursor position.
`protected GuiShape`	`cursorShape` Shape used to draw the cursor of this `UITextField`.
`protected float`	`fontScale` Font scale used to draw the text *.
`protected GuiIcon`	`iconTextfield` Icon used to draw this `UITextField`.
`protected GuiIcon`	`iconTextfieldDisabled` Icon used to draw this `UITextField` when disabled.
`protected int`	`lineOffset` Number of line offset out of this `UITextField` when drawn.
`protected java.util.List<java.lang.String>`	`lines` Different lines if `multiLine` is `true`.
`protected int`	`lineSpacing` Space used between each line.
`protected boolean`	`multiLine` Whether this `UITextField` handles multiline text.
`protected UISlimScrollbar`	`scrollBar` Scrollbar of the textfield
`protected boolean`	`selectingText` Whether currently selecting text.
`protected UITextField.CursorPosition`	`selectionPosition` Current selection cursor position.
`protected GuiShape`	`selectShape` Shape used to draw the selection box.
`protected long`	`startTimer` Cursor blink timer.
`protected java.lang.StringBuilder`	`text` Current text of this `UITextField`.
`protected int`	`textColor` Color of the text for this `UITextField`.

Fields inherited from class net.malisis.core.client.gui.component.UIComponent
alpha, anchor, disabled, focused, height, hovered, icon, INHERITED, name, parent, rp, shape, tooltip, visible, width, x, y, zIndex

Constructor Summary

Constructors
Constructor and Description
`UITextField(MalisisGui gui, boolean multiLine)` Instantiates a new empty `UITextField`.
`UITextField(MalisisGui gui, java.lang.String text)` Instantiates a new single lined `UITextField`.
`UITextField(MalisisGui gui, java.lang.String text, boolean multiLine)` Instantiates a new `UITextField`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addText(java.lang.String text)` Adds text at current cursor position.
`protected void`	`buildLines()` Builds the lines for this `UITextField`.
`protected void`	`createShape(MalisisGui gui)` Creates the shapes used by this `UITextField`.
`void`	`deleteFromCursor(int amount)` Deletes the specified amount of characters.
`void`	`deleteSelectedText()` Deletes the text currently selected.
`void`	`deleteWord(boolean backwards)` Deletes the text from current cursor position to the next space.
`void`	`drawBackground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick)` Draws the background.
`void`	`drawCursor(GuiRenderer renderer)` Draws the cursor of this `UITextField`.
`void`	`drawForeground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick)` Draws the foreground.
`void`	`drawSelectionBox(GuiRenderer renderer)` Draw the selection box of this `UITextField`.
`void`	`drawText(GuiRenderer renderer)` Draws the text of this `UITextField`.
`int`	`getContentHeight()` Gets the content height.
`int`	`getContentWidth()` Gets the content width.
`UITextField.CursorPosition`	`getCursorPosition()` Gets the current cursor position.
`float`	`getFontScale()` Gets the font scale used by this `UITextField`.
`int`	`getHorizontalPadding()` Gets the horizontal padding.
`int`	`getLineHeight()` Gets the line height of this `UITextField`.
`int`	`getLineSpacing()` Gets the line spacing used when drawing.
`float`	`getOffsetX()`
`float`	`getOffsetY()`
`java.lang.String`	`getPropertyString()` Gets the property string.
`UISlimScrollbar`	`getScrollbar()` Gets the `UISlimScrollbar` of this `UITextField`.
`float`	`getScrollStep()`
`java.lang.String`	`getSelectedText()` Gets the currently selected text.
`UITextField.CursorPosition`	`getSelectionPosition()` Gets the selection position.
`java.lang.String`	`getText()` Gets the text of this `UITextField`.
`int`	`getTextColor()` Gets the text color.
`int`	`getVerticalPadding()` Gets the vertical padding.
`protected boolean`	`handleCtrlKeyDown(int keyCode)` Handles the key typed while a control key is pressed.
`void`	`keyTyped(KeyboardEvent event)` Called when a key is pressed.
`void`	`onCursorUpdated()` Called when a cursor is updated.
`void`	`onDoubleClick(MouseEvent.DoubleClick event)` Called when a mouse button is double clicked over this `UITextField`.
`void`	`onDrag(MouseEvent.Drag event)` Called when a mouse button is dragged over this `UITextField`.
`void`	`onMousePress(MouseEvent.Press event)` Called when a mouse button is pressed over this `UITextField`.
`void`	`onMouseRelease(MouseEvent.Release event)` Called when a mouse button is released over this `UITextField`.
`UITextField`	`setAutoSelectOnFocus(boolean auto)` Sets whether this `UITextField` should automatically select its `text` when focused.
`void`	`setCursorPosition(int x, int y)` Sets the position of the cursor at the specified cooridnates.
`void`	`setFocused(boolean focused)` Sets the focused.
`UITextField`	`setFontScale(float fontScale)` Sets the font scale for this `UITextField`.
`void`	`setLineOffset(int line)` Sets the line offset.
`UITextField`	`setLineSpacing(int lineSpacing)` Sets the line spacing for this `UITextField`.
`void`	`setOffsetX(float offsetX, int delta)` Sets the offset x.
`void`	`setOffsetY(float offsetY, int delta)` Sets the offset y.
`UITextField`	`setSize(int width, int height)` Sets the size of this `UITextField`.
`void`	`setText(java.lang.String text)` Sets the text of this `UITextField` and place the cursor at the end.
`UITextField`	`setTextColor(int color)` Sets the text color for this `UITextField`.
`protected void`	`startSelecting()` Starts selecting text if Shift key is pressed.
`protected boolean`	`validateText(java.lang.String text)` Checks against if text is valid.
`protected int`	`visibleLines()` Gets the number of visible lines inside this `UITextField`.

Methods inherited from class net.malisis.core.client.gui.component.UIComponent
addControlComponent, componentX, componentY, draw, fireEvent, fireKeyboardEvent, fireMouseEvent, getAlpha, getAnchor, getComponentAt, getGui, getHeight, getName, getParent, getRawHeight, getRawWidth, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, setAlpha, setAnchor, setDisabled, setHovered, setName, setParent, setPosition, setPosition, setTooltip, setTooltip, setVisible, setZIndex, toString, unregister

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

- Field Detail
  - text
```
protected java.lang.StringBuilder text
```
    Current text of this UITextField.
  - lines
```
protected java.util.List<java.lang.String> lines
```
    Different lines if multiLine is true.
  - multiLine
```
protected boolean multiLine
```
    Whether this UITextField handles multiline text.
  - cursorPosition
```
protected UITextField.CursorPosition cursorPosition
```
    Current cursor position.
  - selectionPosition
```
protected UITextField.CursorPosition selectionPosition
```
    Current selection cursor position.
  - selectingText
```
protected boolean selectingText
```
    Whether currently selecting text.
  - charOffset
```
protected int charOffset
```
    Number of character offset out of this UITextField when drawn.
  - lineOffset
```
protected int lineOffset
```
    Number of line offset out of this UITextField when drawn. Always 0 if multiLine is false
  - lineSpacing
```
protected int lineSpacing
```
    Space used between each line.
  - startTimer
```
protected long startTimer
```
    Cursor blink timer.
  - autoSelectOnFocus
```
protected boolean autoSelectOnFocus
```
    Whether this UITextField should auto select the text when gaining focus.
  - textColor
```
protected int textColor
```
    Color of the text for this UITextField.
  - scrollBar
```
protected UISlimScrollbar scrollBar
```
    Scrollbar of the textfield
  - fontScale
```
protected float fontScale
```
    Font scale used to draw the text *.
  - cursorShape
```
protected GuiShape cursorShape
```
    Shape used to draw the cursor of this UITextField.
  - selectShape
```
protected GuiShape selectShape
```
    Shape used to draw the selection box.
  - iconTextfield
```
protected GuiIcon iconTextfield
```
    Icon used to draw this UITextField.
  - iconTextfieldDisabled
```
protected GuiIcon iconTextfieldDisabled
```
    Icon used to draw this UITextField when disabled.
- Constructor Detail
  - UITextField
```
public UITextField(MalisisGui gui,
           java.lang.String text,
           boolean multiLine)
```
    Instantiates a new UITextField.
    
    Parameters:
    gui - the gui
    text - the text
    multiLine - whether the textfield handles multiple lines
  - UITextField
```
public UITextField(MalisisGui gui,
           java.lang.String text)
```
    Instantiates a new single lined UITextField.
    
    Parameters:
    gui - the gui
    text - the text
  - UITextField
```
public UITextField(MalisisGui gui,
           boolean multiLine)
```
    Instantiates a new empty UITextField.
    
    Parameters:
    gui - the gui
    multiLine - the multi line
- Method Detail
  - createShape
```
protected void createShape(MalisisGui gui)
```
    Creates the shapes used by this UITextField.
    
    Parameters:
    gui - the gui
  - getText
```
public java.lang.String getText()
```
    Gets the text of this UITextField.
    
    Returns:
    the text
  - setText
```
public void setText(java.lang.String text)
```
    Sets the text of this UITextField and place the cursor at the end.
    
    Parameters:
    text - the new text
  - setSize
```
public UITextField setSize(int width,
                  int height)
```
    Sets the size of this UITextField.
    If multiLine is false, height is forced to 12.
    
    Specified by:
    
    setSize in interface ITransformable.Size<UITextField>
    
    Overrides:
    
    setSize in class UIComponent<UITextField>
    
    Parameters:
    width - the width
    height - the height
    
    Returns:
    the UI text field
  - setFocused
```
public void setFocused(boolean focused)
```
    Sets the focused.
    
    Overrides:
    
    setFocused in class UIComponent<UITextField>
    
    Parameters:
    focused - the new focused
  - setFontScale
```
public UITextField setFontScale(float fontScale)
```
    Sets the font scale for this UITextField.
    
    Parameters:
    fontScale - the font scale
    
    Returns:
    this UITextField
  - getFontScale
```
public float getFontScale()
```
    Gets the font scale used by this UITextField.
    
    Returns:
    the font scale
  - getLineSpacing
```
public int getLineSpacing()
```
    Gets the line spacing used when drawing.
    
    Returns:
    the lineSpacing
  - setLineOffset
```
public void setLineOffset(int line)
```
    Sets the line offset.
    
    Parameters:
    line - the new line offset
  - setLineSpacing
```
public UITextField setLineSpacing(int lineSpacing)
```
    Sets the line spacing for this UITextField.
    
    Parameters:
    lineSpacing - the lineSpacing to set
    
    Returns:
    this UITextField
  - getLineHeight
```
public int getLineHeight()
```
    Gets the line height of this UITextField.
    
    Returns:
    the line height
  - getCursorPosition
```
public UITextField.CursorPosition getCursorPosition()
```
    Gets the current cursor position.
    
    Returns:
    the position of the cursor.
  - getSelectionPosition
```
public UITextField.CursorPosition getSelectionPosition()
```
    Gets the selection position.
    
    Returns:
    the selection position
  - setCursorPosition
```
public void setCursorPosition(int x,
                     int y)
```
    Sets the position of the cursor at the specified cooridnates.
    
    Parameters:
    x - the x coordinate
    y - the y coordinate
  - setTextColor
```
public UITextField setTextColor(int color)
```
    Sets the text color for this UITextField.
    
    Parameters:
    color - the color
    
    Returns:
    this UITextField
  - getTextColor
```
public int getTextColor()
```
    Gets the text color.
    
    Returns:
    the text color of this UITextField.
  - setAutoSelectOnFocus
```
public UITextField setAutoSelectOnFocus(boolean auto)
```
    Sets whether this UITextField should automatically select its text when focused.
    
    Parameters:
    auto - the auto
    
    Returns:
    this UITextField
  - getScrollbar
```
public UISlimScrollbar getScrollbar()
```
    Gets the UISlimScrollbar of this UITextField.
    
    Returns:
    the scrollbar
  - buildLines
```
protected void buildLines()
```
    Builds the lines for this UITextField. Does nothing if multiLine is false.
  - addText
```
public void addText(java.lang.String text)
```
    Adds text at current cursor position. If some text is selected, it's deleted first.
    
    Parameters:
    text - the text
  - validateText
```
protected boolean validateText(java.lang.String text)
```
    Checks against if text is valid.
    
    Parameters:
    text - the text
    
    Returns:
    true, if input is valid
  - getSelectedText
```
public java.lang.String getSelectedText()
```
    Gets the currently selected text.
    
    Returns:
    the text selected.
  - deleteSelectedText
```
public void deleteSelectedText()
```
    Deletes the text currently selected.
  - deleteFromCursor
```
public void deleteFromCursor(int amount)
```
    Deletes the specified amount of characters. Negative numbers will delete characters left of the cursor.
    If text is already selected, delete that text instead.
    
    Parameters:
    amount - the amount of characters to delete
  - deleteWord
```
public void deleteWord(boolean backwards)
```
    Deletes the text from current cursor position to the next space.
    
    Parameters:
    backwards - whether to look left for the next space
  - getContentWidth
```
public int getContentWidth()
```
    Gets the content width.
    
    Specified by:
    
    getContentWidth in interface IScrollable
    
    Returns:
    the content width
  - getContentHeight
```
public int getContentHeight()
```
    Gets the content height.
    
    Specified by:
    
    getContentHeight in interface IScrollable
    
    Returns:
    the content height
  - getOffsetX
```
public float getOffsetX()
```
    Specified by:
    
    getOffsetX in interface IScrollable
  - setOffsetX
```
public void setOffsetX(float offsetX,
              int delta)
```
    Sets the offset x.
    
    Specified by:
    
    setOffsetX in interface IScrollable
    
    Parameters:
    offsetX - the offset x
    delta - the delta
  - getOffsetY
```
public float getOffsetY()
```
    Specified by:
    
    getOffsetY in interface IScrollable
  - setOffsetY
```
public void setOffsetY(float offsetY,
              int delta)
```
    Sets the offset y.
    
    Specified by:
    
    setOffsetY in interface IScrollable
    
    Parameters:
    offsetY - the offset y
    delta - the delta
  - getScrollStep
```
public float getScrollStep()
```
    Specified by:
    
    getScrollStep in interface IScrollable
  - getVerticalPadding
```
public int getVerticalPadding()
```
    Gets the vertical padding.
    
    Specified by:
    
    getVerticalPadding in interface IScrollable
    
    Returns:
    the vertical padding
  - getHorizontalPadding
```
public int getHorizontalPadding()
```
    Gets the horizontal padding.
    
    Specified by:
    
    getHorizontalPadding in interface IScrollable
    
    Returns:
    the horizontal padding
  - visibleLines
```
protected int visibleLines()
```
    Gets the number of visible lines inside this UITextField.
    
    Returns:
    the int
  - onCursorUpdated
```
public void onCursorUpdated()
```
    Called when a cursor is updated.
    Offsets the content to make sure the cursor is still visible.
  - drawBackground
```
public void drawBackground(GuiRenderer renderer,
                  int mouseX,
                  int mouseY,
                  float partialTick)
```
    Draws the background.
    
    Specified by:
    
    drawBackground in class UIComponent<UITextField>
    
    Parameters:
    renderer - the renderer
    mouseX - the mouse x
    mouseY - the mouse y
    partialTick - the partial tick
  - drawForeground
```
public void drawForeground(GuiRenderer renderer,
                  int mouseX,
                  int mouseY,
                  float partialTick)
```
    Draws the foreground.
    
    Specified by:
    
    drawForeground in class UIComponent<UITextField>
    
    Parameters:
    renderer - the renderer
    mouseX - the mouse x
    mouseY - the mouse y
    partialTick - the partial tick
  - drawText
```
public void drawText(GuiRenderer renderer)
```
    Draws the text of this UITextField.
    
    Parameters:
    renderer - the renderer
  - drawCursor
```
public void drawCursor(GuiRenderer renderer)
```
    Draws the cursor of this UITextField.
    
    Parameters:
    renderer - the renderer
  - drawSelectionBox
```
public void drawSelectionBox(GuiRenderer renderer)
```
    Draw the selection box of this UITextField.
    
    Parameters:
    renderer - the renderer
  - onMousePress
```
public void onMousePress(MouseEvent.Press event)
```
    Called when a mouse button is pressed over this UITextField.
    
    Parameters:
    event - the event
  - onMouseRelease
```
public void onMouseRelease(MouseEvent.Release event)
```
    Called when a mouse button is released over this UITextField.
    
    Parameters:
    event - the event
  - onDrag
```
public void onDrag(MouseEvent.Drag event)
```
    Called when a mouse button is dragged over this UITextField.
    
    Parameters:
    event - the event
  - onDoubleClick
```
public void onDoubleClick(MouseEvent.DoubleClick event)
```
    Called when a mouse button is double clicked over this UITextField.
    
    Parameters:
    event - the event
  - startSelecting
```
protected void startSelecting()
```
    Starts selecting text if Shift key is pressed.
    Places selection cursor at the current cursor position.
  - keyTyped
```
public void keyTyped(KeyboardEvent event)
```
    Called when a key is pressed.
    
    Parameters:
    event - the event
  - handleCtrlKeyDown
```
protected boolean handleCtrlKeyDown(int keyCode)
```
    Handles the key typed while a control key is pressed.
    
    Parameters:
    keyCode - the key code
    
    Returns:
    true, if successful
  - getPropertyString
```
public java.lang.String getPropertyString()
```
    Gets the property string.
    
    Overrides:
    
    getPropertyString in class UIComponent<UITextField>
    
    Returns:
    the property string

Class UITextField

Nested Class Summary

Nested classes/interfaces inherited from interface net.malisis.core.renderer.animation.transformation.ITransformable

Field Summary

Fields inherited from class net.malisis.core.client.gui.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class net.malisis.core.client.gui.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

text

lines

multiLine

cursorPosition

selectionPosition

selectingText

charOffset

lineOffset

lineSpacing

startTimer

autoSelectOnFocus

textColor

scrollBar

fontScale

cursorShape

selectShape

iconTextfield

iconTextfieldDisabled

Constructor Detail

UITextField

UITextField

UITextField

Method Detail

createShape

getText

setText

setSize

setFocused

setFontScale

getFontScale

getLineSpacing

setLineOffset

setLineSpacing

getLineHeight

getCursorPosition

getSelectionPosition

setCursorPosition

setTextColor

getTextColor

setAutoSelectOnFocus

getScrollbar

buildLines

addText

validateText

getSelectedText

deleteSelectedText

deleteFromCursor

deleteWord

getContentWidth

getContentHeight

getOffsetX

setOffsetX

getOffsetY

setOffsetY

getScrollStep

getVerticalPadding

getHorizontalPadding

visibleLines

onCursorUpdated

drawBackground

drawForeground

drawText

drawCursor

drawSelectionBox

onMousePress

onMouseRelease

onDrag

onDoubleClick

startSelecting

keyTyped