heronarts.p3lx.ui.component

Class UIButton

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UIButton

All Implemented Interfaces:

LXLoopTask, UIContextActions, UIControlTarget, UIFocus, UIKeyFocus, UIMouseFocus, UITabFocus, UITriggerSource, UITriggerTarget

Direct Known Subclasses:

UIButton.Action, UIButton.Trigger, UITriggerModulationButton

public class UIButton
extends UIParameterComponent
implements UIControlTarget, UITriggerSource, UITriggerTarget, UIFocus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIButton.Action
static class	UIButton.Trigger

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
protected int	activeColor
protected boolean	enabled
protected long	exactToggleTime
protected int	inactiveColor
protected boolean	isMomentary
protected boolean	momentaryPressValid

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
UIButton()
UIButton(float w, BooleanParameter p)
UIButton(float w, EnumParameter<?> p)
UIButton(float w, float h, BooleanParameter p)
UIButton(float w, float h, EnumParameter<?> p)
UIButton(float x, float y, float w, float h)

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.
LXListenableNormalizedParameter	getParameter()
BooleanParameter	getTriggerSource()
BooleanParameter	getTriggerTarget()
boolean	isActive()
protected void	onBlur() Subclasses override when element loses focus
protected void	onClick() Subclasses may override when a momentary button is clicked, and the click release happened within the bounds of the box
protected void	onDraw(UI ui, PGraphics pg) Subclasses should override this method to perform their drawing functions.
protected void	onKeyPressed(KeyEvent keyEvent, char keyChar, int keyCode) Subclasses override to receive key events
protected void	onKeyReleased(KeyEvent keyEvent, char keyChar, int keyCode) Subclasses override to receive key events
protected void	onMouseDragged(MouseEvent mouseEvent, float mx, float my, float dx, float dy) Subclasses override to receive mouse 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
protected void	onToggle(boolean active) Subclasses may override this to handle changes to the button's state
UIButton	removeParameter()
UIButton	setActive(boolean active)
protected UIButton	setActive(boolean active, boolean pushToParameter)
UIButton	setActiveColor(int activeColor)
UIButton	setActiveIcon(PImage activeIcon)
UIButton	setActiveLabel(String activeLabel)
UIButton	setEnabled(boolean enabled)
UIButton	setIcon(PImage icon)
UIButton	setIconOffset(float iconOffsetX, float iconOffsetY)
UIButton	setIconOffsetX(float iconOffsetX)
UIButton	setIconOffsetY(float iconOffsetY)
UIButton	setInactiveColor(int inactiveColor)
UIButton	setInactiveIcon(PImage inactiveIcon)
UIButton	setInactiveLabel(String inactiveLabel)
UIButton	setLabel(String label)
UIButton	setMomentary(boolean momentary)
UIButton	setParameter(BooleanParameter parameter)
UIButton	setParameter(EnumParameter<?> parameter)
UIButton	setTriggerable(boolean triggerable)
UIButton	toggle()

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

getContextActions, getOscAddress, 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, 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, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyTyped, onMouseClicked, onMouseMoved, onMouseOut, onMouseOver, onMouseWheel

Methods inherited from class java.lang.Object

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

Field Detail

active

protected boolean active

isMomentary

protected boolean isMomentary

inactiveColor

protected int inactiveColor

activeColor

protected int activeColor

enabled

protected boolean enabled

momentaryPressValid

protected boolean momentaryPressValid

exactToggleTime

protected long exactToggleTime

Constructor Detail

UIButton

public UIButton()

UIButton

public UIButton(float w,
                BooleanParameter p)

UIButton

public UIButton(float w,
                float h,
                BooleanParameter p)

UIButton

public UIButton(float w,
                EnumParameter<?> p)

UIButton

public UIButton(float w,
                float h,
                EnumParameter<?> p)

UIButton

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

Method Detail

setEnabled

public UIButton setEnabled(boolean enabled)

setTriggerable

public UIButton setTriggerable(boolean triggerable)

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 LXListenableNormalizedParameter getParameter()

Specified by:

getParameter in class UIParameterComponent

removeParameter

public UIButton removeParameter()

setParameter

public UIButton setParameter(EnumParameter<?> parameter)

setParameter

public UIButton setParameter(BooleanParameter parameter)

setMomentary

public UIButton setMomentary(boolean momentary)

setIconOffset

public UIButton setIconOffset(float iconOffsetX,
                              float iconOffsetY)

setIconOffsetX

public UIButton setIconOffsetX(float iconOffsetX)

setIconOffsetY

public UIButton setIconOffsetY(float iconOffsetY)

onDraw

protected 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

onBlur

protected void onBlur()

Description copied from class: UIObject

Subclasses override when element loses focus

Overrides:

onBlur in class UIObject

onMouseDragged

protected void onMouseDragged(MouseEvent mouseEvent,
                              float mx,
                              float my,
                              float dx,
                              float dy)

Description copied from class: UIEventHandler

Subclasses override to receive mouse events

Overrides:

onMouseDragged in class UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

dx - movement in x

dy - movement in y

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 UIParameterComponent

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 UIParameterComponent

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

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 UIEventHandler

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

onKeyReleased

protected void onKeyReleased(KeyEvent keyEvent,
                             char keyChar,
                             int keyCode)

Description copied from class: UIEventHandler

Subclasses override to receive key events

Overrides:

onKeyReleased in class UIEventHandler

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

isActive

public boolean isActive()

setActive

public UIButton setActive(boolean active)

setActive

protected UIButton setActive(boolean active,
                             boolean pushToParameter)

toggle

public UIButton toggle()

onClick

protected void onClick()

Subclasses may override when a momentary button is clicked, and the click release happened within the bounds of the box

onToggle

protected void onToggle(boolean active)

Subclasses may override this to handle changes to the button's state

Parameters:

active - Whether button is active

setActiveColor

public UIButton setActiveColor(int activeColor)

setInactiveColor

public UIButton setInactiveColor(int inactiveColor)

setLabel

public UIButton setLabel(String label)

setActiveLabel

public UIButton setActiveLabel(String activeLabel)

setInactiveLabel

public UIButton setInactiveLabel(String inactiveLabel)

setIcon

public UIButton setIcon(PImage icon)

setActiveIcon

public UIButton setActiveIcon(PImage activeIcon)

setInactiveIcon

public UIButton setInactiveIcon(PImage inactiveIcon)

getControlTarget

public LXParameter getControlTarget()

Specified by:

getControlTarget in interface UIControlTarget

getTriggerSource

public BooleanParameter getTriggerSource()

Specified by:

getTriggerSource in interface UITriggerSource

getTriggerTarget

public BooleanParameter getTriggerTarget()

Specified by:

getTriggerTarget in interface UITriggerTarget