UI2dComponent (LX API)

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

All Implemented Interfaces:

LXLoopTask

Direct Known Subclasses:

UI2dContainer, UIColorPicker, UIContextButton, UIContextMenu, UIDiscreteColorBox, UIGradientPattern.UIPaletteGradient, UIImage, UILabel, UIParameterComponent, UISceneButton, UISceneStrip.UIClipViewToggle, UIStop, UIWave
```
public abstract class UI2dComponent
extends UIObject
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`bottomMargin`
`protected float`	`height` Height of the object
`protected float`	`leftMargin`
`protected float`	`rightMargin`
`protected int`	`textAlignHorizontal`
`protected int`	`textAlignVertical`
`protected float`	`textOffsetX`
`protected float`	`textOffsetY`
`protected float`	`topMargin`
`protected float`	`width` Width of the object
`protected float`	`x` Position of the object, relative to parent, top left corner
`protected float`	`y` Position of the object, relative to parent, top left corner

Fields inherited from class heronarts.p3lx.ui.UIObject
children, hasFocus, mousePressContextMenu, visible

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`UI2dComponent()`
`protected`	`UI2dComponent(float x, float y, float width, float height)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UI2dComponent`	`addToContainer(UIContainer container)` Adds this component to a container, also removing it from any other container that is currently holding it.
`UI2dComponent`	`addToContainer(UIContainer container, int index)` Adds this component to a container at a specified index, also removing it from any other container that is currently holding it.
`static String`	`breakTextToWidth(PGraphics pg, String str, float width)` Break a text into multiple lines to fit in the given width
`static String`	`clipTextToWidth(PGraphics pg, String str, float width)` Clip a text to fit in the given width
`boolean`	`contains(float x, float y)` Whether the given coordinate, in the parent-space, is contained by this object.
`protected void`	`drawBackground(UI ui, PGraphics pg)`
`protected void`	`drawBorder(UI ui, PGraphics pg)`
`protected void`	`drawFocus(UI ui, PGraphics pg)` Draws focus on this object.
`protected void`	`drawFocusCorners(UI ui, PGraphics pg, int color)`
`static void`	`drawFocusCorners(UI ui, PGraphics pg, int color, float x, float y, float width, float height, int focusSize)`
`int`	`getBackgroundColor()` The background color, if there is a background
`int`	`getBorderColor()` Current border color
`int`	`getBorderRounding()`
`int`	`getBorderWeight()` The weight of the border
`UI2dContainer`	`getContainer()` Returns the 2d container that this is in
`protected int`	`getFocusColor(UI ui)`
`protected int`	`getFocusSize()` Focus size for hashes drawn on the outline of the object.
`PFont`	`getFont()` Get default font, may be null
`int`	`getFontColor()` The font color, if there is a color specified
`float`	`getHeight()` Height
`UI2dComponent`	`getNextSibling()` Returns the adjacent object in the hierarchy
`UIObject`	`getParent()` Get the parent object that this is in
`UI2dComponent`	`getPrevSibling()` Returns the adjacent object in the hierarchy
`float`	`getWidth()` Width
`float`	`getX()` X position
`float`	`getY()` Y position
`boolean`	`hasBackground()` Whether this object has a background
`boolean`	`hasBorder()` Whether this object has a border
`boolean`	`hasFont()` Whether a font is set on this object
`boolean`	`hasFontColor()` Whether this object has a specific color
`protected boolean`	`isMappable()` Determines whether component is permitted to be a mappable control
`protected void`	`onResize()` Subclasses may override this method, invoked when the component is resized
`UI2dComponent`	`redraw()` Redraws this object.
`UI2dComponent`	`removeFromContainer()` Removes this components from the container is is held by
`UI2dComponent`	`setBackground(boolean hasBackground)` Sets whether the object has a background
`UI2dComponent`	`setBackgroundColor(int backgroundColor)` Sets a background color
`UI2dComponent`	`setBorder(boolean hasBorder)` Sets whether there is a border
`UI2dComponent`	`setBorderColor(int borderColor)` Sets the color of the border
`UI2dComponent`	`setBorderRounding(int borderRounding)`
`UI2dComponent`	`setBorderWeight(int borderWeight)` Sets the weight of the border
`UI2dComponent`	`setBottomMargin(float bottomMargin)` Sets the bottom margin around this object when inside a UI2dContainer with layout
`UI2dComponent`	`setContainerIndex(int index)` Sets the index of this object in its container.
`UI2dComponent`	`setDescription(String description)`
`UI2dComponent`	`setFocusBackground(boolean focusBackground)` Sets whether a focus background color is used
`UI2dComponent`	`setFocusBackgroundColor(int focusBackgroundColor)` Sets a background color to be used when the component is focused
`UI2dComponent`	`setFocusColor(int focusColor)`
`UI2dComponent`	`setFocusCorners(boolean focusCorners)`
`UI2dComponent`	`setFont(PFont font)` Sets the default font for this object to use, null indicates component may use its own default behavior.
`UI2dComponent`	`setFontColor(boolean hasFontColor)` Sets whether the object has a font color
`UI2dComponent`	`setFontColor(int fontColor)` Sets a font color
`UI2dComponent`	`setHeight(float height)` Sets the height of this component
`UI2dComponent`	`setLeftMargin(float leftMargin)` Sets the left margin around this object when inside a UI2dContainer with layout
`UI2dComponent`	`setMappable(boolean mappable)` Sets whether this component can ever be used for mapping control
`UI2dComponent`	`setMargin(float margin)` Sets the margins around this object when inside of a UI2dContainer with layout
`UI2dComponent`	`setMargin(float yMargin, float xMargin)` Sets the margins around this object when inside of a UI2dContainer with layout
`UI2dComponent`	`setMargin(float topMargin, float rightMargin, float bottomMargin, float leftMargin)` Sets the margins around this object when inside of a UI2dContainer with layout
`UI2dComponent`	`setPosition(float[] position)` Sets position based upon an array of either 2 coordinates or 4
`UI2dComponent`	`setPosition(float x, float y)` Set the position of this component in its parent coordinate space
`UI2dComponent`	`setPosition(float x, float y, float width, float height)` Set the position of this component in its parent coordinate space
`UI2dComponent`	`setPosition(UIObject parent, float offsetX, float offsetY)` Sets the position of this object in the global space, relative to a parent object with a defined offset
`UI2dComponent`	`setRightMargin(float rightMargin)` Sets the right margin around this object when inside a UI2dContainer with layout
`UI2dComponent`	`setSize(float width, float height)` Set the dimensions of this component
`UI2dComponent`	`setTextAlignment(int horizontalAlignment)` Sets the text alignment
`UI2dComponent`	`setTextAlignment(int horizontalAlignment, int verticalAlignment)` Sets the text alignment of this component
`UI2dComponent`	`setTextOffset(float textOffsetX, float textOffsetY)` Sets an offset for text rendering position relative to alignment.
`UI2dComponent`	`setTopMargin(float topMargin)` Sets the top margin around this object when inside a UI2dContainer with layout
`UI2dComponent`	`setVisible(boolean visible)` Set the visibility state of this component
`UI2dComponent`	`setWidth(float width)` Sets the width of this component
`UI2dComponent`	`setX(float x)` Set the position of this component in its parent coordinate space
`UI2dComponent`	`setY(float y)` Set the position of this component in its parent coordinate space

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, onDraw, onFocus, onUIResize, removeLoopTask, toggleVisible

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
  - x
```
protected float x
```
    Position of the object, relative to parent, top left corner
  - y
```
protected float y
```
    Position of the object, relative to parent, top left corner
  - width
```
protected float width
```
    Width of the object
  - height
```
protected float height
```
    Height of the object
  - topMargin
```
protected float topMargin
```
  - rightMargin
```
protected float rightMargin
```
  - bottomMargin
```
protected float bottomMargin
```
  - leftMargin
```
protected float leftMargin
```
  - textAlignHorizontal
```
protected int textAlignHorizontal
```
  - textAlignVertical
```
protected int textAlignVertical
```
  - textOffsetX
```
protected float textOffsetX
```
  - textOffsetY
```
protected float textOffsetY
```
- Constructor Detail
  - UI2dComponent
```
protected UI2dComponent()
```
  - UI2dComponent
```
protected UI2dComponent(float x,
                        float y,
                        float width,
                        float height)
```
- Method Detail
  - setDescription
```
public UI2dComponent setDescription(String description)
```
    Overrides:
    
    setDescription in class UIObject
  - getX
```
public final float getX()
```
    X position
    
    Returns:
    
    x position
  - getY
```
public final float getY()
```
    Y position
    
    Returns:
    
    y position
  - getWidth
```
public final float getWidth()
```
    Width
    
    Specified by:
    
    getWidth in class UIObject
    
    Returns:
    
    width
  - getHeight
```
public final float getHeight()
```
    Height
    
    Specified by:
    
    getHeight in class UIObject
    
    Returns:
    
    height
  - contains
```
public boolean contains(float x,
                        float y)
```
    Whether the given coordinate, in the parent-space, is contained by this object.
    
    Overrides:
    
    contains in class UIObject
    
    Parameters:
    
    x - X-coordinate in parent's coordinate space
    
    y - Y-coordinate in parent's coordinate space
    
    Returns:
    
    Whether this object's bounds contain that point
  - setVisible
```
public UI2dComponent setVisible(boolean visible)
```
    Set the visibility state of this component
    
    Overrides:
    
    setVisible in class UIObject
    
    Parameters:
    
    visible - Whether this should be visible
    
    Returns:
    
    this
  - setX
```
public UI2dComponent setX(float x)
```
    Set the position of this component in its parent coordinate space
    
    Parameters:
    
    x - X-position in parents coordinate space
    
    Returns:
    
    this
  - setY
```
public UI2dComponent setY(float y)
```
    Set the position of this component in its parent coordinate space
    
    Parameters:
    
    y - Y-position in parents coordinate space
    
    Returns:
    
    this
  - setPosition
```
public UI2dComponent setPosition(float x,
                                 float y)
```
    Set the position of this component in its parent coordinate space
    
    Parameters:
    
    x - X-position in parents coordinate space
    
    y - Y-position in parents coordinate space
    
    Returns:
    
    this
  - setPosition
```
public UI2dComponent setPosition(float[] position)
```
    Sets position based upon an array of either 2 coordinates or 4
    
    Parameters:
    
    position - length 2 array or x/y, or length 4 of x/y/width/height
    
    Returns:
    
    this
  - setPosition
```
public UI2dComponent setPosition(float x,
                                 float y,
                                 float width,
                                 float height)
```
    Set the position of this component in its parent coordinate space
    
    Parameters:
    
    x - X-position in parents coordinate space
    
    y - Y-position in parents coordinate space
    
    width - Width of object
    
    height - Height of object
    
    Returns:
    
    this
  - setPosition
```
public UI2dComponent setPosition(UIObject parent,
                                 float offsetX,
                                 float offsetY)
```
    Sets the position of this object in the global space, relative to a parent object with a defined offset
    
    Parameters:
    
    parent - Parent object
    
    offsetX - X offset
    
    offsetY - Y offset
    
    Returns:
    
    this
  - setHeight
```
public UI2dComponent setHeight(float height)
```
    Sets the height of this component
    
    Parameters:
    
    height - Height
    
    Returns:
    
    this
  - setWidth
```
public UI2dComponent setWidth(float width)
```
    Sets the width of this component
    
    Parameters:
    
    width - Width of the component
    
    Returns:
    
    Width of this component
  - setSize
```
public UI2dComponent setSize(float width,
                             float height)
```
    Set the dimensions of this component
    
    Parameters:
    
    width - Width of component
    
    height - Height of component
    
    Returns:
    
    this
  - setMargin
```
public UI2dComponent setMargin(float margin)
```
    Sets the margins around this object when inside of a UI2dContainer with layout
    
    Parameters:
    
    margin - Margin on all sides
    
    Returns:
    
    this
  - setMargin
```
public UI2dComponent setMargin(float yMargin,
                               float xMargin)
```
    Sets the margins around this object when inside of a UI2dContainer with layout
    
    Parameters:
    
    yMargin - Vertical margins
    
    xMargin - Horizontal margins
    
    Returns:
    
    this
  - setTopMargin
```
public UI2dComponent setTopMargin(float topMargin)
```
    Sets the top margin around this object when inside a UI2dContainer with layout
    
    Parameters:
    
    topMargin - Top margin
    
    Returns:
    
    this
  - setBottomMargin
```
public UI2dComponent setBottomMargin(float bottomMargin)
```
    Sets the bottom margin around this object when inside a UI2dContainer with layout
    
    Parameters:
    
    bottomMargin - Bottom margin
    
    Returns:
    
    this
  - setLeftMargin
```
public UI2dComponent setLeftMargin(float leftMargin)
```
    Sets the left margin around this object when inside a UI2dContainer with layout
    
    Parameters:
    
    leftMargin - Left margin
    
    Returns:
    
    this
  - setRightMargin
```
public UI2dComponent setRightMargin(float rightMargin)
```
    Sets the right margin around this object when inside a UI2dContainer with layout
    
    Parameters:
    
    rightMargin - Right margin
    
    Returns:
    
    this
  - setMargin
```
public UI2dComponent setMargin(float topMargin,
                               float rightMargin,
                               float bottomMargin,
                               float leftMargin)
```
    Sets the margins around this object when inside of a UI2dContainer with layout
    
    Parameters:
    
    topMargin - Top margin
    
    rightMargin - Right margin
    
    bottomMargin - Bottom margin
    
    leftMargin - Left margin
    
    Returns:
    
    this
  - onResize
```
protected void onResize()
```
    Subclasses may override this method, invoked when the component is resized
  - hasBackground
```
public boolean hasBackground()
```
    Whether this object has a background
    
    Returns:
    
    true or false
  - getBackgroundColor
```
public int getBackgroundColor()
```
    The background color, if there is a background
    
    Returns:
    
    color
  - setBackground
```
public UI2dComponent setBackground(boolean hasBackground)
```
    Sets whether the object has a background
    
    Parameters:
    
    hasBackground - true or false
    
    Returns:
    
    this
  - setBackgroundColor
```
public UI2dComponent setBackgroundColor(int backgroundColor)
```
    Sets a background color
    
    Parameters:
    
    backgroundColor - color
    
    Returns:
    
    this
  - setFocusBackground
```
public UI2dComponent setFocusBackground(boolean focusBackground)
```
    Sets whether a focus background color is used
    
    Parameters:
    
    focusBackground - Focus background color
    
    Returns:
    
    this
  - setFocusBackgroundColor
```
public UI2dComponent setFocusBackgroundColor(int focusBackgroundColor)
```
    Sets a background color to be used when the component is focused
    
    Parameters:
    
    focusBackgroundColor - Color
    
    Returns:
    
    this
  - hasBorder
```
public boolean hasBorder()
```
    Whether this object has a border
    
    Returns:
    
    true or false
  - getBorderColor
```
public int getBorderColor()
```
    Current border color
    
    Returns:
    
    color
  - getBorderWeight
```
public int getBorderWeight()
```
    The weight of the border
    
    Returns:
    
    weight
  - setBorder
```
public UI2dComponent setBorder(boolean hasBorder)
```
    Sets whether there is a border
    
    Parameters:
    
    hasBorder - true or false
    
    Returns:
    
    this
  - setBorderColor
```
public UI2dComponent setBorderColor(int borderColor)
```
    Sets the color of the border
    
    Parameters:
    
    borderColor - color
    
    Returns:
    
    this
  - setBorderWeight
```
public UI2dComponent setBorderWeight(int borderWeight)
```
    Sets the weight of the border
    
    Parameters:
    
    borderWeight - weight
    
    Returns:
    
    this
  - setBorderRounding
```
public UI2dComponent setBorderRounding(int borderRounding)
```
  - getBorderRounding
```
public int getBorderRounding()
```
  - setFocusCorners
```
public UI2dComponent setFocusCorners(boolean focusCorners)
```
  - setFocusColor
```
public UI2dComponent setFocusColor(int focusColor)
```
  - hasFont
```
public boolean hasFont()
```
    Whether a font is set on this object
    
    Returns:
    
    true or false
  - getFont
```
public PFont getFont()
```
    Get default font, may be null
    
    Returns:
    
    The default font, or null
  - setFont
```
public UI2dComponent setFont(PFont font)
```
    Sets the default font for this object to use, null indicates component may use its own default behavior.
    
    Parameters:
    
    font - Font
    
    Returns:
    
    this
  - hasFontColor
```
public boolean hasFontColor()
```
    Whether this object has a specific color
    
    Returns:
    
    true or false
  - getFontColor
```
public int getFontColor()
```
    The font color, if there is a color specified
    
    Returns:
    
    color
  - setFontColor
```
public UI2dComponent setFontColor(boolean hasFontColor)
```
    Sets whether the object has a font color
    
    Parameters:
    
    hasFontColor - true or false
    
    Returns:
    
    this
  - setFontColor
```
public UI2dComponent setFontColor(int fontColor)
```
    Sets a font color
    
    Parameters:
    
    fontColor - color
    
    Returns:
    
    this
  - setTextAlignment
```
public UI2dComponent setTextAlignment(int horizontalAlignment)
```
    Sets the text alignment
    
    Parameters:
    
    horizontalAlignment - From PConstants LEFT/RIGHT/CENTER
    
    Returns:
    
    this
  - setTextOffset
```
public UI2dComponent setTextOffset(float textOffsetX,
                                   float textOffsetY)
```
    Sets an offset for text rendering position relative to alignment. Note that adherence to this offset is not strictly enforced by all subclasses, it is up to them to implement it.
    
    Parameters:
    
    textOffsetX - Text position x offset
    
    textOffsetY - Text position y offset
    
    Returns:
    
    this
  - setTextAlignment
```
public UI2dComponent setTextAlignment(int horizontalAlignment,
                                      int verticalAlignment)
```
    Sets the text alignment of this component
    
    Parameters:
    
    horizontalAlignment - From PConstants LEFT/RIGHT/CENTER
    
    verticalAlignment - From PConstants TOP/BOTTOM/BASELINE/CENTER
    
    Returns:
    
    this
  - clipTextToWidth
```
public static String clipTextToWidth(PGraphics pg,
                                     String str,
                                     float width)
```
    Clip a text to fit in the given width
    
    Parameters:
    
    pg - PGraphics
    
    str - String
    
    width - Width to fit in
    
    Returns:
    
    Clipped version of the string that will fit in the bounds
  - breakTextToWidth
```
public static String breakTextToWidth(PGraphics pg,
                                      String str,
                                      float width)
```
    Break a text into multiple lines to fit in the given width
    
    Parameters:
    
    pg - PGraphics
    
    str - String
    
    width - Width to fit it in
    
    Returns:
    
    Version of the string with linebreaks to fit in the bounds
  - setMappable
```
public UI2dComponent setMappable(boolean mappable)
```
    Sets whether this component can ever be used for mapping control
    
    Parameters:
    
    mappable - Whether this component is a mappable control
    
    Returns:
    
    this
  - isMappable
```
protected boolean isMappable()
```
    Determines whether component is permitted to be a mappable control
    
    Returns:
    
    Whether this component is a mappable control
  - removeFromContainer
```
public UI2dComponent removeFromContainer()
```
    Removes this components from the container is is held by
    
    Returns:
    
    this
  - getParent
```
public UIObject getParent()
```
    Get the parent object that this is in
    
    Overrides:
    
    getParent in class UIObject
    
    Returns:
    
    Parent of this component
  - getPrevSibling
```
public UI2dComponent getPrevSibling()
```
    Returns the adjacent object in the hierarchy
    
    Returns:
    
    The previous UI object in the hierarchy adjacent to this one
  - getNextSibling
```
public UI2dComponent getNextSibling()
```
    Returns the adjacent object in the hierarchy
    
    Returns:
    
    The next UI object in the hierarchy adjacent to this one
  - getContainer
```
public UI2dContainer getContainer()
```
    Returns the 2d container that this is in
    
    Returns:
    
    Container of this component, or null if not in a 2d container
  - addToContainer
```
public final UI2dComponent addToContainer(UIContainer container)
```
    Adds this component to a container, also removing it from any other container that is currently holding it.
    
    Parameters:
    
    container - Container to place in
    
    Returns:
    
    this
  - addToContainer
```
public UI2dComponent addToContainer(UIContainer container,
                                    int index)
```
    Adds this component to a container at a specified index, also removing it from any other container that is currently holding it.
    
    Parameters:
    
    container - Container to place in
    
    index - At which index to place this object in parent container
    
    Returns:
    
    this
  - setContainerIndex
```
public UI2dComponent setContainerIndex(int index)
```
    Sets the index of this object in its container.
    
    Parameters:
    
    index - Desired index
    
    Returns:
    
    this
  - redraw
```
public final UI2dComponent redraw()
```
    Redraws this object.
    
    Returns:
    
    this object
  - drawBackground
```
protected void drawBackground(UI ui,
                              PGraphics pg)
```
  - drawBorder
```
protected void drawBorder(UI ui,
                          PGraphics pg)
```
  - getFocusColor
```
protected int getFocusColor(UI ui)
```
  - getFocusSize
```
protected int getFocusSize()
```
    Focus size for hashes drawn on the outline of the object. May be overridden.
    
    Returns:
    
    Focus hash line size
  - drawFocus
```
protected void drawFocus(UI ui,
                         PGraphics pg)
```
    Draws focus on this object. May be overridden by subclasses to provide custom focus-drawing behavior.
    
    Parameters:
    
    ui - UI
    
    pg - PGraphics
  - drawFocusCorners
```
protected void drawFocusCorners(UI ui,
                                PGraphics pg,
                                int color)
```
  - drawFocusCorners
```
public static void drawFocusCorners(UI ui,
                                    PGraphics pg,
                                    int color,
                                    float x,
                                    float y,
                                    float width,
                                    float height,
                                    int focusSize)
```

Class UI2dComponent

Field Summary

Fields inherited from class heronarts.p3lx.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class heronarts.p3lx.ui.UIObject

Methods inherited from class heronarts.p3lx.ui.UIEventHandler

Methods inherited from class java.lang.Object

Field Detail

x

y

width

height

topMargin

rightMargin

bottomMargin

leftMargin

textAlignHorizontal

textAlignVertical

textOffsetX

textOffsetY

Constructor Detail

UI2dComponent

UI2dComponent

Method Detail

setDescription

getX

getY

getWidth

getHeight

contains

setVisible

setX

setY

setPosition

setPosition

setPosition

setPosition

setHeight

setWidth

setSize

setMargin

setMargin

setTopMargin

setBottomMargin

setLeftMargin

setRightMargin

setMargin

onResize

hasBackground

getBackgroundColor

setBackground

setBackgroundColor

setFocusBackground

setFocusBackgroundColor

hasBorder

getBorderColor

getBorderWeight

setBorder

setBorderColor

setBorderWeight

setBorderRounding

getBorderRounding

setFocusCorners

setFocusColor

hasFont

getFont

setFont

hasFontColor

getFontColor

setFontColor

setFontColor

setTextAlignment

setTextOffset

setTextAlignment

clipTextToWidth

breakTextToWidth

setMappable

isMappable

removeFromContainer