Package com.googlecode.lanterna

Enum TextColor.ANSI

java.lang.Object

java.lang.Enum<TextColor.ANSI>

com.googlecode.lanterna.TextColor.ANSI

All Implemented Interfaces:

TextColor, Serializable, Comparable<TextColor.ANSI>

Enclosing interface:

TextColor

public static enum TextColor.ANSI
extends Enum<TextColor.ANSI>
implements TextColor

This class represent classic ANSI colors that are likely to be very compatible with most terminal implementations. It is limited to 8 colors (plus the 'default' color) but as a norm, using bold mode (SGR code) will slightly alter the color, giving it a bit brighter tone, so in total this will give you 16 (+1) colors.

For more information, see http://en.wikipedia.org/wiki/File:Ansi.png

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.TextColor

TextColor.ANSI, TextColor.Factory, TextColor.Indexed, TextColor.RGB

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLACK
BLUE
CYAN
DEFAULT
GREEN
MAGENTA
RED
WHITE
YELLOW

Method Summary

Modifier and Type	Method	Description
byte[]	getBackgroundSGRSequence()	Returns the byte sequence in between CSI and character 'm' that is used to enable this color as the background color on an ANSI-compatible terminal.
byte[]	getForegroundSGRSequence()	Returns the byte sequence in between CSI and character 'm' that is used to enable this color as the foreground color on an ANSI-compatible terminal.
Color	toColor()	Converts this color to an AWT color object, assuming a standard VGA palette.
static TextColor.ANSI	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TextColor.ANSI[]	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

BLACK

public static final TextColor.ANSI BLACK

RED

public static final TextColor.ANSI RED

GREEN

public static final TextColor.ANSI GREEN

YELLOW

public static final TextColor.ANSI YELLOW

BLUE

public static final TextColor.ANSI BLUE

MAGENTA

public static final TextColor.ANSI MAGENTA

CYAN

public static final TextColor.ANSI CYAN

WHITE

public static final TextColor.ANSI WHITE

DEFAULT

public static final TextColor.ANSI DEFAULT

Method Detail

values

public static TextColor.ANSI[] 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 (TextColor.ANSI c : TextColor.ANSI.values())
    System.out.println(c);

Returns:

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

valueOf

public static TextColor.ANSI 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

getForegroundSGRSequence

public byte[] getForegroundSGRSequence()

Description copied from interface: TextColor

Returns the byte sequence in between CSI and character 'm' that is used to enable this color as the foreground color on an ANSI-compatible terminal.

Specified by:

getForegroundSGRSequence in interface TextColor

Returns:

Byte array out data to output in between of CSI and 'm'

getBackgroundSGRSequence

public byte[] getBackgroundSGRSequence()

Description copied from interface: TextColor

Returns the byte sequence in between CSI and character 'm' that is used to enable this color as the background color on an ANSI-compatible terminal.

Specified by:

getBackgroundSGRSequence in interface TextColor

Returns:

Byte array out data to output in between of CSI and 'm'

toColor

public Color toColor()

Description copied from interface: TextColor

Converts this color to an AWT color object, assuming a standard VGA palette.

Specified by:

toColor in interface TextColor

Returns:

TextColor as an AWT Color