heronarts.p3lx.ui

Class UIWindow

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.UI2dContainer

heronarts.p3lx.ui.UI2dContext

heronarts.p3lx.ui.UIWindow

All Implemented Interfaces:

LXLoopTask, UIContainer, Iterable<UIObject>

public class UIWindow
extends UI2dContext

A UIWindow is a UIContext that by default has a title bar and can be dragged around when the mouse is pressed on the title bar.

Nested Class Summary

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

UI2dContainer.ArrowKeyFocus, UI2dContainer.Layout

Field Summary

Fields

Modifier and Type	Field and Description
static int	TITLE_LABEL_HEIGHT

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
UIWindow(UI ui, String title, float x, float y, float w, float h) Constructs a window object

Method Summary

Modifier and Type	Method and Description
protected void	onBlur() Subclasses override when element loses focus
protected void	onFocus(Event event) Subclasses override when element is focused
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
UIWindow	setTitle(String title) Set the title of the window.

Methods inherited from class heronarts.p3lx.ui.UI2dContext

drawBackground, getGraphics, onResize

Methods inherited from class heronarts.p3lx.ui.UI2dContainer

addChildren, addTopLevelComponent, getChild, getChildren, getContentHeight, getContentTarget, getContentWidth, iterator, newHorizontalContainer, newHorizontalContainer, newHorizontalContainer, newVerticalContainer, newVerticalContainer, newVerticalContainer, onKeyPressed, 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, 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, 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, onDraw, onUIResize, removeLoopTask, toggleVisible

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

onKeyReleased, onKeyTyped, onMouseClicked, 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

Field Detail

TITLE_LABEL_HEIGHT

public static final int TITLE_LABEL_HEIGHT

See Also:

Constant Field Values

Constructor Detail

UIWindow

public UIWindow(UI ui,
                String title,
                float x,
                float y,
                float w,
                float h)

Constructs a window object

Parameters:

ui - UI to place in

title - Title for this window

x - X-coordinate

y - Y-coordinate

w - Width

h - Height

Method Detail

onFocus

protected void onFocus(Event event)

Description copied from class: UIObject

Subclasses override when element is focused

Overrides:

onFocus in class UIObject

Parameters:

event - Event that caused focus

onBlur

protected void onBlur()

Description copied from class: UIObject

Subclasses override when element loses focus

Overrides:

onBlur in class UIObject

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 UIEventHandler

Parameters:

mouseEvent - Mouse event

mx - x-coordinate

my - y-coordinate

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

setTitle

public UIWindow setTitle(String title)

Set the title of the window.

Parameters:

title - Title of the window

Returns:

this window