Package com.nomagic.magicdraw.core.options

Class TreeLayouterOptionsGroup

  • All Implemented Interfaces:
    java.lang.Cloneable
    @OpenApiAll
public class TreeLayouterOptionsGroup
extends AbstractDiagramLayouterOptionsGroup
    Organic Layouter options group.

    • Field Detail

      • HORIZONTAL_VERTICAL

        public static final java.lang.String HORIZONTAL_VERTICAL
        See Also:
        Constant Field Values

      • LAYOUT_STYLES

        private static final java.util.List LAYOUT_STYLES

      • BORDER_DISTRIBUTED

        public static final java.lang.String BORDER_DISTRIBUTED
        See Also:
        Constant Field Values

      • PORT_STYLES

        private static final java.util.List PORT_STYLES

      • ROOT_SHAPE_POSITIONS

        private static final java.util.List ROOT_SHAPE_POSITIONS

      • LAYOUT_STYLE_ENABLE_MAP

        private static final java.lang.Object[][] LAYOUT_STYLE_ENABLE_MAP

      • ORTHOGONAL_LINK_ENABLE_MAP

        private static final java.lang.Object[][] ORTHOGONAL_LINK_ENABLE_MAP

      • ORIENTATION_ENABLE_MAP

        private static final java.lang.Object[][] ORIENTATION_ENABLE_MAP

    • Constructor Detail

      • TreeLayouterOptionsGroup

        public TreeLayouterOptionsGroup()

    • Method Detail

      • getLayoutStyle

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

      • setLayoutStyle

        public void setLayoutStyle​(java.lang.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 java.lang.String getOrientation()
        Get main layout orientation.
        Returns:
        value.

      • setOrientation

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

      • getPortStyle

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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

      • setShapeAlignment

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

      • getShapeAlignment

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