com.wrq.vhi.script.api
Interface EntityEvent

All Superinterfaces:

Event, ModelEvent

All Known Subinterfaces:

ApplyFilterEvent, AttributeEvent, EntityArrivalEvent, EntityDepartureEvent, EntityMoveCursorEvent, ExecuteOperationEvent, FieldEvent, GetCurrentHostRecordEvent, GetRecordTypeEvent, InsertRecordEvent, IsTerminatedEvent, ParseRecordEvent, ParseScreenEvent, ReadAttributeEvent, ReadFieldEvent, RecordEvent, RecordSetEvent, UpdateRecordEvent, WriteAttributeEvent, WriteAttributesEvent, WriteFieldEvent

public interface EntityEvent
extends ModelEvent

Entity event information.

Method Summary

java.lang.String	getEntityName() Gets the entity name.
CursorPosition[]	getTabStops() Gets the list of tab stops on the entity.

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

getEntityName

java.lang.String getEntityName()

Gets the entity name.

Returns:

the name of the entity

getTabStops

CursorPosition[] getTabStops()
                             throws ApptrieveException

Gets the list of tab stops on the entity. An empty array will be returned if no tab stops are defined.

Returns:

the array of tab stops

Throws:

ApptrieveException