ptolemy.vergil.basic.layout

Class LayoutConfiguration

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.vergil.basic.layout.LayoutConfiguration

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class LayoutConfiguration
extends Attribute

An attribute for parameters of automatic layout. This is read by the KIELER layout action to generate a configuration for the layout algorithm.

Since:

Ptolemy II 10.0

Version:

$Id: LayoutConfiguration.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Miro Spoenemann, Christoph Daniel Schulze

See Also:

KielerLayoutAction

Accepted Rating:

Red (msp)

Proposed Rating:

Red (msp)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LayoutConfiguration.InteractionMode Available modes of user interaction.

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEF_ASPECT_RATIO Default value for aspectRatio (non-logarithmic).
static boolean	DEF_DECORATIONS Default value for includeDecorations.
static LayoutConfiguration.InteractionMode	DEF_INTERACTION_MODE Default value for interaction mode.
static boolean	DEF_MINIMIZE_BENDS Default value for minimizeBends.
static boolean	DEF_OLD_ALGORITHM Default value for useOldAlgorithm.
static double	DEF_SPACING Default value for spacing.
StringParameter	helpURL Customized help file to be displayed by the layout configuration dialog.
Parameter	includeDecorations Whether to include unconnected nodes such as comments.
ChoiceParameter	interactionMode Mode of user interaction: whether user positioning is allowed to affect the layout.
DoubleRangeParameter	logAspectRatio The aspect ratio for placement of connected components (logarithmic).
Parameter	minimizeBends Whether bends are minimized.
DoubleRangeParameter	spacing The overall spacing between graph elements.
Parameter	useOldAlgorithm Whether to use Ptolemy's original layout algorithm.

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor and Description
LayoutConfiguration(NamedObj container, java.lang.String name) Create and initialize a layout configuration.

Method Summary

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

useOldAlgorithm

public Parameter useOldAlgorithm

Whether to use Ptolemy's original layout algorithm.

includeDecorations

public Parameter includeDecorations

Whether to include unconnected nodes such as comments.

minimizeBends

public Parameter minimizeBends

Whether bends are minimized. The default value is true.

spacing

public DoubleRangeParameter spacing

The overall spacing between graph elements.

logAspectRatio

public DoubleRangeParameter logAspectRatio

The aspect ratio for placement of connected components (logarithmic).

interactionMode

public ChoiceParameter interactionMode

Mode of user interaction: whether user positioning is allowed to affect the layout.

helpURL

public StringParameter helpURL

Customized help file to be displayed by the layout configuration dialog.

DEF_OLD_ALGORITHM

public static final boolean DEF_OLD_ALGORITHM

Default value for useOldAlgorithm.

See Also:

Constant Field Values

DEF_DECORATIONS

public static final boolean DEF_DECORATIONS

Default value for includeDecorations.

See Also:

Constant Field Values

DEF_MINIMIZE_BENDS

public static final boolean DEF_MINIMIZE_BENDS

Default value for minimizeBends.

See Also:

Constant Field Values

DEF_SPACING

public static final double DEF_SPACING

Default value for spacing.

See Also:

Constant Field Values

DEF_ASPECT_RATIO

public static final double DEF_ASPECT_RATIO

Default value for aspectRatio (non-logarithmic).

See Also:

Constant Field Values

DEF_INTERACTION_MODE

public static final LayoutConfiguration.InteractionMode DEF_INTERACTION_MODE

Default value for interaction mode.

Constructor Detail

LayoutConfiguration

public LayoutConfiguration(NamedObj container,
                           java.lang.String name)
                    throws IllegalActionException,
                           NameDuplicationException

Create and initialize a layout configuration.

Parameters:

container - The container.

name - The name of this attribute.

Throws:

IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.

NameDuplicationException - If the name coincides with an attribute already in the container.