Package heronarts.lx.studio.ui.modulation

Class UIMappingButton

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIParameterComponent

heronarts.glx.ui.component.UIButton

heronarts.lx.studio.ui.modulation.UIMappingButton

All Implemented Interfaces:

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

Direct Known Subclasses:

UIMappingButton.Midi, UIMappingButton.Parameter, UIMappingButton.Trigger

public abstract class UIMappingButton
extends UIButton

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UIMappingButton.Midi
static class	UIMappingButton.Parameter
static class	UIMappingButton.Trigger

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

UIButton.Action, UIButton.EnumFormatter, UIButton.EnumIcon, UIButton.Expander, UIButton.Toggle, UIButton.Tooltip

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final LXModulationEngine	modulationEngine
protected final UI	ui

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

active, activeColor, enabled, inactiveColor, isMomentary, momentaryPressValid

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

Method Summary

Modifier and Type	Method	Description
protected abstract void	activateMappingMode()
protected boolean	isForceActiveMode(LXMappingEngine.Mode mode)
protected abstract boolean	isValidMappingMode(LXMappingEngine.Mode mode)
void	onToggle(boolean on)	Subclasses may override this to handle changes to the button's state

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

dispose, getControlTarget, getDescription, getParameter, getTriggerSource, getTriggerSourceParameter, getTriggerTarget, getTriggerTargetParameter, isActive, onBlur, onClick, onDraw, onKeyPressed, onKeyReleased, onMouseDragged, onMousePressed, onMouseReleased, removeParameter, setActive, setActive, setActiveColor, setActiveColor, setActiveFontColor, setActiveFontColor, setActiveIcon, setActiveLabel, setControlSource, setControlTarget, setEnabled, setEnumFormatter, setEnumIcon, setIcon, setIconColor, setIconColor, setIconColor, setIconLabel, setIconOffset, setIconOffsetX, setIconOffsetY, setInactiveColor, setInactiveColor, setInactiveFontColor, setInactiveFontColor, setInactiveIcon, setInactiveLabel, setLabel, setMomentary, setParameter, setParameter, setTriggerable, toggle

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

getContextActions, getOscAddress, 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, drawBorder, 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, 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, onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

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

Field Details

ui

protected final UI ui

modulationEngine

protected final LXModulationEngine modulationEngine

Method Details

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

activateMappingMode

protected abstract void activateMappingMode()

isValidMappingMode

protected abstract boolean isValidMappingMode(LXMappingEngine.Mode mode)

isForceActiveMode

protected boolean isForceActiveMode(LXMappingEngine.Mode mode)