com.googlecode.lanterna.terminal

Enum Terminal.SGR

java.lang.Object

java.lang.Enum<Terminal.SGR>

com.googlecode.lanterna.terminal.Terminal.SGR

All Implemented Interfaces:

Serializable, Comparable<Terminal.SGR>

Enclosing interface:

Terminal

public static enum Terminal.SGR
extends Enum<Terminal.SGR>

SGR - Select Graphic Rendition, changes the state of the terminal as to what kind of text to print after this command. When applying an ENTER SGR code, it normally applies until you send the corresponding EXIT code. RESET_ALL will clear any code currently enabled.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENTER_BLINK This code may not be supported by all terminals/terminal emulators
ENTER_BOLD Please note that on some terminal implementations, instead of making the text bold, it will draw the text in a slightly different color
ENTER_REVERSE
ENTER_UNDERLINE
EXIT_BLINK
EXIT_BOLD
EXIT_REVERSE
EXIT_UNDERLINE
RESET_ALL Removes any code SGR code currently enabled

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESET_ALL

public static final Terminal.SGR RESET_ALL

Removes any code SGR code currently enabled

ENTER_BOLD

public static final Terminal.SGR ENTER_BOLD

Please note that on some terminal implementations, instead of making the text bold, it will draw the text in a slightly different color

ENTER_REVERSE

public static final Terminal.SGR ENTER_REVERSE

ENTER_UNDERLINE

public static final Terminal.SGR ENTER_UNDERLINE

ENTER_BLINK

public static final Terminal.SGR ENTER_BLINK

This code may not be supported by all terminals/terminal emulators

EXIT_BOLD

public static final Terminal.SGR EXIT_BOLD

EXIT_REVERSE

public static final Terminal.SGR EXIT_REVERSE

EXIT_UNDERLINE

public static final Terminal.SGR EXIT_UNDERLINE

EXIT_BLINK

public static final Terminal.SGR EXIT_BLINK

Method Detail

values

public static Terminal.SGR[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Terminal.SGR c : Terminal.SGR.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Terminal.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