org.eclipse.gef4.zest.fx.layout

Class GraphLayoutContext

java.lang.Object

org.eclipse.gef4.layout.AbstractLayoutContext

org.eclipse.gef4.zest.fx.layout.GraphLayoutContext

All Implemented Interfaces:

IPropertyChangeNotifier, IPropertyStore, ILayoutContext

public class GraphLayoutContext
extends AbstractLayoutContext

The GraphLayoutContext is a Graph-specific ILayoutContext implementation. It adapts GEF4 Graph to GEF4 Layout.

Field Summary

Fields inherited from class org.eclipse.gef4.layout.AbstractLayoutContext

pcs, pss

Fields inherited from interface org.eclipse.gef4.layout.ILayoutContext

DYNAMIC_LAYOUT_ALGORITHM_PROPERTY, STATIC_LAYOUT_ALGORITHM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
GraphLayoutContext() Constructs a new GraphLayoutContext without nodes and edges.
GraphLayoutContext(Graph graph) Constructs a new GraphLayoutContext from the given Graph.

Method Summary

Modifier and Type	Method and Description
ISubgraphLayout	createSubgraph(INodeLayout[] nodes)
IConnectionLayout[]	getConnections()
GraphEdgeLayout	getEdgeLayout(Edge edge) Returns the GraphEdgeLayout corresponding to the given Edge.
IEntityLayout[]	getEntities()
Graph	getGraph() Returns the transfered Graph.
GraphNodeLayout	getNodeLayout(Node node) Returns the GraphNodeLayout corresponding to the given Node.
INodeLayout[]	getNodes()
void	setGraph(Graph graph) Transfers the given Graph into this GraphLayoutContext, i.e. creates GraphNodeLayouts and GraphEdgeLayouts for the Nodes and Edges of the given Graph.

Methods inherited from class org.eclipse.gef4.layout.AbstractLayoutContext

addContextListener, addEdge, addGraphStructureListener, addLayoutFilter, addLayoutListener, addNode, addPropertyChangeListener, addPruningListener, applyDynamicLayout, applyStaticLayout, clearEdges, clearNodes, doFlushChanges, fireBackgroundEnableChangedEvent, fireBoundsChangedEvent, fireConnectionAddedEvent, fireConnectionRemovedEvent, fireNodeAddedEvent, fireNodeMovedEvent, fireNodeRemovedEvent, fireNodeResizedEvent, firePruningEnableChangedEvent, fireSubgraphMovedEvent, fireSubgraphResizedEvent, flushChanges, getConnections, getDynamicLayoutAlgorithm, getProperty, getStaticLayoutAlgorithm, getSubgraphs, isLayoutIrrelevant, isLayoutIrrelevant, removeContextListener, removeEdge, removeGraphStructureListener, removeLayoutFilter, removeLayoutListener, removeNode, removePropertyChangeListener, removePruningListener, schedulePostLayoutPass, schedulePreLayoutPass, setDynamicLayoutAlgorithm, setProperty, setStaticLayoutAlgorithm, unschedulePostLayoutPass, unschedulePreLayoutPass

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphLayoutContext

public GraphLayoutContext()

Constructs a new GraphLayoutContext without nodes and edges.

GraphLayoutContext

public GraphLayoutContext(Graph graph)

Constructs a new GraphLayoutContext from the given Graph. The Nodes and Edges of the Graph are transfered into GraphNodeLayouts and GraphEdgeLayouts.

Parameters:

graph - The Graph that is transfered.

Method Detail

createSubgraph

public ISubgraphLayout createSubgraph(INodeLayout[] nodes)

getConnections

public IConnectionLayout[] getConnections()

Specified by:

getConnections in interface ILayoutContext

Overrides:

getConnections in class AbstractLayoutContext

getEdgeLayout

public GraphEdgeLayout getEdgeLayout(Edge edge)

Returns the GraphEdgeLayout corresponding to the given Edge.

Parameters:

edge - The Edge for which to return the corresponding GraphEdgeLayout.

Returns:

The GraphEdgeLayout corresponding to the given Edge.

getEntities

public IEntityLayout[] getEntities()

getGraph

public Graph getGraph()

Returns the transfered Graph.

Returns:

The transfered Graph.

getNodeLayout

public GraphNodeLayout getNodeLayout(Node node)

Returns the GraphNodeLayout corresponding to the given Node.

Parameters:

node - The Node for which to return the corrsponding GraphNodeLayout.

Returns:

The GraphNodeLayout corresponding to the given Node.

getNodes

public INodeLayout[] getNodes()

Specified by:

getNodes in interface ILayoutContext

Overrides:

getNodes in class AbstractLayoutContext

setGraph

public void setGraph(Graph graph)

Transfers the given Graph into this GraphLayoutContext, i.e. creates GraphNodeLayouts and GraphEdgeLayouts for the Nodes and Edges of the given Graph.

Parameters:

graph - The Graph that is transfered into this GraphLayoutContext.