com.wrq.vhi.script.api
Interface ModelMoveCursorEvent

All Superinterfaces:

Event, HostSessionEvent, ModelCursorEvent, ModelEvent

public interface ModelMoveCursorEvent
extends ModelCursorEvent

Model move cursor event information.

See Also:

ModelEventHandler.moveCursor(com.wrq.vhi.script.api.ModelMoveCursorEvent)

Method Summary

void	defaultMoveCursor() Moves the cursor using the default algorithm.
CursorPosition	getTargetCursorPosition() Gets the target cursor position.

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

getEventCursorPosition, getTabStops

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

getHostSession

Method Detail

getTargetCursorPosition

CursorPosition getTargetCursorPosition()

Gets the target cursor position.

Returns:

the target cursor position

defaultMoveCursor

void defaultMoveCursor()
                       throws ApptrieveException

Moves the cursor using the default algorithm. For character mode hosts this means one of two methods will be used. The method selected depends on the presence of a move cursor forward event handler or command list.

If a move cursor forward event handler is defined or a move cursor forward command list is defined, VHI will iteratively use this event handler or command list to move the cursor until it reaches the desired location. If tab stops are defined on the entity, the request to move the cursor will fail immediately if the location is not at a tab stop. If the cursor returns to the starting location before stopping at the requested location, the cursor movement also fails.

If a method to move the cursor forward is not defined, VHI will use the arrow keys to move the cursor. VHI will calculate how far vertically and horizontally the cursor needs to move and issue the appropriate number of arrow keys in each direction.

If the selected method of cursor movement fails to position the cursor at the requested location, an ApptrieveException will be thrown.

Throws:

ApptrieveException - if the cursor move fails