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

java.lang.Object
  extended by de.cau.cs.kieler.kiml.layout.AbstractLayoutProvider
      extended by de.cau.cs.kieler.kiml.ogdf.OgdfLayoutProvider

public class OgdfLayoutProvider
extends AbstractLayoutProvider

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

Rating red

Nested Class Summary
static class OgdfLayoutProvider.LayoutAlgorithm
          Definition of available layout algorithms.
 
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.
 Object getDefault(String optionId)
          Returns the default value for the given layout option.
 void initialize(String parameter)
          Initialize the layout provider with the given parameter.
 
Methods inherited from class de.cau.cs.kieler.kiml.layout.AbstractLayoutProvider
supportsHierarchy
 
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)
Initialize the layout provider with the given parameter. The default implementation does nothing.

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

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

getDefault

public Object getDefault(String optionId)
Returns the default value for the given layout option. The default implementation always returns null.

Overrides:
getDefault in class AbstractLayoutProvider
Parameters:
optionId - identifier of a layout option
Returns:
the default value for the given option, or null if this layout provider does not know that option