WindowsAnsiWriter (JLine Bundle 3.14.1 API)

java.lang.Object
- java.io.Writer
- - java.io.FilterWriter
  - - org.jline.utils.AnsiWriter
    - - org.jline.terminal.impl.jna.win.WindowsAnsiWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable
```
public final class WindowsAnsiWriter
extends AnsiWriter
```
A Windows ANSI escape processor, uses JNA to access native platform API's to change the console attributes.

Since:

1.0

Author:

Hiram Chirino, Joris Kuipers

Field Summary
- Fields inherited from class org.jline.utils.AnsiWriter
  ATTRIBUTE_BLINK_FAST, ATTRIBUTE_BLINK_OFF, ATTRIBUTE_BLINK_SLOW, ATTRIBUTE_CONCEAL_OFF, ATTRIBUTE_CONCEAL_ON, ATTRIBUTE_INTENSITY_BOLD, ATTRIBUTE_INTENSITY_FAINT, ATTRIBUTE_INTENSITY_NORMAL, ATTRIBUTE_ITALIC, ATTRIBUTE_NEGATIVE_Off, ATTRIBUTE_NEGATIVE_OFF, ATTRIBUTE_NEGATIVE_ON, ATTRIBUTE_UNDERLINE, ATTRIBUTE_UNDERLINE_DOUBLE, ATTRIBUTE_UNDERLINE_OFF, BLACK, BLUE, CYAN, ERASE_LINE, ERASE_LINE_TO_BEGINING, ERASE_LINE_TO_END, ERASE_SCREEN, ERASE_SCREEN_TO_BEGINING, ERASE_SCREEN_TO_END, GREEN, MAGENTA, RED, WHITE, YELLOW
- Fields inherited from class java.io.FilterWriter
  out
- Fields inherited from class java.io.Writer
  lock

Constructor Summary

Constructors
Constructor Description

WindowsAnsiWriter(Writer out, com.sun.jna.Pointer console)

Constructors
Constructor	Description
`WindowsAnsiWriter(Writer out, com.sun.jna.Pointer console)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`processAttributeRest()`	process `SGR 0` corresponding to `Reset / Normal`
`protected void`	`processChangeWindowTitle(String label)`	process `OSC 2;text BEL` corresponding to `Change Window title`
`protected void`	`processCursorDown(int count)`	process `CSI n B` corresponding to `CUD – Cursor Down`
`protected void`	`processCursorDownLine(int count)`	process `CSI n E` corresponding to `CNL – Cursor Next Line`
`protected void`	`processCursorLeft(int count)`	process `CSI n D` corresponding to `CUB – Cursor Back`
`protected void`	`processCursorRight(int count)`	process `CSI n C` corresponding to `CUF – Cursor Forward`
`protected void`	`processCursorTo(int row, int col)`	process `CSI n ; m H` corresponding to `CUP – Cursor Position` or `CSI n ; m f` corresponding to `HVP – Horizontal and Vertical Position`
`protected void`	`processCursorToColumn(int x)`	process `CSI n G` corresponding to `CHA – Cursor Horizontal Absolute`
`protected void`	`processCursorUp(int count)`	process `CSI n A` corresponding to `CUU – Cursor Up`
`protected void`	`processCursorUpLine(int count)`	process `CSI n F` corresponding to `CPL – Cursor Previous Line`
`protected void`	`processDefaultBackgroundColor()`	process `SGR 49` corresponding to `Default background color`
`protected void`	`processDefaultTextColor()`	process `SGR 39` corresponding to `Default text color (foreground)`
`protected void`	`processDeleteLine(int optionInt)`	Process `CSI s` ANSI code, corresponding to `DL – Delete Line`
`protected void`	`processEraseLine(int eraseOption)`	Process `CSI n K` ANSI code, corresponding to `ED – Erase in Line`
`protected void`	`processEraseScreen(int eraseOption)`	Process `CSI n J` ANSI code, corresponding to `ED – Erase in Display`
`protected void`	`processInsertLine(int optionInt)`	Process `CSI s` ANSI code, corresponding to `IL – Insert Line`
`protected void`	`processRestoreCursorPosition()`	Process `CSI u` ANSI code, corresponding to `RCP – Restore Cursor Position`
`protected void`	`processSaveCursorPosition()`	Process `CSI s` ANSI code, corresponding to `SCP – Save Cursor Position`
`protected void`	`processSetAttribute(int attribute)`	process `SGR` other than `0` (reset), `30-39` (foreground), `40-49` (background), `90-97` (foreground high intensity) or `100-107` (background high intensity)
`protected void`	`processSetBackgroundColorExt(int paletteIndex)`	process `SGR 48` corresponding to `extended set background color` with a palette of 255 colors.
`protected void`	`processSetForegroundColorExt(int paletteIndex)`	process `SGR 38` corresponding to `extended set text color (foreground)` with a palette of 255 colors.

Methods inherited from class org.jline.utils.AnsiWriter
close, processChangeIconName, processChangeIconNameAndWindowTitle, processCharsetSelect, processScrollDown, processScrollUp, processSetBackgroundColor, processSetBackgroundColor, processSetBackgroundColorExt, processSetForegroundColor, processSetForegroundColor, processSetForegroundColorExt, processUnknownExtension, processUnknownOperatingSystemCommand, write, write, write

Methods inherited from class java.io.FilterWriter
flush

Methods inherited from class java.io.Writer
append, append, append, nullWriter, write, write

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

- Constructor Detail
  - WindowsAnsiWriter
```
public WindowsAnsiWriter(Writer out,
                         com.sun.jna.Pointer console)
                  throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - processEraseScreen
```
protected void processEraseScreen(int eraseOption)
                           throws IOException
```
    Description copied from class: AnsiWriter
    
    Process CSI n J ANSI code, corresponding to ED – Erase in Display
    
    Overrides:
    
    processEraseScreen in class AnsiWriter
    
    Parameters:
    
    eraseOption - the erase option
    
    Throws:
    
    IOException - if an error occurs
  - processEraseLine
```
protected void processEraseLine(int eraseOption)
                         throws IOException
```
    Description copied from class: AnsiWriter
    
    Process CSI n K ANSI code, corresponding to ED – Erase in Line
    
    Overrides:
    
    processEraseLine in class AnsiWriter
    
    Parameters:
    
    eraseOption - the erase option
    
    Throws:
    
    IOException - if an error occurs
  - processCursorUpLine
```
protected void processCursorUpLine(int count)
                            throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n F corresponding to CPL – Cursor Previous Line
    
    Overrides:
    
    processCursorUpLine in class AnsiWriter
    
    Parameters:
    
    count - line count
    
    Throws:
    
    IOException - if an error occurs
  - processCursorDownLine
```
protected void processCursorDownLine(int count)
                              throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n E corresponding to CNL – Cursor Next Line
    
    Overrides:
    
    processCursorDownLine in class AnsiWriter
    
    Parameters:
    
    count - line count
    
    Throws:
    
    IOException - if an error occurs
  - processCursorLeft
```
protected void processCursorLeft(int count)
                          throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n D corresponding to CUB – Cursor Back
    
    Overrides:
    
    processCursorLeft in class AnsiWriter
    
    Parameters:
    
    count - the count
    
    Throws:
    
    IOException - if an error occurs
  - processCursorRight
```
protected void processCursorRight(int count)
                           throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n C corresponding to CUF – Cursor Forward
    
    Overrides:
    
    processCursorRight in class AnsiWriter
    
    Parameters:
    
    count - the count
    
    Throws:
    
    IOException - if an error occurs
  - processCursorDown
```
protected void processCursorDown(int count)
                          throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n B corresponding to CUD – Cursor Down
    
    Overrides:
    
    processCursorDown in class AnsiWriter
    
    Parameters:
    
    count - the count
    
    Throws:
    
    IOException - if an error occurs
  - processCursorUp
```
protected void processCursorUp(int count)
                        throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n A corresponding to CUU – Cursor Up
    
    Overrides:
    
    processCursorUp in class AnsiWriter
    
    Parameters:
    
    count - the count
    
    Throws:
    
    IOException - if an error occurs
  - processCursorTo
```
protected void processCursorTo(int row,
                               int col)
                        throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n ; m H corresponding to CUP – Cursor Position or CSI n ; m f corresponding to HVP – Horizontal and Vertical Position
    
    Overrides:
    
    processCursorTo in class AnsiWriter
    
    Parameters:
    
    row - the row
    
    col - the column
    
    Throws:
    
    IOException - if an error occurs
  - processCursorToColumn
```
protected void processCursorToColumn(int x)
                              throws IOException
```
    Description copied from class: AnsiWriter
    
    process CSI n G corresponding to CHA – Cursor Horizontal Absolute
    
    Overrides:
    
    processCursorToColumn in class AnsiWriter
    
    Parameters:
    
    x - the column
    
    Throws:
    
    IOException - if an error occurs
  - processSetForegroundColorExt
```
protected void processSetForegroundColorExt(int paletteIndex)
                                     throws IOException
```
    Description copied from class: AnsiWriter
    
    process SGR 38 corresponding to extended set text color (foreground) with a palette of 255 colors.
    
    Overrides:
    
    processSetForegroundColorExt in class AnsiWriter
    
    Parameters:
    
    paletteIndex - the text color in the palette
    
    Throws:
    
    IOException - if an error occurs
  - processSetBackgroundColorExt
```
protected void processSetBackgroundColorExt(int paletteIndex)
                                     throws IOException
```
    Description copied from class: AnsiWriter
    
    process SGR 48 corresponding to extended set background color with a palette of 255 colors.
    
    Overrides:
    
    processSetBackgroundColorExt in class AnsiWriter
    
    Parameters:
    
    paletteIndex - the background color in the palette
    
    Throws:
    
    IOException - if an error occurs
  - processDefaultTextColor
```
protected void processDefaultTextColor()
                                throws IOException
```
    Description copied from class: AnsiWriter
    
    process SGR 39 corresponding to Default text color (foreground)
    
    Overrides:
    
    processDefaultTextColor in class AnsiWriter
    
    Throws:
    
    IOException - if an error occurs
  - processDefaultBackgroundColor
```
protected void processDefaultBackgroundColor()
                                      throws IOException
```
    Description copied from class: AnsiWriter
    
    process SGR 49 corresponding to Default background color
    
    Overrides:
    
    processDefaultBackgroundColor in class AnsiWriter
    
    Throws:
    
    IOException - if an error occurs
  - processAttributeRest
```
protected void processAttributeRest()
                             throws IOException
```
    Description copied from class: AnsiWriter
    
    process SGR 0 corresponding to Reset / Normal
    
    Overrides:
    
    processAttributeRest in class AnsiWriter
    
    Throws:
    
    IOException - if an error occurs
  - processSetAttribute
```
protected void processSetAttribute(int attribute)
                            throws IOException
```
    Description copied from class: AnsiWriter
    
    process SGR other than 0 (reset), 30-39 (foreground), 40-49 (background), 90-97 (foreground high intensity) or 100-107 (background high intensity)
    
    Overrides:
    
    processSetAttribute in class AnsiWriter
    
    Parameters:
    
    attribute - the attribute to set
    
    Throws:
    
    IOException - if an error occurs
    
    See Also:
    
    AnsiWriter.processAttributeRest(), AnsiWriter.processSetForegroundColor(int), AnsiWriter.processSetForegroundColor(int, boolean), AnsiWriter.processSetForegroundColorExt(int), AnsiWriter.processSetForegroundColorExt(int, int, int), AnsiWriter.processDefaultTextColor(), AnsiWriter.processDefaultBackgroundColor()
  - processSaveCursorPosition
```
protected void processSaveCursorPosition()
                                  throws IOException
```
    Description copied from class: AnsiWriter
    
    Process CSI s ANSI code, corresponding to SCP – Save Cursor Position
    
    Overrides:
    
    processSaveCursorPosition in class AnsiWriter
    
    Throws:
    
    IOException - if an error occurs
  - processRestoreCursorPosition
```
protected void processRestoreCursorPosition()
                                     throws IOException
```
    Description copied from class: AnsiWriter
    
    Process CSI u ANSI code, corresponding to RCP – Restore Cursor Position
    
    Overrides:
    
    processRestoreCursorPosition in class AnsiWriter
    
    Throws:
    
    IOException - if an error occurs
  - processInsertLine
```
protected void processInsertLine(int optionInt)
                          throws IOException
```
    Description copied from class: AnsiWriter
    
    Process CSI s ANSI code, corresponding to IL – Insert Line
    
    Overrides:
    
    processInsertLine in class AnsiWriter
    
    Parameters:
    
    optionInt - the option
    
    Throws:
    
    IOException - if an error occurs
  - processDeleteLine
```
protected void processDeleteLine(int optionInt)
                          throws IOException
```
    Description copied from class: AnsiWriter
    
    Process CSI s ANSI code, corresponding to DL – Delete Line
    
    Overrides:
    
    processDeleteLine in class AnsiWriter
    
    Parameters:
    
    optionInt - the option
    
    Throws:
    
    IOException - if an error occurs
  - processChangeWindowTitle
```
protected void processChangeWindowTitle(String label)
```
    Description copied from class: AnsiWriter
    
    process OSC 2;text BEL corresponding to Change Window title
    
    Overrides:
    
    processChangeWindowTitle in class AnsiWriter
    
    Parameters:
    
    label - the title

Class WindowsAnsiWriter

Field Summary

Fields inherited from class org.jline.utils.AnsiWriter

Fields inherited from class java.io.FilterWriter

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

Methods inherited from class org.jline.utils.AnsiWriter

Methods inherited from class java.io.FilterWriter

Methods inherited from class java.io.Writer

Methods inherited from class java.lang.Object

Constructor Detail

WindowsAnsiWriter

Method Detail

processEraseScreen

processEraseLine

processCursorUpLine

processCursorDownLine

processCursorLeft

processCursorRight

processCursorDown

processCursorUp

processCursorTo

processCursorToColumn

processSetForegroundColorExt

processSetBackgroundColorExt

processDefaultTextColor

processDefaultBackgroundColor

processAttributeRest

processSetAttribute

processSaveCursorPosition

processRestoreCursorPosition

processInsertLine

processDeleteLine

processChangeWindowTitle