de.uni_paderborn.fujaba.layout
Class SpringEmbedderLayout

java.lang.Object
  extended byde.uni_paderborn.fujaba.layout.AbstractLayouter
      extended byde.uni_paderborn.fujaba.layout.SpringEmbedderLayout

public class SpringEmbedderLayout
extends AbstractLayouter

Class 'SpringEmbedderLayout' specified in class diagram 'TreeLayout.java diagram'.

Version:
$Revision: 1.29 $
Author:
$Author: schneider $

Field Summary
(package private) static int minDist
          No comment provided by developer, please add a comment to improve documentation.
private static SpringEmbedderLayout myLayouter
          The children of the abstract Layouter are singletons, so define singleton instance.
private  de.upb.tools.fca.FHashMap preferredPos
           ------------- 0..1 Assoc 0..1 SpringEmbedderLayout | fsaObject |---------------------------------------> Point ------------- springEmbedderLayout preferredPos
 
Fields inherited from class de.uni_paderborn.fujaba.layout.AbstractLayouter
 
Constructor Summary
private SpringEmbedderLayout()
          Constructor of the class SpringEmbedderLayout
 
Method Summary
 boolean addToPreferredPos(FSAObject key, java.awt.Point value)
          Access method for an one to n association.
 boolean addToPreferredPos(java.util.Map.Entry entry)
          Access method for an one to n association.
 java.util.Iterator entriesOfPreferredPos()
          No comment provided by developer, please add a comment to improve documentation.
static SpringEmbedderLayout get()
          Use this method to get a reference to singleton layouter classes the class var is defined in AbstractLayouter.
 java.awt.Point getFromPreferredPos(FSAObject key)
          Get the fromPreferredPos attribute of the SpringEmbedderLayout object
 boolean hasInPreferredPos(FSAObject key, java.awt.Point value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInPreferredPos(java.awt.Point value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasKeyInPreferredPos(FSAObject key)
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfPreferredPos()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator keysOfPreferredPos()
          No comment provided by developer, please add a comment to improve documentation.
 void reLayout(FSAContainer currentCanvas)
          UMLMethod: '+ reLayout (currentCanvas : DisResizeable) : Void' Method for invoking a Spring Embedder Layout sequence.
 void removeAllFromPreferredPos()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromPreferredPos(FSAObject key, java.awt.Point value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromPreferredPos(java.awt.Point value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeKeyFromPreferredPos(FSAObject key)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfPreferredPos()
          No comment provided by developer, please add a comment to improve documentation.
private  void springEmbedderLayout(FSAContainer currentCanvas)
          Layout Algorithm doing a Spring Embedder Layout
 
Methods inherited from class de.uni_paderborn.fujaba.layout.AbstractLayouter
checkVisited, getChild, getFrame, getFromToFrame, getHorizDist, getLeft, getPreferredLen, getPresetAdjustment, getRevMyLayouter, getVertDist, innerLayout, isLastCondition, refreshOptions, searchStart, setHorizDist, setLastCondition, setLeft, setPresetAdjustment, setRevMyLayouter, setVertDist
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

myLayouter

private static SpringEmbedderLayout myLayouter
The children of the abstract Layouter are singletons, so define singleton instance.


minDist

static final int minDist
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

preferredPos

private de.upb.tools.fca.FHashMap preferredPos
                      ------------- 0..1            Assoc             0..1
 SpringEmbedderLayout | fsaObject |---------------------------------------> Point
                      ------------- springEmbedderLayout      preferredPos
 

Constructor Detail

SpringEmbedderLayout

private SpringEmbedderLayout()
Constructor of the class SpringEmbedderLayout

Method Detail

get

public static SpringEmbedderLayout get()
Use this method to get a reference to singleton layouter classes the class var is defined in AbstractLayouter.

Returns:
reference to singleton instance of Layout-Classes.

springEmbedderLayout

private void springEmbedderLayout(FSAContainer currentCanvas)
Layout Algorithm doing a Spring Embedder Layout

Parameters:
currentCanvas - the Canvas which has to be layouted

reLayout

public void reLayout(FSAContainer currentCanvas)
              throws java.lang.InterruptedException
UMLMethod: '+ reLayout (currentCanvas : DisResizeable) : Void' Method for invoking a Spring Embedder Layout sequence.

Specified by:
reLayout in class AbstractLayouter
Parameters:
currentCanvas - The Canvas which should be layouted.
Throws:
java.lang.InterruptedException - Exception description not provided

sizeOfPreferredPos

public int sizeOfPreferredPos()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeYou

public void removeYou()
No comment provided by developer, please add a comment to improve documentation.

Overrides:
removeYou in class AbstractLayouter

removeKeyFromPreferredPos

public boolean removeKeyFromPreferredPos(FSAObject key)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
key - No description provided
Returns:
No description provided

removeFromPreferredPos

public boolean removeFromPreferredPos(FSAObject key,
                                      java.awt.Point value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
key - No description provided
value - No description provided
Returns:
No description provided

removeFromPreferredPos

public boolean removeFromPreferredPos(java.awt.Point value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

removeAllFromPreferredPos

public void removeAllFromPreferredPos()
No comment provided by developer, please add a comment to improve documentation.


keysOfPreferredPos

public java.util.Iterator keysOfPreferredPos()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

iteratorOfPreferredPos

public java.util.Iterator iteratorOfPreferredPos()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

hasKeyInPreferredPos

public boolean hasKeyInPreferredPos(FSAObject key)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
key - No description provided
Returns:
No description provided

hasInPreferredPos

public boolean hasInPreferredPos(FSAObject key,
                                 java.awt.Point value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
key - No description provided
value - No description provided
Returns:
No description provided

hasInPreferredPos

public boolean hasInPreferredPos(java.awt.Point value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

getFromPreferredPos

public java.awt.Point getFromPreferredPos(FSAObject key)
Get the fromPreferredPos attribute of the SpringEmbedderLayout object

Parameters:
key - No description provided
Returns:
The fromPreferredPos value

entriesOfPreferredPos

public java.util.Iterator entriesOfPreferredPos()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addToPreferredPos

public boolean addToPreferredPos(FSAObject key,
                                 java.awt.Point value)
Access method for an one to n association.

Parameters:
key - The object added.
value - The object added.
Returns:
No description provided

addToPreferredPos

public boolean addToPreferredPos(java.util.Map.Entry entry)
Access method for an one to n association.

Parameters:
entry - The object added.
Returns:
No description provided