public class LayoutProperties
extends java.lang.Object
LayoutProperties
contains all properties which can be accessed on
ILayoutContext
, IConnectionLayout
, INodeLayout
, and
ISubgraphLayout
, their default values, as well as static accessor
methods for those properties.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 java.lang.Boolean |
DEFAULT_DYNAMIC_LAYOUT_ENABLED
Defines the default value for the
DYNAMIC_LAYOUT_ENABLED_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_PRUNABLE
Defines the default value for the
PRUNABLE_PROPERTY . |
static java.lang.Boolean |
DEFAULT_PRUNING_ENABLED
Defines the default value for the
PRUNING_ENABLED_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 |
DYNAMIC_LAYOUT_ENABLED_PROPERTY
Indicates if layout algorithms can work in the background, reacting to
events/animation.
|
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 |
PRUNABLE_PROPERTY
Stores the prunable state of this NodeLayout.
|
static java.lang.String |
PRUNING_ENABLED_PROPERTY
Indicates whether an algorithm is allowed to prune nodes to subgraphs.
|
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 and Description |
---|
LayoutProperties() |
Modifier and Type | Method and Description |
---|---|
static Rectangle |
getBounds(ILayoutContext graph)
Returns the value of the
BOUNDS_PROPERTY of the given
ILayoutContext . |
static java.lang.Integer |
getDirection(ISubgraphLayout subgraph)
Returns the value of the
DIRECTION_PROPERTY of the given
ISubgraphLayout . |
static Point |
getLocation(IEntityLayout entity)
Returns the value of the
LOCATION_PROPERTY of the given
IEntityLayout . |
static java.lang.Double |
getPreferredAspectRatio(IEntityLayout entity)
Returns the value of the
ASPECT_RATIO_PROPERTY of the given
IEntityLayout . |
static Dimension |
getSize(IEntityLayout entity)
Returns the value of the
SIZE_PROPERTY of the given
IEntityLayout . |
static java.lang.Double |
getWeight(IConnectionLayout edge)
Returns the value of the
WEIGHT_PROPERTY of the given
IConnectionLayout . |
static java.lang.Boolean |
isBoundsExpandable(ILayoutContext graph)
Returns the value of the
BOUNDS_EXPANDABLE_PROPERTY of the given
ILayoutContext . |
static java.lang.Boolean |
isDirected(IConnectionLayout edge)
Returns the value of the
DIRECTED_PROPERTY of the given
IConnectionLayout . |
static java.lang.Boolean |
isDirectionDependant(ISubgraphLayout subgraph)
Returns the value of the
DIRECTION_DEPENDANT_PROPERTY of the
given ISubgraphLayout . |
static java.lang.Boolean |
isDynamicLayoutEnables(ILayoutContext graph)
Returns the value of the
DYNAMIC_LAYOUT_ENABLED_PROPERTY of the
given ILayoutContext . |
static java.lang.Boolean |
isMinimized(INodeLayout node)
Returns the value of the
MINIMIZED_PROPERTY of the given
INodeLayout . |
static java.lang.Boolean |
isMovable(IEntityLayout entity)
Returns the value of the
MOVABLE_PROPERTY of the given
IEntityLayout . |
static java.lang.Boolean |
isPrunable(INodeLayout node)
Returns the value of the
PRUNABLE_PROPERTY of the given
INodeLayout . |
static java.lang.Boolean |
isPruned(INodeLayout node)
Returns
true if the given INodeLayout is pruned to
an ISubgraphLayout , i.e. its INodeLayout.getSubgraph()
method does not return null . |
static java.lang.Boolean |
isResizable(IEntityLayout entity)
Returns the value of the
RESIZABLE_PROPERTY of the given
IEntityLayout . |
static java.lang.Boolean |
isVisible(IConnectionLayout edge)
Returns the value of the
VISIBLE_PROPERTY of the given
IConnectionLayout . |
static java.lang.Boolean |
isVisible(IEntityLayout entity)
Returns the value of the
VISIBLE_PROPERTY of the given
IEntityLayout . |
static void |
setBounds(ILayoutContext graph,
Rectangle bounds)
Sets the value of the
BOUNDS_PROPERTY of the given
ILayoutContext to the given value. |
static void |
setBoundsExpandable(ILayoutContext graph,
boolean boundsExpandable)
Sets the value of the
BOUNDS_EXPANDABLE_PROPERTY of the given
ILayoutContext to the given value. |
static void |
setDirected(IConnectionLayout edge,
boolean directed)
Sets the value of the
DIRECTED_PROPERTY of the given
IConnectionLayout to the given value. |
static void |
setDirection(ISubgraphLayout subgraph,
int direction)
Sets the value of the
DIRECTION_PROPERTY of the given
ISubgraphLayout to the given value. |
static void |
setDirectionDependant(ISubgraphLayout subgraph,
boolean isDirectionDependant)
Sets the value of the
DIRECTION_DEPENDANT_PROPERTY of the given
ISubgraphLayout to the given value. |
static void |
setDynamicLayoutEnabled(ILayoutContext graph,
boolean dynamicLayoutEnabled)
Sets the value of the
DYNAMIC_LAYOUT_ENABLED_PROPERTY of the
given ILayoutContext to the given value. |
static void |
setLocation(IEntityLayout entity,
double x,
double y)
Sets the value of the
LOCATION_PROPERTY of the given
IEntityLayout 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 |
setPrunable(INodeLayout node,
boolean prunable)
Sets the value of the
PRUNABLE_PROPERTY of the given
INodeLayout to the given value. |
static void |
setResizable(IEntityLayout entity,
boolean resizable)
Sets the value of the
RESIZABLE_PROPERTY of the given
IEntityLayout to the given value. |
static void |
setSize(IEntityLayout entity,
double w,
double h)
Sets the value of the
SIZE_PROPERTY of the given
IEntityLayout to the given value. |
static void |
setVisible(IConnectionLayout edge,
boolean visible)
Sets the value of the
VISIBLE_PROPERTY of the given
IConnectionLayout to the given value. |
static void |
setWeight(IConnectionLayout edge,
double weight)
Sets the value of the
WEIGHT_PROPERTY of the given
IConnectionLayout to the given value. |
public static final java.lang.String BOUNDS_PROPERTY
public static final Rectangle DEFAULT_BOUNDS
BOUNDS_PROPERTY
.public static final java.lang.String BOUNDS_EXPANDABLE_PROPERTY
public static final java.lang.Boolean DEFAULT_BOUNDS_EXPANDABLE
BOUNDS_EXPANDABLE_PROPERTY
.public static final java.lang.String PRUNING_ENABLED_PROPERTY
public static final java.lang.Boolean DEFAULT_PRUNING_ENABLED
PRUNING_ENABLED_PROPERTY
.public static final java.lang.String DYNAMIC_LAYOUT_ENABLED_PROPERTY
public static final java.lang.Boolean DEFAULT_DYNAMIC_LAYOUT_ENABLED
DYNAMIC_LAYOUT_ENABLED_PROPERTY
.public static final java.lang.String LOCATION_PROPERTY
public static final Point DEFAULT_LOCATION
LOCATION_PROPERTY
.public static final java.lang.String SIZE_PROPERTY
public static final Dimension DEFAULT_SIZE
SIZE_PROPERTY
.public static final java.lang.String MOVABLE_PROPERTY
public static final java.lang.Boolean DEFAULT_MOVABLE
MOVABLE_PROPERTY
.public static final java.lang.String RESIZABLE_PROPERTY
public static final java.lang.Boolean DEFAULT_RESIZABLE
RESIZABLE_PROPERTY
.public static final java.lang.String ASPECT_RATIO_PROPERTY
public static final java.lang.Double DEFAULT_ASPECT_RATIO
ASPECT_RATIO_PROPERTY
.public static final java.lang.String VISIBLE_PROPERTY
public static final java.lang.Boolean DEFAULT_VISIBLE
VISIBLE_PROPERTY
.public static final java.lang.String MINIMIZED_PROPERTY
public static final java.lang.Boolean DEFAULT_MINIMIZED
MINIMIZED_PROPERTY
.public static final java.lang.String PRUNABLE_PROPERTY
public static final java.lang.Boolean DEFAULT_PRUNABLE
PRUNABLE_PROPERTY
.public static final java.lang.String WEIGHT_PROPERTY
public static final java.lang.Double DEFAULT_WEIGHT
WEIGHT_PROPERTY
.public static final java.lang.String DIRECTED_PROPERTY
public static final java.lang.Boolean DEFAULT_DIRECTED
DIRECTED_PROPERTY
.public static final int DIRECTION_TOP_DOWN
public static final int DIRECTION_BOTTOM_UP
public static final int DIRECTION_LEFT_RIGHT
public static final int DIRECTION_RIGHT_LEFT
public static final java.lang.String DIRECTION_PROPERTY
public static final java.lang.Integer DEFAULT_DIRECTION
DIRECTION_PROPERTY
.public static final java.lang.String DIRECTION_DEPENDANT_PROPERTY
public static final java.lang.Boolean DEFAULT_DIRECTION_DEPENDANT
DIRECTION_DEPENDANT_PROPERTY
.public static Rectangle getBounds(ILayoutContext graph)
BOUNDS_PROPERTY
of the given
ILayoutContext
.graph
- The ILayoutContext
whose BOUNDS_PROPERTY
is
read.BOUNDS_PROPERTY
of the given
ILayoutContext
.public static void setBounds(ILayoutContext graph, Rectangle bounds)
BOUNDS_PROPERTY
of the given
ILayoutContext
to the given value.graph
- The ILayoutContext
whose BOUNDS_PROPERTY
is
changed.bounds
- The new value for the BOUNDS_PROPERTY
of the given
ILayoutContext
.public static java.lang.Boolean isBoundsExpandable(ILayoutContext graph)
BOUNDS_EXPANDABLE_PROPERTY
of the given
ILayoutContext
.graph
- The ILayoutContext
whose
BOUNDS_EXPANDABLE_PROPERTY
is read.BOUNDS_EXPANDABLE_PROPERTY
of the given
ILayoutContext
.public static void setBoundsExpandable(ILayoutContext graph, boolean boundsExpandable)
BOUNDS_EXPANDABLE_PROPERTY
of the given
ILayoutContext
to the given value.graph
- The ILayoutContext
whose
BOUNDS_EXPANDABLE_PROPERTY
is changed.boundsExpandable
- The new value for the BOUNDS_EXPANDABLE_PROPERTY
of
the given ILayoutContext
.public static java.lang.Boolean isDynamicLayoutEnables(ILayoutContext graph)
DYNAMIC_LAYOUT_ENABLED_PROPERTY
of the
given ILayoutContext
.graph
- The ILayoutContext
whose
DYNAMIC_LAYOUT_ENABLED_PROPERTY
is read.DYNAMIC_LAYOUT_ENABLED_PROPERTY
of the
given ILayoutContext
.public static void setDynamicLayoutEnabled(ILayoutContext graph, boolean dynamicLayoutEnabled)
DYNAMIC_LAYOUT_ENABLED_PROPERTY
of the
given ILayoutContext
to the given value.graph
- The ILayoutContext
whose
DYNAMIC_LAYOUT_ENABLED_PROPERTY
is changed.dynamicLayoutEnabled
- The new value for the DYNAMIC_LAYOUT_ENABLED_PROPERTY
of the given ILayoutContext
.public static Point getLocation(IEntityLayout entity)
LOCATION_PROPERTY
of the given
IEntityLayout
.entity
- The IEntityLayout
whose LOCATION_PROPERTY
is
read.LOCATION_PROPERTY
of the given
IEntityLayout
.public static Dimension getSize(IEntityLayout entity)
SIZE_PROPERTY
of the given
IEntityLayout
.entity
- The IEntityLayout
whose SIZE_PROPERTY
is
read.SIZE_PROPERTY
of the given
IEntityLayout
.public static java.lang.Double getPreferredAspectRatio(IEntityLayout entity)
ASPECT_RATIO_PROPERTY
of the given
IEntityLayout
.entity
- The IEntityLayout
whose ASPECT_RATIO_PROPERTY
is read.ASPECT_RATIO_PROPERTY
of the given
IEntityLayout
.public static java.lang.Boolean isResizable(IEntityLayout entity)
RESIZABLE_PROPERTY
of the given
IEntityLayout
.entity
- The IEntityLayout
whose RESIZABLE_PROPERTY
is
read.RESIZABLE_PROPERTY
of the given
IEntityLayout
.public static java.lang.Boolean isMovable(IEntityLayout entity)
MOVABLE_PROPERTY
of the given
IEntityLayout
.entity
- The IEntityLayout
whose MOVABLE_PROPERTY
is
read.MOVABLE_PROPERTY
of the given
IEntityLayout
.public static void setLocation(IEntityLayout entity, double x, double y)
LOCATION_PROPERTY
of the given
IEntityLayout
to the given value.entity
- The IEntityLayout
whose LOCATION_PROPERTY
is
changed.x
- The new x coordinate for the LOCATION_PROPERTY
of the
given IEntityLayout
.y
- The new y coordinate for the LOCATION_PROPERTY
of the
given IEntityLayout
.public static void setSize(IEntityLayout entity, double w, double h)
SIZE_PROPERTY
of the given
IEntityLayout
to the given value.entity
- The IEntityLayout
whose SIZE_PROPERTY
is
changed.w
- The new width for the SIZE_PROPERTY
of the given
IEntityLayout
.h
- The new height for the SIZE_PROPERTY
of the given
IEntityLayout
.public static void setResizable(IEntityLayout entity, boolean resizable)
RESIZABLE_PROPERTY
of the given
IEntityLayout
to the given value.entity
- The IEntityLayout
whose RESIZABLE_PROPERTY
is
changed.resizable
- The new value for the RESIZABLE_PROPERTY
of the given
IEntityLayout
.public static java.lang.Boolean isMinimized(INodeLayout node)
MINIMIZED_PROPERTY
of the given
INodeLayout
.node
- The INodeLayout
whose MINIMIZED_PROPERTY
is
read.MINIMIZED_PROPERTY
of the given
INodeLayout
.public static void setMinimized(INodeLayout node, boolean minimized)
MINIMIZED_PROPERTY
of the given
INodeLayout
to the given value.node
- The INodeLayout
whose MINIMIZED_PROPERTY
is
changed.minimized
- The new value for the MINIMIZED_PROPERTY
of the given
INodeLayout
.public static java.lang.Boolean isPrunable(INodeLayout node)
PRUNABLE_PROPERTY
of the given
INodeLayout
.node
- The INodeLayout
whose PRUNABLE_PROPERTY
is
read.PRUNABLE_PROPERTY
of the given
INodeLayout
.public static java.lang.Boolean isPruned(INodeLayout node)
true
if the given INodeLayout
is pruned to
an ISubgraphLayout
, i.e. its INodeLayout.getSubgraph()
method does not return null
. Otherwise returns
false
.node
- The INodeLayout
whose
INodeLayout.getSubgraph()
is evaluated.true
if the given INodeLayout
is pruned to
an ISubgraphLayout
, otherwise false
.public static void setPrunable(INodeLayout node, boolean prunable)
PRUNABLE_PROPERTY
of the given
INodeLayout
to the given value.node
- The INodeLayout
whose PRUNABLE_PROPERTY
is
changed.prunable
- The new value for the PRUNABLE_PROPERTY
of the given
INodeLayout
.public static java.lang.Boolean isDirected(IConnectionLayout edge)
DIRECTED_PROPERTY
of the given
IConnectionLayout
.edge
- The IConnectionLayout
whose DIRECTED_PROPERTY
is read.DIRECTED_PROPERTY
of the given
IConnectionLayout
.public static java.lang.Boolean isVisible(IConnectionLayout edge)
VISIBLE_PROPERTY
of the given
IConnectionLayout
.edge
- The IConnectionLayout
whose VISIBLE_PROPERTY
is read.VISIBLE_PROPERTY
of the given
IConnectionLayout
.public static java.lang.Boolean isVisible(IEntityLayout entity)
VISIBLE_PROPERTY
of the given
IEntityLayout
.entity
- The IEntityLayout
whose VISIBLE_PROPERTY
is
read.VISIBLE_PROPERTY
of the given
IEntityLayout
.public static java.lang.Double getWeight(IConnectionLayout edge)
WEIGHT_PROPERTY
of the given
IConnectionLayout
.edge
- The IConnectionLayout
whose WEIGHT_PROPERTY
is read.WEIGHT_PROPERTY
of the given
IConnectionLayout
.public static void setDirected(IConnectionLayout edge, boolean directed)
DIRECTED_PROPERTY
of the given
IConnectionLayout
to the given value.edge
- The IConnectionLayout
whose DIRECTED_PROPERTY
is changed.directed
- The new value for the DIRECTED_PROPERTY
of the given
IConnectionLayout
.public static void setVisible(IConnectionLayout edge, boolean visible)
VISIBLE_PROPERTY
of the given
IConnectionLayout
to the given value.edge
- The IConnectionLayout
whose VISIBLE_PROPERTY
is changed.visible
- The new value for the VISIBLE_PROPERTY
of the given
IConnectionLayout
.public static void setWeight(IConnectionLayout edge, double weight)
WEIGHT_PROPERTY
of the given
IConnectionLayout
to the given value.edge
- The IConnectionLayout
whose WEIGHT_PROPERTY
is changed.weight
- The new value for the WEIGHT_PROPERTY
of the given
IConnectionLayout
.public static void setDirectionDependant(ISubgraphLayout subgraph, boolean isDirectionDependant)
DIRECTION_DEPENDANT_PROPERTY
of the given
ISubgraphLayout
to the given value.subgraph
- The ISubgraphLayout
whose
DIRECTION_DEPENDANT_PROPERTY
is changed.isDirectionDependant
- The new value for the DIRECTION_DEPENDANT_PROPERTY
of
the given ISubgraphLayout
.public static void setDirection(ISubgraphLayout subgraph, int direction)
DIRECTION_PROPERTY
of the given
ISubgraphLayout
to the given value.subgraph
- The ISubgraphLayout
whose DIRECTION_PROPERTY
is changed.direction
- The new value for the DIRECTION_PROPERTY
of the given
ISubgraphLayout
.public static java.lang.Boolean isDirectionDependant(ISubgraphLayout subgraph)
DIRECTION_DEPENDANT_PROPERTY
of the
given ISubgraphLayout
.subgraph
- The ISubgraphLayout
whose
DIRECTION_DEPENDANT_PROPERTY
is read.DIRECTION_DEPENDANT_PROPERTY
of the
given ISubgraphLayout
.public static java.lang.Integer getDirection(ISubgraphLayout subgraph)
DIRECTION_PROPERTY
of the given
ISubgraphLayout
.subgraph
- The ISubgraphLayout
whose DIRECTION_PROPERTY
is read.DIRECTION_PROPERTY
of the given
ISubgraphLayout
.Copyright (c) 2014 itemis AG and others. All rights reserved.