Package dev.galasa.zos3270.common.screens

Class TerminalImage

java.lang.Object

dev.galasa.zos3270.common.screens.TerminalImage

public class TerminalImage
extends Object

Pojo to represent a screen image as received or sent from the client. Inbound means received by the client.

Author:

Michael Baylis

Constructor Summary

Constructors

Constructor	Description
TerminalImage(int sequence, @NotNull String id, boolean inbound, String type, String aid, TerminalSize imageSize, int cursorColumn, int cursorRow)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getAid()	Fetch the AID if outbound
int	getCursorColumn()
int	getCursorRow()
List<TerminalField>	getFields()	Fetch the fields
@NotNull String	getId()	Fetch the id
TerminalSize	getImageSize()	Return the image size, if null, then it is the default size
int	getSequence()	Fetch the sequence number
String	getType()	Get the filtering type of the image
boolean	isInbound()	Is inbound to the client.

Methods inherited from class java.lang.Object

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

Constructor Details

TerminalImage

public TerminalImage(int sequence,
 @NotNull
 @NotNull String id,
 boolean inbound,
 String type,
 String aid,
 TerminalSize imageSize,
 int cursorColumn,
 int cursorRow)

Constructor

Parameters:

sequence - The sequence of the image, for the whole terminal interaction

id - Id of this image

inbound - inbound = true if received by the client

type - Type of interaction, interactions can be labels so can be filtered

aid - The AttentionID for outbound messages

imageSize - The size of the image if different to the default

cursorColumn - The position of the cursor on the screen

cursorRow - The position of the cursor on the screen

Method Details

getSequence

public int getSequence()

Fetch the sequence number

Returns:

sequence number

getId

@NotNull
public @NotNull String getId()

Fetch the id

Returns:

the id

isInbound

public boolean isInbound()

Is inbound to the client. false means being sent from the client

Returns:

inbound

getImageSize

public TerminalSize getImageSize()

Return the image size, if null, then it is the default size

Returns:

the terminal size if not default

getFields

public List<TerminalField> getFields()

Fetch the fields

Returns:

Fields

getAid

public String getAid()

Fetch the AID if outbound

Returns:

the aid, only valid for outbound images

getType

public String getType()

Get the filtering type of the image

Returns:

filtering type

getCursorColumn

public int getCursorColumn()

Returns:

the column where the cursor is positioned

getCursorRow

public int getCursorRow()

Returns:

the row where the cursor is positioned