Package org.strassburger.tui4j.formatting.ansi

Enum Class AnsiCode

java.lang.Object

java.lang.Enum<AnsiCode>

org.strassburger.tui4j.formatting.ansi.AnsiCode

All Implemented Interfaces:

Serializable, Comparable<AnsiCode>, Constable

public enum AnsiCode
extends Enum<AnsiCode>

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
BEL
BG_BLACK
BG_BLUE
BG_BRIGHT_BLACK
BG_BRIGHT_BLUE
BG_BRIGHT_CYAN
BG_BRIGHT_GREEN
BG_BRIGHT_MAGENTA
BG_BRIGHT_RED
BG_BRIGHT_WHITE
BG_BRIGHT_YELLOW
BG_CYAN
BG_DEFAULT
BG_GREEN
BG_MAGENTA
BG_RED
BG_WHITE
BG_YELLOW
BLINK
BLINK_OFF
BOLD
BOLD_OFF
BS
CR
CURSOR_BACK
CURSOR_COLUMN
CURSOR_DOWN
CURSOR_FORWARD
CURSOR_HOME
CURSOR_NEXT_LINE
CURSOR_POSITION
CURSOR_POSITION_REQUEST
CURSOR_PREVIOUS_LINE
CURSOR_RESTORE_DEC
CURSOR_RESTORE_SCO
CURSOR_SAVE_DEC
CURSOR_SAVE_SCO
CURSOR_UP
DEL
DIM
ERASE_DISPLAY
ERASE_DISPLAY_CURSOR_TO_BEGINNING
ERASE_DISPLAY_CURSOR_TO_END
ERASE_DISPLAY_ENTIRE
ERASE_DISPLAY_SAVED_LINES
ERASE_LINE
ERASE_LINE_CURSOR_TO_END
ERASE_LINE_ENTIRE
ERASE_LINE_START_TO_CURSOR
ESC
FF
FG_BLACK
FG_BLUE
FG_BRIGHT_BLACK
FG_BRIGHT_BLUE
FG_BRIGHT_CYAN
FG_BRIGHT_GREEN
FG_BRIGHT_MAGENTA
FG_BRIGHT_RED
FG_BRIGHT_WHITE
FG_BRIGHT_YELLOW
FG_CYAN
FG_DEFAULT
FG_GREEN
FG_MAGENTA
FG_RED
FG_WHITE
FG_YELLOW
HIDDEN
HIDDEN_OFF
HT
INVERSE
INVERSE_OFF
ITALIC
ITALIC_OFF
LF
RESET
STRIKETHROUGH
STRIKETHROUGH_OFF
UNDERLINE
UNDERLINE_OFF
VT

Method Summary

Modifier and Type	Method	Description
String	format(Object... args)	Formats the ANSI code with the given arguments.
String	toString()
static AnsiCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AnsiCode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BEL

public static final AnsiCode BEL

BS

public static final AnsiCode BS

HT

public static final AnsiCode HT

LF

public static final AnsiCode LF

VT

public static final AnsiCode VT

FF

public static final AnsiCode FF

CR

public static final AnsiCode CR

ESC

public static final AnsiCode ESC

DEL

public static final AnsiCode DEL

CURSOR_HOME

public static final AnsiCode CURSOR_HOME

CURSOR_POSITION

public static final AnsiCode CURSOR_POSITION

CURSOR_UP

public static final AnsiCode CURSOR_UP

CURSOR_DOWN

public static final AnsiCode CURSOR_DOWN

CURSOR_FORWARD

public static final AnsiCode CURSOR_FORWARD

CURSOR_BACK

public static final AnsiCode CURSOR_BACK

CURSOR_NEXT_LINE

public static final AnsiCode CURSOR_NEXT_LINE

CURSOR_PREVIOUS_LINE

public static final AnsiCode CURSOR_PREVIOUS_LINE

CURSOR_COLUMN

public static final AnsiCode CURSOR_COLUMN

CURSOR_SAVE_DEC

public static final AnsiCode CURSOR_SAVE_DEC

CURSOR_RESTORE_DEC

public static final AnsiCode CURSOR_RESTORE_DEC

CURSOR_SAVE_SCO

public static final AnsiCode CURSOR_SAVE_SCO

CURSOR_RESTORE_SCO

public static final AnsiCode CURSOR_RESTORE_SCO

CURSOR_POSITION_REQUEST

public static final AnsiCode CURSOR_POSITION_REQUEST

ERASE_DISPLAY

public static final AnsiCode ERASE_DISPLAY

ERASE_DISPLAY_CURSOR_TO_END

public static final AnsiCode ERASE_DISPLAY_CURSOR_TO_END

ERASE_DISPLAY_CURSOR_TO_BEGINNING

public static final AnsiCode ERASE_DISPLAY_CURSOR_TO_BEGINNING

ERASE_DISPLAY_ENTIRE

public static final AnsiCode ERASE_DISPLAY_ENTIRE

ERASE_DISPLAY_SAVED_LINES

public static final AnsiCode ERASE_DISPLAY_SAVED_LINES

ERASE_LINE

public static final AnsiCode ERASE_LINE

ERASE_LINE_CURSOR_TO_END

public static final AnsiCode ERASE_LINE_CURSOR_TO_END

ERASE_LINE_START_TO_CURSOR

public static final AnsiCode ERASE_LINE_START_TO_CURSOR

ERASE_LINE_ENTIRE

public static final AnsiCode ERASE_LINE_ENTIRE

RESET

public static final AnsiCode RESET

BOLD

public static final AnsiCode BOLD

DIM

public static final AnsiCode DIM

ITALIC

public static final AnsiCode ITALIC

UNDERLINE

public static final AnsiCode UNDERLINE

BLINK

public static final AnsiCode BLINK

INVERSE

public static final AnsiCode INVERSE

HIDDEN

public static final AnsiCode HIDDEN

STRIKETHROUGH

public static final AnsiCode STRIKETHROUGH

BOLD_OFF

public static final AnsiCode BOLD_OFF

ITALIC_OFF

public static final AnsiCode ITALIC_OFF

UNDERLINE_OFF

public static final AnsiCode UNDERLINE_OFF

BLINK_OFF

public static final AnsiCode BLINK_OFF

INVERSE_OFF

public static final AnsiCode INVERSE_OFF

HIDDEN_OFF

public static final AnsiCode HIDDEN_OFF

STRIKETHROUGH_OFF

public static final AnsiCode STRIKETHROUGH_OFF

FG_BLACK

public static final AnsiCode FG_BLACK

FG_RED

public static final AnsiCode FG_RED

FG_GREEN

public static final AnsiCode FG_GREEN

FG_YELLOW

public static final AnsiCode FG_YELLOW

FG_BLUE

public static final AnsiCode FG_BLUE

FG_MAGENTA

public static final AnsiCode FG_MAGENTA

FG_CYAN

public static final AnsiCode FG_CYAN

FG_WHITE

public static final AnsiCode FG_WHITE

FG_DEFAULT

public static final AnsiCode FG_DEFAULT

BG_BLACK

public static final AnsiCode BG_BLACK

BG_RED

public static final AnsiCode BG_RED

BG_GREEN

public static final AnsiCode BG_GREEN

BG_YELLOW

public static final AnsiCode BG_YELLOW

BG_BLUE

public static final AnsiCode BG_BLUE

BG_MAGENTA

public static final AnsiCode BG_MAGENTA

BG_CYAN

public static final AnsiCode BG_CYAN

BG_WHITE

public static final AnsiCode BG_WHITE

BG_DEFAULT

public static final AnsiCode BG_DEFAULT

FG_BRIGHT_BLACK

public static final AnsiCode FG_BRIGHT_BLACK

FG_BRIGHT_RED

public static final AnsiCode FG_BRIGHT_RED

FG_BRIGHT_GREEN

public static final AnsiCode FG_BRIGHT_GREEN

FG_BRIGHT_YELLOW

public static final AnsiCode FG_BRIGHT_YELLOW

FG_BRIGHT_BLUE

public static final AnsiCode FG_BRIGHT_BLUE

FG_BRIGHT_MAGENTA

public static final AnsiCode FG_BRIGHT_MAGENTA

FG_BRIGHT_CYAN

public static final AnsiCode FG_BRIGHT_CYAN

FG_BRIGHT_WHITE

public static final AnsiCode FG_BRIGHT_WHITE

BG_BRIGHT_BLACK

public static final AnsiCode BG_BRIGHT_BLACK

BG_BRIGHT_RED

public static final AnsiCode BG_BRIGHT_RED

BG_BRIGHT_GREEN

public static final AnsiCode BG_BRIGHT_GREEN

BG_BRIGHT_YELLOW

public static final AnsiCode BG_BRIGHT_YELLOW

BG_BRIGHT_BLUE

public static final AnsiCode BG_BRIGHT_BLUE

BG_BRIGHT_MAGENTA

public static final AnsiCode BG_BRIGHT_MAGENTA

BG_BRIGHT_CYAN

public static final AnsiCode BG_BRIGHT_CYAN

BG_BRIGHT_WHITE

public static final AnsiCode BG_BRIGHT_WHITE

Method Details

values

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

toString

public String toString()

Overrides:

toString in class Enum<AnsiCode>

format

public String format(Object... args)

Formats the ANSI code with the given arguments.

Parameters:

args - the arguments to format the code

Returns:

the formatted ANSI code string