de.cau.cs.kieler.kiml.layout
Interface ILayoutListener


public interface ILayoutListener

Interface for listeners to the KIML layout. In Eclipse such listeners must register using the layoutListeners extension point.

Layout listeners are primarily used to analyze and debug the results of a layout algorithm. For example, a layout listener could store the layout graph structure into an XMI file to enable easy browsing of the structure.

Rating proposed yellow
(2009-12-11) msp

Method Summary
 void layoutPerformed(KNode layoutGraph, IKielerProgressMonitor monitor)
          Called after layout was performed for the given layout graph.
 void layoutRequested(KNode layoutGraph)
          Called when layout is requested for the given layout graph.
 

Method Detail

layoutRequested

void layoutRequested(KNode layoutGraph)
Called when layout is requested for the given layout graph. The given layout graph must not be modified by this method. As the graph is modified by the layout algorithm, a copy of it should be created to reflect its state before layout is applied.

Parameters:
layoutGraph - layout graph that will be processed after this method returns

layoutPerformed

void layoutPerformed(KNode layoutGraph,
                     IKielerProgressMonitor monitor)
Called after layout was performed for the given layout graph. The given layout graph must not be modified by this method.

Parameters:
layoutGraph - layout graph that was layouted
monitor - progress monitor containing execution time results