com.wrq.vhi.script.api
Interface ModelMoveCursorBackwardEvent

All Superinterfaces:
Event, HostSessionEvent, ModelCursorEvent, ModelEvent

public interface ModelMoveCursorBackwardEvent
extends ModelCursorEvent

Model move cursor backward event information.

See Also:
ModelEventHandler.moveCursorBackward(com.wrq.vhi.script.api.ModelMoveCursorBackwardEvent)

Method Summary
 void defaultMoveCursorBackward()
          Executes the model-defined move cursor backward command list and waits for the cursor position to change.
 
Methods inherited from interface com.wrq.vhi.script.api.ModelCursorEvent
getEventCursorPosition, 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

defaultMoveCursorBackward

void defaultMoveCursorBackward()
                               throws ApptrieveException
Executes the model-defined move cursor backward command list and waits for the cursor position to change. If tabstops are defined on the current entity, VHI will wait for the cursor to arrive at a tab stop.

An exception will be thrown if the move backward command list fails or the cursor does not end up at a tab stop when tab stops are defined.

NOTE: An exception will not be thrown if the cursor does not move.

Throws:
ApptrieveException