Package heronarts.lx.studio.ui.clip

Class UISceneButton

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.lx.studio.ui.clip.UIClipAction

heronarts.lx.studio.ui.clip.UISceneButton

All Implemented Interfaces:

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

Direct Known Subclasses:

UISceneButton.Clip, UISceneButton.Pattern

public abstract class UISceneButton
extends UIClipAction
implements UIFocus, UITriggerTarget, UIControlTarget, UIContextActions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UISceneButton.Clip
static class	UISceneButton.Pattern

Nested classes/interfaces inherited from class heronarts.glx.ui.UI2dComponent

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder, UI2dComponent.UIDropTarget

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

UIContextActions.Action, UIContextActions.ContextAction

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	index
protected final LX	lx
protected final UIMixer	mixer

Fields inherited from class heronarts.lx.studio.ui.clip.UIClipAction

BUTTON_ACTIVATION_WIDTH, isButtonDown, isPending

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	UISceneButton(UI ui, UIMixer mixer, DiscreteParameter gridOffset, int index)

Method Summary

Modifier and Type	Method	Description
List<UIContextActions.Action>	getContextActions()	Returns a list of context actions that should be shown for this item
LXNormalizedParameter	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.
protected abstract QuantizedTriggerParameter	getLaunchParameter()
protected int	getSceneIndex()
BooleanParameter	getTriggerTarget()

Methods inherited from class heronarts.lx.studio.ui.clip.UIClipAction

getButtonColor, isActionValid, onBlur, onKeyPressed, onKeyReleased, onMousePressed, onMouseReleased, setLaunchParameter

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, onDraw, 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, dispose, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onFocus, onUIResize, removeLoopTask, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

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

Field Details

mixer

protected final UIMixer mixer

lx

protected final LX lx

index

protected final int index

Constructor Details

UISceneButton

protected UISceneButton(UI ui,
 UIMixer mixer,
 DiscreteParameter gridOffset,
 int index)

Method Details

getLaunchParameter

protected abstract QuantizedTriggerParameter getLaunchParameter()

getSceneIndex

protected int getSceneIndex()

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

getTriggerTarget

public BooleanParameter getTriggerTarget()

Specified by:

getTriggerTarget in interface UITriggerTarget

getControlTarget

public LXNormalizedParameter getControlTarget()

Specified by:

getControlTarget in interface UIControlTarget

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

Returns:

List of context actions