org.eclipse.gef4.layout

Class AbstractLayoutContext

java.lang.Object

org.eclipse.gef4.layout.AbstractLayoutContext

All Implemented Interfaces:

org.eclipse.gef4.common.properties.IPropertyChangeNotifier, org.eclipse.gef4.common.properties.IPropertyStore, ILayoutContext

public abstract class AbstractLayoutContext
extends java.lang.Object
implements ILayoutContext

The AbstractLayoutContext is an abstract ILayoutContext implementation which supports the (un-)registration of PropertyChangeListeners and firing of events, the (un-)registration of any layout listeners and firing of events, the handling and execution of pre and post Runnables, and filtering of layout objects using ILayoutFilter.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	pcs Support object for the (un-)registration of PropertyChangeListeners and firing of events.
protected org.eclipse.gef4.common.properties.PropertyStoreSupport	pss Support object for reading/writing general properties.

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

DYNAMIC_LAYOUT_ALGORITHM_PROPERTY, STATIC_LAYOUT_ALGORITHM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractLayoutContext()

Method Summary

Modifier and Type	Method and Description
void	addContextListener(IContextListener listener) Adds a listener to the context that will be notified about changes related to its configuration.
protected void	addEdge(IConnectionLayout edge) Adds the given IConnectionLayout to the list of edges and fires a corresponding connection-added-event.
void	addGraphStructureListener(IGraphStructureListener listener) Adds a listener to the context that will be notified about changes in graph structure, that is addition and removal of nodes and connections.
void	addLayoutFilter(ILayoutFilter layoutFilter) Adds the given ILayoutFilter to this ILayoutContext.
void	addLayoutListener(ILayoutListener listener) Adds a listener to the context that will be notified about changes in this context's layout, that is movement and resizing of nodes / subgraphs.
protected void	addNode(INodeLayout node) Adds the given INodeLayout to the list of nodes and fires a corresponding node-added-event.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPruningListener(IPruningListener listener) Adds a listener to the context that will be notified about changes in graph pruning, that is hiding and showing of nodes.
void	applyDynamicLayout(boolean clear) Applies the background layout algorithm of this LayoutContext.
void	applyStaticLayout(boolean clear) Applies the static layout algorithm of this LayoutContext.
protected void	clearEdges() Removes all edges from this context using individual removeEdge(IConnectionLayout) calls.
protected void	clearNodes() Removes all nodes from this context using individual removeNode(INodeLayout) calls.
protected void	doFlushChanges(boolean animationHint) Executes all scheduled post-layout Runnables (previously added by schedulePostLayoutPass(Runnable).
void	fireBackgroundEnableChangedEvent() Notifies all previously registered IContextListeners about the state of the background layout flag.
void	fireBoundsChangedEvent() Notifies all previously registered IContextListeners about the bounds change.
void	fireConnectionAddedEvent(IConnectionLayout connection) Notifies all previously registered IGraphStructureListeners about the newly added connection.
void	fireConnectionRemovedEvent(IConnectionLayout connection) Notifies all previously registered IGraphStructureListeners about the removed connection.
void	fireNodeAddedEvent(INodeLayout node) Notifies all previously registered IGraphStructureListeners about the newly added node.
void	fireNodeMovedEvent(INodeLayout node) Notifies all previously registered ILayoutListeners about the moved node.
void	fireNodeRemovedEvent(INodeLayout node) Notifies all previously registered IGraphStructureListeners about the removed node.
void	fireNodeResizedEvent(INodeLayout node) Notifies all previously registered ILayoutListeners about the resized node.
void	firePruningEnableChangedEvent() Notifies all previously registered IContextListeners about the state of the pruning flag.
void	fireSubgraphMovedEvent(ISubgraphLayout subgraph) Notifies all previously registered ILayoutListeners about the moved subgraph.
void	fireSubgraphResizedEvent(ISubgraphLayout subgraph) Notifies all previously registered ILayoutListeners about the resized subgraph.
void	flushChanges(boolean animationHint) Causes all the changes made to elements in this context to affect the display.
IConnectionLayout[]	getConnections() Returns all the connections between nodes that should be laid out.
IConnectionLayout[]	getConnections(IEntityLayout layoutEntity1, IEntityLayout layoutEntity2) Returns all the connections between given source and target entities.
ILayoutAlgorithm	getDynamicLayoutAlgorithm()
INodeLayout[]	getNodes() Returns all the nodes that should be laid out.
java.lang.Object	getProperty(java.lang.String name)
ILayoutAlgorithm	getStaticLayoutAlgorithm() Returns the static layout algorithm used to layout a newly initialized graph or after heavy changes to it.
ISubgraphLayout[]	getSubgraphs() Returns all the subgraphs this context's nodes were pruned to.
boolean	isLayoutIrrelevant(IConnectionLayout connLayout) Returns true when the given IConnectionLayout is not relevant for layout according to the configured layout filters.
boolean	isLayoutIrrelevant(INodeLayout nodeLayout) Returns true when the given INodeLayout is not relevant for layout according to the configured layout filters.
void	removeContextListener(IContextListener listener) Removes a context listener from this context.
protected void	removeEdge(IConnectionLayout edge) Removes the given IConnectionLayout from the list of edges and fires a corresponding connection-removed-event.
void	removeGraphStructureListener(IGraphStructureListener listener) Removes a graph structure listener from this context.
void	removeLayoutFilter(ILayoutFilter layoutFilter) Removes the given ILayoutFilter from this ILayoutContext.
void	removeLayoutListener(ILayoutListener listener) Removes a layout listener from this context.
protected void	removeNode(INodeLayout node) Removes the given INodeLayout from the managed list of nodes and fires a corresponding node-removed-event.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePruningListener(IPruningListener listener) Removes a pruning structure listener from this context.
void	schedulePostLayoutPass(java.lang.Runnable runnable) Adds the given Runnable to the list of runnables which are called when this ILayoutContext is asked to apply all changes made to its elements to the display, i.e. within ILayoutContext.flushChanges(boolean).
void	schedulePreLayoutPass(java.lang.Runnable runnable) Adds the given Runnable to the list of Runnables which are executed before applying a layout, i.e. before ILayoutContext.applyDynamicLayout(boolean) or ILayoutContext.applyStaticLayout(boolean).
void	setDynamicLayoutAlgorithm(ILayoutAlgorithm dynamicLayoutAlgorithm) Sets the dynamic layout algorithm for this context.
void	setProperty(java.lang.String name, java.lang.Object value)
void	setStaticLayoutAlgorithm(ILayoutAlgorithm staticLayoutAlgorithm) Sets the static layout algorithm for this context.
void	unschedulePostLayoutPass(java.lang.Runnable runnable) Removes the given Runnable from the list of runnables which are called when this ILayoutContext is asked to apply all changes made to its elements to the display, i.e. within ILayoutContext.flushChanges(boolean).
void	unschedulePreLayoutPass(java.lang.Runnable runnable) Removes the given Runnable from the list of Runnables which are executed before applying a layout, i.e. before ILayoutContext.applyDynamicLayout(boolean) or ILayoutContext.applyStaticLayout(boolean).

Methods inherited from class java.lang.Object

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

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

createSubgraph, getEntities

Field Detail

pcs

protected java.beans.PropertyChangeSupport pcs

Support object for the (un-)registration of PropertyChangeListeners and firing of events.

pss

protected org.eclipse.gef4.common.properties.PropertyStoreSupport pss

Support object for reading/writing general properties.

Constructor Detail

AbstractLayoutContext

public AbstractLayoutContext()

Method Detail

addContextListener

public void addContextListener(IContextListener listener)

Description copied from interface: ILayoutContext

Adds a listener to the context that will be notified about changes related to its configuration.

Specified by:

addContextListener in interface ILayoutContext

Parameters:

listener - listener to add

addEdge

protected void addEdge(IConnectionLayout edge)

Adds the given IConnectionLayout to the list of edges and fires a corresponding connection-added-event.

Parameters:

edge - IConnectionLayout to add

addGraphStructureListener

public void addGraphStructureListener(IGraphStructureListener listener)

Description copied from interface: ILayoutContext

Adds a listener to the context that will be notified about changes in graph structure, that is addition and removal of nodes and connections. The notifications will not include changes made with API included in layout related interfaces, so that layout algorithms won't be notified about changes they invoke. Only internal changes of the system will fire events.

Specified by:

addGraphStructureListener in interface ILayoutContext

Parameters:

listener - listener to add

addLayoutFilter

public void addLayoutFilter(ILayoutFilter layoutFilter)

Description copied from interface: ILayoutContext

Adds the given ILayoutFilter to this ILayoutContext.

Specified by:

addLayoutFilter in interface ILayoutContext

Parameters:

layoutFilter - The ILayoutFilter to add to this context.

addLayoutListener

public void addLayoutListener(ILayoutListener listener)

Description copied from interface: ILayoutContext

Adds a listener to the context that will be notified about changes in this context's layout, that is movement and resizing of nodes / subgraphs. The notifications will not include changes made with API included in layout related interfaces, so that layout algorithms won't be notified about changes they invoke. Only internal changes of the system will fire events.

Specified by:

addLayoutListener in interface ILayoutContext

Parameters:

listener - listener to add

addNode

protected void addNode(INodeLayout node)

Adds the given INodeLayout to the list of nodes and fires a corresponding node-added-event.

Parameters:

node - INodeLayout to add

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

addPruningListener

public void addPruningListener(IPruningListener listener)

Description copied from interface: ILayoutContext

Adds a listener to the context that will be notified about changes in graph pruning, that is hiding and showing of nodes. The notifications will not include changes made with API included in layout related interfaces, so that layout algorithms won't be notified about changes they invoke. Only internal changes of the system will fire events.

Specified by:

addPruningListener in interface ILayoutContext

Parameters:

listener - listener to add

applyDynamicLayout

public void applyDynamicLayout(boolean clear)

Description copied from interface: ILayoutContext

Applies the background layout algorithm of this LayoutContext. The clean flag is passed-in to the background layout algorithm to indicate whether the context changed significantly since the last layout pass.

Specified by:

applyDynamicLayout in interface ILayoutContext

Parameters:

clear - true to indicate that the algorithm has to fully re-compute the layout, otherwise false.

applyStaticLayout

public void applyStaticLayout(boolean clear)

Description copied from interface: ILayoutContext

Applies the static layout algorithm of this LayoutContext. The clean flag is passed-in to the static layout algorithm to indicate whether the context changed significantly since the last layout pass.

Specified by:

applyStaticLayout in interface ILayoutContext

Parameters:

clear - true to indicate that the algorithm has to fully re-compute the layout, otherwise false.

clearEdges

protected void clearEdges()

Removes all edges from this context using individual removeEdge(IConnectionLayout) calls.

clearNodes

protected void clearNodes()

Removes all nodes from this context using individual removeNode(INodeLayout) calls.

doFlushChanges

protected void doFlushChanges(boolean animationHint)

Executes all scheduled post-layout Runnables (previously added by schedulePostLayoutPass(Runnable).

Parameters:

animationHint - true to indicate that the changes should be applied with an animation, otherwise false.

fireBackgroundEnableChangedEvent

public void fireBackgroundEnableChangedEvent()

Description copied from interface: ILayoutContext

Notifies all previously registered IContextListeners about the state of the background layout flag.

Specified by:

fireBackgroundEnableChangedEvent in interface ILayoutContext

fireBoundsChangedEvent

public void fireBoundsChangedEvent()

Description copied from interface: ILayoutContext

Notifies all previously registered IContextListeners about the bounds change.

Specified by:

fireBoundsChangedEvent in interface ILayoutContext

fireConnectionAddedEvent

public void fireConnectionAddedEvent(IConnectionLayout connection)

Description copied from interface: ILayoutContext

Notifies all previously registered IGraphStructureListeners about the newly added connection.

Specified by:

fireConnectionAddedEvent in interface ILayoutContext

Parameters:

connection - ConnectionLayout of newly added connection

fireConnectionRemovedEvent

public void fireConnectionRemovedEvent(IConnectionLayout connection)

Description copied from interface: ILayoutContext

Notifies all previously registered IGraphStructureListeners about the removed connection.

Specified by:

fireConnectionRemovedEvent in interface ILayoutContext

Parameters:

connection - ConnectionLayout of removed connection

fireNodeAddedEvent

public void fireNodeAddedEvent(INodeLayout node)

Description copied from interface: ILayoutContext

Notifies all previously registered IGraphStructureListeners about the newly added node.

Specified by:

fireNodeAddedEvent in interface ILayoutContext

Parameters:

node - NodeLayout of newly added node

fireNodeMovedEvent

public void fireNodeMovedEvent(INodeLayout node)

Description copied from interface: ILayoutContext

Notifies all previously registered ILayoutListeners about the moved node.

Specified by:

fireNodeMovedEvent in interface ILayoutContext

Parameters:

node - NodeLayout of moved node

fireNodeRemovedEvent

public void fireNodeRemovedEvent(INodeLayout node)

Description copied from interface: ILayoutContext

Notifies all previously registered IGraphStructureListeners about the removed node.

Specified by:

fireNodeRemovedEvent in interface ILayoutContext

Parameters:

node - NodeLayout of removed node

fireNodeResizedEvent

public void fireNodeResizedEvent(INodeLayout node)

Description copied from interface: ILayoutContext

Notifies all previously registered ILayoutListeners about the resized node.

Specified by:

fireNodeResizedEvent in interface ILayoutContext

Parameters:

node - NodeLayout of resized node

firePruningEnableChangedEvent

public void firePruningEnableChangedEvent()

Description copied from interface: ILayoutContext

Notifies all previously registered IContextListeners about the state of the pruning flag.

Specified by:

firePruningEnableChangedEvent in interface ILayoutContext

fireSubgraphMovedEvent

public void fireSubgraphMovedEvent(ISubgraphLayout subgraph)

Description copied from interface: ILayoutContext

Notifies all previously registered ILayoutListeners about the moved subgraph.

Specified by:

fireSubgraphMovedEvent in interface ILayoutContext

Parameters:

subgraph - SubgraphLayout of moved subgraph

fireSubgraphResizedEvent

public void fireSubgraphResizedEvent(ISubgraphLayout subgraph)

Description copied from interface: ILayoutContext

Notifies all previously registered ILayoutListeners about the resized subgraph.

Specified by:

fireSubgraphResizedEvent in interface ILayoutContext

Parameters:

subgraph - SubgraphLayout of resized subgraph

flushChanges

public void flushChanges(boolean animationHint)

Description copied from interface: ILayoutContext

Causes all the changes made to elements in this context to affect the display. Called from layout algorithms on finish of layout.

Specified by:

flushChanges in interface ILayoutContext

Parameters:

animationHint - a hint for display mechanism indicating whether changes are major and should be animated (if true) or not.

getConnections

public IConnectionLayout[] getConnections()

Description copied from interface: ILayoutContext

Returns all the connections between nodes that should be laid out. Replacing elements in the returned array does not affect this context.

Specified by:

getConnections in interface ILayoutContext

Returns:

array of connections between nodes

getConnections

public IConnectionLayout[] getConnections(IEntityLayout layoutEntity1,
                                          IEntityLayout layoutEntity2)

Description copied from interface: ILayoutContext

Returns all the connections between given source and target entities. If given entity is a subgraph, connections adjacent to each of its nodes will be included in the result. All the undirected nodes connecting the two nodes will be also included in the result. Replacing elements in the returned array does not affect this context.

Specified by:

getConnections in interface ILayoutContext

Parameters:

layoutEntity1 - The source entity.

layoutEntity2 - The target entity.

Returns:

The connections between the source and target entities.

getDynamicLayoutAlgorithm

public ILayoutAlgorithm getDynamicLayoutAlgorithm()

Specified by:

getDynamicLayoutAlgorithm in interface ILayoutContext

Returns:

the background algorithm of this context (see ILayoutContext.setDynamicLayoutAlgorithm(ILayoutAlgorithm) for details)

getNodes

public INodeLayout[] getNodes()

Description copied from interface: ILayoutContext

Returns all the nodes that should be laid out. Replacing elements in the returned array does not affect this context.

Specified by:

getNodes in interface ILayoutContext

Returns:

array of nodes to lay out

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface org.eclipse.gef4.common.properties.IPropertyStore

getStaticLayoutAlgorithm

public ILayoutAlgorithm getStaticLayoutAlgorithm()

Description copied from interface: ILayoutContext

Returns the static layout algorithm used to layout a newly initialized graph or after heavy changes to it.

Specified by:

getStaticLayoutAlgorithm in interface ILayoutContext

Returns:

the static layout algorithm

getSubgraphs

public ISubgraphLayout[] getSubgraphs()

Description copied from interface: ILayoutContext

Returns all the subgraphs this context's nodes were pruned to. Replacing elements in the returned array does not affect this context.

Specified by:

getSubgraphs in interface ILayoutContext

Returns:

array of subgraphs (may be empty)

isLayoutIrrelevant

public boolean isLayoutIrrelevant(IConnectionLayout connLayout)

Description copied from interface: ILayoutContext

Returns true when the given IConnectionLayout is not relevant for layout according to the configured layout filters. Otherwise returns false.

Specified by:

isLayoutIrrelevant in interface ILayoutContext

Parameters:

connLayout - The IConnectionLayout in question.

Returns:

true when the given IConnectionLayout is not relevant for layout according to the configure layout filters, otherwise false.

isLayoutIrrelevant

public boolean isLayoutIrrelevant(INodeLayout nodeLayout)

Description copied from interface: ILayoutContext

Returns true when the given INodeLayout is not relevant for layout according to the configured layout filters. Otherwise returns false.

Specified by:

isLayoutIrrelevant in interface ILayoutContext

Parameters:

nodeLayout - The INodeLayout in question.

Returns:

true when the given INodeLayout is not relevant for layout according to the configure layout filters, otherwise false.

removeContextListener

public void removeContextListener(IContextListener listener)

Description copied from interface: ILayoutContext

Removes a context listener from this context.

Specified by:

removeContextListener in interface ILayoutContext

Parameters:

listener - listener to remove

removeEdge

protected void removeEdge(IConnectionLayout edge)

Removes the given IConnectionLayout from the list of edges and fires a corresponding connection-removed-event.

Parameters:

edge - IConnectionLayout to remove

removeGraphStructureListener

public void removeGraphStructureListener(IGraphStructureListener listener)

Description copied from interface: ILayoutContext

Removes a graph structure listener from this context.

Specified by:

removeGraphStructureListener in interface ILayoutContext

Parameters:

listener - listener to remove

removeLayoutFilter

public void removeLayoutFilter(ILayoutFilter layoutFilter)

Description copied from interface: ILayoutContext

Removes the given ILayoutFilter from this ILayoutContext.

Specified by:

removeLayoutFilter in interface ILayoutContext

Parameters:

layoutFilter - The ILayoutFilter to remove to this context.

removeLayoutListener

public void removeLayoutListener(ILayoutListener listener)

Description copied from interface: ILayoutContext

Removes a layout listener from this context.

Specified by:

removeLayoutListener in interface ILayoutContext

Parameters:

listener - listener to remove

removeNode

protected void removeNode(INodeLayout node)

Removes the given INodeLayout from the managed list of nodes and fires a corresponding node-removed-event.

Parameters:

node - INodeLayout to remove

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

removePruningListener

public void removePruningListener(IPruningListener listener)

Description copied from interface: ILayoutContext

Removes a pruning structure listener from this context.

Specified by:

removePruningListener in interface ILayoutContext

Parameters:

listener - listener to remove

schedulePostLayoutPass

public void schedulePostLayoutPass(java.lang.Runnable runnable)

Description copied from interface: ILayoutContext

Adds the given Runnable to the list of runnables which are called when this ILayoutContext is asked to apply all changes made to its elements to the display, i.e. within ILayoutContext.flushChanges(boolean).

Specified by:

schedulePostLayoutPass in interface ILayoutContext

Parameters:

runnable - A Runnable called whenever this context is asked to apply all changes made to its elements to the display.

schedulePreLayoutPass

public void schedulePreLayoutPass(java.lang.Runnable runnable)

Description copied from interface: ILayoutContext

Adds the given Runnable to the list of Runnables which are executed before applying a layout, i.e. before ILayoutContext.applyDynamicLayout(boolean) or ILayoutContext.applyStaticLayout(boolean).

Specified by:

schedulePreLayoutPass in interface ILayoutContext

Parameters:

runnable - The Runnable to add to the list of Runnables which are executed before applying a layout.

setDynamicLayoutAlgorithm

public void setDynamicLayoutAlgorithm(ILayoutAlgorithm dynamicLayoutAlgorithm)

Description copied from interface: ILayoutContext

Sets the dynamic layout algorithm for this context. This algorithm will be used to relayout graph items using ILayoutAlgorithm.applyLayout(boolean) after every event that is not intercepted by any listener when currently changes are not being flushed and background layout is enabled. The clean flag for the background layout algorithm can be set to false by the context when reacting to events.

Specified by:

setDynamicLayoutAlgorithm in interface ILayoutContext

Parameters:

dynamicLayoutAlgorithm - The new dynamic ILayoutAlgorithm for this ILayoutContext.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Specified by:

setProperty in interface org.eclipse.gef4.common.properties.IPropertyStore

setStaticLayoutAlgorithm

public void setStaticLayoutAlgorithm(ILayoutAlgorithm staticLayoutAlgorithm)

Description copied from interface: ILayoutContext

Sets the static layout algorithm for this context. The static algorithm has to be manually invoked, for example, after significant changes to the context.

Specified by:

setStaticLayoutAlgorithm in interface ILayoutContext

Parameters:

staticLayoutAlgorithm - The new static ILayoutAlgorithm for this ILayoutContext.

unschedulePostLayoutPass

public void unschedulePostLayoutPass(java.lang.Runnable runnable)

Description copied from interface: ILayoutContext

Removes the given Runnable from the list of runnables which are called when this ILayoutContext is asked to apply all changes made to its elements to the display, i.e. within ILayoutContext.flushChanges(boolean).

Specified by:

unschedulePostLayoutPass in interface ILayoutContext

Parameters:

runnable - The Runnable that should no longer get called when flushing changes.

unschedulePreLayoutPass

public void unschedulePreLayoutPass(java.lang.Runnable runnable)

Description copied from interface: ILayoutContext

Removes the given Runnable from the list of Runnables which are executed before applying a layout, i.e. before ILayoutContext.applyDynamicLayout(boolean) or ILayoutContext.applyStaticLayout(boolean).

Specified by:

unschedulePreLayoutPass in interface ILayoutContext

Parameters:

runnable - The Runnable to remove from the list of Runnables which are executed before applying a layout.