com.wrq.vhi.script.api
Interface EntityDepartureEvent

All Superinterfaces:

EntityEvent, Event, ModelEvent

public interface EntityDepartureEvent
extends EntityEvent

Entity departure event information.

See Also:

EntityEventHandler.entityDeparture(com.wrq.vhi.script.api.EntityDepartureEvent)

Method Summary

CursorPosition	getCursorPosition() Gets the current position of the cursor on the terminal screen.
java.lang.String	getNextEntity() Gets the name of the newly recognized entity.
RectangularTerminalRegion	getTerminalScreen() Gets the size and contents of the terminal screen.
void	overrideDeparture() Overrides the departure and remains on the current entity.

Methods inherited from interface com.wrq.vhi.script.api.EntityEvent

getEntityName, getTabStops

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

getNextEntity

java.lang.String getNextEntity()

Gets the name of the newly recognized entity.

Returns:

the name of the newly recognized entity or an empty string if none

getTerminalScreen

RectangularTerminalRegion getTerminalScreen()
                                            throws ApptrieveException

Gets the size and contents of the terminal screen.

Returns:

the contents of the entire terminal screen

Throws:

ApptrieveException

getCursorPosition

CursorPosition getCursorPosition()
                                 throws ApptrieveException

Gets the current position of the cursor on the terminal screen.

Returns:

the cursor position

Throws:

ApptrieveException

overrideDeparture

void overrideDeparture()
                       throws ApptrieveException

Overrides the departure and remains on the current entity. This can only be called if a new entity is not recognized (getNextEntity() returns an empty string).

Throws:

ApptrieveException - if the next entity is recognized