heronarts.p3lx.ui.component

Class UIToggleSet

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UIToggleSet

All Implemented Interfaces:

LXLoopTask, LXParameterListener, UIContextActions, UIControlTarget, UIFocus, UIKeyFocus, UIMouseFocus, UITabFocus

public class UIToggleSet
extends UIParameterComponent
implements UIFocus, UIControlTarget, LXParameterListener

Nested Class Summary

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

UIContextActions.Action

Field Summary

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

Method Summary

Modifier and Type	Method and Description
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.
DiscreteParameter	getParameter()
int	getSelectedIndex() Gets the index of the currently selected value in the toggle set
String	getSelectedOption() Get the currently selected option in the toggle set
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	onMousePressed(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.
protected void	onResize() Subclasses may override this method, invoked when the component is resized
protected void	onToggle(int value) Invoked when value is toggled.
protected void	onToggle(String option) Invoked when value is toggled, if subclass did not override the integer version of this method.
UIToggleSet	setEvenSpacing()
UIToggleSet	setOptions(String[] options)
UIToggleSet	setParameter(DiscreteParameter parameter)
UIToggleSet	setSelectedIndex(int index) Sets the control to the given index in the options
UIToggleSet	setSelectedOption(String option) Sets the control to select the given option in the toggle set

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

getContextActions, getOscAddress, onMouseReleased, 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, 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, onBlur, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UIToggleSet

public UIToggleSet()

UIToggleSet

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

Method Detail

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

onResize

protected void onResize()

Description copied from class: UI2dComponent

Subclasses may override this method, invoked when the component is resized

Overrides:

onResize in class UI2dComponent

setOptions

public UIToggleSet setOptions(String[] options)

getParameter

public DiscreteParameter getParameter()

Specified by:

getParameter in class UIParameterComponent

setParameter

public UIToggleSet setParameter(DiscreteParameter parameter)

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

setEvenSpacing

public UIToggleSet setEvenSpacing()

getSelectedIndex

public int getSelectedIndex()

Gets the index of the currently selected value in the toggle set

Returns:

currently selected index

getSelectedOption

public String getSelectedOption()

Get the currently selected option in the toggle set

Returns:

Currently selected option

setSelectedOption

public UIToggleSet setSelectedOption(String option)

Sets the control to select the given option in the toggle set

Parameters:

option - String value, must be one of the options in the toggle set

Returns:

this

setSelectedIndex

public UIToggleSet setSelectedIndex(int index)

Sets the control to the given index in the options

Parameters:

index - Index in the toggle set, from 0 to range-1

Returns:

this

onDraw

public 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

onToggle

protected void onToggle(int value)

Invoked when value is toggled. Subclasses may override.

Parameters:

value - Selected index in the toggle set

onToggle

protected void onToggle(String option)

Invoked when value is toggled, if subclass did not override the integer version of this method. Subclasses may override.

Parameters:

option - Selected option in the toggle set

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

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

getControlTarget

public LXParameter getControlTarget()

Specified by:

getControlTarget in interface UIControlTarget