AnsiTerminal

java.lang.Object
- net.rubygrapefruit.platform.internal.AbstractTerminal
- - net.rubygrapefruit.platform.internal.AnsiTerminal

All Implemented Interfaces:: TerminalOutput

public class AnsiTerminal
extends AbstractTerminal

Nested Class Summary
- Nested classes/interfaces inherited from interface net.rubygrapefruit.platform.terminal.TerminalOutput
  TerminalOutput.Color

Field Summary
- Fields inherited from class net.rubygrapefruit.platform.internal.AbstractTerminal
  NEW_LINE

Constructor Summary

Constructors
Constructor and Description

AnsiTerminal(java.io.OutputStream outputStream, Terminals.Output output)

Constructors
Constructor and Description
`AnsiTerminal(java.io.OutputStream outputStream, Terminals.Output output)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TerminalOutput`	`bold()` Switches the terminal to bold text mode, if supported.
`TerminalOutput`	`bright()` Switches the terminal to high intensity, if supported.
`TerminalOutput`	`clearToEndOfLine()` Clears characters from the cursor position to the end of the current line.
`TerminalOutput`	`cursorDown(int count)` Moves the cursor the given number of characters down.
`TerminalOutput`	`cursorLeft(int count)` Moves the cursor the given number of characters to the left.
`TerminalOutput`	`cursorRight(int count)` Moves the cursor the given number of characters to the right.
`TerminalOutput`	`cursorStartOfLine()` Moves the cursor to the start of the current line.
`TerminalOutput`	`cursorUp(int count)` Moves the cursor the given number of characters up.
`TerminalOutput`	`defaultForeground()` Sets the terminal foreground color to the default, if supported.
`TerminalOutput`	`dim()` Switches the terminal to dim intensity, if supported.
`TerminalOutput`	`foreground(TerminalOutput.Color color)` Sets the terminal foreground color, if supported.
`java.io.OutputStream`	`getOutputStream()` Returns an `OutputStream` that writes to this terminal.
`TerminalSize`	`getTerminalSize()` Returns the size of the terminal.
`TerminalOutput`	`hideCursor()` Hides the cursor.
`protected void`	`init()`
`TerminalOutput`	`normal()` Switches the terminal to normal text mode.
`TerminalOutput`	`reset()` Resets this terminal.
`TerminalOutput`	`showCursor()` Shows the cursor, if hidden.
`boolean`	`supportsColor()` Returns true if this terminal supports setting output colors.
`boolean`	`supportsCursorMotion()` Returns true if this terminal supports moving the cursor.
`boolean`	`supportsCursorVisibility()` Returns true if this terminal supports hiding the cursor.
`boolean`	`supportsTextAttributes()` Returns true if this terminal supports setting text attributes, such as bold.
`java.lang.String`	`toString()`

Methods inherited from class net.rubygrapefruit.platform.internal.AbstractTerminal
newline, write, write, write

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

- Constructor Detail
  - AnsiTerminal
```
public AnsiTerminal(java.io.OutputStream outputStream,
                    Terminals.Output output)
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - init
```
protected void init()
```
    Specified by:
    
    init in class AbstractTerminal
  - supportsTextAttributes
```
public boolean supportsTextAttributes()
```
    Description copied from interface: TerminalOutput
    
    Returns true if this terminal supports setting text attributes, such as bold.
  - supportsColor
```
public boolean supportsColor()
```
    Description copied from interface: TerminalOutput
    
    Returns true if this terminal supports setting output colors.
  - supportsCursorMotion
```
public boolean supportsCursorMotion()
```
    Description copied from interface: TerminalOutput
    
    Returns true if this terminal supports moving the cursor.
  - supportsCursorVisibility
```
public boolean supportsCursorVisibility()
```
    Description copied from interface: TerminalOutput
    
    Returns true if this terminal supports hiding the cursor.
  - getTerminalSize
```
public TerminalSize getTerminalSize()
                             throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Returns the size of the terminal. Supported by all terminals.
    
    Returns:
    
    The current terminal size. Never returns null.
    
    Throws:
    
    NativeException - On failure.
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
```
    Description copied from interface: TerminalOutput
    
    Returns an OutputStream that writes to this terminal. The output stream is not buffered.
  - foreground
```
public TerminalOutput foreground(TerminalOutput.Color color)
                          throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Sets the terminal foreground color, if supported. Does nothing if this terminal does not support setting the foreground color.
    
    Throws:
    
    NativeException - On failure.
  - defaultForeground
```
public TerminalOutput defaultForeground()
                                 throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Sets the terminal foreground color to the default, if supported. Does nothing if this terminal does not support setting the foreground color.
    
    Throws:
    
    NativeException - On failure.
  - bright
```
public TerminalOutput bright()
                      throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Switches the terminal to high intensity, if supported. Does nothing if this terminal does not support bright mode.
    
    Throws:
    
    NativeException - On failure.
  - dim
```
public TerminalOutput dim()
                   throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Switches the terminal to dim intensity, if supported. Does nothing if this terminal does not support dim mode.
    
    Throws:
    
    NativeException - On failure.
  - bold
```
public TerminalOutput bold()
                    throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Switches the terminal to bold text mode, if supported. Does nothing if this terminal does not support bold mode.
    Often the same as TerminalOutput.bright().
    
    Throws:
    
    NativeException - On failure.
  - normal
```
public TerminalOutput normal()
                      throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Switches the terminal to normal text mode. Switches off bold text mode and sets normal intensity. Supported by all terminals.
    
    Throws:
    
    NativeException - On failure.
  - reset
```
public TerminalOutput reset()
                     throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Resets this terminal. Switches to normal text mode, restores default foreground color and shows the cursor. Supported by all terminals.
    
    Throws:
    
    NativeException - On failure.
  - hideCursor
```
public TerminalOutput hideCursor()
                          throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Hides the cursor. Does nothing if this terminal does not support hiding the cursor.
    
    Throws:
    
    NativeException - On failure.
  - showCursor
```
public TerminalOutput showCursor()
                          throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Shows the cursor, if hidden. Supported by all terminals.
    
    Throws:
    
    NativeException - On failure.
  - cursorLeft
```
public TerminalOutput cursorLeft(int count)
                          throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Moves the cursor the given number of characters to the left.
    
    Throws:
    
    NativeException - On failure, or if this terminal does not support cursor motion.
  - cursorRight
```
public TerminalOutput cursorRight(int count)
                           throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Moves the cursor the given number of characters to the right.
    
    Throws:
    
    NativeException - On failure, or if this terminal does not support cursor motion.
  - cursorUp
```
public TerminalOutput cursorUp(int count)
                        throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Moves the cursor the given number of characters up.
    
    Throws:
    
    NativeException - On failure, or if this terminal does not support cursor motion.
  - cursorDown
```
public TerminalOutput cursorDown(int count)
                          throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Moves the cursor the given number of characters down.
    
    Throws:
    
    NativeException - On failure, or if this terminal does not support cursor motion.
  - cursorStartOfLine
```
public TerminalOutput cursorStartOfLine()
                                 throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Moves the cursor to the start of the current line.
    
    Throws:
    
    NativeException - On failure, or if this terminal does not support cursor motion.
  - clearToEndOfLine
```
public TerminalOutput clearToEndOfLine()
                                throws NativeException
```
    Description copied from interface: TerminalOutput
    
    Clears characters from the cursor position to the end of the current line.
    
    Throws:
    
    NativeException - On failure, or if this terminal does not support clearing.

Class AnsiTerminal

Nested Class Summary

Nested classes/interfaces inherited from interface net.rubygrapefruit.platform.terminal.TerminalOutput

Field Summary

Fields inherited from class net.rubygrapefruit.platform.internal.AbstractTerminal

Constructor Summary

Method Summary

Methods inherited from class net.rubygrapefruit.platform.internal.AbstractTerminal

Methods inherited from class java.lang.Object

Constructor Detail

AnsiTerminal

Method Detail

toString

init

supportsTextAttributes

supportsColor

supportsCursorMotion

supportsCursorVisibility

getTerminalSize

getOutputStream

foreground

defaultForeground

bright

dim

bold

normal

reset

hideCursor

showCursor

cursorLeft

cursorRight

cursorUp

cursorDown

cursorStartOfLine

clearToEndOfLine