com.wrq.vhi.script.api
Interface RecordLocation

public interface RecordLocation

Specifies the location of a record within a recordset.

See Also:

ParseScreenEvent

Method Summary

RectangularTerminalRegion	getRecordRegion() Gets the current location, size and contents of the record within the record set.
java.lang.Object	getRecordStateObject(java.lang.String name) Gets the object bound to the specified name in this record context, or null if no object is bound to the name.
boolean	isRecordStateObject(java.lang.String name) Tests for the presence of a record context object bound to the specified name.
boolean	isRecordWhole() Checks if the record is entirely contained within this rectangular region.
RectangularTerminalRegion	setRecordRegion(int left, int top, int width, int height) Changes the location and size of the record within the record set using rectangular coordinates.
void	setRecordStateObject(java.lang.String name, java.lang.Object object) Binds an object to this record context, using the name specified.
void	setRecordWhole(boolean whole) Marks the record as either whole or partial.

Method Detail

getRecordRegion

RectangularTerminalRegion getRecordRegion()

Gets the current location, size and contents of the record within the record set.

Returns:

the contents of the record

setRecordRegion

RectangularTerminalRegion setRecordRegion(int left,
                                          int top,
                                          int width,
                                          int height)

Changes the location and size of the record within the record set using rectangular coordinates.

Parameters:

left - the one-based column within the record set

top - the one-based row within the record set

width - the number of columns in the record

height - the number of rows in the record

Returns:

the new RectangularTerminalRegion for the field

Throws:

java.lang.IllegalArgumentException - if the region is invalid

isRecordWhole

boolean isRecordWhole()

Checks if the record is entirely contained within this rectangular region. It is possible for a record to be split across screens or between columns on the same screen.

Returns:

true if the record is entirely contained within this region

setRecordWhole

void setRecordWhole(boolean whole)

Marks the record as either whole or partial. Whole records must be entirely contained within this region.

Parameters:

whole - true if the record should be considered whole, otherwise false

isRecordStateObject

boolean isRecordStateObject(java.lang.String name)

Tests for the presence of a record context object bound to the specified name.

Parameters:

name - the name of the object

Returns:

true if an object is bound to the specified name

getRecordStateObject

java.lang.Object getRecordStateObject(java.lang.String name)

Gets the object bound to the specified name in this record context, or null if no object is bound to the name.

Parameters:

name - the name of the object

Returns:

the object bound to the specified name or null if none

setRecordStateObject

void setRecordStateObject(java.lang.String name,
                          java.lang.Object object)

Binds an object to this record context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.

Parameters:

name - the name to which to bind the object

object - the object to bind