Terminal (nvt4j 1.2.0 API)

All Known Implementing Classes:

TerminalImpl
```
public interface Terminal
```
This interface is used by the application to read characters from- and to send characters to, the terminal emulator.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the screen.
`void`	`close()` Closes the terminal.
`void`	`flush()` Sends all characters in the buffer (if any) to the terminal.
`int`	`get()` Returns the next character sent by the terminal, or -1 if the stream is closed.
`int`	`get(byte[] buf)` Reads some characters from the terminal and writes them to buffer 'buf' starting from position 0, and returns the number of characters read, or -1 if the stream is closed.
`int`	`get(byte[] buf, int off, int len)` Reads up to 'len' characters from the terminal and writes them to buffer 'buf' starting from position 'off', and returns the number of characters read, or -1 if the stream is closed.
`int`	`getColumns()` Returns the number of columns in the terminal emulator window.
`int`	`getRows()` Returns the number of rows in the terminal emulator window.
`void`	`move(int row, int column)` Sends the terminal emulator a command to move the cursor to the given row and column.
`void`	`put(byte c)` Writes one character to the terminal.
`void`	`put(byte[] buf)` Writes buffer 'buf' to the terminal.
`void`	`put(byte[] buf, int off, int len)` Writes 'len' characters to the terminal, starting from position 'off'.
`void`	`put(char c)` Writes one character to the terminal.
`void`	`put(int c)` Writes one character to the terminal.
`void`	`put(int row, int column, byte c)` Moves the cursor and writes one character to the terminal.
`void`	`put(int row, int column, byte[] buf)` Moves the cursor and writes buffer 'buf' to the terminal.
`void`	`put(int row, int column, byte[] buf, int off, int len)` Moves the cursor and writes 'len' characters to the terminal, starting from position 'off'.
`void`	`put(int row, int column, char c)` Moves the cursor and writes one character to the terminal.
`void`	`put(int row, int column, int c)` Moves the cursor and writes one character to the terminal.
`void`	`put(int row, int column, String s)` Moves the cursor and writes a string to the terminal.
`void`	`put(String s)` Writes a string to the terminal.
`void`	`setCursor(boolean on)` Turns the terminal emulator's cursor on or off.

- Method Detail
  - setCursor
```
void setCursor(boolean on)
               throws IOException
```
    Turns the terminal emulator's cursor on or off.
    
    Throws:
    
    IOException
  - clear
```
void clear()
           throws IOException
```
    Clears the screen.
    
    Throws:
    
    IOException
  - getRows
```
int getRows()
```
    Returns the number of rows in the terminal emulator window. If the window is resized this value is updated accordingly.
  - getColumns
```
int getColumns()
```
    Returns the number of columns in the terminal emulator window. If the window is resized this value is updated accordingly.
  - get
```
int get()
        throws IOException
```
    Returns the next character sent by the terminal, or -1 if the stream is closed. The terminal is in 'raw' mode, not line-buffered mode. This method blocks until a character is available.
    
    Throws:
    
    IOException
  - get
```
int get(byte[] buf)
        throws IOException
```
    Reads some characters from the terminal and writes them to buffer 'buf' starting from position 0, and returns the number of characters read, or -1 if the stream is closed. This method blocks until a character is available. The terminal is in 'raw' mode, not line-buffered mode.
    
    Throws:
    
    IOException
  - get
```
int get(byte[] buf,
      int off,
      int len)
        throws IOException
```
    Reads up to 'len' characters from the terminal and writes them to buffer 'buf' starting from position 'off', and returns the number of characters read, or -1 if the stream is closed. This method blocks until a character is available. The terminal is in 'raw' mode, not line-buffered mode.
    
    Throws:
    
    IOException
  - put
```
void put(byte[] buf,
       int off,
       int len)
         throws IOException
```
    Writes 'len' characters to the terminal, starting from position 'off'.
    
    Throws:
    
    IOException
  - put
```
void put(byte[] buf)
         throws IOException
```
    Writes buffer 'buf' to the terminal.
    
    Throws:
    
    IOException
  - put
```
void put(String s)
         throws IOException
```
    Writes a string to the terminal. The characters are extracted from the string using the method String.getBytes(), which translates each (2-byte) unicode character to a byte.
    
    Throws:
    
    IllegalArgumentException - if the end of string would be outside the window
    
    IOException
  - put
```
void put(int c)
         throws IOException
```
    Writes one character to the terminal. The int is converted into a byte by casting.
    
    Throws:
    
    IOException
  - put
```
void put(char c)
         throws IOException
```
    Writes one character to the terminal. The char is converted into a byte by casting.
    
    Throws:
    
    IOException
  - put
```
void put(byte c)
         throws IOException
```
    Writes one character to the terminal.
    
    Throws:
    
    IOException
  - put
```
void put(int row,
       int column,
       byte[] buf,
       int off,
       int len)
         throws IOException
```
    Moves the cursor and writes 'len' characters to the terminal, starting from position 'off'.
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IOException
  - put
```
void put(int row,
       int column,
       byte[] buf)
         throws IOException
```
    Moves the cursor and writes buffer 'buf' to the terminal.
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IOException
  - put
```
void put(int row,
       int column,
       String s)
         throws IOException
```
    Moves the cursor and writes a string to the terminal. The characters are extracted from the string using the method String.getBytes(), which translates each (2-byte) unicode character to a byte.
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IllegalArgumentException - if the end of string would be outside the window
    
    IOException
  - put
```
void put(int row,
       int column,
       int c)
         throws IOException
```
    Moves the cursor and writes one character to the terminal. The int is converted into a byte by casting.
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IOException
  - put
```
void put(int row,
       int column,
       char c)
         throws IOException
```
    Moves the cursor and writes one character to the terminal. The char is converted into a byte by casting.
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IOException
  - put
```
void put(int row,
       int column,
       byte c)
         throws IOException
```
    Moves the cursor and writes one character to the terminal.
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IOException
  - flush
```
void flush()
           throws IOException
```
    Sends all characters in the buffer (if any) to the terminal.
    
    Throws:
    
    IOException
  - move
```
void move(int row,
        int column)
          throws IOException
```
    Sends the terminal emulator a command to move the cursor to the given row and column. The row must be between 1 and the value of getRows(), while the column must be between 1 and the value of getColumn().
    
    Throws:
    
    IllegalArgumentException - if the coordinates are out of range
    
    IOException
  - close
```
void close()
           throws IOException
```
    Closes the terminal.
    
    Throws:
    
    IOException

Interface Terminal

Method Summary

Method Detail

setCursor

clear

getRows

getColumns

get

get

get

put

put

put

put

put

put

put

put

put

put

put

put

flush

move

close