heronarts.p3lx.ui.component

Class UILabel

java.lang.Object

heronarts.p3lx.ui.UIEventHandler

heronarts.p3lx.ui.UIObject

heronarts.p3lx.ui.UI2dComponent

heronarts.p3lx.ui.component.UILabel

All Implemented Interfaces:

LXLoopTask

Direct Known Subclasses:

UIComponentLabel, UIParameterLabel

public class UILabel
extends UI2dComponent

A simple text label object. Draws a string aligned top-left to its x-y position.

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_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
UILabel()
UILabel(float x, float y, float w, float h)
UILabel(float x, float y, float w, float h, String label)
UILabel(float x, float y, float w, String label)
UILabel(float w, float h, String label)
UILabel(float w, String label)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Objects are encouraged to override this method providing a helpful String displayed to the user explaining the function of this UI component.
protected void	onDraw(UI ui, PGraphics pg) Subclasses should override this method to perform their drawing functions.
UILabel	setBreakLines(boolean breakLines) Sets the label to render text multi-line
UILabel	setBreakLines(boolean breakLines, boolean autoHeight) Sets the label to render text multi-line
UILabel	setLabel(String label)
UILabel	setPadding(int padding) Sets padding on all 4 sides
UILabel	setPadding(int topBottom, int leftRight) Sets padding on top and sides, CSS style
UILabel	setPadding(int topPadding, int rightPadding, int bottomPadding, int leftPadding) Sets padding on all 4 sides

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, getFocusedChild, getLX, getUI, hasDirectFocus, hasFocus, isVisible, keyEventConsumed, loop, mousePressConsumed, onBlur, 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

DEFAULT_HEIGHT

public static final float DEFAULT_HEIGHT

See Also:

Constant Field Values

Constructor Detail

UILabel

public UILabel()

UILabel

public UILabel(float w,
               String label)

UILabel

public UILabel(float w,
               float h,
               String label)

UILabel

public UILabel(float x,
               float y,
               float w,
               String label)

UILabel

public UILabel(float x,
               float y,
               float w,
               float h)

UILabel

public UILabel(float x,
               float y,
               float w,
               float h,
               String label)

Method Detail

setBreakLines

public UILabel setBreakLines(boolean breakLines)

Sets the label to render text multi-line

Parameters:

breakLines - Whether to break lines

Returns:

this

setBreakLines

public UILabel setBreakLines(boolean breakLines,
                             boolean autoHeight)

Sets the label to render text multi-line

Parameters:

breakLines - Whether to break lines

autoHeight - Whether to resize automatically based upon line height

Returns:

this

setPadding

public UILabel setPadding(int padding)

Sets padding on all 4 sides

Parameters:

padding - Padding

Returns:

this

setPadding

public UILabel setPadding(int topBottom,
                          int leftRight)

Sets padding on top and sides, CSS style

Parameters:

topBottom - Top bottom padding

leftRight - Left right padding

Returns:

this

setPadding

public UILabel setPadding(int topPadding,
                          int rightPadding,
                          int bottomPadding,
                          int leftPadding)

Sets padding on all 4 sides

Parameters:

topPadding - Top padding

rightPadding - Right padding

bottomPadding - Bottom padding

leftPadding - Left padding

Returns:

this

onDraw

protected 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

setLabel

public UILabel setLabel(String label)

getDescription

public String getDescription()

Description copied from class: UIObject

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.

Overrides:

getDescription in class UIObject

Returns:

Helpful contextual string explaining function of this element