de.cau.cs.kieler.kiml.ogdf
Class OgdfLayoutProvider

java.lang.Object
  extended by de.cau.cs.kieler.core.properties.MapPropertyHolder
      extended by de.cau.cs.kieler.kiml.AbstractLayoutProvider
          extended by de.cau.cs.kieler.kiml.ogdf.OgdfLayoutProvider
All Implemented Interfaces:
IPropertyHolder

public class OgdfLayoutProvider
extends AbstractLayoutProvider

The OGDF layout provider, that is the entry class used by KIML to call individual layout algorithms.

Rating red

Constructor Summary
OgdfLayoutProvider()
           
 
Method Summary
 void doLayout(KNode layoutNode, IKielerProgressMonitor progressMonitor)
          Performs the actual layout process, that is attaches layout information to the given node object.
 void initialize(LayoutAlgorithm algo)
          Initialize the layout provider with the given algorithm constant.
 void initialize(String parameter)
          Initialize the layout provider with the given parameter.
 
Methods inherited from class de.cau.cs.kieler.kiml.AbstractLayoutProvider
getDebugCanvas, setDebugCanvas, supportsHierarchy
 
Methods inherited from class de.cau.cs.kieler.core.properties.MapPropertyHolder
copyProperties, getAllProperties, getProperty, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OgdfLayoutProvider

public OgdfLayoutProvider()
Method Detail

initialize

public void initialize(String parameter)
                throws KielerException
Initialize the layout provider with the given parameter.

Overrides:
initialize in class AbstractLayoutProvider
Parameters:
parameter - a string used to parameterize the layout provider instance
Throws:
KielerException

initialize

public void initialize(LayoutAlgorithm algo)
Initialize the layout provider with the given algorithm constant.

Parameters:
algo - a layout algorithm constant

doLayout

public void doLayout(KNode layoutNode,
                     IKielerProgressMonitor progressMonitor)
              throws KielerException
Performs the actual layout process, that is attaches layout information to the given node object.

Specified by:
doLayout in class AbstractLayoutProvider
Parameters:
layoutNode - the parent node which should be laid out
progressMonitor - progress monitor used to keep track of progress
Throws:
KielerException - if the method fails to perform layout