Package com.nomagic.magicdraw.core.options

Class TreeLayouterOptionsGroup

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

  • Field Details

  • Constructor Details

    • TreeLayouterOptionsGroup

      public TreeLayouterOptionsGroup()

  • Method Details

    • initCommonDefaultValues

      protected void initCommonDefaultValues()
      Overrides:
      initCommonDefaultValues in class AbstractDiagramLayouterOptionsGroup

    • getLayoutStyle

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

    • setLayoutStyle

      public void setLayoutStyle(String s)
      Set layout style property value..
      Parameters:
      s - the new layout style

    • getMinimalLayerDistance

      public int getMinimalLayerDistance()
      Get the minimal distance between shapes that reside in adjacent layers.
      Returns:
      int value.

    • setMinimalLayerDistance

      public void setMinimalLayerDistance(int d)
      Set the minimal distance between shapes that reside in adjacent layers.
      Parameters:
      d - int value.

    • getMinimalShapeDistance

      public int getMinimalShapeDistance()
      Get the minimal distance between borders of two adjacent shapes on a common circle. The smaller the distance, the more compact resulting layout.
      Returns:
      int value.

    • setMinimalShapeDistance

      public void setMinimalShapeDistance(int d)
      Set the minimal distance between borders of two adjacent shapes on a common circle. The smaller the distance, the more compact resulting layout.
      Parameters:
      d - value.

    • getOrientation

      public String getOrientation()
      Get main layout orientation.
      Returns:
      value.

    • setOrientation

      public void setOrientation(String s)
      Set main layout orientation.
      Parameters:
      s - value.

    • getPortStyle

      public String getPortStyle()
      Get Port Style property value. Determines the way how paths are attached to shapes. Border Centered. Paths are attached to the center of the border of corresponding shapes. Border Distributed. Path attachment points are distributed along the border of corresponding shapes.
      Returns:
      a mode how paths are attached to shapes

    • setPortStyle

      public void setPortStyle(String s)
      Set Port Style property value. Determines the way how paths are attached to shapes. Border Centered. Paths are attached to the center of the border of corresponding shapes. Border Distributed. Path attachment points are distributed along the border of corresponding shapes.
      Parameters:
      s - the new port style to set

    • setOrthogonalLinkRouting

      public void setOrthogonalLinkRouting(boolean b)
      Set Orthogonal Link Routing. If selected, all paths are routed orthogonally in a bus-like fashion. If not selected, paths are routed as straight line segments.
      Parameters:
      b - boolean.

    • getOrthogonalLinkRouting

      public boolean getOrthogonalLinkRouting()
      Get Orthogonal Link Routing. If selected, all paths are routed orthogonally in a bus-like fashion. If not selected, paths are routed as straight line segments.
      Returns:
      true if links are router orthogonally, false otherwise

    • getRootShapePosition

      public String getRootShapePosition()
      Get Root Shape Position property value. Directed Root. Chooses a shape with in-degree zero if present. A good choice for directed rooted trees. Center Root. Chooses the root shape in such a way that the depth of the resulting tree is minimized.
      Returns:
      String.

    • setRootShapePosition

      public void setRootShapePosition(String s)
      Set Root Shape Position property value. Directed Root. Chooses a shape with indegree zero if present. A good choice for directed rooted trees. Center Root. Chooses the root shape in such a way that the depth of the resulting tree is minimized.
      Parameters:
      s - the shape positioning value

    • getPreferredChildWedge

      public int getPreferredChildWedge()
      Get the angular range of the sector that will be reserved for children of a shape. The remaining angular range will be automatically used to accommodate the edge that connects to the root node.
      Returns:
      int.

    • setPreferredChildWedge

      public void setPreferredChildWedge(int d)
      Set the angular range of the sector that will be reserved for children of a shape. The remaining angular range will be automatically used to accommodate the edge that connects to the root node.
      Parameters:
      d - value.

    • getPreferredRootWedge

      public int getPreferredRootWedge()
      Get the angular range of the sector that will be reserved around the root shape to accommodate attached subtrees.
      Returns:
      int

    • setPreferredRootWedge

      public void setPreferredRootWedge(int d)
      Set the angular range of the sector that will be reserved around the root shape to accommodate attached subtrees.
      Parameters:
      d - int.

    • getMinimalLinkLength

      public int getMinimalLinkLength()
      Get the minimal length of a path that connects two shapes that lie on separate circles. The smaller the chosen value, the more compact the resulting layout.
      Returns:
      the minimal length of the path

    • setMinimalLinkLength

      public void setMinimalLinkLength(int d)
      Set the minimal length of a path that connects two shapes that lie on separate circles. The smaller the chosen value, the more compact the resulting layout.
      Parameters:
      d - the new minimal path length

    • getCompactnessFactor

      public double getCompactnessFactor()
      Get compactness factor. Adjusting this value can lead to a variety of differing layouts. For small values, the resulting layout will use much space and shapes tend to be far away from each other. Values around 0.5 lead to evenly distributed shapes, whereas values near 1.0 produce highly compact layouts.
      Returns:
      compactness factor of the graph

    • setCompactnessFactor

      public void setCompactnessFactor(double d)
      Set compactness factor.
      Parameters:
      d - value.

    • getHorizontalSpacing

      public int getHorizontalSpacing()
      Get The minimal horizontal distance between adjacent shapes.
      Returns:
      int.

    • setHorizontalSpacing

      public void setHorizontalSpacing(int d)
      Set The minimal horizontal distance between adjacent shapes.
      Parameters:
      d - int value.

    • getVerticalSpacing

      public int getVerticalSpacing()
      Get The minimal vertical distance between adjacent shapes.
      Returns:
      int.

    • setVerticalSpacing

      public void setVerticalSpacing(int d)
      Set The minimal vertical distance between adjacent shapes.
      Parameters:
      d - int value.

    • setMakeSubTrees

      public void setMakeSubTrees(boolean b)
      Set Make Sub trees property value to set the inheritance paths are joined into inheritance arcs.
      Parameters:
      b - true to create tree sets, false otherwise

    • getMakeSubTrees

      public boolean getMakeSubTrees()
      Get Make Sub trees property value.
      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.

    • setShapeAlignment

      public void setShapeAlignment(String s)
      Sets shape alignment.
      Parameters:
      s - shape alignment to set.

    • getShapeAlignment

      public String getShapeAlignment()
      Gets shape alignment option value.
      Returns:
      shape alignment option value.