Index

A B C D E F G H I M O R S T U V W Y
All Classes and Interfaces|All Packages

A

addFormat(FormatOption...) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Adds the specified formatting options to the formatter.

B

b() - Method in class io.github.darvil.terminal.textformatter.color.TrueColor

Returns the blue component of this color.

bg() - Method in interface io.github.darvil.terminal.textformatter.color.Color

Returns the ANSI escape sequence for this color for the text background.

bg() - Method in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

bg() - Method in class io.github.darvil.terminal.textformatter.color.TrueColor

BLACK - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BLACK - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color black.

BLINK - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

Makes the text blink.

BLUE - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BLUE - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color blue.

BOLD - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

BRIGHT_BLUE - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BRIGHT_COLORS - Static variable in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

Array of all the bright colors.

BRIGHT_CYAN - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BRIGHT_GREEN - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BRIGHT_MAGENTA - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BRIGHT_RED - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BRIGHT_WHITE - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

BRIGHT_YELLOW - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

C

Color - Interface in io.github.darvil.terminal.textformatter.color

concat(Object...) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Concatenates the specified values to the formatter.

create() - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Creates a new TextFormatter with empty contents.

CYAN - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

CYAN - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color cyan.

D

DARK_COLORS - Static variable in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

Array of all the dark colors.

debug - Static variable in class io.github.darvil.terminal.textformatter.TextFormatter

When set to true, the TextFormatter.toString() method will not add any terminal sequences, but rather return the sequences that would be added by marking them as ESC[<sequence here>]

defaultColor - Static variable in class io.github.darvil.terminal.textformatter.TextFormatter

The default color that should be used when no foreground color is specified (if TextFormatter.startWithDefaultColorIfNotDefined is set to true), or when the foreground color is reset.

DIM - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

Makes the text dimmer.

E

enableSequences - Static variable in class io.github.darvil.terminal.textformatter.TextFormatter

When set to false, no formatting will be applied to text.

error(String) - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Returns a new TextFormatter with the specified contents and the error formatting.

F

fg() - Method in interface io.github.darvil.terminal.textformatter.color.Color

Returns the ANSI escape sequence for this color for the text foreground.

fg() - Method in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

fg() - Method in class io.github.darvil.terminal.textformatter.color.TrueColor

FormatOption - Enum Class in io.github.darvil.terminal.textformatter

Enumerates the ANSI format codes that a terminal can normally display.

G

g() - Method in class io.github.darvil.terminal.textformatter.color.TrueColor

Returns the green component of this color.

getSequence(Object...) - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Returns a string with a terminal sequence with the specified values, separated by a semicolon.

GRAY - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

GREEN - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

GREEN - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color green.

H

HIDDEN - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

Hides the text.

I

io.github.darvil.terminal.textformatter - module io.github.darvil.terminal.textformatter

io.github.darvil.terminal.textformatter - package io.github.darvil.terminal.textformatter

io.github.darvil.terminal.textformatter.color - package io.github.darvil.terminal.textformatter.color

isColorDisabledEnv() - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Returns whether there is an environment variable that specifies that the terminal does not support color.

isFormattingNotDefined() - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Returns whether the formatter has no formatting options, no foreground color, and no background color.

isSimple() - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Returns whether the formatter is simple.

ITALIC - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

M

MAGENTA - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

MAGENTA - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color magenta.

O

of(int) - Static method in class io.github.darvil.terminal.textformatter.color.TrueColor

Creates a new TrueColor object with the given RGB components packed into a single integer.

of(int, int, int) - Static method in class io.github.darvil.terminal.textformatter.color.TrueColor

Creates a new TrueColor object with the given RGB components.

of(String) - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Creates a new TextFormatter with the specified contents.

of(String, Color) - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Creates a new TextFormatter with the specified contents and foreground color.

of(String, Color, Color) - Static method in class io.github.darvil.terminal.textformatter.TextFormatter

Creates a new TextFormatter with the specified contents and colors.

R

r() - Method in class io.github.darvil.terminal.textformatter.color.TrueColor

Returns the red component of this color.

RED - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

RED - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color red.

removeFormat(FormatOption...) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Removes the specified formatting options from the formatter.

reset() - Method in enum class io.github.darvil.terminal.textformatter.FormatOption

Returns the ANSI escape sequence which resets the formatting of this option.

RESET_ALL - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

Resets all formatting.

REVERSE - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

Reverses the foreground and background colors.

S

seq() - Method in enum class io.github.darvil.terminal.textformatter.FormatOption

Returns the ANSI escape sequence for this format option.

SimpleColor - Enum Class in io.github.darvil.terminal.textformatter.color

Enumerates the ANSI color codes that a terminal can normally display.

startWithDefaultColorIfNotDefined - Static variable in class io.github.darvil.terminal.textformatter.TextFormatter

When set to true, the default color will be used when no foreground color is specified.

STRIKETHROUGH - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

T

TextFormatter - Class in io.github.darvil.terminal.textformatter

Allows easily formatting of text for it to be displayed in a terminal.

TextFormatter(String) - Constructor for class io.github.darvil.terminal.textformatter.TextFormatter

Creates a new TextFormatter with the specified contents.

toString() - Method in interface io.github.darvil.terminal.textformatter.color.Color

Returns the ANSI escape sequence for this color for the text foreground.

toString() - Method in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

toString() - Method in class io.github.darvil.terminal.textformatter.color.TrueColor

toString() - Method in enum class io.github.darvil.terminal.textformatter.FormatOption

Returns the ANSI escape sequence for this format option.

toString() - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Creates a new String with the contents and all the formatting applied.

TrueColor - Class in io.github.darvil.terminal.textformatter.color

Represents a true color in the RGB color space.

U

UNDERLINE - Enum constant in enum class io.github.darvil.terminal.textformatter.FormatOption

V

valueOf(String) - Static method in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.darvil.terminal.textformatter.FormatOption

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.darvil.terminal.textformatter.FormatOption

Returns an array containing the constants of this enum class, in the order they are declared.

W

WHITE - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

WHITE - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color white.

withBackgroundColor(Color) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Sets the background color of the formatter.

withColors(Color, Color) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Sets the foreground and background color of the formatter.

withConcatGap(String) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Sets the gap between concatenated formatters.

withContents(String) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Sets the contents of the formatter.

withForegroundColor(Color) - Method in class io.github.darvil.terminal.textformatter.TextFormatter

Sets the foreground color of the formatter.

Y

YELLOW - Enum constant in enum class io.github.darvil.terminal.textformatter.color.SimpleColor

YELLOW - Static variable in class io.github.darvil.terminal.textformatter.color.TrueColor

The color yellow.

A B C D E F G H I M O R S T U V W Y
All Classes and Interfaces|All Packages