UIObject (LX API)

java.lang.Object
- heronarts.p3lx.ui.UIEventHandler
- - heronarts.p3lx.ui.UIObject

All Implemented Interfaces:

LXLoopTask

Direct Known Subclasses:

UI2dComponent, UI3dComponent, UI3dContext
```
public abstract class UIObject
extends UIEventHandler
implements LXLoopTask
```

Field Summary

Fields
Modifier and Type Field and Description

protected List<UIObject> children

protected boolean hasFocus

protected boolean mousePressContextMenu

BooleanParameter visible

Fields
Modifier and Type	Field and Description
`protected List<UIObject>`	`children`
`protected boolean`	`hasFocus`
`protected boolean`	`mousePressContextMenu`
`BooleanParameter`	`visible`

Constructor Summary

Constructors
Modifier Constructor and Description

protected UIObject()

Constructors
Modifier	Constructor and Description
`protected`	`UIObject()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected UIObject`	`addLoopTask(LXLoopTask loopTask)` Add a task to be performed on every loop of the UI engine.
`protected void`	`beginDraw(UI ui, PGraphics pg)` Subclasses may override this method to perform operations before their onDraw method is called or any children are drawn.
`UIObject`	`blur()` Blur this object.
`UIObject`	`bringToFront()` Brings this object to the front of its container.
`protected UIObject`	`consumeKeyEvent()` Called in a key event handler to stop this event from bubbling up the parent container chain.
`protected UIObject`	`consumeMousePress()` Called in a mouse event handler to stop this event from bubbling up the parent container chain.
`protected UIObject`	`consumeMouseWheelEvent()` Called in a mouse wheel handler to stop this mouse wheel event from bubbling.
`protected boolean`	`contains(float x, float y)` Whether the given point is contained by this object
`protected void`	`endDraw(UI ui, PGraphics pg)` Subclasses may override this method to perform operations after their onDraw method has been called and after all children have been drawn
`UIObject`	`focus(Event event)` Focuses on this object, giving focus to everything above and whatever was previously focused below.
`String`	`getDescription()` Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component.
`UIObject`	`getFocusedChild()` Gets which immediate child of this object is focused, may be null.
`abstract float`	`getHeight()`
`protected LX`	`getLX()`
`protected UIObject`	`getParent()` Subclasses may access the object that is containing this one
`protected UI`	`getUI()`
`abstract float`	`getWidth()`
`boolean`	`hasDirectFocus()` Whether this object has direct focus, meaning that no child element is focused
`boolean`	`hasFocus()` Whether this object has focus
`boolean`	`isVisible()` Whether this object is visible.
`protected boolean`	`keyEventConsumed()` Checks whether key event was already consumed
`void`	`loop(double deltaMs)` Processes all the loop tasks in this object
`protected boolean`	`mousePressConsumed()` Checks whether the mouse event was already consumed
`protected void`	`onBlur()` Subclasses override when element loses focus
`protected void`	`onDraw(UI ui, PGraphics pg)` Subclasses should override this method to perform their drawing functions.
`protected void`	`onFocus(Event event)` Subclasses override when element is focused
`protected void`	`onUIResize(UI ui)` Subclasses may override this method to handle resize events on the global UI.
`protected UIObject`	`removeLoopTask(LXLoopTask loopTask)` Remove a task from the UI engine
`UIObject`	`setDescription(String description)`
`UIObject`	`setVisible(boolean visible)` Set whether this object is visible
`UIObject`	`toggleVisible()` Toggle visible state of this component

Methods inherited from class heronarts.p3lx.ui.UIEventHandler
onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseMoved, onMouseOut, onMouseOver, onMousePressed, onMouseReleased, onMouseWheel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - visible
```
public final BooleanParameter visible
```
  - children
```
protected final List<UIObject> children
```
  - hasFocus
```
protected boolean hasFocus
```
  - mousePressContextMenu
```
protected boolean mousePressContextMenu
```
- Constructor Detail
  - UIObject
```
protected UIObject()
```
- Method Detail
  - getUI
```
protected UI getUI()
```
  - getLX
```
protected LX getLX()
```
  - addLoopTask
```
protected UIObject addLoopTask(LXLoopTask loopTask)
```
    Add a task to be performed on every loop of the UI engine.
    
    Parameters:
    
    loopTask - Task to be performed on every UI frame
    
    Returns:
    
    this
  - removeLoopTask
```
protected UIObject removeLoopTask(LXLoopTask loopTask)
```
    Remove a task from the UI engine
    
    Parameters:
    
    loopTask - Task to be removed from work list
    
    Returns:
    
    this
  - loop
```
public final void loop(double deltaMs)
```
    Processes all the loop tasks in this object
    
    Specified by:
    
    loop in interface LXLoopTask
  - getParent
```
protected UIObject getParent()
```
    Subclasses may access the object that is containing this one
    
    Returns:
    
    Parent object
  - contains
```
protected boolean contains(float x,
                           float y)
```
    Whether the given point is contained by this object
    
    Parameters:
    
    x - x-coordinate
    
    y - y-coordinate
    
    Returns:
    
    True if the object contains this point
  - getWidth
```
public abstract float getWidth()
```
  - getHeight
```
public abstract float getHeight()
```
  - setDescription
```
public UIObject setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
    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.
    
    Returns:
    
    Helpful contextual string explaining function of this element
  - isVisible
```
public boolean isVisible()
```
    Whether this object is visible.
    
    Returns:
    
    True if this object is being displayed
  - toggleVisible
```
public UIObject toggleVisible()
```
    Toggle visible state of this component
    
    Returns:
    
    this
  - setVisible
```
public UIObject setVisible(boolean visible)
```
    Set whether this object is visible
    
    Parameters:
    
    visible - Whether the object is visible
    
    Returns:
    
    this
  - hasFocus
```
public boolean hasFocus()
```
    Whether this object has focus
    
    Returns:
    
    true or false
  - hasDirectFocus
```
public boolean hasDirectFocus()
```
    Whether this object has direct focus, meaning that no child element is focused
    
    Returns:
    
    true or false
  - getFocusedChild
```
public UIObject getFocusedChild()
```
    Gets which immediate child of this object is focused, may be null. Child may also have focused children.
    
    Returns:
    
    immediate child of this object which has focus
  - focus
```
public UIObject focus(Event event)
```
    Focuses on this object, giving focus to everything above and whatever was previously focused below.
    
    Parameters:
    
    event - Event that triggers focus
    
    Returns:
    
    this
  - blur
```
public UIObject blur()
```
    Blur this object. Blurs its children from the bottom of the tree up.
    
    Returns:
    
    this
  - bringToFront
```
public UIObject bringToFront()
```
    Brings this object to the front of its container.
    
    Returns:
    
    this
  - onUIResize
```
protected void onUIResize(UI ui)
```
    Subclasses may override this method to handle resize events on the global UI. Called on the UI thread, only happens if ui.setResizable(true) has been called.
    
    Parameters:
    
    ui - The UI object
  - beginDraw
```
protected void beginDraw(UI ui,
                         PGraphics pg)
```
    Subclasses may override this method to perform operations before their onDraw method is called or any children are drawn.
    
    Parameters:
    
    ui - UI context
    
    pg - Graphics context
  - onDraw
```
protected void onDraw(UI ui,
                      PGraphics pg)
```
    Subclasses should override this method to perform their drawing functions.
    
    Parameters:
    
    ui - UI context
    
    pg - Graphics context
  - endDraw
```
protected void endDraw(UI ui,
                       PGraphics pg)
```
    Subclasses may override this method to perform operations after their onDraw method has been called and after all children have been drawn
    
    Parameters:
    
    ui - UI context
    
    pg - Graphics context
  - consumeKeyEvent
```
protected UIObject consumeKeyEvent()
```
    Called in a key event handler to stop this event from bubbling up the parent container chain. For example, a button which responds to a space bar press should call consumeKeyEvent() to stop the event from being handled by its container.
    
    Returns:
    
    this
  - keyEventConsumed
```
protected boolean keyEventConsumed()
```
    Checks whether key event was already consumed
    
    Returns:
    
    Whether the key event is already handled
  - consumeMousePress
```
protected UIObject consumeMousePress()
```
    Called in a mouse event handler to stop this event from bubbling up the parent container chain. For example, a button which responds to a mouse press and sets some focus elsewhere should call consumeMousePress() to stop the press from being handled by its container.
    
    Returns:
    
    this
  - mousePressConsumed
```
protected boolean mousePressConsumed()
```
    Checks whether the mouse event was already consumed
    
    Returns:
    
    Whether the mouse event is already handled
  - consumeMouseWheelEvent
```
protected UIObject consumeMouseWheelEvent()
```
    Called in a mouse wheel handler to stop this mouse wheel event from bubbling. Invoked by nested scroll views.
    
    Returns:
    
    this
  - onFocus
```
protected void onFocus(Event event)
```
    Subclasses override when element is focused
    
    Parameters:
    
    event - Event that caused focus
  - onBlur
```
protected void onBlur()
```
    Subclasses override when element loses focus

Class UIObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

Methods inherited from class java.lang.Object

Field Detail

visible

children

hasFocus

mousePressContextMenu

Constructor Detail

UIObject

Method Detail

getUI

getLX

addLoopTask

removeLoopTask

loop

getParent

contains

getWidth

getHeight

setDescription

getDescription

isVisible

toggleVisible

setVisible

hasFocus

hasDirectFocus

getFocusedChild

focus

blur

bringToFront

onUIResize

beginDraw

onDraw

endDraw

consumeKeyEvent

keyEventConsumed

consumeMousePress

mousePressConsumed

consumeMouseWheelEvent

onFocus

onBlur