de.cau.cs.kieler.kiml.util
Class BoxLayoutProvider

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.util.BoxLayoutProvider
All Implemented Interfaces:
IPropertyHolder

public class BoxLayoutProvider
extends AbstractLayoutProvider

A layout algorithm that does not take edges into account, but treats all nodes as isolated boxes.

Rating proposed yellow
(2009-12-11) msp

Field Summary
static String ID
          the layout provider id.
 
Constructor Summary
BoxLayoutProvider()
          Initialize default options of the layout provider.
 
Method Summary
 void doLayout(KNode layoutNode, IKielerProgressMonitor progressMonitor)
          Performs the actual layout process, that is attaches layout information to the given node object.
 
Methods inherited from class de.cau.cs.kieler.kiml.AbstractLayoutProvider
getDebugCanvas, initialize, 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
 

Field Detail

ID

public static final String ID
the layout provider id.

See Also:
Constant Field Values
Constructor Detail

BoxLayoutProvider

public BoxLayoutProvider()
Initialize default options of the layout provider.

Method Detail

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