org.eclipse.gef4.layout.listeners

Class IGraphStructureListener.Stub

java.lang.Object

org.eclipse.gef4.layout.listeners.IGraphStructureListener.Stub

All Implemented Interfaces:

IGraphStructureListener

Enclosing interface:

IGraphStructureListener

public static class IGraphStructureListener.Stub
extends java.lang.Object
implements IGraphStructureListener

A stub implementation of the IGraphStructureListener which contains empty implementations of the specified methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.layout.listeners.IGraphStructureListener

IGraphStructureListener.Stub

Constructor Summary

Constructors

Constructor and Description
Stub()

Method Summary

Modifier and Type	Method and Description
boolean	connectionAdded(ILayoutContext context, IConnectionLayout connection) This method is called whenever a connection is added to a context.
boolean	connectionRemoved(ILayoutContext context, IConnectionLayout connection) This method is called whenever a connection is removed from a context.
boolean	nodeAdded(ILayoutContext context, INodeLayout node) This method is called whenever a node is added to a context.
boolean	nodeRemoved(ILayoutContext context, INodeLayout node) This method is called whenever a node is removed from a context.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stub

public Stub()

Method Detail

nodeAdded

public boolean nodeAdded(ILayoutContext context,
                         INodeLayout node)

Description copied from interface: IGraphStructureListener

This method is called whenever a node is added to a context. No separate events will be fired for eventual connections adjacent to the added node. If true is returned, it means that the receiving listener has intercepted this event. Intercepted events will not be passed to the rest of the listeners. If the event is not intercepted by any listener, ILayoutAlgorithm.applyLayout(boolean) will be called on the context's main algorithm.

Specified by:

nodeAdded in interface IGraphStructureListener

Parameters:

context - the layout context that fired the event

node - the added node

Returns:

true if no dynamic layout should be applied afterwards.

nodeRemoved

public boolean nodeRemoved(ILayoutContext context,
                           INodeLayout node)

Description copied from interface: IGraphStructureListener

This method is called whenever a node is removed from a context. No separate events will be fired for eventual connections adjacent to the removed node. If true is returned, no dynamic layout will be applied after notifying all listeners, i.e. a dynamic layout pass will only be applied when all registered IGraphStructureListeners return false.

Specified by:

nodeRemoved in interface IGraphStructureListener

Parameters:

context - the context that fired the event

node - the removed node

Returns:

true if no dynamic layout should be applied afterwards.

connectionAdded

public boolean connectionAdded(ILayoutContext context,
                               IConnectionLayout connection)

Description copied from interface: IGraphStructureListener

This method is called whenever a connection is added to a context. It can be assumed that both source and target nodes of the added connection already exist in the context.

This method will be called only if both nodes connected by added connection lay directly in the node container owned by the notifying layout context.

If true is returned, no dynamic layout will be applied after notifying all listeners, i.e. a dynamic layout pass will only be applied when all registered IGraphStructureListeners return false.

Specified by:

connectionAdded in interface IGraphStructureListener

Parameters:

context - the context that fired the event

connection - the added connection

Returns:

true if no dynamic layout should be applied afterwards.

connectionRemoved

public boolean connectionRemoved(ILayoutContext context,
                                 IConnectionLayout connection)

Description copied from interface: IGraphStructureListener

This method is called whenever a connection is removed from a context. It can be assumed that both source and target nodes of the removed connection still exist in the context and will not be removed along with it.

This method will be called only if both nodes connected by removed connection lay directly in the node container owned by the notifying layout context.

If true is returned, no dynamic layout will be applied after notifying all listeners, i.e. a dynamic layout pass will only be applied when all registered IGraphStructureListeners return false.

Specified by:

connectionRemoved in interface IGraphStructureListener

Parameters:

context - the context that fired the event

connection - the added connection

Returns:

true if no dynamic layout should be applied afterwards.