Package heronarts.glx.ui.component

Class UICollapsibleSection

java.lang.Object

heronarts.glx.ui.UIEventHandler

heronarts.glx.ui.UIObject

heronarts.glx.ui.UI2dComponent

heronarts.glx.ui.UI2dContainer

heronarts.glx.ui.component.UICollapsibleSection

All Implemented Interfaces:

UIContainer, UIMouseFocus, LXLoopTask, Iterable<UIObject>

Direct Known Subclasses:

UIAudio, UICamera, UIComponentManager, UIDmxManager, UIEnvelop, UIFixtureErrors, UIFixtureInspector, UIFixtureManager, UIMidiInputs, UIMidiMappings, UIMidiSurfaces, UIMidiTemplate, UIMidiTemplates.Picker, UIModelInspector, UIOscManager, UIOutputManager, UIPackageManager, UIPalette, UIPerformanceAudio, UIPerformancePalette, UIPluginManager, UIReaper, UISnapshots, UISoundStageManager, UIViews

public class UICollapsibleSection
extends UI2dContainer
implements UIMouseFocus

Section with a title which can collapse/expand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UICollapsibleSection.Utils

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

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout, UI2dContainer.Position

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	BAR_HEIGHT
protected static final int	PADDING
protected static final int	TITLE_X

Fields inherited from class heronarts.glx.ui.UI2dContainer

bottomPadding, childSpacingX, childSpacingY, leftPadding, rightPadding, topPadding

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
UICollapsibleSection(UI ui, float w, float h)
UICollapsibleSection(UI ui, float x, float y, float w, float h)	Constructs a new collapsible section
UICollapsibleSection(UI ui, float w, float h, BooleanParameter expandedParameter)

Method Summary

Modifier and Type	Method	Description
protected UI2dContainer	controlRow(UI ui, String label, UI2dComponent control)
void	dispose()
static void	drawHorizontalExpansionTriangle(UI ui, VGraphics vg, boolean expanded)
UI2dContainer	getContentTarget()	Returns the object that elements are added to when placed in this container.
boolean	isExpanded()	Whether the section is presently expanded
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
UICollapsibleSection	setAlwaysOpen()
UICollapsibleSection	setExpanded(boolean expanded)	Sets the expanded state of this section
UICollapsibleSection	setExpandedParameter(BooleanParameter expandedParameter)	Set the section to follow and update a parameter for its expansion state
protected void	setFooter(UI2dComponent footer)
protected void	setFooterVisible(boolean footerVisible)
UICollapsibleSection	setTitle(String title)	Sets the title of the section
protected UICollapsibleSection	setTitleX(float x)
UICollapsibleSection	toggle()	Toggles the expansion state of the section
protected void	updateHeight()

Methods inherited from class heronarts.glx.ui.UI2dContainer

addChildren, addTopLevelComponent, getBottomPadding, getChild, getChildren, getChildSpacingX, getChildSpacingY, getContentHeight, getContentWidth, getLeftPadding, getRightPadding, getScrollHeight, getScrollWidth, getTopPadding, hasDragToReorder, isEmpty, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onReflow, reflow, removeAllChildren, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setChildSpacingX, setChildSpacingY, setContentHeight, setContentSize, setContentTarget, setContentWidth, setDragToReorder, setLayout, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

PADDING

protected static final int PADDING

See Also:

• Constant Field Values

TITLE_X

protected static final int TITLE_X

See Also:

• Constant Field Values

BAR_HEIGHT

public static final int BAR_HEIGHT

See Also:

• Constant Field Values

Constructor Details

UICollapsibleSection

public UICollapsibleSection(UI ui,
 float w,
 float h)

UICollapsibleSection

public UICollapsibleSection(UI ui,
 float w,
 float h,
 BooleanParameter expandedParameter)

UICollapsibleSection

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

Constructs a new collapsible section

Parameters:

ui - UI

x - Xpos

y - Ypos

w - Width

h - Height

Method Details

setAlwaysOpen

public UICollapsibleSection setAlwaysOpen()

isExpanded

public boolean isExpanded()

Whether the section is presently expanded

Returns:

Whether section is expanded

setExpandedParameter

public UICollapsibleSection setExpandedParameter(BooleanParameter expandedParameter)

Set the section to follow and update a parameter for its expansion state

Parameters:

expandedParameter - Parameter to follow and update for expansion changes

Returns:

this

setTitleX

protected UICollapsibleSection setTitleX(float x)

setTitle

public UICollapsibleSection setTitle(String title)

Sets the title of the section

Parameters:

title - Title

Returns:

this

drawHorizontalExpansionTriangle

public static void drawHorizontalExpansionTriangle(UI ui,
 VGraphics vg,
 boolean expanded)

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 UI2dContainer

Parameters:

ui - UI context

vg - Graphics context

toggle

public UICollapsibleSection toggle()

Toggles the expansion state of the section

Returns:

this

setExpanded

public UICollapsibleSection setExpanded(boolean expanded)

Sets the expanded state of this section

Parameters:

expanded - Whether section is expanded

Returns:

this

updateHeight

protected void updateHeight()

setFooter

protected void setFooter(UI2dComponent footer)

setFooterVisible

protected void setFooterVisible(boolean footerVisible)

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

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 UI2dContainer

Parameters:

keyEvent - Key event

keyChar - Key character

keyCode - Key code value

getContentTarget

public UI2dContainer getContentTarget()

Description copied from class: UI2dContainer

Returns the object that elements are added to when placed in this container. In most cases, it will be "this" - but some elements have special subcontainers.

Specified by:

getContentTarget in interface UIContainer

Overrides:

getContentTarget in class UI2dContainer

Returns:

Element

controlRow

protected UI2dContainer controlRow(UI ui,
 String label,
 UI2dComponent control)

dispose

public void dispose()

Overrides:

dispose in class UIObject