com.wrq.vhi.script.api
Interface ReadFieldEvent

All Superinterfaces:

EntityEvent, Event, FieldEvent, HostSessionEvent, ModelEvent, RecordEvent, RecordSetEvent

public interface ReadFieldEvent
extends FieldEvent

Read field event information.

See Also:

FieldEventHandler.readField(com.wrq.vhi.script.api.ReadFieldEvent)

Method Summary

java.lang.String	defaultReadField() Gets the value read from the field at the time the event fired.
TerminalRegion	getTerminalRegion() Gets the screen region that describes the location, size and contents of the field at the time the event fired.

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

getFieldMetaData, getFieldName

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

getHostRecordIndex, getRecordIndex, getRecordStateObject, isRecordStateObject, setRecordStateObject

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

getPageNumber, getRecordSetContext, getRecordSetMetaData, getRecordSetName

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

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

getTerminalRegion

TerminalRegion getTerminalRegion()

Gets the screen region that describes the location, size and contents of the field at the time the event fired. The object returned can be cast to either LinearTerminalRegion or RectangularTerminalRegion depending on the type of region. If the location, size or contents of the field changes during the course of this event, it will not be reflected in the value returned.

Returns:

the location and contents of the field

defaultReadField

java.lang.String defaultReadField()

Gets the value read from the field at the time the event fired. If the value of the field changes during the course of this event, it will not be reflected in the value returned. Symbols and spaces will have been removed from the value if the field is configured to do so in the model.

Returns:

the value of the field as if the read event was not scripted