Package heronarts.glx.ui.component

Class UIContextMenu

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.glx.ui.component.UIContextMenu

All Implemented Interfaces:

UIContainer, LXLoopTask, Iterable<UIObject>

public class UIContextMenu
extends UI2dContainer

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

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_WIDTH

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
UIContextMenu(float x, float y, float w, float h)

Method Summary

Modifier and Type	Method	Description
protected void	drawBackground(UI ui, VGraphics vg)
protected void	drawBorder(UI ui, VGraphics vg)
float	getPadding()
float	getScrollHeight()	Returns the height of scrolling content.
protected void	onDraw(UI ui, VGraphics vg)	Subclasses may override to draw some other kind of drop menu
void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode)	Subclasses override to receive key events
void	onMouseMoved(MouseEvent mouseEvent, float x, float y)	Subclasses override to receive mouse events
void	onMouseOut(MouseEvent mouseEvent)	Subclasses override to receive events when mouse moves out of this object
void	onMousePressed(MouseEvent mouseEvent, float x, float y)	Subclasses override to receive mouse events
UIContextMenu	setActions(UIContextActions.Action[] actions)
UIContextMenu	setHighlight(int highlight)
UIContextMenu	setMaxHeight(float maxHeight)
UIContextMenu	setPadding(float padding)
UIContextMenu	setRowHeight(float rowHeight)

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getChildSpacingX, getChildSpacingY, getContentHeight, getContentTarget, getContentWidth, getLeftPadding, getRightPadding, 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

Methods inherited from class heronarts.glx.ui.UI2dComponent

addAfterSibling, addBeforeSibling, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, 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, dispose, 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, onKeyReleased, onMouseDragged, 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

Field Details

DEFAULT_WIDTH

public static final float DEFAULT_WIDTH

See Also:

• Constant Field Values

Constructor Details

UIContextMenu

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

Method Details

getPadding

public float getPadding()

setPadding

public UIContextMenu setPadding(float padding)

Overrides:

setPadding in class UI2dContainer

setRowHeight

public UIContextMenu setRowHeight(float rowHeight)

setMaxHeight

public UIContextMenu setMaxHeight(float maxHeight)

setActions

public UIContextMenu setActions(UIContextActions.Action[] actions)

getScrollHeight

public float getScrollHeight()

Description copied from class: UI2dContainer

Returns the height of scrolling content. By default this is the same as the height of the container itself, but if the container scrolls then the scroll height may be a larger value.

Overrides:

getScrollHeight in class UI2dContainer

Returns:

Height of scrollable content

setHighlight

public UIContextMenu setHighlight(int highlight)

drawBackground

protected void drawBackground(UI ui,
 VGraphics vg)

Overrides:

drawBackground in class UI2dComponent

drawBorder

protected void drawBorder(UI ui,
 VGraphics vg)

Overrides:

drawBorder in class UI2dComponent

onDraw

protected void onDraw(UI ui,
 VGraphics vg)

Subclasses may override to draw some other kind of drop menu

Overrides:

onDraw in class UI2dContainer

Parameters:

ui - UI context

vg - PGraphics 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

onMouseOut

public void onMouseOut(MouseEvent mouseEvent)

Description copied from class: UIEventHandler

Subclasses override to receive events when mouse moves out of this object

Overrides:

onMouseOut in class UIEventHandler

Parameters:

mouseEvent - Mouse Event

onMouseMoved

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

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseMoved in class UIEventHandler

Parameters:

mouseEvent - Mouse event

x - x-coordinate

y - y-coordinate

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 UIEventHandler

Parameters:

mouseEvent - Mouse event

x - x-coordinate

y - y-coordinate