com.wrq.vhi.script.api
Interface AttributeEvent

All Superinterfaces:
EntityEvent, Event, HostSessionEvent, ModelEvent
All Known Subinterfaces:
ReadAttributeEvent, WriteAttributeEvent

public interface AttributeEvent
extends EntityEvent, HostSessionEvent

Attribute event information.


Method Summary
 AttributeMetaData getAttributeMetaData()
          Get the metadata for this attribute.
 java.lang.String getAttributeName()
          Gets the attribute name.
 TerminalRegion getTerminalRegion()
          Gets the screen region that describes the location, size and contents of the attribute.
 
Methods inherited from interface com.wrq.vhi.script.api.EntityEvent
getEntityName, 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

getAttributeName

java.lang.String getAttributeName()
Gets the attribute name.

Returns:
the name of the attribute

getTerminalRegion

TerminalRegion getTerminalRegion()
                                 throws ApptrieveException
Gets the screen region that describes the location, size and contents of the attribute. The object returned can be cast to either LinearTerminalRegion or RectangularTerminalRegion depending on the type of region.

Returns:
the location and contents of the attribute
Throws:
ApptrieveException

getAttributeMetaData

AttributeMetaData getAttributeMetaData()
                                       throws ApptrieveException
Get the metadata for this attribute.

Returns:
the metadata for the attribute
Throws:
ApptrieveException - if an error occurs obtaining the metadata