SmartLabel (easel 0.0.2 API)

java.lang.Object
- easel.ui.AbstractWidget<SmartLabel>
- - easel.ui.text.SmartLabel

public class SmartLabel
extends AbstractWidget<SmartLabel>

A more flexible version of Label which allows for automatic text wrapping, inline colors for specific pieces of text, and convenient builder methods to make producing larger paragraphs of text a bit more convenient. Like other widgets, this SmartLabel requires anchoring before being rendered, and this anchoring should occur AFTER setting all text.

Example use:

 
 new SmartLabel(EaselFonts.MEDIUM_ITALIC, 300, 10)
   .withTextColor(Color.GREEN)
   .withText(Color.GRAY, "Hello, world")
   .withNewlines(2)
   .withText(EaselColors::rainbow, "Dynamic rainbow text!")
   .withNewlines(1)
   .withText("The rest of the text is in green and will automatically wrap once a line passes 300px in width")
   .anchoredCenteredOnScreen();

Field Summary
- Fields inherited from class easel.ui.AbstractWidget
  hasInteractivity, hb, isHovered, leftClickStarted, onLeftClick, onMouseEnter, onMouseLeave, onRightClick, rightClickStarted

Constructor Summary

Constructors
Constructor and Description
`SmartLabel()` Convenience constructor for `SmartLabel(BitmapFont, float, float)` with the base game's `FontHelper.tipBodyFont` and no automatic line wrapping.
`SmartLabel(com.badlogic.gdx.graphics.g2d.BitmapFont font)` Convenience constructor for `SmartLabel(BitmapFont, float, float)` with no automatic line wrapping.
`SmartLabel(com.badlogic.gdx.graphics.g2d.BitmapFont font, float lineWidth)` Convenience constructor for `SmartLabel(BitmapFont, float, float)` with a `lineSpacing = 10`.
`SmartLabel(com.badlogic.gdx.graphics.g2d.BitmapFont font, float lineWidth, float lineSpacing)` The primary constructor for a smart label.
`SmartLabel(float lineWidth)` Convenience constructor for `SmartLabel(BitmapFont, float, float)` with the base game's `FontHelper.tipBodyFont` and `lineSpacing = 10`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getContentHeight()` The internal content height of the widget (excludes margins).
`float`	`getContentWidth()` The internal content width of the widget (excludes margins).
`protected void`	`renderWidget(com.badlogic.gdx.graphics.g2d.SpriteBatch sb)` Custom widgets should implement this method for rendering.
`SmartLabel`	`withNewlines(int count)` Adds a certain number of newlines to the ongoing text block.
`SmartLabel`	`withText(com.badlogic.gdx.graphics.Color textColor, java.lang.String text)` Appends the given text to the end of the label, with a specific (temporary) color.
`SmartLabel`	`withText(java.lang.String text)` Appends the given text to the end of the label.
`SmartLabel`	`withText(java.util.function.Supplier<com.badlogic.gdx.graphics.Color> colorSupplier, java.lang.String text)` Appends the given text to the end of the label, with a specific (temporary) color.
`SmartLabel`	`withTextColor(com.badlogic.gdx.graphics.Color color)` Sets the color of all future text appended via `withText(String)`.
`SmartLabel`	`withTextColor(java.util.function.Supplier<com.badlogic.gdx.graphics.Color> colorSupplier)` Sets the color of all future text appended via `withText(String)` with a dynamic supplier.

Methods inherited from class easel.ui.AbstractWidget
anchoredAt, anchoredAt, anchoredAtClamped, anchoredAtClamped, anchoredCenteredOnMouse, anchoredCenteredOnMouse, anchoredCenteredOnMouseClamped, anchoredCenteredOnMouseClamped, anchoredCenteredOnScreen, anchoredCenteredOnScreen, cancelMovementQueue, cancelMovementQueueForAllChildren, delayedTranslate, getBottom, getContentBottom, getContentCenterX, getContentCenterY, getContentLeft, getContentRight, getContentTop, getHeight, getLeft, getRight, getTop, getWidth, hide, initializeInteractivity, isMouseInBounds, isMouseInContentBounds, leftMouseClick, mouseEnter, mouseLeave, onLeftClick, onMouseEnter, onMouseLeave, onRightClick, refreshAnchor, render, renderTopLevel, resolveMovementQueue, rightMouseClick, scaleHitboxToContent, setAllDelayedMovement, setChildrenDelayedMovement, show, toString, translate, update, updateInteractivity, updateWidget, withMargins, withMargins, withMargins

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

- Constructor Detail
  - SmartLabel
```
public SmartLabel()
```
    Convenience constructor for SmartLabel(BitmapFont, float, float) with the base game's FontHelper.tipBodyFont and no automatic line wrapping.
  - SmartLabel
```
public SmartLabel(float lineWidth)
```
    Convenience constructor for SmartLabel(BitmapFont, float, float) with the base game's FontHelper.tipBodyFont and lineSpacing = 10.
    
    Parameters:
    
    lineWidth - the width before the line breaks automatically
  - SmartLabel
```
public SmartLabel(com.badlogic.gdx.graphics.g2d.BitmapFont font)
```
    Convenience constructor for SmartLabel(BitmapFont, float, float) with no automatic line wrapping.
    
    Parameters:
    
    font - the font of all text on this label
  - SmartLabel
```
public SmartLabel(com.badlogic.gdx.graphics.g2d.BitmapFont font,
                  float lineWidth)
```
    Convenience constructor for SmartLabel(BitmapFont, float, float) with a lineSpacing = 10.
    
    Parameters:
    
    font - the font of all text on this label
    
    lineWidth - the width before the line breaks automatically
  - SmartLabel
```
public SmartLabel(com.badlogic.gdx.graphics.g2d.BitmapFont font,
                  float lineWidth,
                  float lineSpacing)
```
    The primary constructor for a smart label. The entire label will use the given font and will wrap text once a line would exceed the given line width. The line spacing is the gap added between lines and is independent of the height of the actual font (this behavior differs from the way the base game's FontHelper handles it, where the line spacing IS dependent on the font height). Setting the lineWidth to something large, e.g. 10000000, will result in no text wrapping except for manually added newlines using withNewlines(int) (although if text wrapping isn't desired, you may find yourself content with a simple Label instead, as it can be slightly more efficient to construct).
    
    Parameters:
    
    font - the font of all text on this label
    
    lineWidth - the width before the line breaks automatically
    
    lineSpacing - the vertical spacing between each line, i.e. the space between the bottom of a line and the top of the line directly beneath it
- Method Detail
  - withText
```
public SmartLabel withText(java.lang.String text)
```
    Appends the given text to the end of the label. The color of this text will be the one last set by withTextColor(Color). If that function has not been used, it will fallback to the base game's Settings.CREAM_COLOR pale white color. The given text string will be split by words (words are determined by calling text.split(" ") to split on spaces, skipping over empty strings), and then added onto the block at the end of the current line until a new line needs to be formed. A new line is automatically formed whenever adding a word will cause the current line's width to exceed the lineWidth set by the constructor.
    
    Parameters:
    
    text - the text to append
    
    Returns:
    
    this widget
  - withText
```
public SmartLabel withText(com.badlogic.gdx.graphics.Color textColor,
                           java.lang.String text)
```
    Appends the given text to the end of the label, with a specific (temporary) color. After adding all the text, the temporary color will revert back to the one set by the last call of withTextColor(Color), or the base game's Settings.CREAM_COLOR pale white color, if that function has not been used. The given text string will be split by words (words are determined by calling text.split(" ") to split on spaces, skipping over empty strings), and then added onto the block at the end of the current line until a new line needs to be formed. A new line is automatically formed whenever adding a word will cause the current line's width to exceed the lineWidth set by the constructor.
    
    Parameters:
    
    textColor - the color for this block of text
    
    text - the text to append
    
    Returns:
    
    this widget
  - withText
```
public SmartLabel withText(java.util.function.Supplier<com.badlogic.gdx.graphics.Color> colorSupplier,
                           java.lang.String text)
```
    Appends the given text to the end of the label, with a specific (temporary) color. This variant uses a supplier so that you can have dynamically updated colors by including a reference to a function handle. After adding all the text, the temporary color will revert back to the one set by the last call of withTextColor(Color), or the base game's Settings.CREAM_COLOR pale white color, if that function has not been used. The given text string will be split by words (words are determined by calling text.split(" ") to split on spaces, skipping over empty strings), and then added onto the block at the end of the current line until a new line needs to be formed. A new line is automatically formed whenever adding a word will cause the current line's width to exceed the lineWidth set by the constructor.
    
    Parameters:
    
    colorSupplier - the color for this block of text
    
    text - the text to append
    
    Returns:
    
    this widget
  - withTextColor
```
public SmartLabel withTextColor(com.badlogic.gdx.graphics.Color color)
```
    Sets the color of all future text appended via withText(String). If this function has not been used or if text was added prior to setting the color, the previously added text will fallback to the base game's Settings.CREAM_COLOR pale white color. If using one of the overloads that specifies a specific color, e.g. withText(Color, String), then this color is temporarily ignored for that block of text, before reverting back to this color after it finishes that block.
    
    Parameters:
    
    color - the color for all future appended text
    
    Returns:
    
    this widget
  - withTextColor
```
public SmartLabel withTextColor(java.util.function.Supplier<com.badlogic.gdx.graphics.Color> colorSupplier)
```
    Sets the color of all future text appended via withText(String) with a dynamic supplier. If this function has not been used or if text was added prior to setting the color, the previously added text will fallback to the base game's Settings.CREAM_COLOR pale white color. If using one of the overloads that specifies a specific color, e.g. withText(Color, String), then this color is temporarily ignored for that block of text, before reverting back to this color after it finishes that block.
    
    Parameters:
    
    colorSupplier - the color for all future appended text
    
    Returns:
    
    this widget
  - withNewlines
```
public SmartLabel withNewlines(int count)
```
    Adds a certain number of newlines to the ongoing text block. This won't do anything visible until the next withText(String) is called. Calling this function with a count = 1 means the next block of text appended will have its first word at the start of its own line, while a count = 2 leaves an empty line in between any previously added text and the next. Undefined behavior if count is less than or equal to zero. This function is intended to be used between two distinct calls of the withText(String) family of methods.
    
    Parameters:
    
    count - the number of new lines to add before the next text block is appended
    
    Returns:
    
    this widget
  - getContentWidth
```
public float getContentWidth()
```
    Description copied from class: AbstractWidget
    
    The internal content width of the widget (excludes margins). Safe to use before anchoring (values should be accurate after constructor).
    
    Specified by:
    
    getContentWidth in class AbstractWidget<SmartLabel>
    
    Returns:
    
    the width of this widget (excluding margins)
    
    See Also:
    
    AbstractWidget.getWidth(), AbstractWidget.getContentHeight()
  - getContentHeight
```
public float getContentHeight()
```
    Description copied from class: AbstractWidget
    
    The internal content height of the widget (excludes margins). Safe to use before anchoring (values should be accurate after constructor).
    
    Specified by:
    
    getContentHeight in class AbstractWidget<SmartLabel>
    
    Returns:
    
    the height of this widget (excluding margins)
    
    See Also:
    
    AbstractWidget.getHeight(), AbstractWidget.getContentWidth()
  - renderWidget
```
protected void renderWidget(com.badlogic.gdx.graphics.g2d.SpriteBatch sb)
```
    Description copied from class: AbstractWidget
    
    Custom widgets should implement this method for rendering. Use the inner content positions (e.g. AbstractWidget.getContentLeft(), AbstractWidget.getContentWidth(), etc.) to determine any position information necessary for rendering at a specific location. If the library is used as intended, these content locations should be accurate to where the widget needs to be rendered, as they reflect the most up to date location set by an anchoredAt call (this automatically will be interpolated if the anchorAt move is set to occur over several frames).
    
    Note: you NEED to revert any changes you make to the SpriteBatch (e.g. setting a shader, changing the perspective matrix, etc.) by the time this function returns, as the SpriteBatch will be reused for rendering other widgets which will not expect those changes. You also don't technically need to render to this particular SpriteBatch (e.g. you can render to your own batch if you know what you're doing), as long as you follow the general intent of this function to render the widget.
    
    Specified by:
    
    renderWidget in class AbstractWidget<SmartLabel>
    
    Parameters:
    
    sb - the SpriteBatch the widget should be rendered on
    
    See Also:
    
    AbstractWidget.renderTopLevel(SpriteBatch)

Class SmartLabel

Field Summary

Fields inherited from class easel.ui.AbstractWidget

Constructor Summary

Method Summary

Methods inherited from class easel.ui.AbstractWidget

Methods inherited from class java.lang.Object

Constructor Detail

SmartLabel

SmartLabel

SmartLabel

SmartLabel

SmartLabel

Method Detail

withText

withText

withText

withTextColor

withTextColor

withNewlines

getContentWidth

getContentHeight

renderWidget