Package heronarts.glx.ui.component

Class UINumberBox

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

All Implemented Interfaces:

UIContextActions, UIFocus, UIKeyFocus, UIMouseFocus, UITabFocus, LXLoopTask

Direct Known Subclasses:

UIDoubleBox, UIIntegerBox

public abstract class UINumberBox
extends UIInputBox

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

Modifier and Type	Field	Description
protected boolean	hasShiftMultiplier
protected float	shiftMultiplier

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

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

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	drawBorder(UI ui, VGraphics vg)
List<UIContextActions.Action>	getContextActions()	Returns a list of context actions that should be shown for this item
protected void	onMousePressed(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events
UINumberBox	setFill(boolean hasFill)
UINumberBox	setFillColor(int fillColor)
UINumberBox	setFillStyle(UIInputBox.FillStyle fillStyle)
protected void	setModulationTarget(LXParameter parameter)
UINumberBox	setShiftMultiplier(float shiftMultiplier)	Sets a multiplier by which the amount value changes are modulated when the shift key is down.

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

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

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

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

Field Details

hasShiftMultiplier

protected boolean hasShiftMultiplier

shiftMultiplier

protected float shiftMultiplier

Constructor Details

UINumberBox

protected UINumberBox()

UINumberBox

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

Method Details

setFillStyle

public UINumberBox setFillStyle(UIInputBox.FillStyle fillStyle)

setFill

public UINumberBox setFill(boolean hasFill)

setFillColor

public UINumberBox setFillColor(int fillColor)

setShiftMultiplier

public UINumberBox setShiftMultiplier(float shiftMultiplier)

Sets a multiplier by which the amount value changes are modulated when the shift key is down. Either for more precise control or larger jumps, depending on the component.

Parameters:

shiftMultiplier - Amount to multiply by

Returns:

this

setModulationTarget

protected void setModulationTarget(LXParameter parameter)

drawBorder

public void drawBorder(UI ui,
 VGraphics vg)

Overrides:

drawBorder in class UI2dComponent

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

getContextActions

public List<UIContextActions.Action> getContextActions()

Description copied from interface: UIContextActions

Returns a list of context actions that should be shown for this item

Specified by:

getContextActions in interface UIContextActions

Overrides:

getContextActions in class UIParameterComponent

Returns:

List of context actions

dispose

public void dispose()

Overrides:

dispose in class UIObject