java.lang.Object
java.lang.Enum<SGR>
com.googlecode.lanterna.SGR
All Implemented Interfaces:
Serializable, Comparable<SGR>, java.lang.constant.Constable

public enum SGR extends Enum<SGR>
SGR - Select Graphic Rendition, changes the state of the terminal as to what kind of text to print after this command. When working with the Terminal interface, its keeping a state of which SGR codes are active, so activating one of these codes will make it apply to all text until you explicitly deactivate it. When you work with Screen and GUI systems, usually the SGR is a property of an independent character and won't affect others.
  • 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
    Text will blink on the screen by alternating the foreground color between the real foreground color and the background color.
    Bold text mode.
    Draws a border around the text.
    Draws a circle around the text.
    Draws a horizontal line through the text.
    I have no idea, exotic extension, please send me a reference screen shots!
    Italic (cursive) text mode.
    Reverse text mode, will flip the foreground and background colors while active
    Draws a horizontal line under the text.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    SGR()
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static SGR
    Returns the enum constant of this type with the specified name.
    static SGR[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • BOLD

      public static final SGR BOLD
      Bold text mode. Please note that on some terminal implementations, instead of (or in addition to) making the text bold, it will draw the text in a slightly different color
    • REVERSE

      public static final SGR REVERSE
      Reverse text mode, will flip the foreground and background colors while active
    • UNDERLINE

      public static final SGR UNDERLINE
      Draws a horizontal line under the text. Not widely supported.
    • BORDERED

      public static final SGR BORDERED
      Draws a border around the text. Rarely supported.
    • FRAKTUR

      public static final SGR FRAKTUR
      I have no idea, exotic extension, please send me a reference screen shots!
    • CROSSED_OUT

      public static final SGR CROSSED_OUT
      Draws a horizontal line through the text. Rarely supported.
    • CIRCLED

      public static final SGR CIRCLED
      Draws a circle around the text. Rarely supported.
    • ITALIC

      public static final SGR ITALIC
      Italic (cursive) text mode. Some Terminal seem to support it.
  • Constructor Details

    • SGR

      private SGR()
  • Method Details

    • values

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

      public static SGR valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null