guiSET.core

Class MultilineTextbox

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

guiSET.core.Container

guiSET.core.VFlowContainer

guiSET.core.VScrollContainer

guiSET.core.MultilineTextbox

public class MultilineTextbox
extends VScrollContainer

The MultilineTextbox allows entering and pasting multi-line text. If the width of a line exceeds the MultilineTextboxs width, line-breaks are performed. Features copy/paste/cut, select and special events.

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 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
MultilineTextbox()
MultilineTextbox(int width, int height)
MultilineTextbox(int width, int height, int fontSize)
MultilineTextbox(java.lang.String hint, int width, int height)

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()
boolean	getClickSetsCursor()
int	getCursorColor()
int	getCursorPosition()
java.lang.String	getHint()
java.lang.String	getSelection()
int	getSelectionColor()
int	getSelectionEnd()
int	getSelectionStart()
void	paste() Paste from clipboard (and delete selection)
void	removeKeyPressListener()
void	removeTextChangeListener()
void	setClickSetsCursor(boolean clickSetsCursor) if false then clicking on the Textbox does not set the cursor to where the user clicked.
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.
void	setFontSize(float fontSize) Set the font size for the displayed text.
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	setPadding(int all) Apply same padding to all sides
void	setPadding(int top_bottom, int left_right)
void	setPadding(int top, int right, int bottom, int left) Apply individual padding to all sides of the element.
void	setPaddingLeft(int left)
void	setPaddingRight(int right)
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	setSize(int width, int height) Set width and height of element.
void	setSlimScrollHandle(boolean slimScrollHandle) Enable a slim (mobile phone like) scroll handle instead of the standard one.
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).
void	setWidth(int width) Set width of element.

Methods inherited from class guiSET.core.VScrollContainer

getAvailableWidth, getFullScrollHeight, getScrollPosition, getScrollSpeed, isSlimScrollHandle, scrollToItem, scrollToItem, setScrollPosition, setScrollSpeed

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, 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, getAvailableHeight, 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, setPaddingBottom, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setVisibility, setVisible, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

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

Constructor Detail

MultilineTextbox

public MultilineTextbox()

MultilineTextbox

public MultilineTextbox(int width,
                        int height)

MultilineTextbox

public MultilineTextbox(java.lang.String hint,
                        int width,
                        int height)

MultilineTextbox

public MultilineTextbox(int width,
                        int height,
                        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 - cursor positon

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

setClickSetsCursor

public void setClickSetsCursor(boolean clickSetsCursor)

if false then clicking on the Textbox does not set the cursor to where the user clicked. Not really necessary but I needed it once.

Parameters:

clickSetsCursor - clickSetsCursor

setSize

public void setSize(int width,
                    int height)

Description copied from class: Control

Set width and height of element.

Overrides:

setSize in class Control

Parameters:

width - width in pixel

height - height in pixel

setWidth

public void setWidth(int width)

Description copied from class: Control

Set width of element.

Overrides:

setWidth in class Control

Parameters:

width - width in pixel

setPadding

public void setPadding(int all)

Description copied from class: Control

Apply same padding to all sides

Overrides:

setPadding in class Control

Parameters:

all - padding in pixel

setPadding

public void setPadding(int top_bottom,
                       int left_right)

Overrides:

setPadding in class Control

setPadding

public void setPadding(int top,
                       int right,
                       int bottom,
                       int left)

Description copied from class: Control

Apply individual padding to all sides of the element. Padding will create space inside the element between borders and content.

Overrides:

setPadding in class Control

Parameters:

top - top padding in pixel

right - right padding in pixel

bottom - bottom padding in pixel

left - left padding in pixel

setPaddingRight

public void setPaddingRight(int right)

Overrides:

setPaddingRight in class Control

setPaddingLeft

public void setPaddingLeft(int left)

Overrides:

setPaddingLeft in class Control

setSlimScrollHandle

public void setSlimScrollHandle(boolean slimScrollHandle)

Description copied from class: VScrollContainer

Enable a slim (mobile phone like) scroll handle instead of the standard one.

Overrides:

setSlimScrollHandle in class VScrollContainer

Parameters:

slimScrollHandle - slim scrollhandle

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

setFontSize

public void setFontSize(float fontSize)

Description copied from class: TextBased

Set the font size for the displayed text.

Overrides:

setFontSize in class TextBased

Parameters:

fontSize - font size

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

getCursorColor

public int getCursorColor()

getCursorPosition

public int getCursorPosition()

getSelectionColor

public int getSelectionColor()

getHint

public java.lang.String getHint()

getSelectionStart

public int getSelectionStart()

getSelectionEnd

public int getSelectionEnd()

getSelection

public java.lang.String getSelection()

getClickSetsCursor

public boolean getClickSetsCursor()

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

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