io.vertx.ext.shell.term

Interface Tty

All Known Subinterfaces:

CommandProcess, Term

public interface Tty

Provide interactions with the Shell TTY.

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
int	height()
Tty	resizehandler(Handler<Void> handler) Set a resize handler, the handler is called when the tty size changes.
Tty	stdinHandler(Handler<String> handler) Set a stream handler on the standard input to read the data.
String	type()
int	width()
Tty	write(String data) Write data to the standard output.

Method Detail

type

String type()

Returns:

the declared tty type, for instance vt100, xterm-256, etc... it can be null when the tty does not have declared its type.

width

int width()

Returns:

the current width, i.e the number of rows or -1 if unknown

height

int height()

Returns:

the current height, i.e the number of columns or -1 if unknown

stdinHandler

Tty stdinHandler(Handler<String> handler)

Set a stream handler on the standard input to read the data.

Parameters:

handler - the standard input

Returns:

this object

write

Tty write(String data)

Write data to the standard output.

Parameters:

data - the data to write

Returns:

this object

resizehandler

Tty resizehandler(Handler<Void> handler)

Set a resize handler, the handler is called when the tty size changes.

Parameters:

handler - the resize handler

Returns:

this object