Package org.eclipse.gef.layout
Class LayoutProperties
java.lang.Object
org.eclipse.gef.layout.LayoutProperties
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringStores the preferred aspect ratio (width / height) for this EntityLayout.static final StringStores the bounds in which the graph elements can be placed.static final DoubleDefines the default value for theASPECT_RATIO_PROPERTY.static final IntegerDefines the default value for theDIRECTION_PROPERTY.static final BooleanDefines the default value for theMOVABLE_PROPERTY.static final BooleanDefines the default value for theRESIZABLE_PROPERTY.static final DoubleDefines the default value for theWEIGHT_PROPERTY.static final intConstant for bottom-up direction.static final intConstant for direction from left to right.static final StringStores the direction of this subgraph.static final intConstant for direction from right to left.static final intConstant for top-down direction (default).static final StringStores the location of this EntityLayout.static final StringStores the movable state of this EntityLayout.static final StringStores the resizable state of this EntityLayout.static final StringStores the size of this EntityLayout.static final StringStores a weight for this connection. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic RectanglegetBounds(org.eclipse.gef.graph.Graph graph) Returns the value of theBOUNDS_PROPERTYof the givenLayoutContext.static PointgetLocation(org.eclipse.gef.graph.Node node) Returns the value of theLOCATION_PROPERTYof the givenNode.static DoublegetPreferredAspectRatio(org.eclipse.gef.graph.Node node) Returns the value of theASPECT_RATIO_PROPERTYof the givenNode.static DimensiongetSize(org.eclipse.gef.graph.Node node) Returns the value of theSIZE_PROPERTYof the givenNode.static DoublegetWeight(org.eclipse.gef.graph.Edge edge) Returns the value of theWEIGHT_PROPERTYof the givenEdge.static BooleanisMovable(org.eclipse.gef.graph.Node node) Returns the value of theMOVABLE_PROPERTYof the givenNode.static BooleanisResizable(org.eclipse.gef.graph.Node node) Returns the value of theRESIZABLE_PROPERTYof the givenNode.static voidSets the value of theBOUNDS_PROPERTYof the givenLayoutContextto the given value.static voidsetLocation(org.eclipse.gef.graph.Node node, Point location) Sets the value of theLOCATION_PROPERTYof the givenNodeto the given value.static voidsetResizable(org.eclipse.gef.graph.Node node, boolean resizable) Sets the value of theRESIZABLE_PROPERTYof the givenNodeto the given value.static voidSets the value of theSIZE_PROPERTYof the givenNodeto the given value.static voidsetWeight(org.eclipse.gef.graph.Edge edge, double weight) Sets the value of theWEIGHT_PROPERTYof the givenEdgeto the given value.
-
Field Details
-
BOUNDS_PROPERTY
Stores the bounds in which the graph elements can be placed.- See Also:
-
LOCATION_PROPERTY
Stores the location of this EntityLayout.- See Also:
-
SIZE_PROPERTY
Stores the size of this EntityLayout.- See Also:
-
MOVABLE_PROPERTY
Stores the movable state of this EntityLayout.- See Also:
-
DEFAULT_MOVABLE
Defines the default value for theMOVABLE_PROPERTY. -
RESIZABLE_PROPERTY
Stores the resizable state of this EntityLayout. A resizable EntityLayout may be resized by a layout algorithm.- See Also:
-
DEFAULT_RESIZABLE
Defines the default value for theRESIZABLE_PROPERTY. -
ASPECT_RATIO_PROPERTY
Stores the preferred aspect ratio (width / height) for this EntityLayout.- See Also:
-
DEFAULT_ASPECT_RATIO
Defines the default value for theASPECT_RATIO_PROPERTY. -
WEIGHT_PROPERTY
Stores a weight for this connection.- See Also:
-
DEFAULT_WEIGHT
Defines the default value for theWEIGHT_PROPERTY. -
DIRECTION_TOP_DOWN
public static final int DIRECTION_TOP_DOWNConstant for top-down direction (default).- See Also:
-
DIRECTION_BOTTOM_UP
public static final int DIRECTION_BOTTOM_UPConstant for bottom-up direction.- See Also:
-
DIRECTION_LEFT_RIGHT
public static final int DIRECTION_LEFT_RIGHTConstant for direction from left to right.- See Also:
-
DIRECTION_RIGHT_LEFT
public static final int DIRECTION_RIGHT_LEFTConstant for direction from right to left.- See Also:
-
DIRECTION_PROPERTY
Stores the direction of this subgraph.- See Also:
-
DEFAULT_DIRECTION
Defines the default value for theDIRECTION_PROPERTY.
-
-
Constructor Details
-
LayoutProperties
public LayoutProperties()
-
-
Method Details
-
getBounds
Returns the value of theBOUNDS_PROPERTYof the givenLayoutContext.- Parameters:
graph- TheGraphwhoseBOUNDS_PROPERTYis read.- Returns:
- The value of the
BOUNDS_PROPERTYof the givenGraph.
-
setBounds
Sets the value of theBOUNDS_PROPERTYof the givenLayoutContextto the given value.- Parameters:
graph- TheGraphwhoseBOUNDS_PROPERTYis changed.bounds- The new value for theBOUNDS_PROPERTYof the givenGraph.
-
getLocation
Returns the value of theLOCATION_PROPERTYof the givenNode.- Parameters:
node- TheNodewhoseLOCATION_PROPERTYis read.- Returns:
- The value of the
LOCATION_PROPERTYof the givenNode.
-
getSize
Returns the value of theSIZE_PROPERTYof the givenNode.- Parameters:
node- TheNodewhoseSIZE_PROPERTYis read.- Returns:
- The value of the
SIZE_PROPERTYof the givenNode.
-
getPreferredAspectRatio
Returns the value of theASPECT_RATIO_PROPERTYof the givenNode.- Parameters:
node- TheNodewhoseASPECT_RATIO_PROPERTYis read.- Returns:
- The value of the
ASPECT_RATIO_PROPERTYof the givenNode.
-
isResizable
Returns the value of theRESIZABLE_PROPERTYof the givenNode.- Parameters:
node- TheNodewhoseRESIZABLE_PROPERTYis read.- Returns:
- The value of the
RESIZABLE_PROPERTYof the givenNode.
-
isMovable
Returns the value of theMOVABLE_PROPERTYof the givenNode.- Parameters:
node- TheNodewhoseMOVABLE_PROPERTYis read.- Returns:
- The value of the
MOVABLE_PROPERTYof the givenNode.
-
setLocation
Sets the value of theLOCATION_PROPERTYof the givenNodeto the given value.- Parameters:
node- TheNodewhoseLOCATION_PROPERTYis changed.location- The new location for theLOCATION_PROPERTYof the givenNode.
-
setSize
Sets the value of theSIZE_PROPERTYof the givenNodeto the given value.- Parameters:
node- TheNodewhoseSIZE_PROPERTYis changed.size- The new size for theSIZE_PROPERTYof the givenNode.
-
setResizable
public static void setResizable(org.eclipse.gef.graph.Node node, boolean resizable) Sets the value of theRESIZABLE_PROPERTYof the givenNodeto the given value.- Parameters:
node- TheNodewhoseRESIZABLE_PROPERTYis changed.resizable- The new value for theRESIZABLE_PROPERTYof the givenNode.
-
getWeight
Returns the value of theWEIGHT_PROPERTYof the givenEdge.- Parameters:
edge- TheEdgewhoseWEIGHT_PROPERTYis read.- Returns:
- The value of the
WEIGHT_PROPERTYof the givenEdge.
-
setWeight
public static void setWeight(org.eclipse.gef.graph.Edge edge, double weight) Sets the value of theWEIGHT_PROPERTYof the givenEdgeto the given value.- Parameters:
edge- TheEdgewhoseWEIGHT_PROPERTYis changed.weight- The new value for theWEIGHT_PROPERTYof the givenEdge.
-