org.crsh.term.spi

Interface TermIO

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

public interface TermIO
extends java.io.Closeable

Method Summary

Methods

Modifier and Type	Method and Description
void	cls() Clear screen.
CodeType	decode(int code) Decode the intput value.
void	flush() Flush output.
int	getHeight() Returns the term height in chars.
java.lang.String	getProperty(java.lang.String name) Retrieves the value of a property specified by this TermIO
int	getWidth() Returns the term width in chars.
boolean	moveLeft() Move the cursor left.
boolean	moveRight(char c) Move the cursor right.
int	read() Reads an input value.
boolean	releaseAlternateBuffer() Release control of the alternate buffer.
boolean	takeAlternateBuffer() Take control of the alternate buffer.
void	write(char c) Write a char.
void	write(java.lang.CharSequence s) Write a string.
void	write(Style d) Write a style.
void	writeCRLF() Write a CRLF.
void	writeDel() Delete the char under the cursor.

Methods inherited from interface java.io.Closeable

close

Method Detail

read

int read()
         throws java.io.IOException

Reads an input value.

Returns:

the value read

Throws:

java.io.IOException - any io exception

getWidth

int getWidth()

Returns the term width in chars. When the value is not positive it means the value could not be determined.

Returns:

the term width

getHeight

int getHeight()

Returns the term height in chars. When the value is not positive it means the value could not be determined.

Returns:

the term height

getProperty

java.lang.String getProperty(java.lang.String name)

Retrieves the value of a property specified by this TermIO

Parameters:

name - the name of the property

Returns:

value of the property

takeAlternateBuffer

boolean takeAlternateBuffer()
                            throws java.io.IOException

Take control of the alternate buffer. When the alternate buffer is already used nothing happens. The buffer switch should occur when then flush() method is invoked.

Returns:

true if the alternate buffer is shown

Throws:

java.io.IOException

releaseAlternateBuffer

boolean releaseAlternateBuffer()
                               throws java.io.IOException

Release control of the alternate buffer. When the normal buffer is already used nothing happens. The buffer switch should occur when then flush() method is invoked.

Returns:

true if the usual buffer is shown

Throws:

java.io.IOException

decode

CodeType decode(int code)

Decode the intput value.

Parameters:

code - the code

Returns:

the input value type

flush

void flush()
           throws java.io.IOException

Flush output.

Throws:

java.io.IOException - any io exception

write

void write(java.lang.CharSequence s)
           throws java.io.IOException

Write a string.

Parameters:

s - the string to write

Throws:

java.io.IOException - any io exception

write

void write(char c)
           throws java.io.IOException

Write a char.

Parameters:

c - the char to write

Throws:

java.io.IOException - any io exception

write

void write(Style d)
           throws java.io.IOException

Write a style.

Parameters:

d - the data to write

Throws:

java.io.IOException - any io exception

writeDel

void writeDel()
              throws java.io.IOException

Delete the char under the cursor.

Throws:

java.io.IOException - any io exception

writeCRLF

void writeCRLF()
               throws java.io.IOException

Write a CRLF.

Throws:

java.io.IOException - any io exception

cls

void cls()
         throws java.io.IOException

Clear screen.

Throws:

java.io.IOException - any io exception

moveRight

boolean moveRight(char c)
                  throws java.io.IOException

Move the cursor right.

Parameters:

c - the char skipped over

Returns:

true if the cursor moved.

Throws:

java.io.IOException - any io exception

moveLeft

boolean moveLeft()
                 throws java.io.IOException

Move the cursor left.

Returns:

true if the cursor moved

Throws:

java.io.IOException - any io exception