Package ptolemy.vergil.basic.layout.kieler

Class Parameters

  • public class Parameters
extends java.lang.Object
    Responsible for translating layout configuration parameters into the KIELER format. Parameters are read from an instance of the AbstractLayoutConfiguration attribute, which is attached to composite entities when the configuration dialog is opened.
    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Miro Spoenemann, Christoph Daniel Schulze, Ulf Rueegg
    See Also:
    AbstractLayoutConfiguration
    Pt.AcceptedRating:
    Red (msp)
    Pt.ProposedRating:
    Red (msp)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static de.cau.cs.kieler.core.properties.IProperty<java.lang.Float> ASPECT_RATIO
      Layout option for the aspect ratio of connected components.
      static de.cau.cs.kieler.core.properties.IProperty<java.lang.Boolean> DECORATIONS
      Layout option that determines whether decoration nodes are included in layout.
      static de.cau.cs.kieler.core.properties.IProperty<java.lang.Float> SPACING
      Layout option for the overall spacing between elements.
      static de.cau.cs.kieler.core.properties.IProperty<java.lang.Boolean> SPLINES
      Layout option that determines whether splines should be used for FSMs.

    • Constructor Summary

      Constructors 
      Constructor Description
      Parameters​(CompositeEntity compositeEntity)
      Create a parameters instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void configureLayout​(de.cau.cs.kieler.kiml.klayoutdata.KShapeLayout parentLayout, GraphModel graphModel)
      Configure the KIELER layout using a property holder.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DECORATIONS

        public static final de.cau.cs.kieler.core.properties.IProperty<java.lang.Boolean> DECORATIONS
        Layout option that determines whether decoration nodes are included in layout.

      • SPACING

        public static final de.cau.cs.kieler.core.properties.IProperty<java.lang.Float> SPACING
        Layout option for the overall spacing between elements.

      • ASPECT_RATIO

        public static final de.cau.cs.kieler.core.properties.IProperty<java.lang.Float> ASPECT_RATIO
        Layout option for the aspect ratio of connected components.

      • SPLINES

        public static final de.cau.cs.kieler.core.properties.IProperty<java.lang.Boolean> SPLINES
        Layout option that determines whether splines should be used for FSMs.

    • Constructor Detail

      • Parameters

        public Parameters​(CompositeEntity compositeEntity)
        Create a parameters instance.
        Parameters:
        compositeEntity - the composite entity for which parameters are retrieved.

    • Method Detail

      • configureLayout

        public void configureLayout​(de.cau.cs.kieler.kiml.klayoutdata.KShapeLayout parentLayout,
                            GraphModel graphModel)
                     throws IllegalActionException
        Configure the KIELER layout using a property holder.
        Parameters:
        parentLayout - the layout of the parent node
        graphModel - the graph model of the current diagram
        Throws:
        IllegalActionException - if one of the parameters has the wrong type