Package heronarts.lx.studio.ui.device

Class UIEffectDevice

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.lx.studio.ui.device.UIDevice

heronarts.lx.studio.ui.device.UIPresetDevice

heronarts.lx.studio.ui.device.UIEffectDevice

All Implemented Interfaces:

UI2dComponent.UIDragReorder, UIContainer, UIContextActions, UICopy, UIDuplicate, UIKeyFocus, UIMouseFocus, UIPaste, LXLoopTask, Iterable<UIObject>

public class UIEffectDevice
extends UIPresetDevice
implements UI2dComponent.UIDragReorder, UIDuplicate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UIEffectDevice.Container

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

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout, UI2dContainer.Position

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.Action, UIContextActions.ContextAction

Field Summary

Fields

Modifier and Type	Field	Description
final UIDeviceControls	controls

Fields inherited from class heronarts.lx.studio.ui.device.UIPresetDevice

actionLoadPreset, actionRestorePreset, actionSavePreset

Fields inherited from class heronarts.lx.studio.ui.device.UIDevice

BORDER_ROUNDING, CHEVRON_PADDING, component, content, CONTENT_HEIGHT, CONTENT_PICKER_PADDING, device, DEVICE_BAR_WIDTH, ENABLED_BUTTON_PADDING, extraButtonsY, HEIGHT, MARGIN, MODULATOR_SIZE, modulatorContent, PADDING, TITLE_MARGIN, TITLE_PADDING, TRIGGER_BUTTON_PADDING

Fields inherited from class heronarts.glx.ui.UI2dContainer

bottomPadding, childSpacingX, childSpacingY, leftPadding, rightPadding, topPadding

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

Constructor	Description
UIEffectDevice(LXStudio.UI ui, LXComponent parent, LXEffect effect)

Method Summary

Modifier and Type	Method	Description
void	dispose()
List<UIContextActions.Action>	getContextActions()	Returns a list of context actions that should be shown for this item
boolean	isValidDragPosition(float mx, float my)	Whether this mouse press position is valid to initiate dragging
LXClipboardItem	onCopy()
void	onDragReorder(UI2dContainer container, UI2dComponent child, int dragIndex)	Callback when an attempt is made to reorder this component in its container
void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode)	Subclasses override to receive key events
void	onKeyReleased(KeyEvent keyEvent, char keyChar, int keyCode)	Subclasses override to receive key events
void	onPaste(LXClipboardItem item)

Methods inherited from class heronarts.lx.studio.ui.device.UIDevice

addContentPicker, assertValidContainer, drawBorder, onDraw, onMousePressed, onReflow, setTitle, setTitle

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getChildSpacingX, getChildSpacingY, getContentHeight, getContentTarget, getContentWidth, getLeftPadding, getRightPadding, getScrollHeight, getScrollWidth, getTopPadding, hasDragToReorder, isEmpty, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, reflow, removeAllChildren, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setChildSpacingX, setChildSpacingY, setContentHeight, setContentSize, setContentTarget, setContentWidth, setDragToReorder, setLayout, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

Methods inherited from class heronarts.glx.ui.UI2dComponent

addAfterSibling, addBeforeSibling, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawBackground, 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, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, isVisible, loop, onBlur, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface heronarts.glx.ui.UIDuplicate

onDuplicate

Field Details

controls

public final UIDeviceControls controls

Constructor Details

UIEffectDevice

public UIEffectDevice(LXStudio.UI ui,
 LXComponent parent,
 LXEffect effect)

Method Details

onKeyPressed

public void onKeyPressed(KeyEvent keyEvent,
 char keyChar,
 int keyCode)

Description copied from class: UIEventHandler

Subclasses override to receive key events

Overrides:

onKeyPressed in class UIDevice

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

onKeyReleased

public 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

onCopy

public LXClipboardItem onCopy()

Specified by:

onCopy in interface UICopy

onPaste

public void onPaste(LXClipboardItem item)

Specified by:

onPaste in interface UIPaste

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

Overrides:

getContextActions in class UIPresetDevice

Returns:

List of context actions

isValidDragPosition

public boolean isValidDragPosition(float mx,
 float my)

Description copied from interface: UI2dComponent.UIDragReorder

Whether this mouse press position is valid to initiate dragging

Specified by:

isValidDragPosition in interface UI2dComponent.UIDragReorder

Parameters:

mx - Mouse x position

my - Mouse y position

Returns:

Whether to commence dragging from here

onDragReorder

public void onDragReorder(UI2dContainer container,
 UI2dComponent child,
 int dragIndex)

Description copied from interface: UI2dComponent.UIDragReorder

Callback when an attempt is made to reorder this component in its container

Specified by:

onDragReorder in interface UI2dComponent.UIDragReorder

Parameters:

container - Parent container

child - Element being reordered

dragIndex - Targeted index in parent container

dispose

public void dispose()

Overrides:

dispose in class UIDevice