ca.uqac.lif.tui

Class AnsiPrinter

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

ca.uqac.lif.tui.AnsiPrinter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class AnsiPrinter
extends java.io.PrintStream

Print stream with facilities for producing colored text using ANSI escape codes.

Author:

sylvain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnsiPrinter.Color Default 16-color scheme for foreground and background text

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_enabled Whether ANSI codes are enabled.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
AnsiPrinter(java.io.OutputStream out) Instantiates an AnsiPrinter.

Method Summary

Modifier and Type	Method and Description
AnsiPrinter	bg(AnsiPrinter.Color c) Shortcut to setBackgroundColor(Color).
boolean	colorsEnabled() Determines if the display of colours is enabled
void	disableColors() Disables the output of ANSI codes in the output stream
void	enableColors() Enables the output of ANSI codes in the output stream
AnsiPrinter	fg(AnsiPrinter.Color c) Shortcut to setForegroundColor(Color).
static java.lang.String	padToLength(java.lang.String s, int length)
java.lang.String	readLine() Reads a line from the standard input
AnsiPrinter	resetColors() Resets the colors to their default values
AnsiPrinter	setBackgroundColor(AnsiPrinter.Color c) Sets the background color for printed text.
AnsiPrinter	setBackgroundColor(int r, int g, int b) Sets the background color based on its RGB components.
AnsiPrinter	setForegroundColor(AnsiPrinter.Color c) Sets the foreground color for printed text.
AnsiPrinter	setForegroundColor(int r, int g, int b) Sets the foreground color based on its RGB components.
AnsiPrinter	setUnderscore()
AnsiPrinter	setWhiteOnBlack()

Methods inherited from class java.io.PrintStream

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_enabled

protected boolean m_enabled

Whether ANSI codes are enabled. If set to false (with disableColors()), behaves like a normal PrintStream

Constructor Detail

AnsiPrinter

public AnsiPrinter(java.io.OutputStream out)

Instantiates an AnsiPrinter.

Parameters:

out - The OutputStream where the printer will send its output

Method Detail

enableColors

public void enableColors()

Enables the output of ANSI codes in the output stream

disableColors

public void disableColors()

Disables the output of ANSI codes in the output stream

setForegroundColor

public AnsiPrinter setForegroundColor(AnsiPrinter.Color c)

Sets the foreground color for printed text. Until this color is changed, the text will be printed using that color.

Parameters:

c - The color

Returns:

This printer

fg

public AnsiPrinter fg(AnsiPrinter.Color c)

Shortcut to setForegroundColor(Color).

Parameters:

c - The colour

Returns:

This printer

setForegroundColor

public AnsiPrinter setForegroundColor(int r,
                                      int g,
                                      int b)

Sets the foreground color based on its RGB components.

Parameters:

r - The amount of red (R), between 0 and 255

g - The amount of green (G), between 0 and 255

b - The amount of blue (B), between 0 and 255

Returns:

This printer

setBackgroundColor

public AnsiPrinter setBackgroundColor(AnsiPrinter.Color c)

Sets the background color for printed text. Until this color is changed, the text will be printed using that color.

Parameters:

c - The color

Returns:

This printer

bg

public AnsiPrinter bg(AnsiPrinter.Color c)

Shortcut to setBackgroundColor(Color).

Parameters:

c - The colour

Returns:

This printer

setBackgroundColor

public AnsiPrinter setBackgroundColor(int r,
                                      int g,
                                      int b)

Sets the background color based on its RGB components.

Parameters:

r - The amount of red (R), between 0 and 255

g - The amount of green (G), between 0 and 255

b - The amount of blue (B), between 0 and 255

Returns:

This printer

resetColors

public AnsiPrinter resetColors()

Resets the colors to their default values

Returns:

This printer

setUnderscore

public AnsiPrinter setUnderscore()

padToLength

public static java.lang.String padToLength(java.lang.String s,
                                           int length)

readLine

public java.lang.String readLine()

Reads a line from the standard input

Returns:

The line

colorsEnabled

public boolean colorsEnabled()

Determines if the display of colours is enabled

Returns:

true if colors enabled, false otherwise

setWhiteOnBlack

public AnsiPrinter setWhiteOnBlack()