com.wrq.vhi.script.api
Interface ReadAttributeEvent

All Superinterfaces:
AttributeEvent, EntityEvent, Event, HostSessionEvent, ModelEvent

public interface ReadAttributeEvent
extends AttributeEvent

Read attribute event information.

See Also:
AttributeEventHandler.readAttribute(com.wrq.vhi.script.api.ReadAttributeEvent)

Method Summary
 java.lang.String defaultReadAttribute()
          Gets the value read from the attribute at the time the event fired.
 
Methods inherited from interface com.wrq.vhi.script.api.AttributeEvent
getAttributeMetaData, getAttributeName, getTerminalRegion
 
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

defaultReadAttribute

java.lang.String defaultReadAttribute()
Gets the value read from the attribute at the time the event fired. If the value of the attribute 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 attribute is configured to do so in the model.

Returns:
the value of the attribute as if the read event was not scripted