com.wrq.vhi.script.api

Interface WriteAttributesEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent

public interface WriteAttributesEvent
extends EntityEvent, HostSessionEvent

Write attributes event information.

See Also:

EntityEventHandler.writeAttributes(com.wrq.vhi.script.api.WriteAttributesEvent)

Method Summary

Modifier and Type	Method and Description
void	defaultWriteAttributes() Writes the attributes to the screen using the default algorithm.
void	defaultWriteAttributes(java.util.Map values) Writes the attributes to the screen using the default algorithm.
java.util.Map	getAttributeWriteValues() Gets the set of attributes and associated values to be written.
void	writeAttribute(java.lang.String name, java.lang.String value) Writes the specified value to the specified 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

getAttributeWriteValues

java.util.Map getAttributeWriteValues()

Gets the set of attributes and associated values to be written.

Returns:

A map of attribute names to attribute values

writeAttribute

void writeAttribute(java.lang.String name,
                    java.lang.String value)
             throws ApptrieveException

Writes the specified value to the specified attribute. If the cursor is not at the attribute's location, a MoveCursor command will automatically be issued. Upon successfully positioning the cursor at the attribute, the value will be written to the screen, firing the appropriate AttributeEventHandler.writeAttribute(com.wrq.vhi.script.api.WriteAttributeEvent), if any.

Parameters:

name - the attribute name

value - the value to write

Throws:

ApptrieveException

defaultWriteAttributes

void defaultWriteAttributes()
                     throws ApptrieveException

Writes the attributes to the screen using the default algorithm. See defaultWriteAttributes(java.util.Map) for a description of the default algorithm.

Throws:

ApptrieveException

defaultWriteAttributes

void defaultWriteAttributes(java.util.Map values)
                     throws ApptrieveException

Writes the attributes to the screen using the default algorithm. For character mode hosts, attributes will be written in one of two ways:

• Move cursor forward event handler or command list is defined - VHI will iteratively fire the move cursor forward event or iteratively execute the move cursor forward command list. If the cursor moves to a new location, VHI will check if that location corresponds to an attribute that needs writing and write to it. If the cursor does not move to a new location and more attributes still need to be written, VHI will begin iteratively firing the move cursor backward event or move cursor backward command list if defined. If tab stops are defined on the entity, the event or command list must always stop at a tab stop.
• Move cursor forward event handler or command list is NOT defined - VHI will write the attributes in a arbitrary order, issuing a move cursor command to correctly position the cursor at each attribute before writing to it.

Parameters:

values - map of attribute names to attribute values

Throws:

ApptrieveException - if the write fails