guiSET.core

Class Textbox

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

guiSET.core.Container

guiSET.core.HFlowContainer

guiSET.core.HScrollContainer

guiSET.core.Textbox

Direct Known Subclasses:

PasswordTextbox

public class Textbox
extends HScrollContainer

A single-line Textbox that behaves just as you would expect one to behave. When focused (by click) text can be inserted via keyboard. Comes with expected features like cursor, selection, some keyboard shortcuts for cut/copy/paste, scrolling etc...

Author:

Mc-Zen

Nested Class Summary

Nested classes/interfaces inherited from class guiSET.core.Control

Control.Constants, Control.ImageMode, Control.Predicate, Control.Predicate1<T>, Control.Predicate2<T,U>, Control.RenderingMethod, Control.Setter<T>

Field Summary

Fields

Modifier and Type	Field and Description
boolean	submitOnEnter

Fields inherited from class guiSET.core.TextBased

FONT_SIZE, LINE_HEIGHT, TEXT_ALIGN, TEXT_ALIGN_Y, TEXT_COLOR

Fields inherited from class guiSET.core.Control

ALL, ANCHOR_INACTIVE, AUTOSIZE_BOTH, AUTOSIZE_HEIGHT, AUTOSIZE_NONE, AUTOSIZE_WIDTH, BACKGROUND_COLOR, BACKGROUND_COLORS, BORDER, BORDER_COLOR, BORDER_RADIUS, BORDER_WIDTH, BUFFERED_RENDERING, COLORS, defaultRenderingMethod, FILL, FIT, FIT_INSIDE, FOREGROUND_COLOR, HOVER_COLOR, MARGIN, MARGIN_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, name, OPACITY, PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PERCENTAGE_MODE, PIXEL_MODE, PRESSED_COLOR, SPACING, TEXT_PROPERTIES, UNBUFFERED_RENDERING

Constructor Summary

Constructors

Constructor and Description
Textbox()
Textbox(int width)
Textbox(int width, int fontSize)
Textbox(java.lang.String hint)
Textbox(java.lang.String hint, int width)
Textbox(java.lang.String hint, int width, int fontSize)

Method Summary

Modifier and Type	Method and Description
void	copy() Copy selection to clipboard
void	cut() Cut selection and copy to clipboard
void	disableInput() Prevent user from typing or pasting text while maintaining the ability of selecting and copying.
void	enableInput() Undo disableInput()
int	getCursorColor()
int	getCursorPosition()
static int	getGlobalCursorCycleTime()
java.lang.String	getHint()
java.lang.String	getSelectedText()
int	getSelectionColor()
int	getSelectionEnd()
int	getSelectionStart()
void	paste() Paste from clipboard (and delete selection)
void	removeKeyPressListener()
void	removeSubmitListener()
void	removeTextChangeListener()
void	setCursorColor(int cursorColor) Set the color of the cursor.
void	setCursorPosition(int cursorPosition) Set the cursor to a specific index position in the text.
static void	setGlobalCursorCycleTime(int milliseconds) Set the time the cursor needs to blink on and off in milliseconds, default is 1000 (1 second).
void	setHint(java.lang.String hint) Set a hint for the textbox that is displayed when the textbox is empty.
void	setKeyPressListener(Control.Predicate lambda) Set a lambda key listener to the textbox.
void	setKeyPressListener(Control.Predicate1<KeyEvent> lambda) Set a lambda key listener to the textbox.
void	setKeyPressListener(java.lang.String methodName)
void	setKeyPressListener(java.lang.String methodName, java.lang.Object target) Set a key listener to the textbox.
void	setSelection(int start, int end) Set selection.
void	setSelectionColor(int selectionColor) Set highlight color of selection.
void	setSelectionEnd(int selectionEnd) Set the end for the text selection.
void	setSelectionStart(int selectionStart) Set the start for the text selection.
void	setSubmitListener(Control.Predicate lambda) So long as the property submitOnEnter is set to true, pressing enter or return will remove the focus of the textbox and call this event.
void	setSubmitListener(java.lang.String methodName)
void	setSubmitListener(java.lang.String methodName, java.lang.Object target) So long as the property submitOnEnter is set to true, pressing enter or return will remove the focus of the textbox and call this event.
void	setText(java.lang.String text) Set the text content.
void	setTextChangeListener(Control.Predicate lambda) Set a lambda listener that fires when the text has actually changed (not just the cursor or selection).
void	setTextChangeListener(java.lang.String methodName)
void	setTextChangeListener(java.lang.String methodName, java.lang.Object target) Set a listener that fires when the text has actually changed (not just the cursor or selection).

Methods inherited from class guiSET.core.HScrollContainer

getAvailableHeight, getFullScrollWidth, getScrollPosition, getScrollSpeed, isSlimScrollHandle, scrollToItem, scrollToItem, setScrollPosition, setScrollSpeed, setSlimScrollHandle

Methods inherited from class guiSET.core.Container

add, clear, fitContent, getItem, getItems, getNumItems, indexOf, insert, remove, remove, sortItems, traceAbsoluteCoordinates, traceRelativeCoordinates

Methods inherited from class guiSET.core.TextBased

copyStyle, getFont, getFontSize, getLineHeight, getText, getTextAlign, getTextAlignY, getTextColor, isBold, isItalic, isStrikethrough, isUnderlined, setBold, setFont, setFontSize, setForegroundColor, setItalic, setLineHeight, setLineHeightPercent, setStrikethrough, setText, setTextAlign, setTextAlignY, setTextColor, setUnderlined

Methods inherited from class guiSET.core.Control

addAutoAnchors, animate, blur, copyStyle, doForAll, fillParent, fillParent, fillParent, fillParentHeight, fillParentHeight, fillParentWidth, fillParentWidth, focus, forceRepaint, getAnchorMode, getAnchorValue, getAvailableWidth, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getCursor, getForegroundColor, getHeight, getHoverColor, getImage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOffsetXToParent, getOffsetXToWindow, getOffsetYToParent, getOffsetYToWindow, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchor, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setEnabled, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, setHeight, setHoverColor, setImage, setImageMode, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseListener, setMouseListener, setMouseListener, setMouseListener, setOpacity, setOpacity, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setSize, setVisibility, setVisible, setWidth, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

submitOnEnter

public boolean submitOnEnter

Constructor Detail

Textbox

public Textbox()

Textbox

public Textbox(java.lang.String hint)

Textbox

public Textbox(java.lang.String hint,
               int width)

Textbox

public Textbox(java.lang.String hint,
               int width,
               int fontSize)

Textbox

public Textbox(int width)

Textbox

public Textbox(int width,
               int fontSize)

Method Detail

setCursorColor

public void setCursorColor(int cursorColor)

Set the color of the cursor.

Parameters:

cursorColor - rgb integer color

setCursorPosition

public void setCursorPosition(int cursorPosition)

Set the cursor to a specific index position in the text.

Parameters:

cursorPosition - cusor position

setSelectionStart

public void setSelectionStart(int selectionStart)

Set the start for the text selection. Selection start index can never be higher than end index.

Parameters:

selectionStart - selection start position

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

Set the end for the text selection. Selection end index can never be less than start index.

Parameters:

selectionEnd - selection end position

setSelection

public void setSelection(int start,
                         int end)

Set selection. If end is less than start, they will we swapped.

Parameters:

start - selection start position

end - selection end position

setSelectionColor

public void setSelectionColor(int selectionColor)

Set highlight color of selection.

Parameters:

selectionColor - rgb integer color

setHint

public void setHint(java.lang.String hint)

Set a hint for the textbox that is displayed when the textbox is empty.

Parameters:

hint - hint

setText

public void setText(java.lang.String text)

Description copied from class: TextBased

Set the text content. Some elements do not display any text (i.e. most containers).

Overrides:

setText in class TextBased

Parameters:

text - text

disableInput

public void disableInput()

Prevent user from typing or pasting text while maintaining the ability of selecting and copying.

enableInput

public void enableInput()

Undo disableInput()

setGlobalCursorCycleTime

public static void setGlobalCursorCycleTime(int milliseconds)

Set the time the cursor needs to blink on and off in milliseconds, default is 1000 (1 second).

Parameters:

milliseconds - time in milliseconds

getCursorColor

public int getCursorColor()

getCursorPosition

public int getCursorPosition()

getSelectionColor

public int getSelectionColor()

getSelectionStart

public int getSelectionStart()

getSelectionEnd

public int getSelectionEnd()

getSelectedText

public java.lang.String getSelectedText()

getHint

public java.lang.String getHint()

getGlobalCursorCycleTime

public static int getGlobalCursorCycleTime()

setKeyPressListener

public void setKeyPressListener(java.lang.String methodName,
                                java.lang.Object target)

Set a key listener to the textbox. The event is triggered each time any key is pressed when the textbox has focus. Event arguments: KeyEvent

Parameters:

methodName - name of callback method

target - object that declares callback method.

setKeyPressListener

public void setKeyPressListener(java.lang.String methodName)

setKeyPressListener

public void setKeyPressListener(Control.Predicate lambda)

Set a lambda key listener to the textbox. The event is triggered each time any key is pressed when the textbox has focus. Event arguments: none

Parameters:

lambda - lambda expression

setKeyPressListener

public void setKeyPressListener(Control.Predicate1<KeyEvent> lambda)

Set a lambda key listener to the textbox. The event is triggered each time any key is pressed when the textbox has focus. Event arguments: KeyEvent

Parameters:

lambda - lambda expression with KeyEvent as parameter

removeKeyPressListener

public void removeKeyPressListener()

setTextChangeListener

public void setTextChangeListener(java.lang.String methodName,
                                  java.lang.Object target)

Set a listener that fires when the text has actually changed (not just the cursor or selection).

Parameters:

methodName - name of callback method

target - object that declares callback method.

setTextChangeListener

public void setTextChangeListener(java.lang.String methodName)

setTextChangeListener

public void setTextChangeListener(Control.Predicate lambda)

Set a lambda listener that fires when the text has actually changed (not just the cursor or selection). Event arguments: none

Parameters:

lambda - lambda expression

removeTextChangeListener

public void removeTextChangeListener()

setSubmitListener

public void setSubmitListener(java.lang.String methodName,
                              java.lang.Object target)

So long as the property submitOnEnter is set to true, pressing enter or return will remove the focus of the textbox and call this event.

Parameters:

methodName - name of callback method

target - object that declares callback method.

setSubmitListener

public void setSubmitListener(java.lang.String methodName)

setSubmitListener

public void setSubmitListener(Control.Predicate lambda)

So long as the property submitOnEnter is set to true, pressing enter or return will remove the focus of the textbox and call this event. Event arguments: none

Parameters:

lambda - lambda expression

removeSubmitListener

public void removeSubmitListener()

copy

public void copy()

Copy selection to clipboard

paste

public void paste()

Paste from clipboard (and delete selection)

cut

public void cut()

Cut selection and copy to clipboard