com.wrq.vhi.script.api
Interface ModelCursorEvent

All Superinterfaces:

Event, HostSessionEvent, ModelEvent

All Known Subinterfaces:

ModelMoveCursorBackwardEvent, ModelMoveCursorEvent, ModelMoveCursorForwardEvent

public interface ModelCursorEvent
extends ModelEvent, HostSessionEvent

Model cursor event information.

Method Summary

CursorPosition	getEventCursorPosition() Gets the cursor position when the event fired.
CursorPosition[]	getTabStops() Gets the list of tab stops on the current entity.

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

getEventCursorPosition

CursorPosition getEventCursorPosition()

Gets the cursor position when the event fired.

Returns:

the cursor position

getTabStops

CursorPosition[] getTabStops()
                             throws ApptrieveException

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

Returns:

the array of tab stops

Throws:

ApptrieveException