Package heronarts.glx.ui.component

Class UIIndicator

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.component.UIIndicator

All Implemented Interfaces:

UITriggerSource, LXLoopTask

public class UIIndicator
extends UI2dComponent
implements UITriggerSource

Nested Class Summary

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 int	DEFAULT_TIMER_MS
double	indicatorTimeMs
boolean	timerMode

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
UIIndicator(UI ui, float x, float y, float w, float h, BooleanParameter bool)
UIIndicator(UI ui, float w, float h, BooleanParameter bool)
UIIndicator(UI ui, BooleanParameter bool)

Method Summary

Modifier and Type	Method	Description
BooleanParameter	getTriggerSource()
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
UIIndicator	setClickable(boolean clickable)
UIIndicator	setEnabled(boolean enabled)
UIIndicator	setIndicatorBackgroundColor(UITheme.Color indicatorBackground)
UIIndicator	setIndicatorTime(boolean timerMode)
UIIndicator	setIndicatorTime(double indicatorTimeMs)
UIIndicator	setSingleClickable(boolean singleClickable)
UIIndicator	setTriggerable(boolean triggerable)

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, onDraw, 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, onKeyPressed, onKeyReleased, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMouseScroll

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TIMER_MS

public static final int DEFAULT_TIMER_MS

See Also:

• Constant Field Values

timerMode

public boolean timerMode

indicatorTimeMs

public double indicatorTimeMs

Constructor Details

UIIndicator

public UIIndicator(UI ui,
 BooleanParameter bool)

UIIndicator

public UIIndicator(UI ui,
 float w,
 float h,
 BooleanParameter bool)

UIIndicator

public UIIndicator(UI ui,
 float x,
 float y,
 float w,
 float h,
 BooleanParameter bool)

Method Details

setEnabled

public UIIndicator setEnabled(boolean enabled)

setIndicatorBackgroundColor

public UIIndicator setIndicatorBackgroundColor(UITheme.Color indicatorBackground)

setTriggerable

public UIIndicator setTriggerable(boolean triggerable)

setClickable

public UIIndicator setClickable(boolean clickable)

setSingleClickable

public UIIndicator setSingleClickable(boolean singleClickable)

setIndicatorTime

public UIIndicator setIndicatorTime(boolean timerMode)

setIndicatorTime

public UIIndicator setIndicatorTime(double indicatorTimeMs)

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

getTriggerSource

public BooleanParameter getTriggerSource()

Specified by:

getTriggerSource in interface UITriggerSource