Package com.github.tommyettinger.textra

Enum Class Justify

java.lang.Object
java.lang.Enum<Justify>
com.github.tommyettinger.textra.Justify
All Implemented Interfaces:
Serializable, Comparable<Justify>, Constable
public enum Justify extends Enum<Justify>
Determines line justification behavior in a Layout. Besides NONE, which makes no changes, each constant applies justification to some glyphs on a typical Line.
The simplest behavior is that of FULL_ON_ALL_LINES; it adds extra space to every glyph so the text fills all the way to the right edge. FULL_ON_PARAGRAPH acts the same except on the last Line (or only Line) of a paragraph; it will not justify the last line at all.
The other constants cause Lines to justify only spaces. SPACES_ON_ALL_LINES and SPACES_ON_PARAGRAPH only increase the width of the ASCII space character ' ', or decimal 32, hex 0020, and so on. "ALL_LINES" affects all Lines, while "PARAGRAPH" doesn't affect the last (or only) Line.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    FULL_ON_ALL_LINES
    Adds extra x-advance to every glyph so the text fills all the way to the right edge.
    FULL_ON_PARAGRAPH
    Adds extra space to every glyph so the text fills all the way to the right edge, except for the last Line (or only Line) of a paragraph.
    NONE
    No justification will be applied; the x-advances of glyphs will not be changed.
    SPACES_ON_ALL_LINES
    Adds extra x-advance to every space (the char ' ') so the text fills all the way to the right edge.
    SPACES_ON_PARAGRAPH
    Adds extra x-advance to every space (the char ' ') so the text fills all the way to the right edge, except for the last Line (or only Line) of a paragraph.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final boolean
    affectAllGlyphs
     
    final boolean
    affectSpaces
     
    final boolean
    ignoreLastLine
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Justify
    fromGdx(com.badlogic.gdx.utils.Justify gdx)
    Attempts to convert between a libGDX Justify enum and a TextraTypist Justify enum.
    static com.badlogic.gdx.utils.Justify
    toGdx(Justify textra)
    Converts between a TextraTypist Justify enum and a libGDX Justify enum.
    static Justify
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Justify[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final Justify NONE
      No justification will be applied; the x-advances of glyphs will not be changed.

    • SPACES_ON_ALL_LINES

      public static final Justify SPACES_ON_ALL_LINES
      Adds extra x-advance to every space (the char ' ') so the text fills all the way to the right edge.

    • FULL_ON_ALL_LINES

      public static final Justify FULL_ON_ALL_LINES
      Adds extra x-advance to every glyph so the text fills all the way to the right edge.

    • SPACES_ON_PARAGRAPH

      public static final Justify SPACES_ON_PARAGRAPH
      Adds extra x-advance to every space (the char ' ') so the text fills all the way to the right edge, except for the last Line (or only Line) of a paragraph.

    • FULL_ON_PARAGRAPH

      public static final Justify FULL_ON_PARAGRAPH
      Adds extra space to every glyph so the text fills all the way to the right edge, except for the last Line (or only Line) of a paragraph.

  • Field Details

    • ignoreLastLine

      public final boolean ignoreLastLine

    • affectSpaces

      public final boolean affectSpaces

    • affectAllGlyphs

      public final boolean affectAllGlyphs

  • Method Details

    • values

      public static Justify[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Justify valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromGdx

      public static Justify fromGdx(com.badlogic.gdx.utils.Justify gdx)
      Attempts to convert between a libGDX Justify enum and a TextraTypist Justify enum. Currently, TextraTypist doesn't distinguish wrapped lines from unwrapped ones, though it could in the future. The libGDX constants Justify.WrappedLinesBySpace is matched to SPACES_ON_PARAGRAPH here, and Justify.WrappedLinesByGlyph is matched to FULL_ON_PARAGRAPH.
      Parameters:
      gdx - a Justify enum from recent libGDX versions
      Returns:
      the closest TextraTypist Justify enum there is to the given libGDX Justify enum

    • toGdx

      public static com.badlogic.gdx.utils.Justify toGdx(Justify textra)
      Converts between a TextraTypist Justify enum and a libGDX Justify enum. This matches the five possible enum constants here to direct analogs in libGDX, and cannot return Justify.WrappedLinesByGlyph or Justify.WrappedLinesBySpace.
      Parameters:
      textra - a Justify enum from TextraTypist
      Returns:
      the closest Justify enum from libGDX to the given TextraTypist Justify enum