Package heronarts.glx.ui.component

Class UIContextButton

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIContextButton

All Implemented Interfaces:

UIFocus, UIKeyFocus, UIMouseFocus, UITabFocus, LXLoopTask

public class UIContextButton
extends UI2dComponent
implements UIFocus

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UIContextButton.Direction	Direction that a context menu opens from a button
static enum	UIContextButton.HorizontalDirection

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

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Field Summary

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
UIContextButton(UI ui, float x, float y, float w, float h)
UIContextButton(UI ui, float x, float y, float w, float h, UI2dComponent contextMenu)

Method Summary

Modifier and Type	Method	Description
void	dispose()
UI2dComponent	getContextMenu()	Accessor for the underlying context menu object
void	onDraw(UI ui, VGraphics vg)	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
void	onMouseReleased(MouseEvent mouseEvent, float mx, float my)	Subclasses override to receive mouse events
UIContextButton	setContextActions(UIContextActions.Action[] contextActions)	Sets an array of actions that will be shown in the context menu that opens when the button is clicked
UIContextButton	setContextMenuWidth(float contextMenuWidth)	Sets the width of the context menu opened by this button
UIContextButton	setDirection(UIContextButton.Direction direction)	Sets the direction in which the context menu opens
UIContextButton	setHorizontalDirection(UIContextButton.HorizontalDirection horizontalDirection)	Sets the direction in which the context menu opens
UIContextButton	setIcon(VGraphics.Image icon)
UIContextButton	setIconOffset(float iconOffsetX, float iconOffsetY)
UIContextButton	setLabel(String label)	Sets the label visible on the button

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, 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, onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

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

Constructor Details

UIContextButton

public UIContextButton(UI ui,
 float x,
 float y,
 float w,
 float h)

UIContextButton

public UIContextButton(UI ui,
 float x,
 float y,
 float w,
 float h,
 UI2dComponent contextMenu)

Method Details

setIcon

public UIContextButton setIcon(VGraphics.Image icon)

setIconOffset

public UIContextButton setIconOffset(float iconOffsetX,
 float iconOffsetY)

getContextMenu

public UI2dComponent getContextMenu()

Accessor for the underlying context menu object

Returns:

Context menu object opened by this button

setContextMenuWidth

public UIContextButton setContextMenuWidth(float contextMenuWidth)

Sets the width of the context menu opened by this button

Parameters:

contextMenuWidth - Width of context menu

Returns:

this

setContextActions

public UIContextButton setContextActions(UIContextActions.Action[] contextActions)

Sets an array of actions that will be shown in the context menu that opens when the button is clicked

Parameters:

contextActions - Set of context actions shown when button is clicked

Returns:

this

setLabel

public UIContextButton setLabel(String label)

Sets the label visible on the button

Parameters:

label - Label

Returns:

this

setDirection

public UIContextButton setDirection(UIContextButton.Direction direction)

Sets the direction in which the context menu opens

Parameters:

direction - Direction to open

Returns:

this

setHorizontalDirection

public UIContextButton setHorizontalDirection(UIContextButton.HorizontalDirection horizontalDirection)

Sets the direction in which the context menu opens

Parameters:

horizontalDirection - Direction to open

Returns:

this

onDraw

public 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 UI2dComponent

Parameters:

ui - UI context

vg - Graphics context

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

onMouseReleased

public 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

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

dispose

public void dispose()

Overrides:

dispose in class UIObject