se.entra.phantom.server.tn5250e

Class FormatTable

java.lang.Object

se.entra.phantom.server.tn5250e.FormatTable

public class FormatTable
extends Object

This class handles the format table of the 5250 display session.

Constructor Summary

Constructors

Constructor and Description
FormatTable(Display5250 display, DataStream5250 dataStream) Creates a new format table that is empty.

Method Summary

Modifier and Type	Method and Description
int	addField(boolean isInputField, int addr, int attr, int ffw, int[] fcw, int fcwCount, int len) Adds a new field at the specified position.
boolean	backTab(int addr) Performs backtab to another nonbypass field.
boolean	checkInputFields(boolean isEnterKey) Checks all input fields for valid content.
void	clear() Clears the format table.
boolean	eraseInput() This function works only on the unprotected fields that the workstation operator has modified.
int	getFieldCount() Get the count of fields.
Field	getFieldFromAddress(int addr) Locates a field from an address.
int	getFieldIndexFromAddress(int addr) Locates a field index from an address.
int	getFirstNonBypassField() Gets the address of the first possible field on the screen.
int	getInboundFieldData(short[] buf, int pos, boolean stripTrailingNulls, boolean onlyMDT) Gets the data of an inbound read command.
int	getInboundFieldDataSizes(boolean stripTrailingNulls, boolean onlyMDT) Gets the size of an inbound read command.
int	getRegenerationData(short[] buf, int pos) Gets the field regeneration data for the input fields into the provided buffer at a starting position.
int	getRegenerationDataSize() Gets the size of the field regeneration data for the input fields.
boolean	moveCursorToFirstField() Moves the cursor to the first possible field on the screen.
void	nullNonBypass() Nulls all nonbypass fields.
void	nullNonBypassMDT() Nulls all nonbypass fields with the MDT on (and clears the MDT).
void	resetMDT() Resets the MDT for all fields.
void	resetNonBypassMDT() Resets the MDT for all nonbypass fields.
int	setRegenerationData(int fieldCount, short[] buf, int pos) Sets the field regeneration data for the input fields specified in the provided buffer at a starting position.
boolean	tabForward(int addr, boolean isFieldExit) Performs tab to another nonbypass field.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatTable

public FormatTable(Display5250 display,
                   DataStream5250 dataStream)

Creates a new format table that is empty.

Method Detail

getFieldCount

public int getFieldCount()

Get the count of fields.

clear

public void clear()

Clears the format table.

resetNonBypassMDT

public void resetNonBypassMDT()

Resets the MDT for all nonbypass fields.

resetMDT

public void resetMDT()

Resets the MDT for all fields.

nullNonBypass

public void nullNonBypass()

Nulls all nonbypass fields.

nullNonBypassMDT

public void nullNonBypassMDT()

Nulls all nonbypass fields with the MDT on (and clears the MDT).

moveCursorToFirstField

public boolean moveCursorToFirstField()

Moves the cursor to the first possible field on the screen. This field is a nonbypass field.

Returns:

false if no such field exist

getFirstNonBypassField

public int getFirstNonBypassField()

Gets the address of the first possible field on the screen. This field is a nonbypass field.

Returns:

-1 if no such field exist.

addField

public int addField(boolean isInputField,
                    int addr,
                    int attr,
                    int ffw,
                    int[] fcw,
                    int fcwCount,
                    int len)

Adds a new field at the specified position. If there is already a field in this position (because position is already + 1), then this field will get these new values.

Returns:

The next address where a field attribute can be put.

getFieldFromAddress

public Field getFieldFromAddress(int addr)

Locates a field from an address.

Returns:

null if no such field is found.

getFieldIndexFromAddress

public int getFieldIndexFromAddress(int addr)

Locates a field index from an address.

Returns:

null if no such field is found.

getInboundFieldDataSizes

public int getInboundFieldDataSizes(boolean stripTrailingNulls,
                                    boolean onlyMDT)

Gets the size of an inbound read command. The size is calculated for all the requested entry fields. When only MDT fields are requested, the size for SBA+Row+Col is added.

getInboundFieldData

public int getInboundFieldData(short[] buf,
                               int pos,
                               boolean stripTrailingNulls,
                               boolean onlyMDT)

Gets the data of an inbound read command. When only MDT fields are requested, SBA+Row+Col is added.

tabForward

public boolean tabForward(int addr,
                          boolean isFieldExit)

Performs tab to another nonbypass field.

Finds the best suited entry field: after the current the current address (backtab).

Returns:

false if no input field is found or if there is a field check of the current input field that causes an error.

backTab

public boolean backTab(int addr)

Performs backtab to another nonbypass field.

Finds the best suited entry field: before the current address.

Returns:

false if no input field is found or if there is a field check of the current input field that causes an error.

eraseInput

public boolean eraseInput()

This function works only on the unprotected fields that the workstation operator has modified. When the workstation operator presses the Erase Input key, all the modified fields are cleared to nulls and the cursor is moved to the first input field. The MDT bit remains on.

getRegenerationDataSize

public int getRegenerationDataSize()

Gets the size of the field regeneration data for the input fields.

getRegenerationData

public int getRegenerationData(short[] buf,
                               int pos)

Gets the field regeneration data for the input fields into the provided buffer at a starting position.

setRegenerationData

public int setRegenerationData(int fieldCount,
                               short[] buf,
                               int pos)

Sets the field regeneration data for the input fields specified in the provided buffer at a starting position.

checkInputFields

public boolean checkInputFields(boolean isEnterKey)

Checks all input fields for valid content.