Package heronarts.glx.ui.component

Class UIButton

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIParameterComponent

heronarts.glx.ui.component.UIButton

All Implemented Interfaces:

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

Direct Known Subclasses:

UIButton.Action, UIButton.Toggle, UIButton.Tooltip, UIButton.Trigger, UIMappingButton

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UIButton.Action
static interface	UIButton.EnumFormatter
static class	UIButton.Expander
static class	UIButton.Toggle
static class	UIButton.Tooltip
static class	UIButton.Trigger

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

UI2dComponent.Scissor, UI2dComponent.Scissored, UI2dComponent.UIDragReorder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
protected UIColor	activeColor
protected boolean	enabled
protected UIColor	inactiveColor
protected boolean	isMomentary
protected boolean	momentaryPressValid

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

DEFAULT_HEIGHT, useCommandEngine

Fields inherited from class heronarts.glx.ui.UI2dComponent

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

Method Summary

Modifier and Type	Method	Description
void	dispose()
LXNormalizedParameter	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()
protected BooleanParameter	getTriggerSourceParameter()
BooleanParameter	getTriggerTarget()
protected BooleanParameter	getTriggerTargetParameter()
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, VGraphics vg)	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	setActiveColor(UIColor activeColor)
UIButton	setActiveFontColor(int activeFontColor)	Sets the active font color
UIButton	setActiveFontColor(UIColor activeFontColor)	Sets the active font color
UIButton	setActiveIcon(VGraphics.Image activeIcon)
UIButton	setActiveLabel(String activeLabel)
UIButton	setControlSource(LXNormalizedParameter controlSource)	Sets an explicit control source for the button, which may or may not match its other parameter behavior.
UIButton	setControlTarget(LXNormalizedParameter controlTarget)	Sets an explicit control target for the button, which may or may not match its other parameter behavior.
UIButton	setEnabled(boolean enabled)
UIButton	setEnumFormatter(UIButton.EnumFormatter formatter)
UIButton	setIcon(VGraphics.Image icon)
UIButton	setIconColor(boolean iconColor)
UIButton	setIconColor(int iconColor)
UIButton	setIconColor(UIColor iconColor)
UIButton	setIconOffset(float iconOffsetX, float iconOffsetY)
UIButton	setIconOffsetX(float iconOffsetX)
UIButton	setIconOffsetY(float iconOffsetY)
UIButton	setInactiveColor(int inactiveColor)
UIButton	setInactiveColor(UIColor inactiveColor)
UIButton	setInactiveIcon(VGraphics.Image inactiveIcon)
UIButton	setInactiveLabel(String inactiveLabel)
UIButton	setLabel(String label)
UIButton	setMomentary(boolean momentary)
UIButton	setParameter(BooleanParameter parameter)
UIButton	setParameter(EnumParameter<? extends Object> parameter)
UIButton	setTriggerable(boolean triggerable)
UIButton	toggle()

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

getContextActions, getOscAddress, setEnableContextActions, setModulationRangeCommand, setNormalizedCommand, setUseCommandEngine

Methods inherited from class heronarts.glx.ui.UI2dComponent

addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, addToContainer, assertValidContainer, clipTextToWidth, clipTextToWidth, contains, dbch, drawBackground, drawBorder, drawFocus, drawFocusCorners, drawFocusCorners, drawParentBackground, getAbsoluteX, getAbsoluteY, getBackgroundColor, getBorderColor, getBorderWeight, getContainer, getDebugClassHierarchy, getDebugClassHierarchy, getFocusColor, getFocusSize, getFont, getFontColor, getHeight, getMappableParameter, getNextSibling, getParent, getPrevSibling, 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, blur, bringToFront, focus, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, loop, onFocus, onUIResize, removeLoopTask, requireUIThread, setConsumeMousePress, setDebugId, toggleVisible, toString

Methods inherited from class heronarts.glx.ui.UIEventHandler

onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

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

Field Details

active

protected boolean active

isMomentary

protected boolean isMomentary

inactiveColor

protected UIColor inactiveColor

activeColor

protected UIColor activeColor

enabled

protected boolean enabled

momentaryPressValid

protected boolean momentaryPressValid

Constructor Details

UIButton

public UIButton()

UIButton

public UIButton(float w,
 BooleanParameter p)

UIButton

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

UIButton

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

UIButton

public UIButton(float w,
 float h)

UIButton

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

Method Details

setActiveFontColor

public UIButton setActiveFontColor(int activeFontColor)

Sets the active font color

Parameters:

activeFontColor - color

Returns:

this

setActiveFontColor

public UIButton setActiveFontColor(UIColor activeFontColor)

Sets the active font color

Parameters:

activeFontColor - color

Returns:

this

setEnabled

public UIButton setEnabled(boolean enabled)

setTriggerable

public UIButton setTriggerable(boolean triggerable)

setIconColor

public UIButton setIconColor(boolean iconColor)

setIconColor

public UIButton setIconColor(int iconColor)

setIconColor

public UIButton setIconColor(UIColor iconColor)

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<? extends Object> parameter)

setEnumFormatter

public UIButton setEnumFormatter(UIButton.EnumFormatter formatter)

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,
 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

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

onToggle

protected void onToggle(boolean active)

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

Parameters:

active - Whether button is active

onClick

protected void onClick()

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

setActiveColor

public UIButton setActiveColor(int activeColor)

setActiveColor

public UIButton setActiveColor(UIColor activeColor)

setInactiveColor

public UIButton setInactiveColor(int inactiveColor)

setInactiveColor

public UIButton setInactiveColor(UIColor inactiveColor)

setLabel

public UIButton setLabel(String label)

setActiveLabel

public UIButton setActiveLabel(String activeLabel)

setInactiveLabel

public UIButton setInactiveLabel(String inactiveLabel)

setIcon

public UIButton setIcon(VGraphics.Image icon)

setActiveIcon

public UIButton setActiveIcon(VGraphics.Image activeIcon)

setInactiveIcon

public UIButton setInactiveIcon(VGraphics.Image inactiveIcon)

setControlSource

public UIButton setControlSource(LXNormalizedParameter controlSource)

Sets an explicit control source for the button, which may or may not match its other parameter behavior. Useful for buttons that need to perform a custom LXCommand rather than explicitly change parameter value, but still should be mappable for modulation and MIDI.

Parameters:

controlSource - Control source

Returns:

this

setControlTarget

public UIButton setControlTarget(LXNormalizedParameter controlTarget)

Sets an explicit control target for the button, which may or may not match its other parameter behavior. Useful for buttons that need to perform a custom LXCommand rather than explicitly change parameter value, but still should be mappable for modulation and MIDI.

Parameters:

controlTarget - Control target

Returns:

this

getControlTarget

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

getTriggerSourceParameter

protected BooleanParameter getTriggerSourceParameter()

getTriggerTargetParameter

protected BooleanParameter getTriggerTargetParameter()

dispose

public void dispose()

Overrides:

dispose in class UIObject