com.wrq.vhi.script.api
Interface FieldLocation

public interface FieldLocation

Specifies the location of a field within a recordset record.

See Also:

ParseRecordEvent

Method Summary

TerminalRegion	getFieldRegion() Gets the current location, size and contents of the field within the record.
LinearTerminalRegion	setFieldRegion(int offset, int length) Changes the location and size of the field within the record using linear coordinates.

Method Detail

getFieldRegion

TerminalRegion getFieldRegion()

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

Returns:

the contents of the record

setFieldRegion

LinearTerminalRegion setFieldRegion(int offset,
                                    int length)

Changes the location and size of the field within the record using linear coordinates.

Parameters:

offset - the zero-based offset from the beginning of the record

length - the length of the field

Returns:

the new TerminalRegion for the field

Throws:

java.lang.IllegalArgumentException - if the region is invalid