heronarts.lx.studio.ui.modulation

Class UITriggerModulationButton

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UIButton

heronarts.lx.studio.ui.modulation.UITriggerModulationButton

All Implemented Interfaces:

LXLoopTask, UIContextActions, UIControlTarget, UIFocus, UIKeyFocus, UIMouseFocus, UITabFocus, UITriggerSource, UITriggerTarget

public class UITriggerModulationButton
extends UIButton
implements UITriggerSource

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.p3lx.ui.component.UIButton

UIButton.Action, UIButton.Trigger

Field Summary

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

active, activeColor, enabled, exactToggleTime, inactiveColor, isMomentary, momentaryPressValid

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
UITriggerModulationButton(UI ui, LX lx, BooleanParameter trigger, float x, float y, float w, float h)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component.
BooleanParameter	getTriggerSource()
void	onToggle(boolean on) Subclasses may override this to handle changes to the button's state

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

getControlTarget, getParameter, getTriggerTarget, isActive, onBlur, onClick, onDraw, onKeyPressed, onKeyReleased, onMouseDragged, onMousePressed, onMouseReleased, removeParameter, setActive, setActive, setActiveColor, setActiveIcon, setActiveLabel, setEnabled, setIcon, setIconOffset, setIconOffsetX, setIconOffsetY, setInactiveColor, setInactiveIcon, setInactiveLabel, setLabel, setMomentary, setParameter, setParameter, setTriggerable, toggle

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

onKeyTyped, onMouseClicked, onMouseMoved, onMouseOut, onMouseOver, onMouseWheel

Methods inherited from class java.lang.Object

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

Constructor Detail

UITriggerModulationButton

public UITriggerModulationButton(UI ui,
                                 LX lx,
                                 BooleanParameter trigger,
                                 float x,
                                 float y,
                                 float w,
                                 float h)

Method Detail

onToggle

public void onToggle(boolean on)

Description copied from class: UIButton

Subclasses may override this to handle changes to the button's state

Overrides:

onToggle in class UIButton

Parameters:

on - Whether button is active

getTriggerSource

public BooleanParameter getTriggerSource()

Specified by:

getTriggerSource in interface UITriggerSource

Overrides:

getTriggerSource in class UIButton

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 UIButton

Returns:

Helpful contextual string explaining function of this element