heronarts.p3lx.ui.component

Class UIParameterControl

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

All Implemented Interfaces:

LXLoopTask, LXParameterListener, UIContextActions, UIControlTarget, UICopy, UIFocus, UIKeyFocus, UIModulationSource, UIModulationTarget, UIMouseFocus, UIPaste, UITabFocus

Direct Known Subclasses:

UICompoundParameterControl, UISwitch

public abstract class UIParameterControl
extends UIInputBox
implements UIControlTarget, UIModulationTarget, UIModulationSource, LXParameterListener, 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

Modifier and Type	Field and Description
protected boolean	enabled
protected boolean	keyEditable
protected static int	LABEL_HEIGHT
protected static int	LABEL_MARGIN
protected LXNormalizedParameter	parameter
protected LXParameter.Polarity	polarity
static int	TEXT_MARGIN

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

editable, editBuffer, editing, 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

Modifier	Constructor and Description
protected	UIParameterControl(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.
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.
static String	getDescription(LXParameter parameter)
protected int	getFocusColor(UI ui)
int	getModulatedValueColor(int baseColor) Given a base color for a control, return the color used to display the modulated component of its value.
LXNormalizedParameter	getModulationSource()
CompoundParameter	getModulationTarget()
protected double	getNormalized()
LXNormalizedParameter	getParameter()
protected String	getValueString()
protected void	incrementValue(KeyEvent keyEvent) Subclasses may optionally override to decrement value in response to arrows.
boolean	isEnabled()
protected boolean	isValidCharacter(char keyChar)
protected void	onBlur() Subclasses override when element loses focus
LXClipboardItem	onCopy()
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	onKeyReleased(KeyEvent keyEvent, char keyChar, int keyCode) Subclasses override to receive key 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
void	onParameterChanged(LXParameter parameter) Invoked when the value of a parameter is changed.
void	onPaste(LXClipboardItem item)
protected void	saveEditBuffer()
UIInputBox	setEditable(boolean editable)
UIParameterControl	setEnabled(boolean enabled)
UIParameterControl	setLabel(String label)
protected UIParameterControl	setNormalized(double normalized)
UIParameterControl	setParameter(LXNormalizedParameter parameter)
UIParameterControl	setPolarity(LXParameter.Polarity polarity)
UIParameterControl	setShowLabel(boolean showLabel)

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

edit, enableImmediateEdit, enableMousePressEdit, enableReturnKeyEdit, getEditBufferValue, getFillWidthNormalized, incrementMouseValue, isEditable, onMouseDragged, 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, 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

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

LABEL_MARGIN

protected static final int LABEL_MARGIN

See Also:

Constant Field Values

LABEL_HEIGHT

protected static final int LABEL_HEIGHT

See Also:

Constant Field Values

TEXT_MARGIN

public static final int TEXT_MARGIN

See Also:

Constant Field Values

parameter

protected LXNormalizedParameter parameter

polarity

protected LXParameter.Polarity polarity

enabled

protected boolean enabled

keyEditable

protected boolean keyEditable

Constructor Detail

UIParameterControl

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

Method Detail

setEnabled

public UIParameterControl setEnabled(boolean enabled)

Overrides:

setEnabled in class UIInputBox

getDescription

public static String getDescription(LXParameter 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

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class UIInputBox

setEditable

public UIInputBox setEditable(boolean editable)

Overrides:

setEditable in class UIInputBox

setShowLabel

public UIParameterControl setShowLabel(boolean showLabel)

setLabel

public UIParameterControl setLabel(String label)

getFocusColor

protected int getFocusColor(UI ui)

Overrides:

getFocusColor in class UI2dComponent

onParameterChanged

public void onParameterChanged(LXParameter parameter)

Description copied from interface: LXParameterListener

Invoked when the value of a parameter is changed.

Specified by:

onParameterChanged in interface LXParameterListener

Parameters:

parameter - The parameter that has changed its value

getNormalized

protected double getNormalized()

setNormalized

protected UIParameterControl setNormalized(double normalized)

getParameter

public LXNormalizedParameter getParameter()

Specified by:

getParameter in class UIParameterComponent

setPolarity

public UIParameterControl setPolarity(LXParameter.Polarity polarity)

setParameter

public UIParameterControl setParameter(LXNormalizedParameter parameter)

getValueString

protected String getValueString()

Specified by:

getValueString in class UIInputBox

isValidCharacter

protected boolean isValidCharacter(char keyChar)

Specified by:

isValidCharacter in class UIInputBox

saveEditBuffer

protected void saveEditBuffer()

Specified by:

saveEditBuffer in class UIInputBox

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 UIInputBox

Parameters:

ui - UI context

pg - Graphics context

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.

Overrides:

decrementValue in class UIInputBox

Parameters:

keyEvent - Key event in response to

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.

Overrides:

incrementValue in class UIInputBox

Parameters:

keyEvent - Key event in response to

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 UIInputBox

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

onKeyReleased

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

Description copied from class: UIEventHandler

Subclasses override to receive key events

Overrides:

onKeyReleased in class UIEventHandler

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code 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 UIInputBox

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 UIInputBox

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onBlur

protected void onBlur()

Description copied from class: UIObject

Subclasses override when element loses focus

Overrides:

onBlur in class UIInputBox

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

getModulatedValueColor

public int getModulatedValueColor(int baseColor)

Given a base color for a control, return the color used to display the modulated component of its value. Currently, just dims the base color.

Parameters:

baseColor - Base color to determine modulated color from

Returns:

Color to use for modulated value

onCopy

public LXClipboardItem onCopy()

Specified by:

onCopy in interface UICopy

onPaste

public void onPaste(LXClipboardItem item)

Specified by:

onPaste in interface UIPaste