heronarts.p3lx.ui.component

Class UIInputBox

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

All Implemented Interfaces:

LXLoopTask, UIContextActions, UIFocus, UIKeyFocus, UIMouseFocus, UITabFocus

Direct Known Subclasses:

UINumberBox, UIParameterControl, UITextBox

public abstract class UIInputBox
extends UIParameterComponent
implements UIFocus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIInputBox.FillStyle
static interface	UIInputBox.ProgressIndicator

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

UIContextActions.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	editable
protected String	editBuffer
protected boolean	editing
protected boolean	enabled
protected int	fillColor
protected UIInputBox.FillStyle	fillStyle
protected boolean	hasFill
protected UIInputBox.FillStyle	progressFillStyle
protected boolean	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

Modifier	Constructor and Description
protected	UIInputBox()
protected	UIInputBox(float x, float y, float w, float h)

Method Summary

Modifier and Type	Method and Description
protected void	decrementValue(KeyEvent keyEvent) Subclasses may optionally override to decrement value in response to arrows.
void	edit()
UIInputBox	enableImmediateEdit(boolean immediateEdit)
UIInputBox	enableMousePressEdit(boolean mousePressEdit)
UIInputBox	enableReturnKeyEdit(boolean returnKeyEdit)
protected String	getEditBufferValue()
protected double	getFillWidthNormalized()
protected abstract String	getValueString()
protected void	incrementMouseValue(MouseEvent mouseEvent, int offset) Subclasses may optionally implement to change value based upon mouse click+drag in the box.
protected void	incrementValue(KeyEvent keyEvent) Subclasses may optionally override to decrement value in response to arrows.
boolean	isEditable()
boolean	isEnabled()
protected abstract boolean	isValidCharacter(char keyChar)
protected void	onBlur() Subclasses override when element loses focus
protected void	onDraw(UI ui, PGraphics pg) Subclasses should override this method to perform their drawing functions.
protected void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode) Subclasses override to receive key events
protected void	onMouseDragged(MouseEvent mouseEvent, float mx, float my, float dx, float dy) Subclasses override to receive mouse events
protected void	onMousePressed(MouseEvent mouseEvent, float mx, float my) Subclasses override to receive mouse events
protected void	onMouseReleased(MouseEvent mouseEvent, float mx, float my) Subclasses override to receive mouse events
protected abstract void	saveEditBuffer()
UIInputBox	setEditable(boolean editable)
UIInputBox	setEnabled(boolean enabled)
UIInputBox	setProgressColor(boolean hasProgressColor)
UIInputBox	setProgressColor(int progressColor)
UIInputBox	setProgressFillStyle(UIInputBox.FillStyle progressFillStyle)
UIInputBox	setProgressIndicator(UIInputBox.ProgressIndicator meter)
protected void	setValueCommand(double value)

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

getContextActions, getOscAddress, getParameter, 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, getDescription, 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

Field Detail

enabled

protected boolean enabled

editable

protected boolean editable

editing

protected boolean editing

editBuffer

protected String editBuffer

hasFill

protected boolean hasFill

fillColor

protected int fillColor

returnKeyEdit

protected boolean returnKeyEdit

fillStyle

protected UIInputBox.FillStyle fillStyle

progressFillStyle

protected UIInputBox.FillStyle progressFillStyle

Constructor Detail

UIInputBox

protected UIInputBox()

UIInputBox

protected UIInputBox(float x,
                     float y,
                     float w,
                     float h)

Method Detail

setProgressColor

public UIInputBox setProgressColor(boolean hasProgressColor)

setProgressColor

public UIInputBox setProgressColor(int progressColor)

setProgressFillStyle

public UIInputBox setProgressFillStyle(UIInputBox.FillStyle progressFillStyle)

setProgressIndicator

public UIInputBox setProgressIndicator(UIInputBox.ProgressIndicator meter)

enableReturnKeyEdit

public UIInputBox enableReturnKeyEdit(boolean returnKeyEdit)

enableImmediateEdit

public UIInputBox enableImmediateEdit(boolean immediateEdit)

enableMousePressEdit

public UIInputBox enableMousePressEdit(boolean mousePressEdit)

getValueString

protected abstract String getValueString()

saveEditBuffer

protected abstract void saveEditBuffer()

isEditable

public boolean isEditable()

setEditable

public UIInputBox setEditable(boolean editable)

isEnabled

public boolean isEnabled()

setEnabled

public UIInputBox setEnabled(boolean enabled)

edit

public void edit()

getEditBufferValue

protected String getEditBufferValue()

onBlur

protected void onBlur()

Description copied from class: UIObject

Subclasses override when element loses focus

Overrides:

onBlur in class UIObject

getFillWidthNormalized

protected double getFillWidthNormalized()

onDraw

protected void onDraw(UI ui,
                      PGraphics pg)

Description copied from class: UIObject

Subclasses should override this method to perform their drawing functions.

Overrides:

onDraw in class UIObject

Parameters:

ui - UI context

pg - Graphics context

isValidCharacter

protected abstract boolean isValidCharacter(char keyChar)

decrementValue

protected void decrementValue(KeyEvent keyEvent)

Subclasses may optionally override to decrement value in response to arrows. Decrement is invoked for the left or down arrow keys.

Parameters:

keyEvent - Key event

incrementValue

protected void incrementValue(KeyEvent keyEvent)

Subclasses may optionally override to decrement value in response to arrows. Increment is invoked for the right or up keys.

Parameters:

keyEvent - Key event

onKeyPressed

protected void onKeyPressed(KeyEvent keyEvent,
                            char keyChar,
                            int keyCode)

Description copied from class: UIEventHandler

Subclasses override to receive key events

Overrides:

onKeyPressed in class UIEventHandler

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

incrementMouseValue

protected void incrementMouseValue(MouseEvent mouseEvent,
                                   int offset)

Subclasses may optionally implement to change value based upon mouse click+drag in the box.

Parameters:

mouseEvent - Mouse event

offset - Units of mouse movement, positive or negative

setValueCommand

protected void setValueCommand(double value)

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 UIParameterComponent

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onMouseReleased

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

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseReleased in class UIParameterComponent

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onMouseDragged

protected void onMouseDragged(MouseEvent mouseEvent,
                              float mx,
                              float my,
                              float dx,
                              float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseDragged in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - movement in x

dy - movement in y