heronarts.p3lx.ui.component

Class UIDropMenu

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UIDropMenu

All Implemented Interfaces:

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

public class UIDropMenu
extends UIParameterComponent
implements UIFocus, UIControlTarget, LXParameterListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIDropMenu.Direction

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

UIContextActions.Action

Field Summary

Fields inherited from class heronarts.p3lx.ui.component.UIParameterComponent

DEFAULT_HEIGHT, useCommandEngine

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

Constructor and Description
UIDropMenu(float w, DiscreteParameter parameter)
UIDropMenu(float w, float h, DiscreteParameter parameter)
UIDropMenu(float x, float y, float w, float h)
UIDropMenu(float x, float y, float w, float h, DiscreteParameter parameter)

Method Summary

Modifier and Type	Method and Description
LXParameter	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 int	getFocusSize() Focus size for hashes drawn on the outline of the object.
DiscreteParameter	getParameter()
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 x, float y) Subclasses override to receive mouse events
void	onParameterChanged(LXParameter p) Invoked when the value of a parameter is changed.
UIDropMenu	setDirection(UIDropMenu.Direction direction) Sets the direction that this drop menu opens, up or down
UIDropMenu	setEnabled(boolean enabled)
UIDropMenu	setOptions(String[] options) Sets the list of string options to display in the menu
UIDropMenu	setParameter(DiscreteParameter parameter)

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

getContextActions, getOscAddress, onMouseReleased, setNormalizedCommand, setUseCommandEngine

Methods inherited from class heronarts.p3lx.ui.UI2dComponent

addToContainer, addToContainer, breakTextToWidth, clipTextToWidth, contains, drawBackground, drawBorder, drawFocus, drawFocusCorners, drawFocusCorners, getBackgroundColor, getBorderColor, getBorderRounding, getBorderWeight, getContainer, getFocusColor, 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, 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, onMouseWheel

Methods inherited from class java.lang.Object

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

Constructor Detail

UIDropMenu

public UIDropMenu(float x,
                  float y,
                  float w,
                  float h)

UIDropMenu

public UIDropMenu(float w,
                  DiscreteParameter parameter)

UIDropMenu

public UIDropMenu(float w,
                  float h,
                  DiscreteParameter parameter)

UIDropMenu

public UIDropMenu(float x,
                  float y,
                  float w,
                  float h,
                  DiscreteParameter parameter)

Method Detail

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

getParameter

public DiscreteParameter getParameter()

Specified by:

getParameter in class UIParameterComponent

setEnabled

public UIDropMenu setEnabled(boolean enabled)

setParameter

public UIDropMenu setParameter(DiscreteParameter parameter)

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from interface: LXParameterListener

Invoked when the value of a parameter is changed.

Specified by:

onParameterChanged in interface LXParameterListener

Parameters:

p - The parameter that has changed its value

setDirection

public UIDropMenu setDirection(UIDropMenu.Direction direction)

Sets the direction that this drop menu opens, up or down

Parameters:

direction - Direction menu should open

Returns:

this

setOptions

public UIDropMenu setOptions(String[] options)

Sets the list of string options to display in the menu

Parameters:

options - Options array

Returns:

this

getFocusSize

protected int getFocusSize()

Description copied from class: UI2dComponent

Focus size for hashes drawn on the outline of the object. May be overridden.

Overrides:

getFocusSize in class UI2dComponent

Returns:

Focus hash line size

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

onMousePressed

public void onMousePressed(MouseEvent mouseEvent,
                           float x,
                           float y)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMousePressed in class UIParameterComponent

Parameters:

mouseEvent - Mouse event

x - x-coordinate

y - y-coordinate

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 UIEventHandler

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

getControlTarget

public LXParameter getControlTarget()

Specified by:

getControlTarget in interface UIControlTarget