heronarts.lx.studio.ui.device

Class UIDevice

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.UI2dContainer

heronarts.lx.studio.ui.device.UIDevice

All Implemented Interfaces:

LXLoopTask, UIContainer, UIKeyFocus, UIMouseFocus, Iterable<UIObject>

Direct Known Subclasses:

UIBusDevice, UIEffectDevice, UIPatternDevice

public abstract class UIDevice
extends UI2dContainer
implements UIMouseFocus, UIKeyFocus

Nested Class Summary

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

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CHEVRON_PADDING
protected LXComponent	component
protected UI2dContainer	content
protected LXDeviceComponent	device
protected static int	DEVICE_BAR_WIDTH
protected static int	ENABLED_BUTTON_PADDING
protected static int	HEIGHT
protected static int	MARGIN
protected static int	MODULATOR_SIZE
protected UI2dContainer	modulatorContent
protected static int	PADDING
protected static int	TITLE_MARGIN
protected static int	TITLE_PADDING

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

Modifier	Constructor and Description
protected	UIDevice(LXStudio.UI ui, LXComponent component, float contentWidth)

Method Summary

Modifier and Type	Method and Description
protected void	addContentPicker(LXStudio.UI ui, LXBus bus)
UI2dComponent	addToContainer(UIContainer container, int index) Adds this component to a container at a specified index, also removing it from any other container that is currently holding it.
void	drawFocus(UI ui, PGraphics pg) Draws focus on this object.
void	onDraw(UI ui, PGraphics pg) Subclasses should override this method to perform their drawing functions.
void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode) Subclasses override to receive key events
void	onMousePressed(MouseEvent mouseEvent, float mx, float my) Subclasses override to receive mouse events
protected void	reflow()
protected UIDevice	setEnabledButton(BooleanParameter p)
protected UIDevice	setEnabledButton(BooleanParameter p, boolean isMomentary)
protected UIDevice	setTitle(String title)
protected UIDevice	setTitle(StringParameter title)

Methods inherited from class heronarts.p3lx.ui.UI2dContainer

addChildren, addTopLevelComponent, getChild, getChildren, getContentHeight, getContentTarget, getContentWidth, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setContentHeight, setContentSize, setContentTarget, setContentWidth, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

Methods inherited from class heronarts.p3lx.ui.UI2dComponent

addToContainer, breakTextToWidth, clipTextToWidth, contains, drawBackground, drawBorder, 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, getDescription, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onBlur, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMouseReleased, onMouseWheel

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

HEIGHT

protected static final int HEIGHT

See Also:

Constant Field Values

PADDING

protected static final int PADDING

See Also:

Constant Field Values

MARGIN

protected static final int MARGIN

See Also:

Constant Field Values

TITLE_MARGIN

protected static final int TITLE_MARGIN

See Also:

Constant Field Values

TITLE_PADDING

protected static final int TITLE_PADDING

See Also:

Constant Field Values

ENABLED_BUTTON_PADDING

protected static final int ENABLED_BUTTON_PADDING

See Also:

Constant Field Values

DEVICE_BAR_WIDTH

protected static final int DEVICE_BAR_WIDTH

See Also:

Constant Field Values

CHEVRON_PADDING

protected static final int CHEVRON_PADDING

See Also:

Constant Field Values

MODULATOR_SIZE

protected static final int MODULATOR_SIZE

See Also:

Constant Field Values

modulatorContent

protected final UI2dContainer modulatorContent

content

protected final UI2dContainer content

component

protected final LXComponent component

device

protected final LXDeviceComponent device

Constructor Detail

UIDevice

protected UIDevice(LXStudio.UI ui,
                   LXComponent component,
                   float contentWidth)

Method Detail

addContentPicker

protected void addContentPicker(LXStudio.UI ui,
                                LXBus bus)

addToContainer

public UI2dComponent addToContainer(UIContainer container,
                                    int index)

Description copied from class: UI2dComponent

Adds this component to a container at a specified index, also removing it from any other container that is currently holding it.

Overrides:

addToContainer in class UI2dComponent

Parameters:

container - Container to place in

index - At which index to place this object in parent container

Returns:

this

reflow

protected void reflow()

Overrides:

reflow in class UI2dContainer

setEnabledButton

protected UIDevice setEnabledButton(BooleanParameter p)

setEnabledButton

protected UIDevice setEnabledButton(BooleanParameter p,
                                    boolean isMomentary)

setTitle

protected UIDevice setTitle(StringParameter title)

setTitle

protected UIDevice setTitle(String title)

drawFocus

public void drawFocus(UI ui,
                      PGraphics pg)

Description copied from class: UI2dComponent

Draws focus on this object. May be overridden by subclasses to provide custom focus-drawing behavior.

Overrides:

drawFocus in class UI2dComponent

Parameters:

ui - UI

pg - PGraphics

onDraw

public void onDraw(UI ui,
                   PGraphics pg)

Description copied from class: UIObject

Subclasses should override this method to perform their drawing functions.

Overrides:

onDraw in class UIObject

Parameters:

ui - UI context

pg - Graphics context

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 UI2dContainer

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

onMousePressed

public 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