net.malisis.core.client.gui.component.interaction

Class UITextField

java.lang.Object

net.malisis.core.client.gui.component.UIComponent<UITextField>

net.malisis.core.client.gui.component.interaction.UITextField

All Implemented Interfaces:

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

Direct Known Subclasses:

BBTextField, UIPasswordField

public class UITextField
extends UIComponent<UITextField>
implements IScrollable, IGuiText<UITextField>

UITextField.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UITextField.CursorPosition This class determines a position inside the text divides in lines.

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

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	bgColor Background color of this UITextField.
protected int	charOffset Number of character offset out of this UITextField when drawn.
protected int	cursorColor Cursor color for this UITextField.
protected UITextField.CursorPosition	cursorPosition Current cursor position.
protected GuiShape	cursorShape Shape used to draw the cursor of this UITextField.
protected FontRenderOptions	disabledFro The FontRenderOptions to use for this UITooltip when disabled.
protected boolean	editable Whether this UITextField is editable.
protected MalisisFont	font The MalisisFont to use for this UITooltip.
protected FontRenderOptions	fro The FontRenderOptions to use for this UITooltip.
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 int	selectColor Selection color for this UITextField.
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 com.google.common.base.Predicate<java.lang.String>	validator Validator

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

alpha, anchor, disabled, focused, height, hovered, iconProvider, 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

Modifier and Type	Method and Description
void	addText(java.lang.String str) Adds text at current cursor position.
void	buildLines() Builds the lines for 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.
int	getCursorColor() Gets the cursor color.
UITextField.CursorPosition	getCursorPosition() Gets the current cursor position.
FontRenderOptions	getDisabledFontRendererOptions() Gets the FontRenderOptions used when disabled.
MalisisFont	getFont() Gets the MalisisFont.
FontRenderOptions	getFontRenderOptions() Gets the FontRenderOptions.
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() Gets the offset x.
float	getOffsetY() Gets the offset y.
java.lang.String	getPropertyString() Gets the property string.
UISlimScrollbar	getScrollbar() Gets the UISlimScrollbar of this UITextField.
float	getScrollStep() Gets the scroll step.
int	getSelectColor() Gets the select color.
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.
com.google.common.base.Predicate<java.lang.String>	getValidator() Gets the predicate used to validate input text.
int	getVerticalPadding() Gets the vertical padding.
int	getVisibleLines() Gets the number of visible lines inside this UITextField.
protected boolean	handleCtrlKeyDown(int keyCode) Handles the key typed while a control key is pressed.
boolean	isEditable() Checks if is editable.
void	onAddedToScreen() Called when this UIComponent is added to screen.
boolean	onButtonPress(int x, int y, MouseButton button) On button press.
boolean	onButtonRelease(int x, int y, MouseButton button) On button release.
protected void	onCursorUpdated() Called when a cursor is updated.
boolean	onDoubleClick(int x, int y, MouseButton button) On double click.
boolean	onDrag(int lastX, int lastY, int x, int y, MouseButton button) On drag.
boolean	onKeyTyped(char keyChar, int keyCode) On key typed.
void	selectWord() Select word.
void	selectWord(int position) Select word.
UITextField	setAutoSelectOnFocus(boolean auto) Sets whether this UITextField should automatically select its text when focused.
UITextField	setCursorColor(int cursorColor) Sets the cursor color.
void	setCursorPosition(int x, int y) Sets the position of the cursor at the specified cooridnates.
UITextField	setDisabledFontRendererOptions(FontRenderOptions fro) Sets the FontRenderOptions to use when disabled.
UITextField	setEditable(boolean editable) Sets the editable.
void	setFocused(boolean focused) Sets the focused.
UITextField	setFont(MalisisFont font) Sets the MalisisFont.
UITextField	setFontRenderOptions(FontRenderOptions fro) Sets the FontRenderOptions.
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	setOptions(int bgColor, int cursorColor, int selectColor) Sets the options.
void	setParent(UIComponent<?> parent) Sets the parent of this UIComponent.
UITextField	setSelectColor(int selectColor) Sets the select color.
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	setValidator(com.google.common.base.Predicate<java.lang.String> validator) Sets the predicate used to validate input text.
protected void	startSelecting() Starts selecting text if Shift key is pressed.
protected boolean	validateText(java.lang.String text) Checks against if text is valid.

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

addControlComponent, attachData, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getData, getGui, getHeight, getIconProvider, getName, getParent, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onClick, onMouseMove, onRightClick, onScrollWheel, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, self, setAlpha, setAnchor, setDisabled, setHovered, setName, 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

font

protected MalisisFont font

The MalisisFont to use for this UITooltip.

fro

protected FontRenderOptions fro

The FontRenderOptions to use for this UITooltip.

disabledFro

protected FontRenderOptions disabledFro

The FontRenderOptions to use for this UITooltip when disabled.

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.

validator

protected com.google.common.base.Predicate<java.lang.String> validator

Validator

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.

selectingText

protected boolean selectingText

Whether currently selecting text.

cursorPosition

protected UITextField.CursorPosition cursorPosition

Current cursor position.

selectionPosition

protected UITextField.CursorPosition selectionPosition

Current selection cursor position.

startTimer

protected long startTimer

Cursor blink timer.

autoSelectOnFocus

protected boolean autoSelectOnFocus

Whether this UITextField should auto select the text when gaining focus.

editable

protected boolean editable

Whether this UITextField is editable.

scrollBar

protected UISlimScrollbar scrollBar

Scrollbar of the textfield *.

bgColor

protected int bgColor

Background color of this UITextField.

cursorColor

protected int cursorColor

Cursor color for this UITextField.

selectColor

protected int selectColor

Selection color for this UITextField.

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

setParent

public void setParent(UIComponent<?> parent)

Description copied from class: UIComponent

Sets the parent of this UIComponent.

Overrides:

setParent in class UIComponent<UITextField>

Parameters:

parent - the parent

onAddedToScreen

public void onAddedToScreen()

Description copied from class: UIComponent

Called when this UIComponent is added to screen.
Triggers a SpaceChangeEvent.SizeChangeEvent if this component size is relative.

Overrides:

onAddedToScreen in class UIComponent<UITextField>

getFont

public MalisisFont getFont()

Description copied from interface: IGuiText

Gets the MalisisFont.

Specified by:

getFont in interface IGuiText<UITextField>

Returns:

the font

setFont

public UITextField setFont(MalisisFont font)

Description copied from interface: IGuiText

Sets the MalisisFont.

Specified by:

setFont in interface IGuiText<UITextField>

Parameters:

font - the new font

Returns:

the t

getFontRenderOptions

public FontRenderOptions getFontRenderOptions()

Description copied from interface: IGuiText

Gets the FontRenderOptions.

Specified by:

getFontRenderOptions in interface IGuiText<UITextField>

Returns:

the font renderer options

setFontRenderOptions

public UITextField setFontRenderOptions(FontRenderOptions fro)

Description copied from interface: IGuiText

Sets the FontRenderOptions.

Specified by:

setFontRenderOptions in interface IGuiText<UITextField>

Parameters:

fro - the fro

Returns:

the t

getDisabledFontRendererOptions

public FontRenderOptions getDisabledFontRendererOptions()

Gets the FontRenderOptions used when disabled.

Returns:

the disabled font renderer options

setDisabledFontRendererOptions

public UITextField setDisabledFontRendererOptions(FontRenderOptions fro)

Sets the FontRenderOptions to use when disabled.

Parameters:

fro - the fro

Returns:

this UITextField

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

getSelectedText

public java.lang.String getSelectedText()

Gets the currently selected text.

Returns:

the text selected.

getCursorColor

public int getCursorColor()

Gets the cursor color.

Returns:

the cursor color

setCursorColor

public UITextField setCursorColor(int cursorColor)

Sets the cursor color.

Parameters:

cursorColor - the cursor color

Returns:

the UI text field

getSelectColor

public int getSelectColor()

Gets the select color.

Returns:

the select color

setSelectColor

public UITextField setSelectColor(int selectColor)

Sets the select color.

Parameters:

selectColor - the select color

Returns:

the UI text field

setOptions

public UITextField setOptions(int bgColor,
                              int cursorColor,
                              int selectColor)

Sets the options.

Parameters:

bgColor - the bg color

cursorColor - the cursor color

selectColor - the select color

Returns:

the UI text field

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

getLineSpacing

public int getLineSpacing()

Gets the line spacing used when drawing.

Returns:

the lineSpacing

setLineSpacing

public UITextField setLineSpacing(int lineSpacing)

Sets the line spacing for this UITextField.

Parameters:

lineSpacing - the lineSpacing to set

Returns:

this UITextField

setLineOffset

public void setLineOffset(int line)

Sets the line offset.

Parameters:

line - the new line offset

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

setAutoSelectOnFocus

public UITextField setAutoSelectOnFocus(boolean auto)

Sets whether this UITextField should automatically select its text when focused.

Parameters:

auto - the auto

Returns:

this UITextField

isEditable

public boolean isEditable()

Checks if is editable.

Returns:

true, if is editable

setEditable

public UITextField setEditable(boolean editable)

Sets the editable.

Parameters:

editable - the editable

Returns:

the UI text field

getScrollbar

public UISlimScrollbar getScrollbar()

Gets the UISlimScrollbar of this UITextField.

Returns:

the scrollbar

getValidator

public com.google.common.base.Predicate<java.lang.String> getValidator()

Gets the predicate used to validate input text.

Returns:

the predicate

setValidator

public UITextField setValidator(com.google.common.base.Predicate<java.lang.String> validator)

Sets the predicate used to validate input text.

Parameters:

validator - the validator

Returns:

the UI text field

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()

Gets the offset x.

Specified by:

getOffsetX in interface IScrollable

Returns:

the offset x

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()

Gets the offset y.

Specified by:

getOffsetY in interface IScrollable

Returns:

the offset y

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()

Gets the scroll step.

Specified by:

getScrollStep in interface IScrollable

Returns:

the scroll step

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

getVisibleLines

public int getVisibleLines()

Gets the number of visible lines inside this UITextField.

Returns:

the int

getLineHeight

public int getLineHeight()

Gets the line height of this UITextField.

Returns:

the line height

buildLines

public void buildLines()

Builds the lines for this UITextField.

validateText

protected boolean validateText(java.lang.String text)

Checks against if text is valid.

Parameters:

text - the text

Returns:

true, if input is valid

addText

public void addText(java.lang.String str)

Adds text at current cursor position. If some text is selected, it's deleted first.

Parameters:

str - the text

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

selectWord

public void selectWord()

Select word.

selectWord

public void selectWord(int position)

Select word.

Parameters:

position - the position

onCursorUpdated

protected void onCursorUpdated()

Called when a cursor is updated.
Offsets the content to make sure the cursor is still visible.

startSelecting

protected void startSelecting()

Starts selecting text if Shift key is pressed.
Places selection cursor at the current cursor position.

onButtonPress

public boolean onButtonPress(int x,
                             int y,
                             MouseButton button)

On button press.

Overrides:

onButtonPress in class UIComponent<UITextField>

Parameters:

x - the x

y - the y

button - the button

Returns:

true, if successful

onButtonRelease

public boolean onButtonRelease(int x,
                               int y,
                               MouseButton button)

On button release.

Overrides:

onButtonRelease in class UIComponent<UITextField>

Parameters:

x - the x

y - the y

button - the button

Returns:

true, if successful

onDrag

public boolean onDrag(int lastX,
                      int lastY,
                      int x,
                      int y,
                      MouseButton button)

On drag.

Overrides:

onDrag in class UIComponent<UITextField>

Parameters:

lastX - the last x

lastY - the last y

x - the x

y - the y

button - the button

Returns:

true, if successful

onDoubleClick

public boolean onDoubleClick(int x,
                             int y,
                             MouseButton button)

On double click.

Overrides:

onDoubleClick in class UIComponent<UITextField>

Parameters:

x - the x

y - the y

button - the button

Returns:

true, if successful

onKeyTyped

public boolean onKeyTyped(char keyChar,
                          int keyCode)

On key typed.

Specified by:

onKeyTyped in interface IKeyListener

Overrides:

onKeyTyped in class UIComponent<UITextField>

Parameters:

keyChar - the key char

keyCode - the key code

Returns:

true, if successful

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

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

getPropertyString

public java.lang.String getPropertyString()

Gets the property string.

Overrides:

getPropertyString in class UIComponent<UITextField>

Returns:

the property string