Package de.linusdev.lutils.ansi.sgr

Enum Class SGRParameters

java.lang.Object
java.lang.Enum<SGRParameters>
de.linusdev.lutils.ansi.sgr.SGRParameters
All Implemented Interfaces:
SGRParameter, Serializable, Comparable<SGRParameters>, Constable
public enum SGRParameters extends Enum<SGRParameters> implements SGRParameter
See Also:

  • Enum Constant Details

    • RESET

      public static final SGRParameters RESET
      All attributes off.

      IntelliJ Console: supported

    • BOLD

      public static final SGRParameters BOLD
      bold font.

      IntelliJ Console: not supported

    • FAINT

      public static final SGRParameters FAINT
      faint or light font.

      IntelliJ Console: not supported

    • ITALIC

      public static final SGRParameters ITALIC
      italic font. (Not widely supported)

      IntelliJ Console: supported

    • UNDERLINE

      public static final SGRParameters UNDERLINE
      Underline.

      IntelliJ Console: not tested

    • INVERT

      public static final SGRParameters INVERT
      Swap foreground and background colors.

      IntelliJ Console: not tested

    • CONCEAL

      public static final SGRParameters CONCEAL
      Not widely supported.

      IntelliJ Console: not tested

    • STRIKE

      public static final SGRParameters STRIKE
      Strike through.

      IntelliJ Console: not tested

    • PRIMARY

      public static final SGRParameters PRIMARY
      Default font.

      IntelliJ Console: not tested

    • GOTHIC

      public static final SGRParameters GOTHIC
      Gothic font.

      IntelliJ Console: not tested

    • DOUBLY_UNDERLINED

      public static final SGRParameters DOUBLY_UNDERLINED
      Doubly underlined.
      Support is exclusive with NOT_BOLD.

      IntelliJ Console: not tested

    • NOT_BOLD

      public static final SGRParameters NOT_BOLD
      Removes BOLD.
      Support is exclusive with DOUBLY_UNDERLINED.

      IntelliJ Console: not tested

    • NORMAL_FONT_WEIGHT

      public static final SGRParameters NORMAL_FONT_WEIGHT
      Removes BOLD and FAINT. May reset color.

      IntelliJ Console: not tested

    • NOT_ITALIC_OR_BLACK_LETTER

      public static final SGRParameters NOT_ITALIC_OR_BLACK_LETTER
      Removes ITALIC.

      IntelliJ Console: not tested

    • NOT_UNDERLINED

      public static final SGRParameters NOT_UNDERLINED
      Removes UNDERLINE.

      IntelliJ Console: not tested

    • NOT_BLINKING

      public static final SGRParameters NOT_BLINKING
      Removes SLOW_BLINk and RAPID_BLINK.

      IntelliJ Console: not tested

    • PROPORTIONAL_SPACING

      public static final SGRParameters PROPORTIONAL_SPACING
      Not widely supported.

      IntelliJ Console: not tested

    • NOT_REVERSED

      public static final SGRParameters NOT_REVERSED
      Not INVERT.

      IntelliJ Console: not tested

    • REVEAL

      public static final SGRParameters REVEAL
      Not CONCEAL.

      IntelliJ Console: not tested

    • NOT_STRIKE

      public static final SGRParameters NOT_STRIKE
      Not STRIKE.

      IntelliJ Console: not tested

    • FOREGROUND_BLACK

      public static final SGRParameters FOREGROUND_BLACK
      Sets foreground color to black.

      IntelliJ Console: not tested

    • FOREGROUND_RED

      public static final SGRParameters FOREGROUND_RED
      Sets foreground color to red.

      IntelliJ Console: supported

    • FOREGROUND_GREEN

      public static final SGRParameters FOREGROUND_GREEN
      Sets foreground color to green.

      IntelliJ Console: not tested

    • FOREGROUND_YELLOW

      public static final SGRParameters FOREGROUND_YELLOW
      Sets foreground color to yellow.

      IntelliJ Console: not tested

    • FOREGROUND_BLUE

      public static final SGRParameters FOREGROUND_BLUE
      Sets foreground color to blue.

      IntelliJ Console: not tested

    • FOREGROUND_MAGENTA

      public static final SGRParameters FOREGROUND_MAGENTA
      Sets foreground color to magenta.

      IntelliJ Console: not tested

    • FOREGROUND_CYAN

      public static final SGRParameters FOREGROUND_CYAN
      Sets foreground color to cyan.

      IntelliJ Console: not tested

    • FOREGROUND_WHITE

      public static final SGRParameters FOREGROUND_WHITE
      Sets foreground color to white.

      IntelliJ Console: not tested

    • FOREGROUND_COLOR_8_BIT

      public static final SGRParameters FOREGROUND_COLOR_8_BIT
      Sets foreground color to given 8-bit color. First argument must be 5, second is the 8-bit color

      IntelliJ Console: not tested

    • FOREGROUND_COLOR_24_BIT

      public static final SGRParameters FOREGROUND_COLOR_24_BIT
      Sets foreground color to given 24-bit color. First argument must be 2, second, third and fourth is red, green and blue respectively

      IntelliJ Console: not tested

    • FOREGROUND_DEFAULT_COLOR

      public static final SGRParameters FOREGROUND_DEFAULT_COLOR
      Sets foreground color to the default foreground color

      IntelliJ Console: not tested

    • BACKGROUND_BLACK

      public static final SGRParameters BACKGROUND_BLACK
      Sets background color to black.

      IntelliJ Console: not tested

    • BACKGROUND_RED

      public static final SGRParameters BACKGROUND_RED
      Sets background color to red.

      IntelliJ Console: not tested

    • BACKGROUND_GREEN

      public static final SGRParameters BACKGROUND_GREEN
      Sets background color to green.

      IntelliJ Console: not tested

    • BACKGROUND_YELLOW

      public static final SGRParameters BACKGROUND_YELLOW
      Sets background color to yellow.

      IntelliJ Console: not tested

    • BACKGROUND_BLUE

      public static final SGRParameters BACKGROUND_BLUE
      Sets background color to blue.

      IntelliJ Console: not tested

    • BACKGROUND_MAGENTA

      public static final SGRParameters BACKGROUND_MAGENTA
      Sets background color to magenta.

      IntelliJ Console: not tested

    • BACKGROUND_CYAN

      public static final SGRParameters BACKGROUND_CYAN
      Sets background color to cyan.

      IntelliJ Console: not tested

    • BACKGROUND_WHITE

      public static final SGRParameters BACKGROUND_WHITE
      Sets background color to white.

      IntelliJ Console: not tested

    • BACKGROUND_COLOR_8_BIT

      public static final SGRParameters BACKGROUND_COLOR_8_BIT
      Sets background color to given 8-bit color. First argument must be 5, second is the 8-bit color

      IntelliJ Console: not tested

    • BACKGROUND_COLOR_24_BIT

      public static final SGRParameters BACKGROUND_COLOR_24_BIT
      Sets background color to given 24-bit color. First argument must be 2, second, third and fourth is red, green and blue respectively

      IntelliJ Console: not tested

    • BACKGROUND_DEFAULT_COLOR

      public static final SGRParameters BACKGROUND_DEFAULT_COLOR
      Sets background color to the default background color

      IntelliJ Console: not tested

    • DISABLED_PROPORTIONAL_SPACING

      public static final SGRParameters DISABLED_PROPORTIONAL_SPACING
      Disables PROPORTIONAL_SPACING.

      IntelliJ Console: not tested

    • FRAMED

      public static final SGRParameters FRAMED
      Framed.

      IntelliJ Console: not tested

    • ENCIRCLED

      public static final SGRParameters ENCIRCLED
      Encircled.

      IntelliJ Console: not tested

    • OVERLINED

      public static final SGRParameters OVERLINED
      Overlined.

      IntelliJ Console: not tested

    • NEITHER_FRAMED_NOR_ENCIRCLED

      public static final SGRParameters NEITHER_FRAMED_NOR_ENCIRCLED
      Not FRAMED nor ENCIRCLED.

      IntelliJ Console: not tested

    • NOT_OVERLINED

      public static final SGRParameters NOT_OVERLINED
      Not OVERLINED.

      IntelliJ Console: not tested

    • SET_UNDERLINE_COLOR_8_BIT

      public static final SGRParameters SET_UNDERLINE_COLOR_8_BIT
      Not in standard.

      IntelliJ Console: not tested

    • SET_UNDERLINE_COLOR_24_BIT

      public static final SGRParameters SET_UNDERLINE_COLOR_24_BIT
      Not in standard.

      IntelliJ Console: not tested

    • DEFAULT_UNDERLINE_COLOR

      public static final SGRParameters DEFAULT_UNDERLINE_COLOR
      Not in standard.

      IntelliJ Console: not tested

    • IDEOGRAM_UNDERLINE

      public static final SGRParameters IDEOGRAM_UNDERLINE
      Rarely supported.

      IntelliJ Console: not tested

    • RIGHT_SIDE_LINE

      public static final SGRParameters RIGHT_SIDE_LINE
      Rarely supported.

      IntelliJ Console: not tested

    • IDEOGRAM_DOUBLE_UNDERLINE

      public static final SGRParameters IDEOGRAM_DOUBLE_UNDERLINE
      Rarely supported.

      IntelliJ Console: not tested

    • RIGHT_SIDE_DOUBLE_LINE

      public static final SGRParameters RIGHT_SIDE_DOUBLE_LINE
      Rarely supported.

      IntelliJ Console: not tested

    • IDEOGRAM_OVERLINE

      public static final SGRParameters IDEOGRAM_OVERLINE
      Rarely supported.

      IntelliJ Console: not tested

    • LEFT_SIDE_LINE

      public static final SGRParameters LEFT_SIDE_LINE
      Rarely supported.

      IntelliJ Console: not tested

    • IDEOGRAM_DOUBLE_OVERLINE

      public static final SGRParameters IDEOGRAM_DOUBLE_OVERLINE
      Rarely supported.

      IntelliJ Console: not tested

    • LEFT_SIDE_DOUBLE_LINE

      public static final SGRParameters LEFT_SIDE_DOUBLE_LINE
      Rarely supported.

      IntelliJ Console: not tested

    • IDEOGRAM_STRESS_MARKING

      public static final SGRParameters IDEOGRAM_STRESS_MARKING
      Rarely supported.

      IntelliJ Console: not tested

    • NO_IDEOGRAM_ATTRIBUTES

      public static final SGRParameters NO_IDEOGRAM_ATTRIBUTES
      Rarely supported. Resets Ideogram and left/right side line

      IntelliJ Console: not tested

    • SUPERSCRIPT

      public static final SGRParameters SUPERSCRIPT
      Rarely supported.

      IntelliJ Console: not tested

    • SUBSCRIPT

      public static final SGRParameters SUBSCRIPT
      Rarely supported.

      IntelliJ Console: not tested

    • NOT_SUPERSCRIPT_NOR_SUBSCRIPT

      public static final SGRParameters NOT_SUPERSCRIPT_NOR_SUBSCRIPT
      Rarely supported. Not SUBSCRIPT nor SUPERSCRIPT

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_BLACK

      public static final SGRParameters FOREGROUND_BRIGHT_BLACK
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_RED

      public static final SGRParameters FOREGROUND_BRIGHT_RED
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_GREEN

      public static final SGRParameters FOREGROUND_BRIGHT_GREEN
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_YELLOW

      public static final SGRParameters FOREGROUND_BRIGHT_YELLOW
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_BLUE

      public static final SGRParameters FOREGROUND_BRIGHT_BLUE
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_MAGENTA

      public static final SGRParameters FOREGROUND_BRIGHT_MAGENTA
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_CYAN

      public static final SGRParameters FOREGROUND_BRIGHT_CYAN
      Not in standard.

      IntelliJ Console: not tested

    • FOREGROUND_BRIGHT_WHITE

      public static final SGRParameters FOREGROUND_BRIGHT_WHITE
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_BLACK

      public static final SGRParameters BACKGROUND_BRIGHT_BLACK

    • BACKGROUND_BRIGHT_RED

      public static final SGRParameters BACKGROUND_BRIGHT_RED
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_GREEN

      public static final SGRParameters BACKGROUND_BRIGHT_GREEN
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_YELLOW

      public static final SGRParameters BACKGROUND_BRIGHT_YELLOW
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_BLUE

      public static final SGRParameters BACKGROUND_BRIGHT_BLUE
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_MAGENTA

      public static final SGRParameters BACKGROUND_BRIGHT_MAGENTA
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_CYAN

      public static final SGRParameters BACKGROUND_BRIGHT_CYAN
      Not in standard.

      IntelliJ Console: not tested

    • BACKGROUND_BRIGHT_WHITE

      public static final SGRParameters BACKGROUND_BRIGHT_WHITE
      Not in standard.

      IntelliJ Console: not tested

  • Method Details

    • values

      public static SGRParameters[] 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 SGRParameters 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

    • getIdentifier

      public int getIdentifier()
      Description copied from interface: SGRParameter
      The identifier of this parameter.
      Specified by:
      getIdentifier in interface SGRParameter
      Returns:
      code

    • argumentCount

      public int argumentCount()
      Description copied from interface: SGRParameter
      How many arguments this parameter requires. Negative numbers for an unknown amount.
      Specified by:
      argumentCount in interface SGRParameter
      Returns:
      required number of parameters or any negative number.