WindowsAnsiOutputStream (JLine JNA Terminal 3.3.1 API)

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
  - - org.jline.terminal.impl.jna.win.AnsiOutputStream
    - - org.jline.terminal.impl.jna.win.WindowsAnsiOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable
```
public final class WindowsAnsiOutputStream
extends AnsiOutputStream
```
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.terminal.impl.jna.win.AnsiOutputStream
  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, RESET_CODE, REST_CODE, WHITE, YELLOW
- Fields inherited from class java.io.FilterOutputStream
  out

Constructor Summary

Constructors
Constructor and Description

WindowsAnsiOutputStream(OutputStream os, com.sun.jna.Pointer console)

Constructors
Constructor and Description
`WindowsAnsiOutputStream(OutputStream os, com.sun.jna.Pointer console)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`processSetBackgroundColor(int color, boolean bright)` process `SGR 40-47` or `SGR 100-107` corresponding to `Set background color` either in normal mode or high intensity.
`protected void`	`processSetForegroundColor(int color, boolean bright)` process `SGR 30-37` or `SGR 90-97` corresponding to `Set text color (foreground)` either in normal mode or high intensity.

Methods inherited from class org.jline.terminal.impl.jna.win.AnsiOutputStream
close, processChangeIconName, processChangeIconNameAndWindowTitle, processScrollDown, processScrollUp, processSetBackgroundColor, processSetBackgroundColorExt, processSetBackgroundColorExt, processSetForegroundColor, processSetForegroundColorExt, processSetForegroundColorExt, processUnknownExtension, processUnknownOperatingSystemCommand, write

Methods inherited from class java.io.FilterOutputStream
flush, write, write

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

- Constructor Detail
  - WindowsAnsiOutputStream
```
public WindowsAnsiOutputStream(OutputStream os,
                               com.sun.jna.Pointer console)
                        throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - processDefaultTextColor
```
protected void processDefaultTextColor()
                                throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process SGR 39 corresponding to Default text color (foreground)
    
    Overrides:
    
    processDefaultTextColor in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processDefaultBackgroundColor
```
protected void processDefaultBackgroundColor()
                                      throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process SGR 49 corresponding to Default background color
    
    Overrides:
    
    processDefaultBackgroundColor in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processEraseScreen
```
protected void processEraseScreen(int eraseOption)
                           throws IOException
```
    Description copied from class: AnsiOutputStream
    
    Process CSI n J ANSI code, corresponding to ED – Erase in Display
    
    Overrides:
    
    processEraseScreen in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processEraseLine
```
protected void processEraseLine(int eraseOption)
                         throws IOException
```
    Description copied from class: AnsiOutputStream
    
    Process CSI n K ANSI code, corresponding to ED – Erase in Line
    
    Overrides:
    
    processEraseLine in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processCursorUpLine
```
protected void processCursorUpLine(int count)
                            throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n F corresponding to CPL – Cursor Previous Line
    
    Overrides:
    
    processCursorUpLine in class AnsiOutputStream
    
    Parameters:
    
    count - line count
    
    Throws:
    
    IOException
  - processCursorDownLine
```
protected void processCursorDownLine(int count)
                              throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n E corresponding to CNL – Cursor Next Line
    
    Overrides:
    
    processCursorDownLine in class AnsiOutputStream
    
    Parameters:
    
    count - line count
    
    Throws:
    
    IOException
  - processCursorLeft
```
protected void processCursorLeft(int count)
                          throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n D corresponding to CUB – Cursor Back
    
    Overrides:
    
    processCursorLeft in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processCursorRight
```
protected void processCursorRight(int count)
                           throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n C corresponding to CUF – Cursor Forward
    
    Overrides:
    
    processCursorRight in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processCursorDown
```
protected void processCursorDown(int count)
                          throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n B corresponding to CUD – Cursor Down
    
    Overrides:
    
    processCursorDown in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processCursorUp
```
protected void processCursorUp(int count)
                        throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n A corresponding to CUU – Cursor Up
    
    Overrides:
    
    processCursorUp in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processCursorTo
```
protected void processCursorTo(int row,
                               int col)
                        throws IOException
```
    Description copied from class: AnsiOutputStream
    
    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 AnsiOutputStream
    
    Throws:
    
    IOException
  - processCursorToColumn
```
protected void processCursorToColumn(int x)
                              throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process CSI n G corresponding to CHA – Cursor Horizontal Absolute
    
    Overrides:
    
    processCursorToColumn in class AnsiOutputStream
    
    Parameters:
    
    x - the column
    
    Throws:
    
    IOException
  - processSetForegroundColor
```
protected void processSetForegroundColor(int color,
                                         boolean bright)
                                  throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process SGR 30-37 or SGR 90-97 corresponding to Set text color (foreground) either in normal mode or high intensity.
    
    Overrides:
    
    processSetForegroundColor in class AnsiOutputStream
    
    Parameters:
    
    color - the text color
    
    bright - is high intensity?
    
    Throws:
    
    IOException
  - processSetBackgroundColor
```
protected void processSetBackgroundColor(int color,
                                         boolean bright)
                                  throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process SGR 40-47 or SGR 100-107 corresponding to Set background color either in normal mode or high intensity.
    
    Overrides:
    
    processSetBackgroundColor in class AnsiOutputStream
    
    Parameters:
    
    color - the background color
    
    bright - is high intensity?
    
    Throws:
    
    IOException
  - processAttributeRest
```
protected void processAttributeRest()
                             throws IOException
```
    Description copied from class: AnsiOutputStream
    
    process SGR 0 corresponding to Reset / Normal
    
    Overrides:
    
    processAttributeRest in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processSetAttribute
```
protected void processSetAttribute(int attribute)
                            throws IOException
```
    Description copied from class: AnsiOutputStream
    
    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 AnsiOutputStream
    
    Throws:
    
    IOException
    
    See Also:
    
    AnsiOutputStream.processAttributeRest(), AnsiOutputStream.processSetForegroundColor(int), AnsiOutputStream.processSetForegroundColor(int, boolean), AnsiOutputStream.processSetForegroundColorExt(int), AnsiOutputStream.processSetForegroundColorExt(int, int, int), AnsiOutputStream.processDefaultTextColor(), AnsiOutputStream.processDefaultBackgroundColor()
  - processSaveCursorPosition
```
protected void processSaveCursorPosition()
                                  throws IOException
```
    Description copied from class: AnsiOutputStream
    
    Process CSI s ANSI code, corresponding to SCP – Save Cursor Position
    
    Overrides:
    
    processSaveCursorPosition in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processRestoreCursorPosition
```
protected void processRestoreCursorPosition()
                                     throws IOException
```
    Description copied from class: AnsiOutputStream
    
    Process CSI u ANSI code, corresponding to RCP – Restore Cursor Position
    
    Overrides:
    
    processRestoreCursorPosition in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processInsertLine
```
protected void processInsertLine(int optionInt)
                          throws IOException
```
    Description copied from class: AnsiOutputStream
    
    Process CSI s ANSI code, corresponding to IL – Insert Line
    
    Overrides:
    
    processInsertLine in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processDeleteLine
```
protected void processDeleteLine(int optionInt)
                          throws IOException
```
    Description copied from class: AnsiOutputStream
    
    Process CSI s ANSI code, corresponding to DL – Delete Line
    
    Overrides:
    
    processDeleteLine in class AnsiOutputStream
    
    Throws:
    
    IOException
  - processChangeWindowTitle
```
protected void processChangeWindowTitle(String label)
```
    Description copied from class: AnsiOutputStream
    
    process OSC 2;text BEL corresponding to Change Window title
    
    Overrides:
    
    processChangeWindowTitle in class AnsiOutputStream

Class WindowsAnsiOutputStream

Field Summary

Fields inherited from class org.jline.terminal.impl.jna.win.AnsiOutputStream

Fields inherited from class java.io.FilterOutputStream

Constructor Summary

Method Summary

Methods inherited from class org.jline.terminal.impl.jna.win.AnsiOutputStream

Methods inherited from class java.io.FilterOutputStream

Methods inherited from class java.lang.Object

Constructor Detail

WindowsAnsiOutputStream

Method Detail

processDefaultTextColor

processDefaultBackgroundColor

processEraseScreen

processEraseLine

processCursorUpLine

processCursorDownLine

processCursorLeft

processCursorRight

processCursorDown

processCursorUp

processCursorTo

processCursorToColumn

processSetForegroundColor

processSetBackgroundColor

processAttributeRest

processSetAttribute

processSaveCursorPosition

processRestoreCursorPosition

processInsertLine

processDeleteLine

processChangeWindowTitle