heronarts.p3lx.ui.component

Class UIDoubleBox

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.UINumberBox

heronarts.p3lx.ui.component.UIDoubleBox

All Implemented Interfaces:

LXLoopTask, UIContextActions, UIControlTarget, UIFocus, UIKeyFocus, UIModulationSource, UIModulationTarget, UIMouseFocus, UITabFocus

public class UIDoubleBox
extends UINumberBox
implements UIControlTarget, UIModulationSource, UIModulationTarget

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

Modifier and Type	Field and Description
protected double	editMultiplier

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

hasShiftMultiplier, shiftMultiplier

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
UIDoubleBox()
UIDoubleBox(float w, BoundedParameter parameter)
UIDoubleBox(float w, float h, BoundedParameter parameter)
UIDoubleBox(float x, float y, float w, BoundedParameter parameter)
UIDoubleBox(float x, float y, float w, float h)
UIDoubleBox(float x, float y, float w, float h, BoundedParameter parameter)

Method Summary

Modifier and Type	Method and Description
protected void	decrementValue(KeyEvent keyEvent) Subclasses may optionally override to decrement value in response to arrows.
LXParameter	getControlTarget()
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 double	getFillWidthNormalized()
LXNormalizedParameter	getModulationSource()
CompoundParameter	getModulationTarget()
protected double	getNormalized()
BoundedParameter	getParameter()
double	getValue()
protected 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.
protected boolean	isValidCharacter(char keyChar)
static boolean	isValidInputCharacter(char keyChar)
protected void	onMouseDragged(MouseEvent mouseEvent, float mx, float my, float dx, float dy) Subclasses override to receive mouse events
protected void	onValueChange(double value) Invoked when value changes, subclasses may override to handle.
protected void	saveEditBuffer()
UIDoubleBox	setEditMultiplier(double editMultiplier)
UIDoubleBox	setNormalized(double normalized)
UIDoubleBox	setNormalizedMouseEditing(boolean normalizedMouseEditing)
UIDoubleBox	setParameter(BoundedParameter parameter)
UIDoubleBox	setRange(double minValue, double maxValue)
UIDoubleBox	setValue(double value)
protected UIDoubleBox	setValue(double value, boolean pushToParameter)
protected UIDoubleBox	setValue(LXParameter p)

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

setFill, setFillColor, setFillStyle, setShiftMultiplier

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

edit, enableImmediateEdit, enableMousePressEdit, enableReturnKeyEdit, getEditBufferValue, isEditable, isEnabled, onBlur, onDraw, onKeyPressed, 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

Field Detail

editMultiplier

protected double editMultiplier

Constructor Detail

UIDoubleBox

public UIDoubleBox()

UIDoubleBox

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

UIDoubleBox

public UIDoubleBox(float w,
                   BoundedParameter parameter)

UIDoubleBox

public UIDoubleBox(float w,
                   float h,
                   BoundedParameter parameter)

UIDoubleBox

public UIDoubleBox(float x,
                   float y,
                   float w,
                   BoundedParameter parameter)

UIDoubleBox

public UIDoubleBox(float x,
                   float y,
                   float w,
                   float h,
                   BoundedParameter parameter)

Method Detail

setEditMultiplier

public UIDoubleBox setEditMultiplier(double editMultiplier)

setNormalizedMouseEditing

public UIDoubleBox setNormalizedMouseEditing(boolean normalizedMouseEditing)

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

getParameter

public BoundedParameter getParameter()

Specified by:

getParameter in class UIParameterComponent

setParameter

public UIDoubleBox setParameter(BoundedParameter parameter)

setRange

public UIDoubleBox setRange(double minValue,
                            double maxValue)

getNormalized

protected double getNormalized()

setNormalized

public UIDoubleBox setNormalized(double normalized)

getFillWidthNormalized

protected double getFillWidthNormalized()

Overrides:

getFillWidthNormalized in class UIInputBox

getValue

public double getValue()

setValue

protected UIDoubleBox setValue(LXParameter p)

setValue

public UIDoubleBox setValue(double value)

setValue

protected UIDoubleBox setValue(double value,
                               boolean pushToParameter)

getValueString

protected String getValueString()

Specified by:

getValueString in class UIInputBox

onValueChange

protected void onValueChange(double value)

Invoked when value changes, subclasses may override to handle.

Parameters:

value - New value that is being set

saveEditBuffer

protected void saveEditBuffer()

Specified by:

saveEditBuffer in class UIInputBox

isValidInputCharacter

public static boolean isValidInputCharacter(char keyChar)

isValidCharacter

protected boolean isValidCharacter(char keyChar)

Specified by:

isValidCharacter in class UIInputBox

decrementValue

protected void decrementValue(KeyEvent keyEvent)

Description copied from class: UIInputBox

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

Overrides:

decrementValue in class UIInputBox

Parameters:

keyEvent - Key event

incrementValue

protected void incrementValue(KeyEvent keyEvent)

Description copied from class: UIInputBox

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

Overrides:

incrementValue in class UIInputBox

Parameters:

keyEvent - Key event

incrementMouseValue

protected void incrementMouseValue(MouseEvent mouseEvent,
                                   int offset)

Description copied from class: UIInputBox

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

Overrides:

incrementMouseValue in class UIInputBox

Parameters:

mouseEvent - Mouse event

offset - Units of mouse movement, positive or negative

getControlTarget

public LXParameter getControlTarget()

Specified by:

getControlTarget in interface UIControlTarget

getModulationSource

public LXNormalizedParameter getModulationSource()

Specified by:

getModulationSource in interface UIModulationSource

getModulationTarget

public CompoundParameter getModulationTarget()

Specified by:

getModulationTarget in interface UIModulationTarget

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 UIInputBox

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - movement in x

dy - movement in y