heronarts.p3lx.ui.component

Class UICheckbox

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UIParameterComponent

heronarts.p3lx.ui.component.UICheckbox

All Implemented Interfaces:

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

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

Nested Class Summary

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

UIContextActions.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
static int	DEFAULT_HEIGHT
static int	DEFAULT_WIDTH
protected boolean	enabled
protected boolean	isMomentary

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

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

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	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	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
UICheckbox	removeParameter()
UICheckbox	setActive(boolean active)
protected UICheckbox	setActive(boolean active, boolean pushToParameter)
UICheckbox	setEnabled(boolean enabled)
UICheckbox	setMomentary(boolean momentary)
UICheckbox	setParameter(BooleanParameter parameter)
UICheckbox	setTriggerable(boolean triggerable)
UICheckbox	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, onBlur, onFocus, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

active

protected boolean active

isMomentary

protected boolean isMomentary

enabled

protected boolean enabled

Constructor Detail

UICheckbox

public UICheckbox()

UICheckbox

public UICheckbox(float w,
                  BooleanParameter p)

UICheckbox

public UICheckbox(float x,
                  float y)

UICheckbox

public UICheckbox(float x,
                  float y,
                  BooleanParameter p)

UICheckbox

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

UICheckbox

public UICheckbox(float x,
                  float y,
                  float w,
                  float h,
                  BooleanParameter p)

Method Detail

setEnabled

public UICheckbox setEnabled(boolean enabled)

setTriggerable

public UICheckbox 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 UICheckbox removeParameter()

setParameter

public UICheckbox setParameter(BooleanParameter parameter)

setMomentary

public UICheckbox setMomentary(boolean momentary)

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

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 UICheckbox setActive(boolean active)

setActive

protected UICheckbox setActive(boolean active,
                               boolean pushToParameter)

toggle

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

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