Package com.nomagic.magicdraw.core.options

Class OrganicLayouterOptionsGroup

java.lang.Object
com.nomagic.magicdraw.core.options.OptionsGroup
com.nomagic.magicdraw.core.options.AbstractPropertyOptionsGroup
com.nomagic.magicdraw.core.options.AbstractDiagramLayouterOptionsGroup
com.nomagic.magicdraw.core.options.OrganicLayouterOptionsGroup
All Implemented Interfaces:
Cloneable
@OpenApiAll public class OrganicLayouterOptionsGroup extends AbstractDiagramLayouterOptionsGroup
Organic Layouter options group.

  • Field Details

  • Constructor Details

    • OrganicLayouterOptionsGroup

      public OrganicLayouterOptionsGroup()

  • Method Details

    • initCommonDefaultValues

      protected void initCommonDefaultValues()
      Overrides:
      initCommonDefaultValues in class AbstractDiagramLayouterOptionsGroup

    • setPreferredLinkLength

      public void setPreferredLinkLength(int len)
      Set the preferred length of all paths. The layouter tries to arrange the shapes in such a way that paths have the determined path length.
      Parameters:
      len - The given value.

    • getPreferredLinkLength

      public int getPreferredLinkLength()
      Get the preferred length of all paths. The layouter tries to arrange the shapes in such a way that paths have the determined path length.
      Returns:
      Int value.

    • setObeyShapeSize

      public void setObeyShapeSize(boolean b)
      Set The obey Shape Size. If True, the distance between two shapes is calculated with respect to shapes' size.
      Parameters:
      b - boolean.

    • isObeyShapeSize

      public boolean isObeyShapeSize()
      Checks The obay Shape Size. If True, the distance between two shapes is calculated with respect to shapes' size.
      Returns:
      true if should obey shape size, false otherwise

    • setActivateTreeBeautifier

      public void setActivateTreeBeautifier(boolean b)
      Set Activate Tree Beautifier. If True, optimizes tree-like substructures of the diagram. Optimization process might ignore some layout options.
      Parameters:
      b - boolean

    • isActivateTreeBeautifier

      public boolean isActivateTreeBeautifier()
      Checks Activate Tree Beautifier. If True, optimizes tree-like substructures of the diagram. Optimization process might ignore some layout options.
      Returns:
      boolean

    • setLayoutOnlyTopLevel

      public void setLayoutOnlyTopLevel(boolean b)
      Set Layout Only Top Level property value in order to keeps the relative position of symbols inside packages and performs the top level layout.
      Parameters:
      b - boolean.

    • isLayoutOnlyTopLevel

      public boolean isLayoutOnlyTopLevel()
      Check Layout Only Top Level property value. It indicates position of symbols inside packages is on the top level layout.
      Returns:
      true if only top level of the diagram should be layouted, false otherwise

    • setGravityFactor

      public void setGravityFactor(double d)
      Set Gravity Factor property value. This value regulates the tendency of the shapes to be placed near the center of the diagram. The greater factor is the closer shapes are placed to the center of diagram. Negative values lead to huge layouts.
      Parameters:
      d - double.

    • getGravityFactor

      public double getGravityFactor()
      Get Gravity Factor property value. This value regulates the tendency of the shapes to be placed near the center of the diagram. The greater factor is the closer shapes are placed to the center of diagram. Negative values lead to huge layouts.
      Returns:
      double

    • setPackageShapeCompactness

      public void setPackageShapeCompactness(double d)
      Set Packages Shape Compactness property value. This value control the compactness of package shape. Larger values lead to more compact package shapes but paths between packages may be longer and shapes inside packages tend to get clutched together at the center of the package.
      Parameters:
      d - double.

    • getPackageShapeCompactness

      public double getPackageShapeCompactness()
      Get Packages Shape Compactness property value. This value control the compactness of package shape. Larger values lead to more compact package shapes but paths between packages may be longer and shapes inside packages tend to get clutched together at the center of the package.
      Returns:
      double

    • setLinkAttraction

      public void setLinkAttraction(int a)
      Set Link Attraction property value. Higher values makes Layouter obey the given preferred path length.
      Parameters:
      a - int.

    • getLinkAttraction

      public int getLinkAttraction()
      Get Link Attraction property value. Higher values makes Layouter obey the given preferred path length.
      Returns:
      int.

    • setShapeRepulsion

      public void setShapeRepulsion(int a)
      Set Shape Repulsion. Higher values result in greater shape distances.
      Parameters:
      a - the shape repulsion value to set

    • getShapeRepulsion

      public int getShapeRepulsion()
      Get Shape Repulsion. Higher values result in greater shape distances.
      Returns:
      int.

    • addProperty

      public void addProperty(Property property)
      Description copied from class: AbstractPropertyOptionsGroup
      Adds property to this group. DescriptionID will be reset. To add property with description use AbstractPropertyOptionsGroup.addProperty(Property, String) method.
      Overrides:
      addProperty in class AbstractPropertyOptionsGroup
      Parameters:
      property - property to be added.