com.wrq.vhi.script.api

Interface TerminalRegion

All Known Subinterfaces:

LinearTerminalRegion, RectangularTerminalRegion

public interface TerminalRegion

Provides information about a region of the terminal screen.

Method Summary

Modifier and Type	Method and Description
int	getLength() Gets the number of characters contained within the region.
TerminalCell	getTerminalCell(int offset) Gets additional information about a single character within this screen region as a separate immutable object.
java.lang.String	getText() Gets the text contents of the region.

Method Detail

getLength

int getLength()

Gets the number of characters contained within the region.

Returns:

the number of characters in the region

getText

java.lang.String getText()

Gets the text contents of the region.

Returns:

the text contents

getTerminalCell

TerminalCell getTerminalCell(int offset)

Gets additional information about a single character within this screen region as a separate immutable object.

Parameters:

offset - zero-based offset of character from the start of the region

Returns:

TerminalCell object defining terminal screen information for this character

Throws:

java.lang.IllegalArgumentException - if the offset is invalid