org.eclipse.gef4.layout

Class LayoutProperties

java.lang.Object

org.eclipse.gef4.layout.LayoutProperties

public class LayoutProperties
extends java.lang.Object

LayoutProperties contains all properties which can be accessed on ILayoutContext, IEdgeLayout, INodeLayout, their default values, as well as static accessor methods for those properties.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASPECT_RATIO_PROPERTY Stores the preferred aspect ratio (width / height) for this EntityLayout.
static java.lang.String	BOUNDS_EXPANDABLE_PROPERTY Indicates whether an algorithm is allowed to place graph elements outside of the bounds.
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 the ASPECT_RATIO_PROPERTY.
static Rectangle	DEFAULT_BOUNDS Defines the default value for the BOUNDS_PROPERTY.
static java.lang.Boolean	DEFAULT_BOUNDS_EXPANDABLE Defines the default value for the BOUNDS_EXPANDABLE_PROPERTY.
static java.lang.Boolean	DEFAULT_DIRECTED Defines the default value for the DIRECTED_PROPERTY.
static java.lang.Integer	DEFAULT_DIRECTION Defines the default value for the DIRECTION_PROPERTY.
static java.lang.Boolean	DEFAULT_DIRECTION_DEPENDANT Defines the default value for the DIRECTION_DEPENDANT_PROPERTY.
static Point	DEFAULT_LOCATION Defines the default value for the LOCATION_PROPERTY.
static java.lang.Boolean	DEFAULT_MINIMIZED Defines the default value for the MINIMIZED_PROPERTY.
static java.lang.Boolean	DEFAULT_MOVABLE Defines the default value for the MOVABLE_PROPERTY.
static java.lang.Boolean	DEFAULT_RESIZABLE Defines the default value for the RESIZABLE_PROPERTY.
static Dimension	DEFAULT_SIZE Defines the default value for the SIZE_PROPERTY.
static java.lang.Boolean	DEFAULT_VISIBLE Defines the default value for the VISIBLE_PROPERTY.
static java.lang.Double	DEFAULT_WEIGHT Defines the default value for the WEIGHT_PROPERTY.
static java.lang.String	DIRECTED_PROPERTY Stores a weight for this connection.
static int	DIRECTION_BOTTOM_UP Constant for bottom-up direction.
static java.lang.String	DIRECTION_DEPENDANT_PROPERTY Indicates whether this subgraph is visualized differently depending on its .
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	MINIMIZED_PROPERTY Stores the minimized state of this NodeLayout.
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	VISIBLE_PROPERTY Stores the visibility state of the entity.
static java.lang.String	WEIGHT_PROPERTY Stores a weight for this connection.

Constructor Summary

Constructors

Constructor and Description
LayoutProperties()

Method Summary

Modifier and Type	Method and Description
static Rectangle	getBounds(ILayoutContext context) Returns the value of the BOUNDS_PROPERTY of the given ILayoutContext.
static Point	getLocation(INodeLayout node) Returns the value of the LOCATION_PROPERTY of the given INodeLayout.
static java.lang.Double	getPreferredAspectRatio(INodeLayout node) Returns the value of the ASPECT_RATIO_PROPERTY of the given INodeLayout.
static Dimension	getSize(INodeLayout node) Returns the value of the SIZE_PROPERTY of the given INodeLayout.
static java.lang.Double	getWeight(IEdgeLayout edge) Returns the value of the WEIGHT_PROPERTY of the given IEdgeLayout.
static java.lang.Boolean	isBoundsExpandable(ILayoutContext context) Returns the value of the BOUNDS_EXPANDABLE_PROPERTY of the given ILayoutContext.
static java.lang.Boolean	isDirected(IEdgeLayout edge) Returns the value of the DIRECTED_PROPERTY of the given IEdgeLayout.
static java.lang.Boolean	isMinimized(INodeLayout node) Returns the value of the MINIMIZED_PROPERTY of the given INodeLayout.
static java.lang.Boolean	isMovable(INodeLayout node) Returns the value of the MOVABLE_PROPERTY of the given INodeLayout.
static java.lang.Boolean	isResizable(INodeLayout node) Returns the value of the RESIZABLE_PROPERTY of the given INodeLayout.
static java.lang.Boolean	isVisible(IEdgeLayout edge) Returns the value of the VISIBLE_PROPERTY of the given IEdgeLayout.
static java.lang.Boolean	isVisible(INodeLayout node) Returns the value of the VISIBLE_PROPERTY of the given INodeLayout.
static void	setBounds(ILayoutContext context, Rectangle bounds) Sets the value of the BOUNDS_PROPERTY of the given ILayoutContext to the given value.
static void	setBoundsExpandable(ILayoutContext context, boolean boundsExpandable) Sets the value of the BOUNDS_EXPANDABLE_PROPERTY of the given ILayoutContext to the given value.
static void	setDirected(IEdgeLayout edge, boolean directed) Sets the value of the DIRECTED_PROPERTY of the given IEdgeLayout to the given value.
static void	setLocation(INodeLayout node, double x, double y) Sets the value of the LOCATION_PROPERTY of the given INodeLayout to the given value.
static void	setMinimized(INodeLayout node, boolean minimized) Sets the value of the MINIMIZED_PROPERTY of the given INodeLayout to the given value.
static void	setResizable(INodeLayout node, boolean resizable) Sets the value of the RESIZABLE_PROPERTY of the given INodeLayout to the given value.
static void	setSize(INodeLayout node, double w, double h) Sets the value of the SIZE_PROPERTY of the given INodeLayout to the given value.
static void	setVisible(IEdgeLayout edge, boolean visible) Sets the value of the VISIBLE_PROPERTY of the given IEdgeLayout to the given value.
static void	setWeight(IEdgeLayout edge, double weight) Sets the value of the WEIGHT_PROPERTY of the given IEdgeLayout to the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

DEFAULT_BOUNDS

public static final Rectangle DEFAULT_BOUNDS

Defines the default value for the BOUNDS_PROPERTY.

BOUNDS_EXPANDABLE_PROPERTY

public static final java.lang.String BOUNDS_EXPANDABLE_PROPERTY

Indicates whether an algorithm is allowed to place graph elements outside of the bounds.

See Also:

Constant Field Values

DEFAULT_BOUNDS_EXPANDABLE

public static final java.lang.Boolean DEFAULT_BOUNDS_EXPANDABLE

Defines the default value for the BOUNDS_EXPANDABLE_PROPERTY.

LOCATION_PROPERTY

public static final java.lang.String LOCATION_PROPERTY

Stores the location of this EntityLayout.

See Also:

Constant Field Values

DEFAULT_LOCATION

public static final Point DEFAULT_LOCATION

Defines the default value for the LOCATION_PROPERTY.

SIZE_PROPERTY

public static final java.lang.String SIZE_PROPERTY

Stores the size of this EntityLayout.

See Also:

Constant Field Values

DEFAULT_SIZE

public static final Dimension DEFAULT_SIZE

Defines the default value for the SIZE_PROPERTY.

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 the MOVABLE_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 the RESIZABLE_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 the ASPECT_RATIO_PROPERTY.

VISIBLE_PROPERTY

public static final java.lang.String VISIBLE_PROPERTY

Stores the visibility state of the entity.

See Also:

Constant Field Values

DEFAULT_VISIBLE

public static final java.lang.Boolean DEFAULT_VISIBLE

Defines the default value for the VISIBLE_PROPERTY.

MINIMIZED_PROPERTY

public static final java.lang.String MINIMIZED_PROPERTY

Stores the minimized state of this NodeLayout. A minimized NodeLayout resizes its visual to (0, 0). When it is unminimized, it resizes it back to its previous dimension. Note that a NodeLayout can be minimized even if it is not resizable.

See Also:

Constant Field Values

DEFAULT_MINIMIZED

public static final java.lang.Boolean DEFAULT_MINIMIZED

Defines the default value for the MINIMIZED_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 the WEIGHT_PROPERTY.

DIRECTED_PROPERTY

public static final java.lang.String DIRECTED_PROPERTY

Stores a weight for this connection.

See Also:

Constant Field Values

DEFAULT_DIRECTED

public static final java.lang.Boolean DEFAULT_DIRECTED

Defines the default value for the DIRECTED_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 the DIRECTION_PROPERTY.

DIRECTION_DEPENDANT_PROPERTY

public static final java.lang.String DIRECTION_DEPENDANT_PROPERTY

Indicates whether this subgraph is visualized differently depending on its .

See Also:

Constant Field Values

DEFAULT_DIRECTION_DEPENDANT

public static final java.lang.Boolean DEFAULT_DIRECTION_DEPENDANT

Defines the default value for the DIRECTION_DEPENDANT_PROPERTY.

Constructor Detail

LayoutProperties

public LayoutProperties()

Method Detail

getBounds

public static Rectangle getBounds(ILayoutContext context)

Returns the value of the BOUNDS_PROPERTY of the given ILayoutContext.

Parameters:

context - The ILayoutContext whose BOUNDS_PROPERTY is read.

Returns:

The value of the BOUNDS_PROPERTY of the given ILayoutContext.

setBounds

public static void setBounds(ILayoutContext context,
                             Rectangle bounds)

Sets the value of the BOUNDS_PROPERTY of the given ILayoutContext to the given value.

Parameters:

context - The ILayoutContext whose BOUNDS_PROPERTY is changed.

bounds - The new value for the BOUNDS_PROPERTY of the given ILayoutContext.

isBoundsExpandable

public static java.lang.Boolean isBoundsExpandable(ILayoutContext context)

Returns the value of the BOUNDS_EXPANDABLE_PROPERTY of the given ILayoutContext.

Parameters:

context - The ILayoutContext whose BOUNDS_EXPANDABLE_PROPERTY is read.

Returns:

The value of the BOUNDS_EXPANDABLE_PROPERTY of the given ILayoutContext.

setBoundsExpandable

public static void setBoundsExpandable(ILayoutContext context,
                                       boolean boundsExpandable)

Sets the value of the BOUNDS_EXPANDABLE_PROPERTY of the given ILayoutContext to the given value.

Parameters:

context - The ILayoutContext whose BOUNDS_EXPANDABLE_PROPERTY is changed.

boundsExpandable - The new value for the BOUNDS_EXPANDABLE_PROPERTY of the given ILayoutContext.

getLocation

public static Point getLocation(INodeLayout node)

Returns the value of the LOCATION_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose LOCATION_PROPERTY is read.

Returns:

The value of the LOCATION_PROPERTY of the given INodeLayout.

getSize

public static Dimension getSize(INodeLayout node)

Returns the value of the SIZE_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose SIZE_PROPERTY is read.

Returns:

The value of the SIZE_PROPERTY of the given INodeLayout.

getPreferredAspectRatio

public static java.lang.Double getPreferredAspectRatio(INodeLayout node)

Returns the value of the ASPECT_RATIO_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose ASPECT_RATIO_PROPERTY is read.

Returns:

The value of the ASPECT_RATIO_PROPERTY of the given INodeLayout.

isResizable

public static java.lang.Boolean isResizable(INodeLayout node)

Returns the value of the RESIZABLE_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose RESIZABLE_PROPERTY is read.

Returns:

The value of the RESIZABLE_PROPERTY of the given INodeLayout.

isMovable

public static java.lang.Boolean isMovable(INodeLayout node)

Returns the value of the MOVABLE_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose MOVABLE_PROPERTY is read.

Returns:

The value of the MOVABLE_PROPERTY of the given INodeLayout.

setLocation

public static void setLocation(INodeLayout node,
                               double x,
                               double y)

Sets the value of the LOCATION_PROPERTY of the given INodeLayout to the given value.

Parameters:

node - The INodeLayout whose LOCATION_PROPERTY is changed.

x - The new x coordinate for the LOCATION_PROPERTY of the given INodeLayout.

y - The new y coordinate for the LOCATION_PROPERTY of the given INodeLayout.

setSize

public static void setSize(INodeLayout node,
                           double w,
                           double h)

Sets the value of the SIZE_PROPERTY of the given INodeLayout to the given value.

Parameters:

node - The INodeLayout whose SIZE_PROPERTY is changed.

w - The new width for the SIZE_PROPERTY of the given INodeLayout.

h - The new height for the SIZE_PROPERTY of the given INodeLayout.

setResizable

public static void setResizable(INodeLayout node,
                                boolean resizable)

Sets the value of the RESIZABLE_PROPERTY of the given INodeLayout to the given value.

Parameters:

node - The INodeLayout whose RESIZABLE_PROPERTY is changed.

resizable - The new value for the RESIZABLE_PROPERTY of the given INodeLayout.

isMinimized

public static java.lang.Boolean isMinimized(INodeLayout node)

Returns the value of the MINIMIZED_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose MINIMIZED_PROPERTY is read.

Returns:

The value of the MINIMIZED_PROPERTY of the given INodeLayout.

setMinimized

public static void setMinimized(INodeLayout node,
                                boolean minimized)

Sets the value of the MINIMIZED_PROPERTY of the given INodeLayout to the given value.

Parameters:

node - The INodeLayout whose MINIMIZED_PROPERTY is changed.

minimized - The new value for the MINIMIZED_PROPERTY of the given INodeLayout.

isDirected

public static java.lang.Boolean isDirected(IEdgeLayout edge)

Returns the value of the DIRECTED_PROPERTY of the given IEdgeLayout.

Parameters:

edge - The IEdgeLayout whose DIRECTED_PROPERTY is read.

Returns:

The value of the DIRECTED_PROPERTY of the given IEdgeLayout.

isVisible

public static java.lang.Boolean isVisible(IEdgeLayout edge)

Returns the value of the VISIBLE_PROPERTY of the given IEdgeLayout.

Parameters:

edge - The IEdgeLayout whose VISIBLE_PROPERTY is read.

Returns:

The value of the VISIBLE_PROPERTY of the given IEdgeLayout.

isVisible

public static java.lang.Boolean isVisible(INodeLayout node)

Returns the value of the VISIBLE_PROPERTY of the given INodeLayout.

Parameters:

node - The INodeLayout whose VISIBLE_PROPERTY is read.

Returns:

The value of the VISIBLE_PROPERTY of the given INodeLayout.

getWeight

public static java.lang.Double getWeight(IEdgeLayout edge)

Returns the value of the WEIGHT_PROPERTY of the given IEdgeLayout.

Parameters:

edge - The IEdgeLayout whose WEIGHT_PROPERTY is read.

Returns:

The value of the WEIGHT_PROPERTY of the given IEdgeLayout.

setDirected

public static void setDirected(IEdgeLayout edge,
                               boolean directed)

Sets the value of the DIRECTED_PROPERTY of the given IEdgeLayout to the given value.

Parameters:

edge - The IEdgeLayout whose DIRECTED_PROPERTY is changed.

directed - The new value for the DIRECTED_PROPERTY of the given IEdgeLayout.

setVisible

public static void setVisible(IEdgeLayout edge,
                              boolean visible)

Sets the value of the VISIBLE_PROPERTY of the given IEdgeLayout to the given value.

Parameters:

edge - The IEdgeLayout whose VISIBLE_PROPERTY is changed.

visible - The new value for the VISIBLE_PROPERTY of the given IEdgeLayout.

setWeight

public static void setWeight(IEdgeLayout edge,
                             double weight)

Sets the value of the WEIGHT_PROPERTY of the given IEdgeLayout to the given value.

Parameters:

edge - The IEdgeLayout whose WEIGHT_PROPERTY is changed.

weight - The new value for the WEIGHT_PROPERTY of the given IEdgeLayout.