Package heronarts.lx.studio.ui.clip

Class UIClipButton

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.lx.studio.ui.clip.UIClipButton

All Implemented Interfaces:

UIContainer, UIContextActions, UIControlTarget, UICopy, UIDuplicate, UIFocus, UIKeyFocus, UIMouseFocus, UIPaste, UITabFocus, UITriggerTarget, LXLoopTask, Iterable<UIObject>

public class UIClipButton
extends UI2dContainer
implements UIFocus, UITriggerTarget, UIControlTarget, UIContextActions, UIDuplicate

Nested Class Summary

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
static final int	HEIGHT
protected static final int	LABEL_X
protected final LX	lx
protected final UIMixer	mixer
static final int	PADDING
protected final int	slotIndex

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

Modifier	Constructor	Description
protected	UIClipButton(UI ui, UIMixer mixer, LX lx, LXBus bus, int index, float x, float y, float width)

Method Summary

Modifier and Type	Method	Description
void	dispose()
static void	drawPlayTriangle(UI ui, VGraphics vg)
static void	drawPlayTriangle(UI ui, VGraphics vg, float x, float y)
protected int	getButtonColor(UI ui, LXClip clip)
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.
BooleanParameter	getTriggerTarget()
LXClipboardItem	onCopy()
protected void	onDraw(UI ui, VGraphics vg)	Subclasses should override this method to perform their drawing functions.
void	onDuplicate(KeyEvent keyEvent)
protected void	onFocus(Event event)	Subclasses override when element is focused
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
protected void	onMouseReleased(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events
void	onPaste(LXClipboardItem item)
protected void	setClip(LXClip clip)
protected void	setCondensed(boolean condensed)

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, onReflow, 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, 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, onBlur, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, setMouseCursor, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onGamepadAxisChanged, onGamepadButtonPressed, onGamepadButtonReleased, onKeyReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, 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

Field Details

HEIGHT

public static final int HEIGHT

See Also:

• Constant Field Values

PADDING

public static final int PADDING

See Also:

• Constant Field Values

LABEL_X

protected static final int LABEL_X

See Also:

• Constant Field Values

mixer

protected final UIMixer mixer

lx

protected final LX lx

slotIndex

protected final int slotIndex

Constructor Details

UIClipButton

protected UIClipButton(UI ui,
 UIMixer mixer,
 LX lx,
 LXBus bus,
 int index,
 float x,
 float y,
 float width)

Method Details

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

setCondensed

protected void setCondensed(boolean condensed)

setClip

protected void setClip(LXClip clip)

onFocus

protected void onFocus(Event event)

Description copied from class: UIObject

Subclasses override when element is focused

Overrides:

onFocus in class UIObject

Parameters:

event - Event that caused the focus to occur

drawPlayTriangle

public static void drawPlayTriangle(UI ui,
 VGraphics vg)

drawPlayTriangle

public static void drawPlayTriangle(UI ui,
 VGraphics vg,
 float x,
 float y)

getButtonColor

protected int getButtonColor(UI ui,
 LXClip clip)

onDraw

protected void onDraw(UI ui,
 VGraphics vg)

Description copied from class: UI2dComponent

Subclasses should override this method to perform their drawing functions.

Overrides:

onDraw in class UI2dContainer

Parameters:

ui - UI context

vg - Graphics context

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 UI2dContainer

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

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 UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

onMouseReleased

protected void onMouseReleased(MouseEvent mouseEvent,
 float mx,
 float my)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseReleased in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

getTriggerTarget

public BooleanParameter getTriggerTarget()

Specified by:

getTriggerTarget in interface UITriggerTarget

getControlTarget

public LXNormalizedParameter getControlTarget()

Specified by:

getControlTarget in interface UIControlTarget

onCopy

public LXClipboardItem onCopy()

Specified by:

onCopy in interface UICopy

onPaste

public void onPaste(LXClipboardItem item)

Specified by:

onPaste in interface UIPaste

onDuplicate

public void onDuplicate(KeyEvent keyEvent)

Specified by:

onDuplicate in interface UIDuplicate

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

dispose

public void dispose()

Overrides:

dispose in class UIObject