Package com.nomagic.magicdraw.core.options

Class OrthogonalLayouterOptionsGroup

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.OrthogonalLayouterOptionsGroup
All Implemented Interfaces:
Cloneable
@OpenApiAll public class OrthogonalLayouterOptionsGroup extends AbstractDiagramLayouterOptionsGroup
Organic Layouter options group.

  • Field Details

  • Constructor Details

    • OrthogonalLayouterOptionsGroup

      public OrthogonalLayouterOptionsGroup()

  • Method Details

    • initCommonDefaultValues

      protected void initCommonDefaultValues()
      Overrides:
      initCommonDefaultValues in class AbstractDiagramLayouterOptionsGroup

    • getLayoutStyle

      public String getLayoutStyle()
      Get String representation of layout style.
      Returns:
      string.

    • setLayoutStyle

      public void setLayoutStyle(String style)
      Set Layout style
      Parameters:
      style - the given layout style.

    • setLinkLengthReduction

      public void setLinkLengthReduction(boolean b)
      Set Link Length Reduction Property value. If true the overall path lengths will be reduced. The cost for the reduction is an increased execution time of the layouter.
      Parameters:
      b - boolean

    • getLinkLengthReduction

      public boolean getLinkLengthReduction()
      Get Link Length Reduction Property value. If true the overall path lengths will be reduced. The cost for the reduction is an increased execution time of the layouter.
      Returns:
      boolean

    • setUseExistingDrawingAsSketch

      public void setUseExistingDrawingAsSketch(boolean b)
      Set Use Existing Drawing As Sketch property value.. The layouter tries to "orthogonalize" the given sketch by interpreting it and without making too many modifications in respect to the original drawing.
      Parameters:
      b - true to use existing drawing as a sketch, false to layout from scratch

    • getUseExistingDrawingAsSketch

      public boolean getUseExistingDrawingAsSketch()
      Get Use Existing Drawing As Sketch property value.. The layouter tries to "orthogonalize" the given sketch by interpreting it and without making too many modifications in respect to the original drawing.
      Returns:
      boolean

    • setCrossingPostprocessing

      public void setCrossingPostprocessing(boolean b)
      Set Crossing Post precessing property value. If true the overall number of path crossings will be reduced. The cost for the reduction is increased execution time of the layouter.
      Parameters:
      b - boolean

    • getCrossingPostprocessing

      public boolean getCrossingPostprocessing()
      Get Crossing Post precessing property value. If true the overall number of path crossings will be reduced. The cost for the reduction is increased execution time of the layouter.
      Returns:
      true if cross post processing is enabled, false otherwise

    • setUseRandomization

      public void setUseRandomization(boolean b)
      Set use Randomization property value. If enabled the overall layout quality will increase with high probability. The cost for this layout optimization is increased execution time and non-deterministic behavior of the layouter.
      Parameters:
      b - true to use randomization, false otherwise

    • getUseRandomization

      public boolean getUseRandomization()
      Get use Randomization property value. If enabled the overall layout quality will increase with high probability. The cost for this layout optimization is increased execution time and non-deterministic behavior of the layouter.
      Returns:
      true if use randomization is enabled, false otherwise

    • getGroupLayoutQuality

      public double getGroupLayoutQuality()
      Get the desired layout quality. Higher values result in less connection crossings and smaller layout area, but also increased computation time.
      Returns:
      the value of group layout quality

    • setGroupLayoutQuality

      public void setGroupLayoutQuality(double d)
      Set the desired layout quality. Higher values result in less connection crossings and smaller layout area, but also increased computation time.
      Parameters:
      d - double.

    • 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:
      boolean

    • 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.

    • getGrid

      public int getGrid()
      Get Grid property value. This property defines the virtual grid spacing used by the layouter. Each shape center point lies on a grid point.
      Returns:
      int

    • setGrid

      public void setGrid(int d)
      Set Grid property value. This property defines the virtual grid spacing used by the layouter. Each shape center point lies on a grid point.
      Parameters:
      d - int