Package dev.galasa.zos3270.spi

Class Terminal

java.lang.Object

dev.galasa.zos3270.spi.Terminal

All Implemented Interfaces:

ITerminal

Direct Known Subclasses:

Zos3270TerminalImpl

public class Terminal
extends Object
implements ITerminal

Field Summary

Fields

Modifier and Type	Field	Description
ITextScannerManagerSpi	textScan

Constructor Summary

Constructors

Constructor	Description
Terminal(String id, String host, int port, boolean ssl, int primaryColumns, int primaryRows, int alternateColumns, int alternateRows, ITextScannerManagerSpi textScan)	Deprecated, for removal: This API element is subject to removal in a future version. use the Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage) constructor instead.
Terminal(String id, String host, int port, boolean ssl, ITextScannerManagerSpi textScan)	Deprecated, for removal: This API element is subject to removal in a future version. use the Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage) constructor instead.
Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage)
Terminal(String id, String host, int port, ITextScannerManagerSpi textScan)	Deprecated, for removal: This API element is subject to removal in a future version. use the Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage) constructor instead.

Method Summary

Modifier and Type	Method	Description
ITerminal	backSpace()
ITerminal	backTab()
ITerminal	clear()
void	connect()
ITerminal	cursorDown()
ITerminal	cursorLeft()
ITerminal	cursorRight()
ITerminal	cursorUp()
void	disconnect()
ITerminal	enter()
ITerminal	eraseEof()
ITerminal	eraseInput()
String	getHostPort()
String	getId()
Screen	getScreen()
ITerminal	home()
boolean	isClearScreen()
boolean	isConnected()
boolean	isSwitchedSSL()
boolean	isTextInField(String text)
boolean	isTextInField(String text, long timeoutInMilliseconds)
void	networkClosed()
ITerminal	newLine()
ITerminal	pa1()
ITerminal	pa2()
ITerminal	pa3()
ITerminal	pf1()
ITerminal	pf10()
ITerminal	pf11()
ITerminal	pf12()
ITerminal	pf13()
ITerminal	pf14()
ITerminal	pf15()
ITerminal	pf16()
ITerminal	pf17()
ITerminal	pf18()
ITerminal	pf19()
ITerminal	pf2()
ITerminal	pf20()
ITerminal	pf21()
ITerminal	pf22()
ITerminal	pf23()
ITerminal	pf24()
ITerminal	pf3()
ITerminal	pf4()
ITerminal	pf5()
ITerminal	pf6()
ITerminal	pf7()
ITerminal	pf8()
ITerminal	pf9()
ITerminal	positionCursorToFieldContaining(@NotNull String text)
void	registerDatastreamListener(IDatastreamListener listener)
ITerminal	reportExtendedScreen(boolean printCursor, boolean printColour, boolean printHighlight, boolean printIntensity, boolean printProtected, boolean printNumeric, boolean printModified)	Report to the log the current state of the terminal with optional extended datastream settings
ITerminal	reportScreen()	Temporary Print to console
ITerminal	reportScreenWithCursor()
Colour	retrieveColourAtCursor()	Return the colour of the character at the cursor position
Colour	retrieveColourAtPosition(int row, int col)	Return the colour of the character at the cursor position
String	retrieveFieldAtCursor()	Return a String of the contents of the current Field.
String	retrieveFieldTextAfterFieldWithString(String fieldName)	Returns a String of text in a Field with a given name.
Highlight	retrieveHighlightAtCursor()	Return the highlighting of the character at the cursor position
Highlight	retrieveHighlightAtPosition(int row, int col)	Return the highlighting of the character at the cursor position
String	retrieveScreen()	Returns the screen print out as a String.
String	retrieveText(int row, int col, int length)	Retrieve text from the screen.
String	retrieveTextAtCursor(int length)	Retrieve text from the screen.
boolean	searchText(String text)	Perform a search on a String to check whether or not it is on the terminal screen.
boolean	searchText(String text, int occurrences)	Perform a search on a String to check whether or not it is on the terminal screen.
boolean	searchText(String text, int occurrences, long milliTimeout)	Perform a search on a String to check whether or not it is on the terminal screen.
boolean	searchText(String text, long milliTimeout)	Perform a search on a String to check whether or not it is on the terminal screen.
void	setAutoReconnect(boolean newAutoReconnect)
void	setCursorPosition(int row, int col)	Set the position of the Cursor
void	setDeviceTypes(List<String> deviceTypes)
void	setDoStartTls(boolean doStartTls)
ITerminal	tab()
ITerminal	type(String text)
void	unregisterDatastreamListener(IDatastreamListener listener)
Terminal	verifyTextInField(String text)
ITerminal	waitForKeyboard()
ITerminal	waitForTextInField(String text)
int	waitForTextInField(String[] ok, String[] error)
int	waitForTextInField(String[] ok, String[] error, long timeoutInMilliseconds)
ITerminal	wfk()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

textScan

public ITextScannerManagerSpi textScan

Constructor Details

Terminal

@Deprecated(since="0.28.0",
            forRemoval=true)
public Terminal(String id,
 String host,
 int port,
 ITextScannerManagerSpi textScan)
         throws TerminalInterruptedException

Deprecated, for removal: This API element is subject to removal in a future version.

use the Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage) constructor instead.

Throws:

TerminalInterruptedException

Terminal

@Deprecated(since="0.28.0",
            forRemoval=true)
public Terminal(String id,
 String host,
 int port,
 boolean ssl,
 ITextScannerManagerSpi textScan)
         throws TerminalInterruptedException

Deprecated, for removal: This API element is subject to removal in a future version.

use the Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage) constructor instead.

Throws:

TerminalInterruptedException

Terminal

@Deprecated(since="0.28.0",
            forRemoval=true)
public Terminal(String id,
 String host,
 int port,
 boolean ssl,
 int primaryColumns,
 int primaryRows,
 int alternateColumns,
 int alternateRows,
 ITextScannerManagerSpi textScan)
         throws TerminalInterruptedException

Deprecated, for removal: This API element is subject to removal in a future version.

use the Terminal(String id, String host, int port, boolean ssl, TerminalSize primarySize, TerminalSize alternateSize, ITextScannerManagerSpi textScan, Charset codePage) constructor instead.

Throws:

TerminalInterruptedException

Terminal

public Terminal(String id,
 String host,
 int port,
 boolean ssl,
 TerminalSize primarySize,
 TerminalSize alternateSize,
 ITextScannerManagerSpi textScan,
 Charset codePage)
         throws TerminalInterruptedException

Throws:

TerminalInterruptedException

Method Details

setAutoReconnect

public void setAutoReconnect(boolean newAutoReconnect)

setDeviceTypes

public void setDeviceTypes(List<String> deviceTypes)

connect

public void connect()
             throws NetworkException

Specified by:

connect in interface ITerminal

Throws:

NetworkException

disconnect

public void disconnect()
                throws TerminalInterruptedException

Specified by:

disconnect in interface ITerminal

Throws:

TerminalInterruptedException

networkClosed

public void networkClosed()

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ITerminal

waitForKeyboard

public ITerminal waitForKeyboard()
                          throws TimeoutException,
KeyboardLockedException,
TerminalInterruptedException

Specified by:

waitForKeyboard in interface ITerminal

Throws:

TimeoutException

KeyboardLockedException

TerminalInterruptedException

wfk

public ITerminal wfk()
              throws TimeoutException,
KeyboardLockedException,
TerminalInterruptedException

Specified by:

wfk in interface ITerminal

Throws:

TimeoutException

KeyboardLockedException

TerminalInterruptedException

getScreen

public Screen getScreen()

positionCursorToFieldContaining

public ITerminal positionCursorToFieldContaining(@NotNull
 @NotNull String text)
                                          throws TextNotFoundException,
KeyboardLockedException

Specified by:

positionCursorToFieldContaining in interface ITerminal

Throws:

TextNotFoundException

KeyboardLockedException

verifyTextInField

public Terminal verifyTextInField(String text)
                           throws TextNotFoundException

Specified by:

verifyTextInField in interface ITerminal

Throws:

TextNotFoundException

isTextInField

public boolean isTextInField(String text)

Specified by:

isTextInField in interface ITerminal

isTextInField

public boolean isTextInField(String text,
 long timeoutInMilliseconds)
                      throws TerminalInterruptedException

Specified by:

isTextInField in interface ITerminal

Throws:

TerminalInterruptedException

searchText

public boolean searchText(String text)

Description copied from interface: ITerminal

Perform a search on a String to check whether or not it is on the terminal screen. If after a timeout the String is not found on the terminal, the method will return false to the caller.

Specified by:

searchText in interface ITerminal

Returns:

if the text was found

searchText

public boolean searchText(String text,
 int occurrences)

Description copied from interface: ITerminal

Perform a search on a String to check whether or not it is on the terminal screen. If after a timeout the String is not found on the terminal, the method will return false to the caller. The returned boolean will depend on if the amount of occurrences is found.

Specified by:

searchText in interface ITerminal

Returns:

if the text was found

searchText

public boolean searchText(String text,
 long milliTimeout)

Description copied from interface: ITerminal

Perform a search on a String to check whether or not it is on the terminal screen. If after a timeout the String is not found on the terminal, the method will return false to the caller.

Specified by:

searchText in interface ITerminal

Returns:

if the text was found

searchText

public boolean searchText(String text,
 int occurrences,
 long milliTimeout)

Description copied from interface: ITerminal

Perform a search on a String to check whether or not it is on the terminal screen. If after a timeout the String is not found on the terminal with at least the amount of occurrences input the method will return false to the caller.

Specified by:

searchText in interface ITerminal

Returns:

if the text was found

waitForTextInField

public ITerminal waitForTextInField(String text)
                             throws TerminalInterruptedException,
TextNotFoundException,
Zos3270Exception

Specified by:

waitForTextInField in interface ITerminal

Returns:

Throws:

TerminalInterruptedException

TextNotFoundException

ErrorTextFoundException

Zos3270Exception

waitForTextInField

public int waitForTextInField(String[] ok,
 String[] error)
                       throws TerminalInterruptedException,
TextNotFoundException,
ErrorTextFoundException,
Zos3270Exception

Specified by:

waitForTextInField in interface ITerminal

Parameters:

ok - - An array of text strings to find on the screen

error - - An array of text strings deemed to be errors

Returns:

the index of the ok string that was found

Throws:

TerminalInterruptedException - - If the wait was interrupted for some reason

TextNotFoundException - - None of the ok or error strings were found before the timeout

ErrorTextFoundException - - One of the error strings were found, index of which is in the exception

Zos3270Exception - - general zos 3270 error

waitForTextInField

public int waitForTextInField(String[] ok,
 String[] error,
 long timeoutInMilliseconds)
                       throws TerminalInterruptedException,
TextNotFoundException,
ErrorTextFoundException,
Zos3270Exception

Specified by:

waitForTextInField in interface ITerminal

Parameters:

ok - - An array of text strings to find on the screen

error - - An array of text strings deemed to be errors

timeoutInMilliseconds - - timeout

Returns:

the index of the ok string that was found

Throws:

TerminalInterruptedException - - If the wait was interrupted for some reason

TextNotFoundException - - None of the ok or error strings were found before the timeout

ErrorTextFoundException - - One of the error strings were found

Zos3270Exception - - general zos 3270 error

type

public ITerminal type(String text)
               throws KeyboardLockedException,
FieldNotFoundException

Specified by:

type in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

eraseEof

public ITerminal eraseEof()
                   throws KeyboardLockedException,
FieldNotFoundException

Specified by:

eraseEof in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

eraseInput

public ITerminal eraseInput()
                     throws KeyboardLockedException,
FieldNotFoundException

Specified by:

eraseInput in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

tab

public ITerminal tab()
              throws KeyboardLockedException,
FieldNotFoundException

Specified by:

tab in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

backTab

public ITerminal backTab()
                  throws KeyboardLockedException,
FieldNotFoundException

Specified by:

backTab in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

cursorUp

public ITerminal cursorUp()
                   throws KeyboardLockedException,
FieldNotFoundException

Specified by:

cursorUp in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

cursorDown

public ITerminal cursorDown()
                     throws KeyboardLockedException,
FieldNotFoundException

Specified by:

cursorDown in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

cursorLeft

public ITerminal cursorLeft()
                     throws KeyboardLockedException,
FieldNotFoundException

Specified by:

cursorLeft in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

cursorRight

public ITerminal cursorRight()
                      throws KeyboardLockedException,
FieldNotFoundException

Specified by:

cursorRight in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

home

public ITerminal home()
               throws KeyboardLockedException,
FieldNotFoundException

Specified by:

home in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

newLine

public ITerminal newLine()
                  throws KeyboardLockedException,
FieldNotFoundException

Specified by:

newLine in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

backSpace

public ITerminal backSpace()
                    throws KeyboardLockedException,
FieldNotFoundException

Specified by:

backSpace in interface ITerminal

Throws:

KeyboardLockedException

FieldNotFoundException

enter

public ITerminal enter()
                throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

enter in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

clear

public ITerminal clear()
                throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

clear in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf1

public ITerminal pf1()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf1 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf2

public ITerminal pf2()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf2 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf3

public ITerminal pf3()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf3 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf4

public ITerminal pf4()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf4 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf5

public ITerminal pf5()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf5 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf6

public ITerminal pf6()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf6 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf7

public ITerminal pf7()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf7 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf8

public ITerminal pf8()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf8 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf9

public ITerminal pf9()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf9 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf10

public ITerminal pf10()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf10 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf11

public ITerminal pf11()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf11 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf12

public ITerminal pf12()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf12 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf13

public ITerminal pf13()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf13 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf14

public ITerminal pf14()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf14 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf15

public ITerminal pf15()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf15 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf16

public ITerminal pf16()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf16 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf17

public ITerminal pf17()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf17 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf18

public ITerminal pf18()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf18 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf19

public ITerminal pf19()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf19 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf20

public ITerminal pf20()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf20 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf21

public ITerminal pf21()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf21 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf22

public ITerminal pf22()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf22 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf23

public ITerminal pf23()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf23 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pf24

public ITerminal pf24()
               throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pf24 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pa1

public ITerminal pa1()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pa1 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pa2

public ITerminal pa2()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pa2 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

pa3

public ITerminal pa3()
              throws KeyboardLockedException,
NetworkException,
TerminalInterruptedException

Specified by:

pa3 in interface ITerminal

Throws:

KeyboardLockedException

NetworkException

TerminalInterruptedException

reportScreen

public ITerminal reportScreen()

Description copied from interface: ITerminal

Temporary Print to console

Specified by:

reportScreen in interface ITerminal

Returns:

ITerminal for chaining

reportScreenWithCursor

public ITerminal reportScreenWithCursor()

Specified by:

reportScreenWithCursor in interface ITerminal

reportExtendedScreen

public ITerminal reportExtendedScreen(boolean printCursor,
 boolean printColour,
 boolean printHighlight,
 boolean printIntensity,
 boolean printProtected,
 boolean printNumeric,
 boolean printModified)
                               throws Zos3270Exception

Description copied from interface: ITerminal

Report to the log the current state of the terminal with optional extended datastream settings

Specified by:

reportExtendedScreen in interface ITerminal

Parameters:

printCursor - - report cursor position

printColour - - report the colour

printHighlight - - report highlighting

printIntensity - - report intensity

printProtected - - report field protection

printNumeric - - report numeric restrictions

printModified - - report field modification

Returns:

the ITerminal for fluent API

Throws:

Zos3270Exception

getId

public String getId()

Specified by:

getId in interface ITerminal

retrieveScreen

public String retrieveScreen()

Returns the screen print out as a String. For use in edge testing cases.

Specified by:

retrieveScreen in interface ITerminal

Returns:

Screen as String

retrieveFieldAtCursor

public String retrieveFieldAtCursor()

Return a String of the contents of the current Field. Current field is the one which the cursor is at.

Specified by:

retrieveFieldAtCursor in interface ITerminal

Returns:

Current Field as String

retrieveFieldTextAfterFieldWithString

public String retrieveFieldTextAfterFieldWithString(String fieldName)
                                             throws TextNotFoundException

Returns a String of text in a Field with a given name.

Specified by:

retrieveFieldTextAfterFieldWithString in interface ITerminal

Parameters:

fieldName - Name of the field to be extracted from

Returns:

String which has been extracted from the field

Throws:

TextNotFoundException

getHostPort

public String getHostPort()

registerDatastreamListener

public void registerDatastreamListener(IDatastreamListener listener)

Specified by:

registerDatastreamListener in interface ITerminal

unregisterDatastreamListener

public void unregisterDatastreamListener(IDatastreamListener listener)

Specified by:

unregisterDatastreamListener in interface ITerminal

isSwitchedSSL

public boolean isSwitchedSSL()

Specified by:

isSwitchedSSL in interface ITerminal

setDoStartTls

public void setDoStartTls(boolean doStartTls)

Specified by:

setDoStartTls in interface ITerminal

isClearScreen

public boolean isClearScreen()

Specified by:

isClearScreen in interface ITerminal

setCursorPosition

public void setCursorPosition(int row,
 int col)
                       throws KeyboardLockedException,
Zos3270Exception

Description copied from interface: ITerminal

Set the position of the Cursor

Specified by:

setCursorPosition in interface ITerminal

Parameters:

row - - The row on the screen to set the cursor

col - - the column on the screen to set the cursor

Throws:

KeyboardLockedException - - If an attempt is made to move the cursor whilst the screen is locked

Zos3270Exception - - If the position exceeds the boundaries of the screen

retrieveText

public String retrieveText(int row,
 int col,
 int length)
                    throws Zos3270Exception

Description copied from interface: ITerminal

Retrieve text from the screen. Null characters and field attribute positions are replaced with spaces. If there are not enough characters on the row to satisfy the length requirement, the retrieve will wrap to the next row, unless it is the last row, in which case an exception will be thrown.

Specified by:

retrieveText in interface ITerminal

Parameters:

row - - The row on the screen to start the extract

col - - The column on the screen to start the extract

length - - The number of characters to extract

Returns:

The contents extracted

Throws:

Zos3270Exception - - If the position exceeds the boundaries of the screen or the length causes the extract to overflow the end of the screen buffer

retrieveTextAtCursor

public String retrieveTextAtCursor(int length)
                            throws Zos3270Exception

Description copied from interface: ITerminal

Retrieve text from the screen. Null characters and field attribute positions are replaced with spaces. If there are not enough characters on the row to satisfy the length requirement, the retrieve will wrap to the next row, unless it is the last row, in which case an exception will be thrown.

Specified by:

retrieveTextAtCursor in interface ITerminal

Parameters:

length - - The number of characters to extract

Returns:

The contents extracted

Throws:

Zos3270Exception - - If the length causes the extract to overflow the end of the screen buffer

retrieveColourAtCursor

public Colour retrieveColourAtCursor()

Description copied from interface: ITerminal

Return the colour of the character at the cursor position

Specified by:

retrieveColourAtCursor in interface ITerminal

Returns:

- if position is not in an extended field, null us returned

retrieveColourAtPosition

public Colour retrieveColourAtPosition(int row,
 int col)
                                throws Zos3270Exception

Description copied from interface: ITerminal

Return the colour of the character at the cursor position

Specified by:

retrieveColourAtPosition in interface ITerminal

Parameters:

row - of the screen, index 1 based

col - of the screen, index 1 based

Returns:

- if position is not in an extended field, null us returned

Throws:

Zos3270Exception

retrieveHighlightAtCursor

public Highlight retrieveHighlightAtCursor()

Description copied from interface: ITerminal

Return the highlighting of the character at the cursor position

Specified by:

retrieveHighlightAtCursor in interface ITerminal

Returns:

- if position is not in an extended field, null us returned

retrieveHighlightAtPosition

public Highlight retrieveHighlightAtPosition(int row,
 int col)
                                      throws Zos3270Exception

Description copied from interface: ITerminal

Return the highlighting of the character at the cursor position

Specified by:

retrieveHighlightAtPosition in interface ITerminal

Parameters:

row - of the screen, index 1 based

col - of the screen, index 1 based

Returns:

- if position is not in an extended field, null us returned

Throws:

Zos3270Exception