Package org.eclipse.gef.layout
Class LayoutProperties
- java.lang.Object
-
- org.eclipse.gef.layout.LayoutProperties
-
public class LayoutProperties extends java.lang.Object
LayoutProperties
contains all properties which can be accessed onGraph
,Edge
,Node
, their default values, as well as static accessor methods for those properties.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ASPECT_RATIO_PROPERTY
Stores the preferred aspect ratio (width / height) for this EntityLayout.static java.lang.String
BOUNDS_PROPERTY
Stores the bounds in which the graph elements can be placed.static java.lang.Double
DEFAULT_ASPECT_RATIO
Defines the default value for theASPECT_RATIO_PROPERTY
.static java.lang.Integer
DEFAULT_DIRECTION
Defines the default value for theDIRECTION_PROPERTY
.static java.lang.Boolean
DEFAULT_MOVABLE
Defines the default value for theMOVABLE_PROPERTY
.static java.lang.Boolean
DEFAULT_RESIZABLE
Defines the default value for theRESIZABLE_PROPERTY
.static java.lang.Double
DEFAULT_WEIGHT
Defines the default value for theWEIGHT_PROPERTY
.static int
DIRECTION_BOTTOM_UP
Constant for bottom-up direction.static int
DIRECTION_LEFT_RIGHT
Constant for direction from left to right.static java.lang.String
DIRECTION_PROPERTY
Stores the direction of this subgraph.static int
DIRECTION_RIGHT_LEFT
Constant for direction from right to left.static int
DIRECTION_TOP_DOWN
Constant for top-down direction (default).static java.lang.String
LOCATION_PROPERTY
Stores the location of this EntityLayout.static java.lang.String
MOVABLE_PROPERTY
Stores the movable state of this EntityLayout.static java.lang.String
RESIZABLE_PROPERTY
Stores the resizable state of this EntityLayout.static java.lang.String
SIZE_PROPERTY
Stores the size of this EntityLayout.static java.lang.String
WEIGHT_PROPERTY
Stores a weight for this connection.
-
Constructor Summary
Constructors Constructor Description LayoutProperties()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Rectangle
getBounds(org.eclipse.gef.graph.Graph graph)
Returns the value of theBOUNDS_PROPERTY
of the givenLayoutContext
.static Point
getLocation(org.eclipse.gef.graph.Node node)
Returns the value of theLOCATION_PROPERTY
of the givenNode
.static java.lang.Double
getPreferredAspectRatio(org.eclipse.gef.graph.Node node)
Returns the value of theASPECT_RATIO_PROPERTY
of the givenNode
.static Dimension
getSize(org.eclipse.gef.graph.Node node)
Returns the value of theSIZE_PROPERTY
of the givenNode
.static java.lang.Double
getWeight(org.eclipse.gef.graph.Edge edge)
Returns the value of theWEIGHT_PROPERTY
of the givenEdge
.static java.lang.Boolean
isMovable(org.eclipse.gef.graph.Node node)
Returns the value of theMOVABLE_PROPERTY
of the givenNode
.static java.lang.Boolean
isResizable(org.eclipse.gef.graph.Node node)
Returns the value of theRESIZABLE_PROPERTY
of the givenNode
.static void
setBounds(org.eclipse.gef.graph.Graph graph, Rectangle bounds)
Sets the value of theBOUNDS_PROPERTY
of the givenLayoutContext
to the given value.static void
setLocation(org.eclipse.gef.graph.Node node, Point location)
Sets the value of theLOCATION_PROPERTY
of the givenNode
to the given value.static void
setResizable(org.eclipse.gef.graph.Node node, boolean resizable)
Sets the value of theRESIZABLE_PROPERTY
of the givenNode
to the given value.static void
setSize(org.eclipse.gef.graph.Node node, Dimension size)
Sets the value of theSIZE_PROPERTY
of the givenNode
to the given value.static void
setWeight(org.eclipse.gef.graph.Edge edge, double weight)
Sets the value of theWEIGHT_PROPERTY
of the givenEdge
to the given value.
-
-
-
Field Detail
-
BOUNDS_PROPERTY
public static final java.lang.String BOUNDS_PROPERTY
Stores the bounds in which the graph elements can be placed.- See Also:
- Constant Field Values
-
LOCATION_PROPERTY
public static final java.lang.String LOCATION_PROPERTY
Stores the location of this EntityLayout.- See Also:
- Constant Field Values
-
SIZE_PROPERTY
public static final java.lang.String SIZE_PROPERTY
Stores the size of this EntityLayout.- See Also:
- Constant Field Values
-
MOVABLE_PROPERTY
public static final java.lang.String MOVABLE_PROPERTY
Stores the movable state of this EntityLayout.- See Also:
- Constant Field Values
-
DEFAULT_MOVABLE
public static final java.lang.Boolean DEFAULT_MOVABLE
Defines the default value for theMOVABLE_PROPERTY
.
-
RESIZABLE_PROPERTY
public static final java.lang.String RESIZABLE_PROPERTY
Stores the resizable state of this EntityLayout. A resizable EntityLayout may be resized by a layout algorithm.- See Also:
- Constant Field Values
-
DEFAULT_RESIZABLE
public static final java.lang.Boolean DEFAULT_RESIZABLE
Defines the default value for theRESIZABLE_PROPERTY
.
-
ASPECT_RATIO_PROPERTY
public static final java.lang.String ASPECT_RATIO_PROPERTY
Stores the preferred aspect ratio (width / height) for this EntityLayout.- See Also:
- Constant Field Values
-
DEFAULT_ASPECT_RATIO
public static final java.lang.Double DEFAULT_ASPECT_RATIO
Defines the default value for theASPECT_RATIO_PROPERTY
.
-
WEIGHT_PROPERTY
public static final java.lang.String WEIGHT_PROPERTY
Stores a weight for this connection.- See Also:
- Constant Field Values
-
DEFAULT_WEIGHT
public static final java.lang.Double DEFAULT_WEIGHT
Defines the default value for theWEIGHT_PROPERTY
.
-
DIRECTION_TOP_DOWN
public static final int DIRECTION_TOP_DOWN
Constant for top-down direction (default).- See Also:
- Constant Field Values
-
DIRECTION_BOTTOM_UP
public static final int DIRECTION_BOTTOM_UP
Constant for bottom-up direction.- See Also:
- Constant Field Values
-
DIRECTION_LEFT_RIGHT
public static final int DIRECTION_LEFT_RIGHT
Constant for direction from left to right.- See Also:
- Constant Field Values
-
DIRECTION_RIGHT_LEFT
public static final int DIRECTION_RIGHT_LEFT
Constant for direction from right to left.- See Also:
- Constant Field Values
-
DIRECTION_PROPERTY
public static final java.lang.String DIRECTION_PROPERTY
Stores the direction of this subgraph.- See Also:
- Constant Field Values
-
DEFAULT_DIRECTION
public static final java.lang.Integer DEFAULT_DIRECTION
Defines the default value for theDIRECTION_PROPERTY
.
-
-
Method Detail
-
getBounds
public static Rectangle getBounds(org.eclipse.gef.graph.Graph graph)
Returns the value of theBOUNDS_PROPERTY
of the givenLayoutContext
.- Parameters:
graph
- TheGraph
whoseBOUNDS_PROPERTY
is read.- Returns:
- The value of the
BOUNDS_PROPERTY
of the givenGraph
.
-
setBounds
public static void setBounds(org.eclipse.gef.graph.Graph graph, Rectangle bounds)
Sets the value of theBOUNDS_PROPERTY
of the givenLayoutContext
to the given value.- Parameters:
graph
- TheGraph
whoseBOUNDS_PROPERTY
is changed.bounds
- The new value for theBOUNDS_PROPERTY
of the givenGraph
.
-
getLocation
public static Point getLocation(org.eclipse.gef.graph.Node node)
Returns the value of theLOCATION_PROPERTY
of the givenNode
.- Parameters:
node
- TheNode
whoseLOCATION_PROPERTY
is read.- Returns:
- The value of the
LOCATION_PROPERTY
of the givenNode
.
-
getSize
public static Dimension getSize(org.eclipse.gef.graph.Node node)
Returns the value of theSIZE_PROPERTY
of the givenNode
.- Parameters:
node
- TheNode
whoseSIZE_PROPERTY
is read.- Returns:
- The value of the
SIZE_PROPERTY
of the givenNode
.
-
getPreferredAspectRatio
public static java.lang.Double getPreferredAspectRatio(org.eclipse.gef.graph.Node node)
Returns the value of theASPECT_RATIO_PROPERTY
of the givenNode
.- Parameters:
node
- TheNode
whoseASPECT_RATIO_PROPERTY
is read.- Returns:
- The value of the
ASPECT_RATIO_PROPERTY
of the givenNode
.
-
isResizable
public static java.lang.Boolean isResizable(org.eclipse.gef.graph.Node node)
Returns the value of theRESIZABLE_PROPERTY
of the givenNode
.- Parameters:
node
- TheNode
whoseRESIZABLE_PROPERTY
is read.- Returns:
- The value of the
RESIZABLE_PROPERTY
of the givenNode
.
-
isMovable
public static java.lang.Boolean isMovable(org.eclipse.gef.graph.Node node)
Returns the value of theMOVABLE_PROPERTY
of the givenNode
.- Parameters:
node
- TheNode
whoseMOVABLE_PROPERTY
is read.- Returns:
- The value of the
MOVABLE_PROPERTY
of the givenNode
.
-
setLocation
public static void setLocation(org.eclipse.gef.graph.Node node, Point location)
Sets the value of theLOCATION_PROPERTY
of the givenNode
to the given value.- Parameters:
node
- TheNode
whoseLOCATION_PROPERTY
is changed.location
- The new location for theLOCATION_PROPERTY
of the givenNode
.
-
setSize
public static void setSize(org.eclipse.gef.graph.Node node, Dimension size)
Sets the value of theSIZE_PROPERTY
of the givenNode
to the given value.- Parameters:
node
- TheNode
whoseSIZE_PROPERTY
is changed.size
- The new size for theSIZE_PROPERTY
of the givenNode
.
-
setResizable
public static void setResizable(org.eclipse.gef.graph.Node node, boolean resizable)
Sets the value of theRESIZABLE_PROPERTY
of the givenNode
to the given value.- Parameters:
node
- TheNode
whoseRESIZABLE_PROPERTY
is changed.resizable
- The new value for theRESIZABLE_PROPERTY
of the givenNode
.
-
getWeight
public static java.lang.Double getWeight(org.eclipse.gef.graph.Edge edge)
Returns the value of theWEIGHT_PROPERTY
of the givenEdge
.- Parameters:
edge
- TheEdge
whoseWEIGHT_PROPERTY
is read.- Returns:
- The value of the
WEIGHT_PROPERTY
of the givenEdge
.
-
setWeight
public static void setWeight(org.eclipse.gef.graph.Edge edge, double weight)
Sets the value of theWEIGHT_PROPERTY
of the givenEdge
to the given value.- Parameters:
edge
- TheEdge
whoseWEIGHT_PROPERTY
is changed.weight
- The new value for theWEIGHT_PROPERTY
of the givenEdge
.
-
-