heronarts.p3lx.ui.component

Class UICollapsibleSection

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.UI2dContainer

heronarts.p3lx.ui.component.UICollapsibleSection

All Implemented Interfaces:

LXLoopTask, UIContainer, UIMouseFocus, Iterable<UIObject>

Direct Known Subclasses:

UIAudio, UICamera, UIComponentManager, UIFixtureInspector, UIFixtureManager, UIMidiInputs, UIMidiMappings, UIMidiSurfaces, UIOscManager, UIOutputManager, UIPackageManager, UIPalette, UIPluginManager, UISnapshots

public class UICollapsibleSection
extends UI2dContainer
implements UIMouseFocus

Section with a title which can collapse/expand

Nested Class Summary

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

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout

Field Summary

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

Method Summary

Modifier and Type	Method and Description
UI2dContainer	getContentTarget() Returns the object that elements are added to when placed in this container.
boolean	isExpanded()
void	onDraw(UI ui, PGraphics pg) 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	setExpanded(boolean expanded) Sets the expanded state of this section
UICollapsibleSection	setTitle(String title) Sets the title of the section
protected UICollapsibleSection	setTitleX(float x)
UICollapsibleSection	toggle() Toggles the expansion state of the section

Methods inherited from class heronarts.p3lx.ui.UI2dContainer

addChildren, addTopLevelComponent, getChild, getChildren, getContentHeight, getContentWidth, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, reflow, removeAllChildren, setArrowKeyFocus, setChildMargin, setChildSpacing, setChildSpacing, setContentHeight, setContentSize, setContentTarget, setContentWidth, setLayout, setMinHeight, setMinWidth, setPadding, setPadding, setPadding

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

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMouseReleased, onMouseWheel

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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 Detail

isExpanded

public boolean isExpanded()

setTitleX

protected UICollapsibleSection setTitleX(float x)

setTitle

public UICollapsibleSection setTitle(String title)

Sets the title of the section

Parameters:

title - Title

Returns:

this

onDraw

public 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

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

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