Ansi (jansi API Reference (1.17.1))

java.lang.Object
- org.fusesource.jansi.Ansi

```
public class Ansi
extends java.lang.Object
```
Provides a fluent API for generating ANSI escape sequences.

Since:

1.0

Author:

Hiram Chirino

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Ansi.Attribute

static class Ansi.Color

static class Ansi.Erase

Nested Classes
Modifier and Type	Class and Description
`static class`	`Ansi.Attribute`
`static class`	`Ansi.Color`
`static class`	`Ansi.Erase`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DISABLE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DISABLE`

Constructor Summary

Constructors
Constructor and Description

Ansi()

Ansi(Ansi parent)

Ansi(int size)

Ansi(java.lang.StringBuilder builder)

Constructors
Constructor and Description
`Ansi()`
`Ansi(Ansi parent)`
`Ansi(int size)`
`Ansi(java.lang.StringBuilder builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Ansi`	`a(Ansi.Attribute attribute)`
`Ansi`	`a(boolean value)`
`Ansi`	`a(char value)`
`Ansi`	`a(char[] value)`
`Ansi`	`a(char[] value, int offset, int len)`
`Ansi`	`a(java.lang.CharSequence value)`
`Ansi`	`a(java.lang.CharSequence value, int start, int end)`
`Ansi`	`a(double value)`
`Ansi`	`a(float value)`
`Ansi`	`a(int value)`
`Ansi`	`a(long value)`
`Ansi`	`a(java.lang.Object value)`
`Ansi`	`a(java.lang.String value)`
`Ansi`	`a(java.lang.StringBuffer value)`
`static Ansi`	`ansi()`
`static Ansi`	`ansi(int size)`
`static Ansi`	`ansi(java.lang.StringBuilder builder)`
`Ansi`	`bg(Ansi.Color color)`
`Ansi`	`bgBright(Ansi.Color color)`
`Ansi`	`bgBrightCyan()`
`Ansi`	`bgBrightDefault()`
`Ansi`	`bgBrightGreen()`
`Ansi`	`bgBrightMagenta()`
`Ansi`	`bgBrightRed()`
`Ansi`	`bgBrightYellow()`
`Ansi`	`bgCyan()`
`Ansi`	`bgDefault()`
`Ansi`	`bgGreen()`
`Ansi`	`bgMagenta()`
`Ansi`	`bgRed()`
`Ansi`	`bgYellow()`
`Ansi`	`bold()`
`Ansi`	`boldOff()`
`Ansi`	`cursor(int row, int column)` Moves the cursor to row n, column m.
`Ansi`	`cursorDown(int y)`
`Ansi`	`cursorDownLine()`
`Ansi`	`cursorDownLine(int n)`
`Ansi`	`cursorLeft(int x)`
`Ansi`	`cursorRight(int x)`
`Ansi`	`cursorToColumn(int x)`
`Ansi`	`cursorUp(int y)`
`Ansi`	`cursorUpLine()`
`Ansi`	`cursorUpLine(int n)`
`Ansi`	`eraseLine()`
`Ansi`	`eraseLine(Ansi.Erase kind)`
`Ansi`	`eraseScreen()`
`Ansi`	`eraseScreen(Ansi.Erase kind)`
`Ansi`	`fg(Ansi.Color color)`
`Ansi`	`fgBlack()`
`Ansi`	`fgBlue()`
`Ansi`	`fgBright(Ansi.Color color)`
`Ansi`	`fgBrightBlack()`
`Ansi`	`fgBrightBlue()`
`Ansi`	`fgBrightCyan()`
`Ansi`	`fgBrightDefault()`
`Ansi`	`fgBrightGreen()`
`Ansi`	`fgBrightMagenta()`
`Ansi`	`fgBrightRed()`
`Ansi`	`fgBrightYellow()`
`Ansi`	`fgCyan()`
`Ansi`	`fgDefault()`
`Ansi`	`fgGreen()`
`Ansi`	`fgMagenta()`
`Ansi`	`fgRed()`
`Ansi`	`fgYellow()`
`Ansi`	`format(java.lang.String pattern, java.lang.Object... args)`
`static boolean`	`isDetected()`
`static boolean`	`isEnabled()`
`Ansi`	`newline()`
`Ansi`	`render(java.lang.String text)` Uses the `AnsiRenderer` to generate the ANSI escape sequences for the supplied text.
`Ansi`	`render(java.lang.String text, java.lang.Object... args)` String formats and renders the supplied arguments.
`Ansi`	`reset()`
`Ansi`	`restorCursorPosition()` Deprecated.
`Ansi`	`restoreCursorPosition()`
`Ansi`	`saveCursorPosition()`
`Ansi`	`scrollDown(int rows)`
`Ansi`	`scrollUp(int rows)`
`static void`	`setDetector(java.util.concurrent.Callable<java.lang.Boolean> detector)`
`static void`	`setEnabled(boolean flag)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DISABLE

public static final java.lang.String DISABLE

Constructor Detail

Ansi
```
public Ansi()
```

Ansi
```
public Ansi(Ansi parent)
```

Ansi
```
public Ansi(int size)
```

Ansi

public Ansi(java.lang.StringBuilder builder)

Method Detail

setDetector

public static void setDetector(java.util.concurrent.Callable<java.lang.Boolean> detector)

isDetected
```
public static boolean isDetected()
```

setEnabled

public static void setEnabled(boolean flag)

isEnabled
```
public static boolean isEnabled()
```

ansi
```
public static Ansi ansi()
```

ansi

public static Ansi ansi(java.lang.StringBuilder builder)

ansi
```
public static Ansi ansi(int size)
```

fg
```
public Ansi fg(Ansi.Color color)
```

fgBlack
```
public Ansi fgBlack()
```

fgBlue
```
public Ansi fgBlue()
```

fgCyan
```
public Ansi fgCyan()
```

fgDefault
```
public Ansi fgDefault()
```

fgGreen
```
public Ansi fgGreen()
```

fgMagenta
```
public Ansi fgMagenta()
```

fgRed
```
public Ansi fgRed()
```

fgYellow
```
public Ansi fgYellow()
```

bg
```
public Ansi bg(Ansi.Color color)
```

bgCyan
```
public Ansi bgCyan()
```

bgDefault
```
public Ansi bgDefault()
```

bgGreen
```
public Ansi bgGreen()
```

bgMagenta
```
public Ansi bgMagenta()
```

bgRed
```
public Ansi bgRed()
```

bgYellow
```
public Ansi bgYellow()
```

fgBright

public Ansi fgBright(Ansi.Color color)

fgBrightBlack
```
public Ansi fgBrightBlack()
```

fgBrightBlue
```
public Ansi fgBrightBlue()
```

fgBrightCyan
```
public Ansi fgBrightCyan()
```

fgBrightDefault
```
public Ansi fgBrightDefault()
```

fgBrightGreen
```
public Ansi fgBrightGreen()
```

fgBrightMagenta
```
public Ansi fgBrightMagenta()
```

fgBrightRed
```
public Ansi fgBrightRed()
```

fgBrightYellow
```
public Ansi fgBrightYellow()
```

bgBright

public Ansi bgBright(Ansi.Color color)

bgBrightCyan
```
public Ansi bgBrightCyan()
```

bgBrightDefault
```
public Ansi bgBrightDefault()
```

bgBrightGreen
```
public Ansi bgBrightGreen()
```

bgBrightMagenta
```
public Ansi bgBrightMagenta()
```

bgBrightRed
```
public Ansi bgBrightRed()
```

bgBrightYellow
```
public Ansi bgBrightYellow()
```

a

public Ansi a(Ansi.Attribute attribute)

cursor
```
public Ansi cursor(int row,
                   int column)
```
Moves the cursor to row n, column m. The values are 1-based, and default to 1 (top left corner) if omitted. A sequence such as CSI ;5H is a synonym for CSI 1;5H as well as CSI 17;H is the same as CSI 17H and CSI 17;1H

Parameters:

row - row (1-based) from top

column - column (1 based) from left

Returns:

Ansi

cursorToColumn
```
public Ansi cursorToColumn(int x)
```

cursorUp
```
public Ansi cursorUp(int y)
```

cursorDown
```
public Ansi cursorDown(int y)
```

cursorRight
```
public Ansi cursorRight(int x)
```

cursorLeft
```
public Ansi cursorLeft(int x)
```

cursorDownLine
```
public Ansi cursorDownLine()
```

cursorDownLine
```
public Ansi cursorDownLine(int n)
```

cursorUpLine
```
public Ansi cursorUpLine()
```

cursorUpLine
```
public Ansi cursorUpLine(int n)
```

eraseScreen
```
public Ansi eraseScreen()
```

eraseScreen

public Ansi eraseScreen(Ansi.Erase kind)

eraseLine
```
public Ansi eraseLine()
```

eraseLine

public Ansi eraseLine(Ansi.Erase kind)

scrollUp
```
public Ansi scrollUp(int rows)
```

scrollDown
```
public Ansi scrollDown(int rows)
```

saveCursorPosition
```
public Ansi saveCursorPosition()
```

restorCursorPosition

@Deprecated
public Ansi restorCursorPosition()

Deprecated.

restoreCursorPosition
```
public Ansi restoreCursorPosition()
```

reset
```
public Ansi reset()
```

bold
```
public Ansi bold()
```

boldOff
```
public Ansi boldOff()
```

a

public Ansi a(java.lang.String value)

a
```
public Ansi a(boolean value)
```

a
```
public Ansi a(char value)
```

a

public Ansi a(char[] value,
              int offset,
              int len)

a
```
public Ansi a(char[] value)
```

a

public Ansi a(java.lang.CharSequence value,
              int start,
              int end)

a

public Ansi a(java.lang.CharSequence value)

a
```
public Ansi a(double value)
```

a
```
public Ansi a(float value)
```

a
```
public Ansi a(int value)
```

a
```
public Ansi a(long value)
```

a

public Ansi a(java.lang.Object value)

a

public Ansi a(java.lang.StringBuffer value)

newline
```
public Ansi newline()
```

format

public Ansi format(java.lang.String pattern,
                   java.lang.Object... args)

render
```
public Ansi render(java.lang.String text)
```
Uses the AnsiRenderer to generate the ANSI escape sequences for the supplied text.

Parameters:

text - text

Returns:

this

Since:

1.1

render
```
public Ansi render(java.lang.String text,
                   java.lang.Object... args)
```
String formats and renders the supplied arguments. Uses the AnsiRenderer to generate the ANSI escape sequences.

Parameters:

text - format

args - arguments

Returns:

this

Since:

1.1

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class Ansi

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISABLE

Constructor Detail

Ansi

Ansi

Ansi

Ansi

Method Detail

setDetector

isDetected

setEnabled

isEnabled

ansi

ansi

ansi

fg

fgBlack

fgBlue

fgCyan

fgDefault

fgGreen

fgMagenta

fgRed

fgYellow

bg

bgCyan

bgDefault

bgGreen

bgMagenta

bgRed

bgYellow

fgBright

fgBrightBlack

fgBrightBlue

fgBrightCyan

fgBrightDefault

fgBrightGreen

fgBrightMagenta

fgBrightRed

fgBrightYellow

bgBright

bgBrightCyan

bgBrightDefault

bgBrightGreen

bgBrightMagenta

bgBrightRed

bgBrightYellow

a

cursor

cursorToColumn

cursorUp

cursorDown

cursorRight

cursorLeft

cursorDownLine

cursorDownLine

cursorUpLine

cursorUpLine

eraseScreen

eraseScreen

eraseLine

eraseLine

scrollUp

scrollDown

saveCursorPosition

restorCursorPosition

restoreCursorPosition

reset

bold

boldOff

a

a

a

a