com.bonzaiengine.ui.widget

Class TextField

java.lang.Object

com.bonzaiengine.ui.widget.Widget

com.bonzaiengine.ui.widget.TextField

All Implemented Interfaces:

IScrollable

public class TextField
extends Widget
implements IScrollable

Nested Class Summary

Nested classes/interfaces inherited from class com.bonzaiengine.ui.widget.Widget

Widget.NotifyEvent

Constructor Summary

Constructors

Constructor and Description
TextField()

Method Summary

Modifier and Type	Method and Description
boolean	addChangeListener(ChangeListener l)
java.lang.String	getAppender()
int	getBorder()
Sprite	getCaret()
java.lang.String	getCaretSelection()
float[]	getColor()
float[]	getColorFocus()
float[]	getColorOver()
float[]	getColorSelected()
float[]	getColorSelectedBack()
float[]	getColorSelectedBackFocus()
java.lang.String	getFontName()
int	getFontSize()
java.lang.String	getFullText()
int	getMaxLength()
java.lang.String	getPrepender()
java.lang.String	getRange(Vec2i start, Vec2i end)
int	getStepForHorizontalScrolling()
int	getStepForVerticalScrolling()
java.lang.String	getText()
double	getTextAsDoubleOrSet(double value)
float	getTextAsFloatOrSet(float value)
int	getTextAsIntOrSet(int value)
boolean	isDelayEvents()
boolean	isEditable()
boolean	isLowerCase()
boolean	isMultipleLine()
boolean	isValueAdjusting()
boolean	removeChangeListener(ChangeListener l)
void	setAppender(java.lang.String appender)
void	setBorder(int border)
void	setCaret(Sprite caret)
void	setColor(Color4 color)
void	setColorFocus(Color4 colorFocus)
void	setColorOver(Color4 colorOver)
void	setColorSelected(Color4 colorSelected)
void	setColorSelectedBack(Color4 colorSelectedBack)
void	setColorSelectedBackFocus(Color4 colorSelectedBackFocus)
void	setDefaultDisplay(java.lang.Object defaultText)
void	setDelayEvents(boolean delayEvents)
void	setEditable(boolean editable)
void	setFontName(java.lang.String fontName)
void	setFontSize(int fontSize)
void	setLowerCase(boolean lowerCase)
void	setMaxLength(int maxLength)
void	setMultipleLine(boolean multipleLine)
void	setPrepender(java.lang.String prepender)
void	setText(java.lang.String text)
void	update(UI ui, long timePassedMS) Widget update.

Methods inherited from class com.bonzaiengine.ui.widget.Widget

addAnimator, addFocusListener, addKeyListener, addMouseFocusListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, find, find, focusTraversal, forceSize, getBackground, getBackgroundBorder, getBackgroundColor, getBackgroundFocus, getBackgroundOver, getBackgroundPress, getBorderSize, getConstraint, getDisableFade, getHeight, getHeightOnScreen, getInsets, getInsetsBottom, getInsetsHeight, getInsetsLeft, getInsetsRight, getInsetsTop, getInsetsWidth, getLocation, getLocationAnchor, getLocationOnScreen, getLocationRef, getLocationRef2, getLocationRefAnchor, getLocationX, getLocationXOnScreen, getLocationY, getLocationYOnScreen, getMaxHeight, getMaxWidth, getMenuPopup, getMinHeight, getMinHeightWidget, getMinWidth, getMinWidthWidget, getName, getOpacity, getParent, getPopup, getRoot, getStyle, getTooltip, getViewport, getViewportInternal, getWidth, getWidthOnScreen, hasFocus, isAutoPackHeight, isAutoPackWidth, isEnabled, isEnabledHerited, isEventsOnExternalDrag, isExternalDrag, isFocusable, isMouseDown, isMouseOver, isMouseOverOrDown, isOver, isVisible, isVisibleAndEnabledHerited, isVisibleHerited, keyPressed, keyReleased, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, refreshFocus, removeAnimator, removeFocusListener, removeKeyListener, removeMouseFocusListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, render, requestFocus, setAutoPack, setAutoPackHeight, setAutoPackWidth, setBackground, setBackgroundBorder, setBackgroundColor, setBackgroundFocus, setBackgroundOver, setBackgroundPress, setBorderSize, setCatchAllEvents, setDisableFade, setEnabled, setEventsOnExternalDrag, setExternalDrag, setFocusable, setFocusOwner, setInsets, setInsets, setLocation, setLocation, setLocationAnchor, setLocationAndAnchorInViewport, setLocationRef, setLocationRef2, setLocationRefAnchor, setMaxSize, setMaxSize, setMenuPopup, setMinSize, setMinSize, setName, setOpacity, setPopup, setSize, setSize, setStyle, setTooltip, setVisible, toString, uiFireAction

Methods inherited from class java.lang.Object

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

Constructor Detail

TextField

public TextField()

Method Detail

addChangeListener

public final boolean addChangeListener(ChangeListener l)

Parameters:

l - listener to register to this widget

removeChangeListener

public final boolean removeChangeListener(ChangeListener l)

update

public void update(UI ui,
                   long timePassedMS)

Description copied from class: Widget

Widget update. Occures before rendering to compute current states and absolute positioning.

Overrides:

update in class Widget

getCaretSelection

public final java.lang.String getCaretSelection()

getRange

public final java.lang.String getRange(Vec2i start,
                                       Vec2i end)

getStepForHorizontalScrolling

public final int getStepForHorizontalScrolling()

Specified by:

getStepForHorizontalScrolling in interface IScrollable

Returns:

the scroll step in pixels, or -1 if not applicable (use default instead)

getStepForVerticalScrolling

public final int getStepForVerticalScrolling()

Specified by:

getStepForVerticalScrolling in interface IScrollable

Returns:

the scroll step in pixels, or -1 if not applicable (use default instead)

setDefaultDisplay

public final void setDefaultDisplay(java.lang.Object defaultText)

setText

public final void setText(java.lang.String text)

Parameters:

text - new text of this TextField

getText

public final java.lang.String getText()

Returns:

the text of this TextField

getTextAsFloatOrSet

public final float getTextAsFloatOrSet(float value)

Returns:

the text parsed as float, or set the value if not parsable

getTextAsDoubleOrSet

public final double getTextAsDoubleOrSet(double value)

Returns:

the text parsed as double, or set the value if not parsable

getTextAsIntOrSet

public final int getTextAsIntOrSet(int value)

Returns:

the text parsed as int, or set the value if not parsable

getFullText

public final java.lang.String getFullText()

Returns:

getText() with getAppender() appended

getPrepender

public final java.lang.String getPrepender()

Returns:

the prepender

setPrepender

public void setPrepender(java.lang.String prepender)

Parameters:

prepender - set the new prepender or null

getAppender

public final java.lang.String getAppender()

Returns:

the appender

setAppender

public void setAppender(java.lang.String appender)

Parameters:

appender - set the new appender or null

setEditable

public final void setEditable(boolean editable)

Parameters:

editable - true to let the user edit this TextField value

isEditable

public final boolean isEditable()

Returns:

true if this TextField is editable

setMaxLength

public final void setMaxLength(int maxLength)

Parameters:

maxLength - maximum number of character

getMaxLength

public final int getMaxLength()

Returns:

the maximum number of character, -1 if unlimited

setBorder

public final void setBorder(int border)

Parameters:

border - new border size in pixels

getBorder

public final int getBorder()

Returns:

the border size

setDelayEvents

public final void setDelayEvents(boolean delayEvents)

Parameters:

delayEvents - set true to delay user input events (default false)

isDelayEvents

public final boolean isDelayEvents()

Returns:

true if events are delayed

getCaret

public final Sprite getCaret()

Returns:

the caret used by this Widget

setCaret

public final void setCaret(Sprite caret)

Parameters:

caret - the caret used by this Widget

setColor

public final void setColor(Color4 color)

Parameters:

color - the color of the text

getColor

public final float[] getColor()

Returns:

the color of the text

setColorSelected

public final void setColorSelected(Color4 colorSelected)

Parameters:

colorSelected - the color of the text selected

getColorSelected

public final float[] getColorSelected()

Returns:

the color of the text selected

setColorSelectedBack

public final void setColorSelectedBack(Color4 colorSelectedBack)

Parameters:

colorSelectedBack - the color of the text selected

getColorSelectedBack

public final float[] getColorSelectedBack()

Returns:

the color of the text selected

setColorSelectedBackFocus

public final void setColorSelectedBackFocus(Color4 colorSelectedBackFocus)

Parameters:

colorSelectedBackFocus - the color of the text selected

getColorSelectedBackFocus

public final float[] getColorSelectedBackFocus()

Returns:

the color of the text selected

setColorOver

public final void setColorOver(Color4 colorOver)

Parameters:

colorOver - the color of the text when the mouse is over this TextField.
Use null to use the regular color

getColorOver

public final float[] getColorOver()

Returns:

the color of the text when the mouse is over this, or null

setColorFocus

public final void setColorFocus(Color4 colorFocus)

Parameters:

colorFocus - the color of the text when this TextField is focused.
Use null to use the regular color

getColorFocus

public final float[] getColorFocus()

Returns:

the color of the text when this TextField is focused, or null

isValueAdjusting

public final boolean isValueAdjusting()

Returns:

true is the value set by user input (events)

setMultipleLine

public final void setMultipleLine(boolean multipleLine)

isMultipleLine

public final boolean isMultipleLine()

setLowerCase

public final void setLowerCase(boolean lowerCase)

Parameters:

lowerCase - true to force lower case characters on this TextField's text

isLowerCase

public final boolean isLowerCase()

Returns:

true if this TextField text is lower case

setFontName

public void setFontName(java.lang.String fontName)

Parameters:

fontName - a font

getFontName

public final java.lang.String getFontName()

Returns:

the last font set

getFontSize

public final int getFontSize()

Returns:

the font size in pixels of this TextField, or -1 for default

setFontSize

public final void setFontSize(int fontSize)

Parameters:

fotnSize - the new font size in pixels of this TextField, or -1 for default