Package org.eclipse.gef.layout

Class LayoutProperties

java.lang.Object
org.eclipse.gef.layout.LayoutProperties
public class LayoutProperties extends Object
LayoutProperties contains all properties which can be accessed on Graph, Edge, Node, their default values, as well as static accessor methods for those properties.

  • Field Details

    • BOUNDS_PROPERTY

      public static final String BOUNDS_PROPERTY
      Stores the bounds in which the graph elements can be placed.
      See Also:

    • LOCATION_PROPERTY

      public static final String LOCATION_PROPERTY
      Stores the location of this EntityLayout.
      See Also:

    • SIZE_PROPERTY

      public static final String SIZE_PROPERTY
      Stores the size of this EntityLayout.
      See Also:

    • MOVABLE_PROPERTY

      public static final String MOVABLE_PROPERTY
      Stores the movable state of this EntityLayout.
      See Also:

    • DEFAULT_MOVABLE

      public static final Boolean DEFAULT_MOVABLE
      Defines the default value for the MOVABLE_PROPERTY.

    • RESIZABLE_PROPERTY

      public static final String RESIZABLE_PROPERTY
      Stores the resizable state of this EntityLayout. A resizable EntityLayout may be resized by a layout algorithm.
      See Also:

    • DEFAULT_RESIZABLE

      public static final Boolean DEFAULT_RESIZABLE
      Defines the default value for the RESIZABLE_PROPERTY.

    • ASPECT_RATIO_PROPERTY

      public static final String ASPECT_RATIO_PROPERTY
      Stores the preferred aspect ratio (width / height) for this EntityLayout.
      See Also:

    • DEFAULT_ASPECT_RATIO

      public static final Double DEFAULT_ASPECT_RATIO
      Defines the default value for the ASPECT_RATIO_PROPERTY.

    • WEIGHT_PROPERTY

      public static final String WEIGHT_PROPERTY
      Stores a weight for this connection.
      See Also:

    • DEFAULT_WEIGHT

      public static final Double DEFAULT_WEIGHT
      Defines the default value for the WEIGHT_PROPERTY.

    • DIRECTION_TOP_DOWN

      public static final int DIRECTION_TOP_DOWN
      Constant for top-down direction (default).
      See Also:

    • DIRECTION_BOTTOM_UP

      public static final int DIRECTION_BOTTOM_UP
      Constant for bottom-up direction.
      See Also:

    • DIRECTION_LEFT_RIGHT

      public static final int DIRECTION_LEFT_RIGHT
      Constant for direction from left to right.
      See Also:

    • DIRECTION_RIGHT_LEFT

      public static final int DIRECTION_RIGHT_LEFT
      Constant for direction from right to left.
      See Also:

    • DIRECTION_PROPERTY

      public static final String DIRECTION_PROPERTY
      Stores the direction of this subgraph.
      See Also:

    • DEFAULT_DIRECTION

      public static final Integer DEFAULT_DIRECTION
      Defines the default value for the DIRECTION_PROPERTY.

  • Constructor Details

    • LayoutProperties

      public LayoutProperties()

  • Method Details

    • getBounds

      public static Rectangle getBounds(org.eclipse.gef.graph.Graph graph)
      Returns the value of the BOUNDS_PROPERTY of the given LayoutContext.
      Parameters:
      graph - The Graph whose BOUNDS_PROPERTY is read.
      Returns:
      The value of the BOUNDS_PROPERTY of the given Graph.

    • setBounds

      public static void setBounds(org.eclipse.gef.graph.Graph graph, Rectangle bounds)
      Sets the value of the BOUNDS_PROPERTY of the given LayoutContext to the given value.
      Parameters:
      graph - The Graph whose BOUNDS_PROPERTY is changed.
      bounds - The new value for the BOUNDS_PROPERTY of the given Graph.

    • getLocation

      public static Point getLocation(org.eclipse.gef.graph.Node node)
      Returns the value of the LOCATION_PROPERTY of the given Node.
      Parameters:
      node - The Node whose LOCATION_PROPERTY is read.
      Returns:
      The value of the LOCATION_PROPERTY of the given Node.

    • getSize

      public static Dimension getSize(org.eclipse.gef.graph.Node node)
      Returns the value of the SIZE_PROPERTY of the given Node .
      Parameters:
      node - The Node whose SIZE_PROPERTY is read.
      Returns:
      The value of the SIZE_PROPERTY of the given Node .

    • getPreferredAspectRatio

      public static Double getPreferredAspectRatio(org.eclipse.gef.graph.Node node)
      Returns the value of the ASPECT_RATIO_PROPERTY of the given Node.
      Parameters:
      node - The Node whose ASPECT_RATIO_PROPERTY is read.
      Returns:
      The value of the ASPECT_RATIO_PROPERTY of the given Node.

    • isResizable

      public static Boolean isResizable(org.eclipse.gef.graph.Node node)
      Returns the value of the RESIZABLE_PROPERTY of the given Node.
      Parameters:
      node - The Node whose RESIZABLE_PROPERTY is read.
      Returns:
      The value of the RESIZABLE_PROPERTY of the given Node.

    • isMovable

      public static Boolean isMovable(org.eclipse.gef.graph.Node node)
      Returns the value of the MOVABLE_PROPERTY of the given Node.
      Parameters:
      node - The Node whose MOVABLE_PROPERTY is read.
      Returns:
      The value of the MOVABLE_PROPERTY of the given Node.

    • setLocation

      public static void setLocation(org.eclipse.gef.graph.Node node, Point location)
      Sets the value of the LOCATION_PROPERTY of the given Node to the given value.
      Parameters:
      node - The Node whose LOCATION_PROPERTY is changed.
      location - The new location for the LOCATION_PROPERTY of the given Node.

    • setSize

      public static void setSize(org.eclipse.gef.graph.Node node, Dimension size)
      Sets the value of the SIZE_PROPERTY of the given Node to the given value.
      Parameters:
      node - The Node whose SIZE_PROPERTY is changed.
      size - The new size for the SIZE_PROPERTY of the given Node.

    • setResizable

      public static void setResizable(org.eclipse.gef.graph.Node node, boolean resizable)
      Sets the value of the RESIZABLE_PROPERTY of the given Node to the given value.
      Parameters:
      node - The Node whose RESIZABLE_PROPERTY is changed.
      resizable - The new value for the RESIZABLE_PROPERTY of the given Node.

    • getWeight

      public static Double getWeight(org.eclipse.gef.graph.Edge edge)
      Returns the value of the WEIGHT_PROPERTY of the given Edge.
      Parameters:
      edge - The Edge whose WEIGHT_PROPERTY is read.
      Returns:
      The value of the WEIGHT_PROPERTY of the given Edge.

    • setWeight

      public static void setWeight(org.eclipse.gef.graph.Edge edge, double weight)
      Sets the value of the WEIGHT_PROPERTY of the given Edge to the given value.
      Parameters:
      edge - The Edge whose WEIGHT_PROPERTY is changed.
      weight - The new value for the WEIGHT_PROPERTY of the given Edge.