Package com.github.tommyettinger.textra

Class Layout

java.lang.Object
com.github.tommyettinger.textra.Layout
All Implemented Interfaces:
com.badlogic.gdx.utils.Pool.Poolable
public class Layout extends Object implements com.badlogic.gdx.utils.Pool.Poolable
A replacement for libGDX's GlyphLayout, more or less; stores one or more (possibly empty) Lines of text, which can use color and style markup from Font, and can be drawn with Font.drawGlyphs(Batch, Layout, float, float, int). This is a Poolable class, and you can obtain a Layout with Pools.obtain(Layout.class) followed by setting the font, or just using a constructor.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    atLimit
     
    protected float
    baseColor
     
    protected String
    ellipsis
     
    protected Font
    font
     
    protected com.badlogic.gdx.utils.Array<Line>
    lines
     
    protected int
    maxLines
     
    protected float
    targetWidth
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Layout()
     
    Layout​(Font font)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Layout
    add​(long glyph)
    Adds a long glyph as processed by Font to store color and style info with the char.
    StringBuilder
    appendInto​(StringBuilder sb)
    Primarily used by toString(), but can be useful if you want to append many Layouts into a StringBuilder.
    Layout
    clear()
     
    Layout
    font​(Font font)
    One of the ways to set the font on a Layout; this one returns this Layout for chaining.
    float
    getBaseColor()
    Gets the base color of the Layout, as the float bits of a Color.
    String
    getEllipsis()
    Gets the ellipsis, which may be null, or may be a String that can be placed at the end of the text if its max lines are exceeded.
    Font
    getFont()
     
    float
    getHeight()
     
    Line
    getLine​(int i)
    Gets a Line from this by its index.
    int
    getMaxLines()
    The maximum number of Lines this Layout can contain.
    float
    getTargetWidth()
     
    float
    getWidth()
     
    Line
    insertLine​(int index)
     
    int
    lines()
     
    Line
    peekLine()
     
    Line
    pushLine()
     
    void
    reset()
    Resets the object for reuse.
    void
    setBaseColor​(float baseColor)
    Sets the base color of the Layout; this is what font color will be used immediately after resetting formatting with [], as well as the initial color used by text that hasn't been formatted.
    void
    setBaseColor​(com.badlogic.gdx.graphics.Color baseColor)
    Sets the base color of the Layout; this is what font color will be used immediately after resetting formatting with [], as well as the initial color used by text that hasn't been formatted.
    void
    setEllipsis​(String ellipsis)
    Sets the ellipsis text, which replaces the last few glyphs if non-null and the text added would exceed the getMaxLines() of this Layout.
    void
    setFont​(Font font)
    One of the ways to set the font on a Layout; this is a traditional setter.
    void
    setMaxLines​(int maxLines)
    Sets the maximum number of Lines this Layout can contain; this is always at least 1.
    Layout
    setTargetWidth​(float targetWidth)
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • font

      protected Font font

    • lines

      protected final com.badlogic.gdx.utils.Array<Line> lines

    • maxLines

      protected int maxLines

    • atLimit

      protected boolean atLimit

    • ellipsis

      protected String ellipsis

    • targetWidth

      protected float targetWidth

    • baseColor

      protected float baseColor

  • Constructor Details

    • Layout

      public Layout()

    • Layout

      public Layout​(Font font)

  • Method Details

    • font

      public Layout font​(Font font)
      One of the ways to set the font on a Layout; this one returns this Layout for chaining.
      Parameters:
      font - the font to use
      Returns:
      this Layout, for chaining

    • getFont

      public Font getFont()

    • setFont

      public void setFont​(Font font)
      One of the ways to set the font on a Layout; this is a traditional setter.
      Parameters:
      font - the font to use

    • add

      public Layout add​(long glyph)
      Adds a long glyph as processed by Font to store color and style info with the char.
      Parameters:
      glyph - usually produced by Font to store color and style info with the char
      Returns:
      this Layout, for chaining

    • clear

      public Layout clear()

    • getWidth

      public float getWidth()

    • getHeight

      public float getHeight()

    • lines

      public int lines()

    • getLine

      public Line getLine​(int i)
      Gets a Line from this by its index.
      Parameters:
      i - index for the Line to fetch; must be at least 0 and less than lines().
      Returns:
      the Line at the given index

    • peekLine

      public Line peekLine()

    • pushLine

      public Line pushLine()

    • insertLine

      public Line insertLine​(int index)

    • getTargetWidth

      public float getTargetWidth()

    • setTargetWidth

      public Layout setTargetWidth​(float targetWidth)

    • getBaseColor

      public float getBaseColor()
      Gets the base color of the Layout, as the float bits of a Color. The base color is what font color will be used immediately after resetting formatting with [], as well as the initial color used by text that hasn't been formatted. You can fill a Color object with this value using Color.abgr8888ToColor(Color, float) (it modifies the Color you give it).
      Returns:
      the base color of the Layout, as float bits

    • setBaseColor

      public void setBaseColor​(float baseColor)
      Sets the base color of the Layout; this is what font color will be used immediately after resetting formatting with [], as well as the initial color used by text that hasn't been formatted. This takes the color as a primitive float, which you can get from a Color object with Color.toFloatBits(), or in some cases from existing data produced by Font.
      Parameters:
      baseColor - the float bits of a Color, as obtainable via Color.toFloatBits()

    • setBaseColor

      public void setBaseColor​(com.badlogic.gdx.graphics.Color baseColor)
      Sets the base color of the Layout; this is what font color will be used immediately after resetting formatting with [], as well as the initial color used by text that hasn't been formatted. If the given Color is null, this treats it as white.
      Parameters:
      baseColor - a Color to use for text that hasn't been formatted; if null, will be treated as white

    • getMaxLines

      public int getMaxLines()
      The maximum number of Lines this Layout can contain.
      Returns:
      the maximum number of Line objects this Layout can contain

    • setMaxLines

      public void setMaxLines​(int maxLines)
      Sets the maximum number of Lines this Layout can contain; this is always at least 1.
      Parameters:
      maxLines - the limit for how many Line objects this Layout can contain; always 1 or more

    • getEllipsis

      public String getEllipsis()
      Gets the ellipsis, which may be null, or may be a String that can be placed at the end of the text if its max lines are exceeded.
      Returns:
      an ellipsis String or null

    • setEllipsis

      public void setEllipsis​(String ellipsis)
      Sets the ellipsis text, which replaces the last few glyphs if non-null and the text added would exceed the getMaxLines() of this Layout. For the ellipsis to appear, this has to be called with a non-null String (often "...", or "…" if the font supports it), and setMaxLines(int) needs to have been called with a small enough number, such as 1.
      Parameters:
      ellipsis - a String for a Layout to end with if its max lines are exceeded, or null to avoid such truncation

    • reset

      public void reset()
      Resets the object for reuse. The font is nulled, but the lines are freed, cleared, and then one blank line is re-added to lines so it can be used normally later.
      Specified by:
      reset in interface com.badlogic.gdx.utils.Pool.Poolable

    • appendInto

      public StringBuilder appendInto​(StringBuilder sb)
      Primarily used by toString(), but can be useful if you want to append many Layouts into a StringBuilder.
      Parameters:
      sb - a non-null StringBuilder from the JDK
      Returns:
      sb, for chaining

    • toString

      public String toString()
      Overrides:
      toString in class Object