de.uni_paderborn.fujaba.layout.options
Class LayoutPreferences

java.lang.Object
  extended byde.uni_paderborn.fujaba.preferences.AbstractPreferences
      extended byde.uni_paderborn.fujaba.layout.options.LayoutPreferences

public class LayoutPreferences
extends AbstractPreferences

Contains all options of Mr Layout.

Version:
$Revision: 1.9 $
Author:
$Author: joerg $

Field Summary
private static java.lang.String COLLAPSE_CLASSES
          No comment provided by developer, please add a comment to improve documentation.
private static boolean DEF_COLLAPSE_CLASSES
          No comment provided by developer, please add a comment to improve documentation.
private static int DEF_HOR_DIST
          No comment provided by developer, please add a comment to improve documentation.
private static int DEF_MINIMUM_WIDTH
          No comment provided by developer, please add a comment to improve documentation.
private static int DEF_NUM_OF_ITER
          No comment provided by developer, please add a comment to improve documentation.
private static int DEF_SEL_ACTIVITY_DIAGRAM_LAYOUT
          No comment provided by developer, please add a comment to improve documentation.
private static int DEF_SEL_LAYOUT
          No comment provided by developer, please add a comment to improve documentation.
private static boolean DEF_SHOW_ROLE_NAMES
          No comment provided by developer, please add a comment to improve documentation.
private static double DEF_STRETCH_FACTOR
          No comment provided by developer, please add a comment to improve documentation.
private static int DEF_VER_DIST
          No comment provided by developer, please add a comment to improve documentation.
private static java.lang.String HOR_DIST
          No comment provided by developer, please add a comment to improve documentation.
private static java.lang.String MINIMUM_WIDTH
          No comment provided by developer, please add a comment to improve documentation.
private static java.lang.String NUM_OF_ITER
          No comment provided by developer, please add a comment to improve documentation.
private static LayoutPreferences options
          The instance of this singleton class.
private static java.lang.String PROPERTY_NAME
          This is the properties key for Fujaba's properties.
private static java.lang.String SEL_ACTIVITY_DIAGRAM_LAYOUT
          No comment provided by developer, please add a comment to improve documentation.
private static java.lang.String SEL_LAYOUT
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String SHOW_ROLE_NAMES
          No comment provided by developer, please add a comment to improve documentation.
private static java.lang.String STRETCH_FACTOR
          No comment provided by developer, please add a comment to improve documentation.
private static java.lang.String VER_DIST
          No comment provided by developer, please add a comment to improve documentation.
 
Fields inherited from class de.uni_paderborn.fujaba.preferences.AbstractPreferences
 
Constructor Summary
private LayoutPreferences()
          The private constructor for this class.
 
Method Summary
static LayoutPreferences get()
          This method provides the user the singleton instance of this class.
 int getHorizDist()
          Get the horizDist attribute of the LayoutPreferences object
 int getMinimumWidth()
          Get the minimumWidth attribute of the LayoutPreferences object
 int getNumberIterations()
          How many iterations should the spring embedder do.
 double getStretchFactor()
          A multiplier for the edge stretching.
 int getVertDist()
          Get the vertDist attribute of the LayoutPreferences object
 int getWhichActivityDiagramLayout()
          Get the whichActivityDiagramLayout attribute of the LayoutPreferences object
 int getWhichLayout()
          Get the whichLayout attribute of the LayoutPreferences object
 boolean isCollapseClasses()
          CollapseClasses indicates if classes should be collapsed initially when adding to class diagram.
 boolean isShowRoleNames()
          Get the showRoleNames attribute of the GeneralPreferences object
 void setCollapseClasses(boolean value)
          CollapseClasses indicates if classes should be collapsed initially when adding to class diagram.
 void setDefaults()
          Set the default values for all options.
 void setHorizDist(int value)
          Sets the horizDist attribute of the LayoutPreferences object
 void setHorizDist(java.lang.String newDist)
          Sets the horizDist attribute of the LayoutPreferences object
 void setMinimumWidth(int value)
          Sets the minimumWidth attribute of the LayoutPreferences object
 void setMinimumWidth(java.lang.String newWidth)
          Sets the minimumWidth attribute of the LayoutPreferences object
 void setNumberIterations(int value)
          How many iterations should the spring embedder do.
 void setNumberIterations(java.lang.String newIterations)
          How many iterations should the spring embedder do.
 void setShowRoleNames(boolean value)
          Sets the showRoleNames attribute of the GeneralPreferences object
 void setStretchFactor(double value)
          A multiplier for the edge stretching.
 void setStretchFactor(java.lang.String newStretchFactor)
          A multiplier for the edge stretching.
 void setVertDist(int value)
          Sets the vertDist attribute of the LayoutPreferences object
 void setVertDist(java.lang.String newDist)
          Sets the vertDist attribute of the LayoutPreferences object
 void setWhichActivityDiagramLayout(int value)
          Sets the whichActivityDiagramLayout attribute of the LayoutPreferences object
 void setWhichLayout(int value)
          Sets the whichLayout attribute of the LayoutPreferences object
 
Methods inherited from class de.uni_paderborn.fujaba.preferences.AbstractPreferences
addPropertyChangeListener, isModified, removePropertyChangeListener, setModified
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_NAME

private static final java.lang.String PROPERTY_NAME
This is the properties key for Fujaba's properties.

See Also:
Constant Field Values

COLLAPSE_CLASSES

private static final java.lang.String COLLAPSE_CLASSES
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

SHOW_ROLE_NAMES

public static final java.lang.String SHOW_ROLE_NAMES
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

SEL_LAYOUT

private static final java.lang.String SEL_LAYOUT
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

SEL_ACTIVITY_DIAGRAM_LAYOUT

private static final java.lang.String SEL_ACTIVITY_DIAGRAM_LAYOUT
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

HOR_DIST

private static final java.lang.String HOR_DIST
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

VER_DIST

private static final java.lang.String VER_DIST
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

NUM_OF_ITER

private static final java.lang.String NUM_OF_ITER
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

MINIMUM_WIDTH

private static final java.lang.String MINIMUM_WIDTH
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

STRETCH_FACTOR

private static final java.lang.String STRETCH_FACTOR
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

DEF_COLLAPSE_CLASSES

private static final boolean DEF_COLLAPSE_CLASSES
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

DEF_SHOW_ROLE_NAMES

private static final boolean DEF_SHOW_ROLE_NAMES
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

DEF_SEL_LAYOUT

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

See Also:
Constant Field Values

DEF_SEL_ACTIVITY_DIAGRAM_LAYOUT

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

See Also:
Constant Field Values

DEF_HOR_DIST

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

See Also:
Constant Field Values

DEF_VER_DIST

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

See Also:
Constant Field Values

DEF_MINIMUM_WIDTH

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

See Also:
Constant Field Values

DEF_NUM_OF_ITER

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

See Also:
Constant Field Values

DEF_STRETCH_FACTOR

private static final double DEF_STRETCH_FACTOR
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

options

private static LayoutPreferences options
The instance of this singleton class. Use LayoutPreferences.get() to get an instance of this class.

See Also:
get()
Constructor Detail

LayoutPreferences

private LayoutPreferences()
The private constructor for this class. Use LayoutPreferences.get() to get an instance of this class.

See Also:
get()
Method Detail

get

public static LayoutPreferences get()
This method provides the user the singleton instance of this class.

Returns:
No description provided

setDefaults

public void setDefaults()
Set the default values for all options.

Specified by:
setDefaults in class AbstractPreferences

isCollapseClasses

public boolean isCollapseClasses()
CollapseClasses indicates if classes should be collapsed initially when adding to class diagram.

Returns:
true if classes should be collapsed initially.

setCollapseClasses

public void setCollapseClasses(boolean value)
CollapseClasses indicates if classes should be collapsed initially when adding to class diagram.

Parameters:
value -

setShowRoleNames

public void setShowRoleNames(boolean value)
Sets the showRoleNames attribute of the GeneralPreferences object

Parameters:
value - The new showRoleNames value

isShowRoleNames

public boolean isShowRoleNames()
Get the showRoleNames attribute of the GeneralPreferences object

Returns:
The showRoleNames value

getWhichActivityDiagramLayout

public int getWhichActivityDiagramLayout()
Get the whichActivityDiagramLayout attribute of the LayoutPreferences object

Returns:
The whichActivityDiagramLayout value

setWhichActivityDiagramLayout

public void setWhichActivityDiagramLayout(int value)
Sets the whichActivityDiagramLayout attribute of the LayoutPreferences object

Parameters:
value - The new whichActivityDiagramLayout value

getWhichLayout

public int getWhichLayout()
Get the whichLayout attribute of the LayoutPreferences object

Returns:
The whichLayout value

setWhichLayout

public void setWhichLayout(int value)
Sets the whichLayout attribute of the LayoutPreferences object

Parameters:
value - The new whichLayout value

getHorizDist

public int getHorizDist()
Get the horizDist attribute of the LayoutPreferences object

Returns:
The horizDist value

setHorizDist

public void setHorizDist(int value)
Sets the horizDist attribute of the LayoutPreferences object

Parameters:
value - The new horizDist value

setHorizDist

public void setHorizDist(java.lang.String newDist)
Sets the horizDist attribute of the LayoutPreferences object

Parameters:
newDist - The new horizDist value

getVertDist

public int getVertDist()
Get the vertDist attribute of the LayoutPreferences object

Returns:
The vertDist value

setVertDist

public void setVertDist(int value)
Sets the vertDist attribute of the LayoutPreferences object

Parameters:
value - The new vertDist value

setVertDist

public void setVertDist(java.lang.String newDist)
Sets the vertDist attribute of the LayoutPreferences object

Parameters:
newDist - The new vertDist value

getMinimumWidth

public int getMinimumWidth()
Get the minimumWidth attribute of the LayoutPreferences object

Returns:
The vertDist value

setMinimumWidth

public void setMinimumWidth(int value)
Sets the minimumWidth attribute of the LayoutPreferences object

Parameters:
value - The new vertDist value

setMinimumWidth

public void setMinimumWidth(java.lang.String newWidth)
Sets the minimumWidth attribute of the LayoutPreferences object

Parameters:
newWidth - The new minimumWidth value

getNumberIterations

public int getNumberIterations()
How many iterations should the spring embedder do.

Returns:
The numberIterations value

setNumberIterations

public void setNumberIterations(int value)
How many iterations should the spring embedder do.

Parameters:
value - The new numberIterations value

setNumberIterations

public void setNumberIterations(java.lang.String newIterations)
How many iterations should the spring embedder do.

Parameters:
newIterations - The new numberIterations value

getStretchFactor

public double getStretchFactor()
A multiplier for the edge stretching.

Returns:
The stretchFactor value

setStretchFactor

public void setStretchFactor(double value)
A multiplier for the edge stretching.

Parameters:
value - The new stretchFactor value

setStretchFactor

public void setStretchFactor(java.lang.String newStretchFactor)
A multiplier for the edge stretching.

Parameters:
newStretchFactor - The new stretchFactor value