org.graffiti.plugin.algorithm.animation
Interface Animation.GraphModificationPolicy

Enclosing interface:
Animation

public static interface Animation.GraphModificationPolicy

Specifies the behaviour of an animation on the event of its underlying graph being modified. Through this interface animations expose the possibility to signal the addition, modification and removal of nodes and edges as well as the underlying graph having been modified or cleared.

The general contract of GraphModificationPolicy is to signal only one and the most specific event; i.e. the event of a node having been added will trigger nodeAdded but not graphModified or both.

Version:
$Revision$ $Date$
Author:
Harald Frankenberger

Method Summary
 void disable()
          Disables this graph modification policy; i.e.
 void edgeAdded(Edge e)
          Signals the event that the specified edge has been added.
 void edgeModified(Edge e)
          Signals the event that the specified edge has been modified.
 void edgeRemoved(Edge e)
          Signals the event that the specified edge has been removed.
 void enable()
          Enables this graph modification policy; i.e.
 void graphCleared(Graph g)
          Signals the event that the specified graph has been cleared.
 void graphModified(Graph g)
          Signals the event that the specified graph has been modified.
 void nodeAdded(Node n)
          Signals the event that the specified node has been added.
 void nodeModified(Node n)
          Signals the event that the specified node has been modified.
 void nodeRemoved(Node n)
          Signals the event that the specified node has been removed.
 

Method Detail

nodeAdded

void nodeAdded(Node n)
Signals the event that the specified node has been added.

Parameters:
n - the node that has been added.

nodeModified

void nodeModified(Node n)
Signals the event that the specified node has been modified.

Modifications in this context encompass e.g. the addition or removal of an attribute, or the modification of an attribute's value.

Parameters:
n - the node that has been modified.

nodeRemoved

void nodeRemoved(Node n)
Signals the event that the specified node has been removed.

Note that the specified node has already been removed; i.e. its attributes could have been already removed or it could have been modified in another way.

Parameters:
n - the node that has been removed.

edgeAdded

void edgeAdded(Edge e)
Signals the event that the specified edge has been added.

Parameters:
e - the edge that has been added.

edgeModified

void edgeModified(Edge e)
Signals the event that the specified edge has been modified.

Modifications in this context encompass e.g. the addition or removal of an attribute, or the modification of an attribute's value.

Parameters:
e - the edge that has been modified.

edgeRemoved

void edgeRemoved(Edge e)
Signals the event that the specified edge has been removed.

Note that the specified edge has already been removed; i.e. its attributes could have been already removed or it could have been modified in another way.

Parameters:
e - the edge that has been removed.

graphModified

void graphModified(Graph g)
Signals the event that the specified graph has been modified.

Modifications in this context encompass e.g. the addition or removal of an attribute, or the modification of an attribute's value.

Parameters:
g - the graph that has been modified.

graphCleared

void graphCleared(Graph g)
Signals the event that the specified graph has been cleared.

Note that the specified graph has already been cleared; i.e. its attributes could have been already removed or it could have been modified in another way.

Parameters:
g - the graph that has been cleared.

enable

void enable()
Enables this graph modification policy; i.e. its notification mechanism.


disable

void disable()
Disables this graph modification policy; i.e. its notification mechanism.



Generated at 2012-05-30 11:00:36 PM CEST