org.eclipse.gef4.layout.listeners

Class LayoutListenerSupport

java.lang.Object

org.eclipse.gef4.layout.listeners.LayoutListenerSupport

public class LayoutListenerSupport
extends java.lang.Object

The LayoutListenerSupport can handle the (un-)registration of layout event listeners (IContextListener, IGraphStructureListener, ILayoutListener, and IPruningListener) and firing of events. It is used by the AbstractLayoutContext.

Constructor Summary

Constructors

Constructor and Description
LayoutListenerSupport(ILayoutContext context) Constructs a new LayoutListenerSupport for the given ILayoutContext.

Method Summary

Modifier and Type	Method and Description
void	addContextListener(IContextListener listener) Adds the given IContextListener to the list of listeners which are notified about context changes.
void	addGraphStructureListener(IGraphStructureListener listener) Adds the given IGraphStructureListener to the list of listeners which are notified about structural changes.
void	addLayoutListener(ILayoutListener listener) Adds the given ILayoutListener to the list of listeners which are notified about layout changes.
void	addPruningListener(IPruningListener listener) Adds the given IPruningListener to the list of listeners which are notified about pruning changes.
void	fireBackgroundEnableChangedEvent() Notifies all IContextListeners via IContextListener.backgroundEnableChanged(ILayoutContext).
void	fireBoundsChangedEvent() Notifies all IContextListeners via IContextListener.boundsChanged(ILayoutContext).
void	fireConnectionAddedEvent(IConnectionLayout connection) Notifies all IGraphStructureListeners via IGraphStructureListener.connectionAdded(ILayoutContext, IConnectionLayout) .
void	fireConnectionRemovedEvent(IConnectionLayout connection) Notifies all IGraphStructureListeners via IGraphStructureListener.connectionRemoved(ILayoutContext, IConnectionLayout) .
void	fireNodeAddedEvent(INodeLayout node) Notifies all IGraphStructureListeners via IGraphStructureListener.nodeAdded(ILayoutContext, INodeLayout) .
void	fireNodeMovedEvent(INodeLayout node) Notifies all ILayoutListeners via ILayoutListener.nodeMoved(ILayoutContext, INodeLayout) .
void	fireNodeRemovedEvent(INodeLayout node) Notifies all IGraphStructureListeners via IGraphStructureListener.nodeRemoved(ILayoutContext, INodeLayout) .
void	fireNodeResizedEvent(INodeLayout node) Notifies all ILayoutListeners via ILayoutListener.nodeResized(ILayoutContext, INodeLayout) .
void	firePruningEnableChangedEvent() Notifies all IContextListeners via IContextListener.pruningEnablementChanged(ILayoutContext).
void	fireSubgraphMovedEvent(ISubgraphLayout subgraph) Notifies all ILayoutListeners via ILayoutListener.subgraphMoved(ILayoutContext, ISubgraphLayout) .
void	fireSubgraphResizedEvent(ISubgraphLayout subgraph) Notifies all ILayoutListeners via ILayoutListener.subgraphResized(ILayoutContext, ISubgraphLayout) .
void	removeContextListener(IContextListener listener) Removes the given IContextListener from the list of listeners which are notified about context changes.
void	removeGraphStructureListener(IGraphStructureListener listener) Removes the given IGraphStructureListener from the list of listeners which are notified about structural changes.
void	removeLayoutListener(ILayoutListener listener) Removes the given ILayoutListener from the list of listeners which are notified about layout changes.
void	removePruningListener(IPruningListener listener) Removes the given IPruningListener from the list of listeners which are notified about pruning changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutListenerSupport

public LayoutListenerSupport(ILayoutContext context)

Constructs a new LayoutListenerSupport for the given ILayoutContext.

Parameters:

context - The ILayoutContext for which this LayoutListenerSupport handles (un-)registration of layout listeners and firing of events.

Method Detail

addContextListener

public void addContextListener(IContextListener listener)

Adds the given IContextListener to the list of listeners which are notified about context changes.

Parameters:

listener - The IContextListener which is added to the listeners list.

addGraphStructureListener

public void addGraphStructureListener(IGraphStructureListener listener)

Adds the given IGraphStructureListener to the list of listeners which are notified about structural changes.

Parameters:

listener - The IGraphStructureListener which is added to the listeners list.

addLayoutListener

public void addLayoutListener(ILayoutListener listener)

Adds the given ILayoutListener to the list of listeners which are notified about layout changes.

Parameters:

listener - The ILayoutListener which is added to the listeners list.

addPruningListener

public void addPruningListener(IPruningListener listener)

Adds the given IPruningListener to the list of listeners which are notified about pruning changes.

Parameters:

listener - The IPruningListener which is added to the listeners list.

fireBackgroundEnableChangedEvent

public void fireBackgroundEnableChangedEvent()

Notifies all IContextListeners via IContextListener.backgroundEnableChanged(ILayoutContext).

fireBoundsChangedEvent

public void fireBoundsChangedEvent()

Notifies all IContextListeners via IContextListener.boundsChanged(ILayoutContext).

A dynamic layout is applied afterwards unless all listeners return true.

fireConnectionAddedEvent

public void fireConnectionAddedEvent(IConnectionLayout connection)

Notifies all IGraphStructureListeners via IGraphStructureListener.connectionAdded(ILayoutContext, IConnectionLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

connection - The IConnectionLayout which was added to the ILayoutContext.

fireConnectionRemovedEvent

public void fireConnectionRemovedEvent(IConnectionLayout connection)

Notifies all IGraphStructureListeners via IGraphStructureListener.connectionRemoved(ILayoutContext, IConnectionLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

connection - The IConnectionLayout which was removed from the ILayoutContext.

fireNodeAddedEvent

public void fireNodeAddedEvent(INodeLayout node)

Notifies all IGraphStructureListeners via IGraphStructureListener.nodeAdded(ILayoutContext, INodeLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

node - The INodeLayout which was added to the ILayoutContext.

fireNodeMovedEvent

public void fireNodeMovedEvent(INodeLayout node)

Notifies all ILayoutListeners via ILayoutListener.nodeMoved(ILayoutContext, INodeLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

node - The INodeLayout whose LayoutProperties.LOCATION_PROPERTY changed.

fireNodeRemovedEvent

public void fireNodeRemovedEvent(INodeLayout node)

Notifies all IGraphStructureListeners via IGraphStructureListener.nodeRemoved(ILayoutContext, INodeLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

node - The INodeLayout which was removed from the ILayoutContext.

fireNodeResizedEvent

public void fireNodeResizedEvent(INodeLayout node)

Notifies all ILayoutListeners via ILayoutListener.nodeResized(ILayoutContext, INodeLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

node - The INodeLayout whose LayoutProperties.SIZE_PROPERTY changed.

firePruningEnableChangedEvent

public void firePruningEnableChangedEvent()

Notifies all IContextListeners via IContextListener.pruningEnablementChanged(ILayoutContext).

fireSubgraphMovedEvent

public void fireSubgraphMovedEvent(ISubgraphLayout subgraph)

Notifies all ILayoutListeners via ILayoutListener.subgraphMoved(ILayoutContext, ISubgraphLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

subgraph - The ISubgraphLayout whose LayoutProperties.LOCATION_PROPERTY changed.

fireSubgraphResizedEvent

public void fireSubgraphResizedEvent(ISubgraphLayout subgraph)

Notifies all ILayoutListeners via ILayoutListener.subgraphResized(ILayoutContext, ISubgraphLayout) .

A dynamic layout is applied afterwards unless all listeners return true.

Parameters:

subgraph - The ISubgraphLayout whose LayoutProperties.SIZE_PROPERTY changed.

removeContextListener

public void removeContextListener(IContextListener listener)

Removes the given IContextListener from the list of listeners which are notified about context changes.

Parameters:

listener - The IContextListener which is removed from the listeners list.

removeGraphStructureListener

public void removeGraphStructureListener(IGraphStructureListener listener)

Removes the given IGraphStructureListener from the list of listeners which are notified about structural changes.

Parameters:

listener - The IGraphStructureListener which is removed from the listeners list.

removeLayoutListener

public void removeLayoutListener(ILayoutListener listener)

Removes the given ILayoutListener from the list of listeners which are notified about layout changes.

Parameters:

listener - The ILayoutListener which is removed from the listeners list.

removePruningListener

public void removePruningListener(IPruningListener listener)

Removes the given IPruningListener from the list of listeners which are notified about pruning changes.

Parameters:

listener - The IPruningListener which is removed from the listeners list.