Package dev.galasa.zos3270.spi

Class Screen

java.lang.Object

dev.galasa.zos3270.spi.Screen

public class Screen
extends Object

Screen representation of the 3270 terminal

Constructor Summary

Constructors

Constructor	Description
Screen()	Deprecated, for removal: This API element is subject to removal in a future version. use the Screen(TerminalSize primarySize, TerminalSize alternateSize, Network network, Charset codePage) constructor instead.
Screen(int columns, int rows, int alternateColumns, int alternateRows, dev.galasa.zos3270.internal.comms.Network network)	Deprecated, for removal: This API element is subject to removal in a future version. use the Screen(TerminalSize primarySize, TerminalSize alternateSize, Network network, Charset codePage) constructor instead.
Screen(int columns, int rows, dev.galasa.zos3270.internal.comms.Network network)	Deprecated, for removal: This API element is subject to removal in a future version. use the Screen(TerminalSize primarySize, TerminalSize alternateSize, Network network, Charset codePage) constructor instead.
Screen(TerminalSize primarySize, TerminalSize alternateSize, dev.galasa.zos3270.internal.comms.Network network, Charset codePage)

Method Summary

Modifier and Type	Method	Description
byte[]	aid(AttentionIdentification aid)
void	backSpace()
void	backTab()
@NotNull Field[]	calculateFields()
void	cursorDown()
void	cursorLeft()
void	cursorRight()
void	cursorUp()
void	erase()
void	eraseAlternate()
void	eraseEof()
void	eraseInput()
int	getAlternateColumns()
int	getAlternateRows()
Charset	getCodePage()
Colour	getColourAtPosition(int pos)
int	getCursor()
int	getCursorColumn()
int	getCursorRow()
List<IDatastreamListener>	getDatastreamListeners()
Field	getFieldAt(int col, int row)
Highlight	getHighlightAtPosition(int pos)
int	getNoOfColumns()
int	getNoOfRows()
int	getPrimaryColumns()
int	getPrimaryRows()
int	getScreenSize()
String	getValueFromFieldContaining(String text)
void	home()
boolean	isClearScreen()
boolean	isSSCPLUDisplay()
boolean	isTextInField(String text)
Field	locateFieldAt(int cursorPos)
void	lockKeyboard()
void	networkClosed()
void	newLine()
void	nullify(int col, int row, int len)
void	positionCursorToFieldContaining(@NotNull String text)
String	printExtendedScreen(boolean printCursor, boolean printColour, boolean printHighlight, boolean printIntensity, boolean printProtected, boolean printNumeric, boolean printModified)
String	printFields()
String	printScreen()
String	printScreenTextWithCursor()
void	processInboundMessage(dev.galasa.zos3270.internal.comms.Inbound3270Message inbound)
void	processOrders(List<dev.galasa.zos3270.internal.datastream.AbstractOrder> orders, dev.galasa.zos3270.internal.datastream.WriteControlCharacter writeControlCharacter)
void	registerDatastreamListener(IDatastreamListener listener)
void	registerScreenUpdateListener(IScreenUpdateListener listener)
String	retrieveFlatScreen()
int	searchFieldContaining(@NotNull String[] okText, String[] errorText)
void	searchFieldContaining(String text)
void	setBuffer(int col, int row, String text)
void	setBuffer(IBufferHolder[] newBuffer)
void	setCursorPosition(int newPosition)
void	setCursorPosition(int column, int row)
void	setDatastreamListenersDirection(String datastreamHex, IDatastreamListener.DatastreamDirection direction)
void	setIsSSCPLUDisplay(boolean isSSCPLUDisplay)
void	tab()
void	testingSetLastAid(AttentionIdentification aid)
void	type(String text)
int	type(String text, int position)
int	type(String text, int column, int row)
void	unregisterDatastreamListener(IDatastreamListener listener)
void	unregisterScreenUpdateListener(IScreenUpdateListener listener)
void	waitForKeyboard(int maxWait)	Wait on the keyboard being free
int	waitForTextInField(String[] ok, String[] error, long timeoutInMilliseconds)
int	waitForTextInField(String text, long maxWait)

Methods inherited from class java.lang.Object

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

Constructor Details

Screen

@Deprecated(since="0.28.0",
            forRemoval=true)
public Screen()
       throws TerminalInterruptedException

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

use the Screen(TerminalSize primarySize, TerminalSize alternateSize, Network network, Charset codePage) constructor instead.

Throws:

TerminalInterruptedException

Screen

@Deprecated(since="0.28.0",
            forRemoval=true)
public Screen(int columns,
 int rows,
 dev.galasa.zos3270.internal.comms.Network network)
       throws TerminalInterruptedException

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

use the Screen(TerminalSize primarySize, TerminalSize alternateSize, Network network, Charset codePage) constructor instead.

Throws:

TerminalInterruptedException

Screen

@Deprecated(since="0.28.0",
            forRemoval=true)
public Screen(int columns,
 int rows,
 int alternateColumns,
 int alternateRows,
 dev.galasa.zos3270.internal.comms.Network network)
       throws TerminalInterruptedException

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

use the Screen(TerminalSize primarySize, TerminalSize alternateSize, Network network, Charset codePage) constructor instead.

Throws:

TerminalInterruptedException

Screen

public Screen(TerminalSize primarySize,
 TerminalSize alternateSize,
 dev.galasa.zos3270.internal.comms.Network network,
 Charset codePage)
       throws TerminalInterruptedException

Throws:

TerminalInterruptedException

Method Details

lockKeyboard

public void lockKeyboard()
                  throws TerminalInterruptedException

Throws:

TerminalInterruptedException

networkClosed

public void networkClosed()
                   throws TerminalInterruptedException

Throws:

TerminalInterruptedException

processInboundMessage

public void processInboundMessage(dev.galasa.zos3270.internal.comms.Inbound3270Message inbound)
                           throws DatastreamException

Throws:

DatastreamException

setDatastreamListenersDirection

public void setDatastreamListenersDirection(String datastreamHex,
 IDatastreamListener.DatastreamDirection direction)

processOrders

public void processOrders(List<dev.galasa.zos3270.internal.datastream.AbstractOrder> orders,
 dev.galasa.zos3270.internal.datastream.WriteControlCharacter writeControlCharacter)
                   throws DatastreamException

Throws:

DatastreamException

erase

public void erase()

eraseAlternate

public void eraseAlternate()

printScreen

public String printScreen()

printScreenTextWithCursor

public String printScreenTextWithCursor()

printExtendedScreen

public String printExtendedScreen(boolean printCursor,
 boolean printColour,
 boolean printHighlight,
 boolean printIntensity,
 boolean printProtected,
 boolean printNumeric,
 boolean printModified)
                           throws Zos3270Exception

Throws:

Zos3270Exception

retrieveFlatScreen

public String retrieveFlatScreen()

calculateFields

@NotNull
public @NotNull Field[] calculateFields()

searchFieldContaining

public void searchFieldContaining(String text)
                           throws TextNotFoundException

Throws:

TextNotFoundException

searchFieldContaining

public int searchFieldContaining(@NotNull
 @NotNull String[] okText,
 String[] errorText)
                          throws TextNotFoundException,
ErrorTextFoundException

Throws:

TextNotFoundException

ErrorTextFoundException

isTextInField

public boolean isTextInField(String text)

waitForKeyboard

public void waitForKeyboard(int maxWait)
                     throws TimeoutException,
TerminalInterruptedException

Wait on the keyboard being free

Parameters:

maxWait - - time in milliseconds

Throws:

KeyboardLockedException

InterruptedException

TimeoutException

TerminalInterruptedException

waitForTextInField

public int waitForTextInField(String text,
 long maxWait)
                       throws TerminalInterruptedException,
TextNotFoundException,
Zos3270Exception

Throws:

TerminalInterruptedException

TextNotFoundException

Zos3270Exception

waitForTextInField

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

Throws:

TerminalInterruptedException

TextNotFoundException

ErrorTextFoundException

Zos3270Exception

positionCursorToFieldContaining

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

Throws:

KeyboardLockedException

TextNotFoundException

eraseEof

public void eraseEof()
              throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

eraseInput

public void eraseInput()
                throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

tab

public void tab()
         throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

backTab

public void backTab()
             throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

cursorUp

public void cursorUp()
              throws KeyboardLockedException

Throws:

KeyboardLockedException

cursorDown

public void cursorDown()
                throws KeyboardLockedException

Throws:

KeyboardLockedException

cursorLeft

public void cursorLeft()
                throws KeyboardLockedException

Throws:

KeyboardLockedException

cursorRight

public void cursorRight()
                 throws KeyboardLockedException

Throws:

KeyboardLockedException

home

public void home()
          throws KeyboardLockedException

Throws:

KeyboardLockedException

newLine

public void newLine()
             throws KeyboardLockedException

Throws:

KeyboardLockedException

backSpace

public void backSpace()
               throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

getNoOfColumns

public int getNoOfColumns()

getNoOfRows

public int getNoOfRows()

registerScreenUpdateListener

public void registerScreenUpdateListener(IScreenUpdateListener listener)

unregisterScreenUpdateListener

public void unregisterScreenUpdateListener(IScreenUpdateListener listener)

getCursor

public int getCursor()

getCursorRow

public int getCursorRow()

getCursorColumn

public int getCursorColumn()

locateFieldAt

public Field locateFieldAt(int cursorPos)

getValueFromFieldContaining

public String getValueFromFieldContaining(String text)
                                   throws TextNotFoundException

Throws:

TextNotFoundException

type

public void type(String text)
          throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

type

public int type(String text,
 int column,
 int row)
         throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

type

public int type(String text,
 int position)
         throws KeyboardLockedException,
FieldNotFoundException

Throws:

KeyboardLockedException

FieldNotFoundException

aid

public byte[] aid(AttentionIdentification aid)
           throws DatastreamException,
TerminalInterruptedException

Throws:

DatastreamException

TerminalInterruptedException

getScreenSize

public int getScreenSize()

printFields

public String printFields()

setBuffer

public void setBuffer(IBufferHolder[] newBuffer)

setBuffer

public void setBuffer(int col,
 int row,
 String text)

nullify

public void nullify(int col,
 int row,
 int len)

getFieldAt

public Field getFieldAt(int col,
 int row)

setCursorPosition

public void setCursorPosition(int newPosition)

setCursorPosition

public void setCursorPosition(int column,
 int row)

registerDatastreamListener

public void registerDatastreamListener(IDatastreamListener listener)

unregisterDatastreamListener

public void unregisterDatastreamListener(IDatastreamListener listener)

getDatastreamListeners

public List<IDatastreamListener> getDatastreamListeners()

getPrimaryColumns

public int getPrimaryColumns()

getPrimaryRows

public int getPrimaryRows()

getAlternateColumns

public int getAlternateColumns()

getAlternateRows

public int getAlternateRows()

testingSetLastAid

public void testingSetLastAid(AttentionIdentification aid)

isClearScreen

public boolean isClearScreen()

getColourAtPosition

public Colour getColourAtPosition(int pos)

getHighlightAtPosition

public Highlight getHighlightAtPosition(int pos)

getCodePage

public Charset getCodePage()

isSSCPLUDisplay

public boolean isSSCPLUDisplay()

setIsSSCPLUDisplay

public void setIsSSCPLUDisplay(boolean isSSCPLUDisplay)