heronarts.p3lx.ui.component

Class UITextBox

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UIInputBox

heronarts.p3lx.ui.component.UITextBox

All Implemented Interfaces:

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

Direct Known Subclasses:

UIFileNameBox

public class UITextBox
extends UIInputBox
implements UICopy, UIPaste

Nested Class Summary

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

UIInputBox.FillStyle, UIInputBox.ProgressIndicator

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

UIContextActions.Action

Field Summary

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

editable, editBuffer, editing, enabled, fillColor, fillStyle, hasFill, progressFillStyle, returnKeyEdit

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

DEFAULT_HEIGHT, useCommandEngine

Fields inherited from class heronarts.p3lx.ui.UI2dComponent

bottomMargin, height, leftMargin, rightMargin, textAlignHorizontal, textAlignVertical, textOffsetX, textOffsetY, topMargin, width, x, y

Fields inherited from class heronarts.p3lx.ui.UIObject

children, hasFocus, mousePressContextMenu, visible

Constructor Summary

Constructors

Constructor and Description
UITextBox()
UITextBox(float x, float y, float w, float h)

Method Summary

Modifier and Type	Method and Description
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	getEditBufferValue()
LXParameter	getParameter()
String	getValue()
protected String	getValueString()
protected boolean	isValidCharacter(char keyChar)
static boolean	isValidTextCharacter(char keyChar)
LXClipboardItem	onCopy()
void	onPaste(LXClipboardItem item)
protected void	onValueChange(String value) Subclasses may override to handle value changes
protected void	saveEditBuffer()
UITextBox	setParameter(StringParameter parameter)
UITextBox	setValue(String value)
UITextBox	setValue(String value, boolean pushToParameter)

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

decrementValue, edit, enableImmediateEdit, enableMousePressEdit, enableReturnKeyEdit, getFillWidthNormalized, incrementMouseValue, incrementValue, isEditable, isEnabled, onBlur, onDraw, onKeyPressed, onMouseDragged, onMousePressed, onMouseReleased, setEditable, setEnabled, setProgressColor, setProgressColor, setProgressFillStyle, setProgressIndicator, setValueCommand

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

getContextActions, getOscAddress, setNormalizedCommand, setUseCommandEngine

Methods inherited from class heronarts.p3lx.ui.UI2dComponent

addToContainer, addToContainer, breakTextToWidth, clipTextToWidth, contains, drawBackground, drawBorder, drawFocus, drawFocusCorners, drawFocusCorners, getBackgroundColor, getBorderColor, getBorderRounding, getBorderWeight, getContainer, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getNextSibling, getParent, getPrevSibling, getWidth, getX, getY, hasBackground, hasBorder, hasFont, hasFontColor, isMappable, onResize, redraw, removeFromContainer, setBackground, setBackgroundColor, setBorder, setBorderColor, setBorderRounding, setBorderWeight, setBottomMargin, setContainerIndex, setDescription, setFocusBackground, setFocusBackgroundColor, setFocusColor, setFocusCorners, setFont, setFontColor, setFontColor, setHeight, setLeftMargin, setMappable, setMargin, setMargin, setMargin, setPosition, setPosition, setPosition, setPosition, setRightMargin, setSize, setTextAlignment, setTextAlignment, setTextOffset, setTopMargin, setVisible, setWidth, setX, setY

Methods inherited from class heronarts.p3lx.ui.UIObject

addLoopTask, beginDraw, blur, bringToFront, consumeKeyEvent, consumeMousePress, consumeMouseWheelEvent, endDraw, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyReleased, onKeyTyped, onMouseClicked, onMouseMoved, onMouseOut, onMouseOver, onMouseWheel

Methods inherited from class java.lang.Object

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

Constructor Detail

UITextBox

public UITextBox()

UITextBox

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

Method Detail

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

getEditBufferValue

protected String getEditBufferValue()

Overrides:

getEditBufferValue in class UIInputBox

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

Specified by:

saveEditBuffer in class UIInputBox

isValidTextCharacter

public static boolean isValidTextCharacter(char keyChar)

isValidCharacter

protected boolean isValidCharacter(char keyChar)

Specified by:

isValidCharacter in class UIInputBox

onCopy

public LXClipboardItem onCopy()

Specified by:

onCopy in interface UICopy

onPaste

public void onPaste(LXClipboardItem item)

Specified by:

onPaste in interface UIPaste