org.azyva.dragom.execcontext.plugin

Interface EventPlugin

All Superinterfaces:

ExecContextPlugin

public interface EventPlugin
extends ExecContextPlugin

Manages NodeEvent's at the ExecContext level.

Author:

David Raymond

Method Summary

Modifier and Type	Method and Description
void	raiseNodeEvent(NodeEvent nodeEvent) Raises a NodeEvent.
<NodeEventClass extends NodeEvent> void	registerListener(Node node, NodeEventListener<NodeEventClass> nodeEventListener, boolean indChildrenAlso, boolean indTransient) Registers a NodeEventListener for NodeEvent's raised on a Node.

Method Detail

registerListener

<NodeEventClass extends NodeEvent> void registerListener(Node node,
                                                         NodeEventListener<NodeEventClass> nodeEventListener,
                                                         boolean indChildrenAlso,
                                                         boolean indTransient)

Registers a NodeEventListener for NodeEvent's raised on a Node.

The NodeEventListener is associated with the specified Node, but within the ExecContext. It can be bound to workspace or tool scope depending on indTransient.

It is also possible to register NodeEventListener's directly on a Node, and thus within the Model.

Generally NodeEvent's are raised (by NodePlugin's, tools or other) by calling Node.raiseNodeEvent(org.azyva.dragom.model.event.NodeEvent) which after having dispatched the Event to EventListener's registered within Node's, calls the raiseNodeEvent(org.azyva.dragom.model.event.NodeEvent) method to dispatch the Event to EventListener's registered within the ExecContext.

Type Parameters:

NodeEventClass - NodeEvent class.

Parameters:

node - Node.

nodeEventListener - NodeEventListener.

indChildrenAlso - Indicates if NodeEvent raised on children should be dispatched to the NodeEventListener.

indTransient - Indicates if the NodeEventListener is to be bound to tool scope, as opposed to workspace scope.

raiseNodeEvent

void raiseNodeEvent(NodeEvent nodeEvent)

Raises a NodeEvent.

The NodeEvent is dispatched to all NodeEventListener's interested in it which have been registered within the ExecContext using registerListener(org.azyva.dragom.model.Node, org.azyva.dragom.model.event.NodeEventListener<NodeEventClass>, boolean, boolean).

The NodeEvent sub-interface (ModuleEvent or ClassificationNodeEvent) must match the type of Node.

Parameters:

nodeEvent - NodeEvent.