com.wrq.vhi.script.api
Interface ParseScreenEvent

All Superinterfaces:
EntityEvent, Event, HostSessionEvent, ModelEvent, RecordSetEvent

public interface ParseScreenEvent
extends RecordSetEvent

Parse screen event information.

See Also:
RecordSetEventHandler.parseScreen(com.wrq.vhi.script.api.ParseScreenEvent)

Method Summary
 RecordLocation createRecordLocation(int firstRow, int height, boolean whole)
          Creates a record location given a row and height.
 RecordLocation createRecordLocation(int left, int top, int width, int height, boolean whole)
          Creates a record location given a rectangular region.
 java.util.List defaultParseScreen()
          Gets the default record locations as defined in the model.
 RectangularTerminalRegion getRecordSetRegion()
          Gets the rectangular screen region which describes the location, size and contents of the recordset.
 
Methods inherited from interface com.wrq.vhi.script.api.RecordSetEvent
getPageNumber, getRecordSetContext, getRecordSetMetaData, getRecordSetName
 
Methods inherited from interface com.wrq.vhi.script.api.EntityEvent
getEntityName, getTabStops
 
Methods inherited from interface com.wrq.vhi.script.api.HostSessionEvent
getHostSession
 
Methods inherited from interface com.wrq.vhi.script.api.ModelEvent
getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext
 
Methods inherited from interface com.wrq.vhi.script.api.Event
checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment
 

Method Detail

getRecordSetRegion

RectangularTerminalRegion getRecordSetRegion()
Gets the rectangular screen region which describes the location, size and contents of the recordset.

Returns:
the location, size and contents of the recordset

defaultParseScreen

java.util.List defaultParseScreen()
Gets the default record locations as defined in the model. The contents of the returned list can be modified and used as the event's return value.

Returns:
a list of RecordLocation objects

createRecordLocation

RecordLocation createRecordLocation(int firstRow,
                                    int height,
                                    boolean whole)
Creates a record location given a row and height. This method assumes the record spans the width of the record set.

Parameters:
firstRow - the one-based first row measured from the top of the record set (not the top of the screen)
height - the number or rows in the record
whole - true if the record is whole, otherwise false
Returns:
a RecordLocation object describing the record's location
Throws:
java.lang.IllegalArgumentException - if the row or height is invalid

createRecordLocation

RecordLocation createRecordLocation(int left,
                                    int top,
                                    int width,
                                    int height,
                                    boolean whole)
Creates a record location given a rectangular region.

Parameters:
left - the one-based horizontal offset from the left side of the record set (not the column on the screen)
top - the one-based vertical offset from the top of the record set (not the row on the screen)
width - the number of rows in the record
height - the number of columns in the record
whole - true if the record is whole, otherwise false
Returns:
a RecordLocation object describing the record's location
Throws:
java.lang.IllegalArgumentException - if the row or height is invalid