Package heronarts.glx.ui.component

Class UITextBox

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIParameterComponent

heronarts.glx.ui.component.UIInputBox

heronarts.glx.ui.component.UITextBox

All Implemented Interfaces:

UIContextActions, UICopy, UIFocus, UIKeyFocus, UIMouseFocus, UIPaste, UITabFocus, LXLoopTask

Direct Known Subclasses:

UIFileNameBox

public class UITextBox
extends UIInputBox
implements UICopy, UIPaste

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.glx.ui.component.UIInputBox

UIInputBox.EditState, UIInputBox.FillStyle, UIInputBox.ProgressIndicator

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dComponent

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Nested classes/interfaces inherited from interface heronarts.glx.ui.UIContextActions

UIContextActions.Action, UIContextActions.ContextAction

Field Summary

Fields inherited from class heronarts.glx.ui.component.UIInputBox

editable, editing, enabled, fillColor, fillStyle, hasFill, mouseEditable, returnKeyEdit

Fields inherited from class heronarts.glx.ui.component.UIParameterComponent

DEFAULT_HEIGHT, useCommandEngine

Fields inherited from class heronarts.glx.ui.UI2dComponent

borderRoundingBottomLeft, borderRoundingBottomRight, borderRoundingTopLeft, borderRoundingTopRight, debug, debugName, hasBorderRounding, height, marginBottom, marginLeft, marginRight, marginTop, redraw, scissor, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, width, x, y

Fields inherited from class heronarts.glx.ui.UIObject

children, hasFocus, visible

Constructor Summary

Constructors

Constructor	Description
UITextBox()
UITextBox(float w, float h)
UITextBox(float x, float y, float w, float h)
UITextBox(float x, float y, float w, float h, StringParameter parameter)
UITextBox(float w, float h, StringParameter parameter)

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	focusKeyPress(KeyEvent keyEvent, char keyChar, int keyCode)	Gives the text box focus and processes the key event which just occurred which would give it focus
String	getDescription()	Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component.
protected String	getInitialEditBufferValue()
LXParameter	getParameter()
String	getValue()
protected String	getValueString()
boolean	isValidCharacter(char keyChar)
static boolean	isValidTextCharacter(char keyChar)
LXClipboardItem	onCopy()
protected void	onMousePressed(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events
void	onPaste(LXClipboardItem item)
protected void	onValueChange(String value)	Subclasses may override to handle value changes
protected void	saveEditBuffer(String editBuffer)
UITextBox	setEmptyValueAllowed(boolean isEmptyValueAllowed)
UITextBox	setParameter(StringParameter parameter)
UITextBox	setValidCharacters(String validCharacters)	Set a custom list of valid characters for this text box
UITextBox	setValue(String value)
UITextBox	setValue(String value, boolean pushToParameter)

Methods inherited from class heronarts.glx.ui.component.UIInputBox

decrementValue, disableImmediateAppend, disableImmediateEdit, disableReturnKeyEdit, edit, edit, editAppend, enableImmediateAppend, enableImmediateEdit, enableReturnKeyEdit, getEditBuffer, getEditRange, getFillWidthNormalized, incrementMouseValue, incrementValue, isEditable, isEnabled, onBlur, onDraw, onDrawText, onEditChange, onEditFinished, onKeyPressed, onMouseDragged, onMouseReleased, setEditable, setEnabled, setMouseEditable, setProgressColor, setProgressColor, setProgressColor, setProgressIndicator, setValueCommand

Methods inherited from class heronarts.glx.ui.component.UIParameterComponent

getContextActions, getOscAddress, setEnableContextActions, setModulationRangeCommand, setNormalizedCommand, setUseCommandEngine

Methods inherited from class heronarts.glx.ui.UI2dComponent

addAfterSibling, addBeforeSibling, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawBackground, drawBorder, drawComponentBackground, drawFocus, drawFocusCorners, drawFocusCorners, drawParentBackground, getAbsoluteX, getAbsoluteY, getBackgroundColor, getBorderColor, getBorderWeight, getBottomMargin, getContainer, getDebugClassHierarchy, getDebugClassHierarchy, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getLeftMargin, getMappableParameter, getNextSibling, getNextSibling, getParent, getPrevSibling, getPrevSibling, getRightMargin, getTopMargin, getWidth, getX, getY, hasBackground, hasBorder, hasFont, hasFontColor, isMappable, onResize, redraw, removeFromContainer, removeFromContainer, setBackground, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBorderColor, setBorderRounding, setBorderRounding, setBorderWeight, setBottomMargin, setContainerIndex, setContainerPosition, setDebug, setDebug, setDescription, setFocusBackground, setFocusBackgroundColor, setFocusBackgroundColor, setFocusColor, setFocusColor, setFocusCorners, setFont, setFontColor, setFontColor, setFontColor, setHeight, setLeftMargin, setMappable, setMargin, setMargin, setMargin, setPosition, setPosition, setPosition, setPosition, setRightMargin, setSize, setTextAlignment, setTextAlignment, setTextOffset, setTopMargin, setVisible, setWidth, setX, setY, vgRoundedRect, vgRoundedRect, vgRoundedRect

Methods inherited from class heronarts.glx.ui.UIObject

addListener, addListener, addLoopTask, addLoopTask, blur, bringToFront, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onKeyReleased, onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UITextBox

public UITextBox()

UITextBox

public UITextBox(float w,
 float h)

UITextBox

public UITextBox(float x,
 float y,
 float w,
 float h)

UITextBox

public UITextBox(float w,
 float h,
 StringParameter parameter)

UITextBox

public UITextBox(float x,
 float y,
 float w,
 float h,
 StringParameter parameter)

Method Details

getParameter

public LXParameter getParameter()

Specified by:

getParameter in class UIParameterComponent

setParameter

public UITextBox setParameter(StringParameter parameter)

getDescription

public String getDescription()

Description copied from class: UIObject

Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component. If no help is available, return null rather than an empty String.

Overrides:

getDescription in class UIObject

Returns:

Helpful contextual string explaining function of this element

getValue

public String getValue()

getValueString

protected String getValueString()

Specified by:

getValueString in class UIInputBox

getInitialEditBufferValue

protected String getInitialEditBufferValue()

Overrides:

getInitialEditBufferValue in class UIInputBox

setEmptyValueAllowed

public UITextBox setEmptyValueAllowed(boolean isEmptyValueAllowed)

setValue

public UITextBox setValue(String value)

setValue

public UITextBox setValue(String value,
 boolean pushToParameter)

onValueChange

protected void onValueChange(String value)

Subclasses may override to handle value changes

Parameters:

value - New value being set

saveEditBuffer

protected void saveEditBuffer(String editBuffer)

Specified by:

saveEditBuffer in class UIInputBox

setValidCharacters

public UITextBox setValidCharacters(String validCharacters)

Set a custom list of valid characters for this text box

Parameters:

validCharacters - Valid characters

Returns:

this

isValidTextCharacter

public static boolean isValidTextCharacter(char keyChar)

isValidCharacter

public boolean isValidCharacter(char keyChar)

Specified by:

isValidCharacter in class UIInputBox

onMousePressed

protected void onMousePressed(MouseEvent mouseEvent,
 float mx,
 float my)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMousePressed in class UIInputBox

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

focusKeyPress

public void focusKeyPress(KeyEvent keyEvent,
 char keyChar,
 int keyCode)

Gives the text box focus and processes the key event which just occurred which would give it focus

Parameters:

keyEvent - Key Event

keyChar - Key character

keyCode - Key code

onCopy

public LXClipboardItem onCopy()

Specified by:

onCopy in interface UICopy

onPaste

public void onPaste(LXClipboardItem item)

Specified by:

onPaste in interface UIPaste

dispose

public void dispose()

Overrides:

dispose in class UIObject