org.eclipse.gef4.layout.listeners

Interface IPruningListener

public interface IPruningListener

An IPruningListener is notified about pruning changes, i.e. adding INodeLayouts to an ISubgraphLayout (pruning), or removing INodeLayouts from an ISubgraphLayout (unpruning).

Method Summary

Modifier and Type	Method and Description
boolean	nodesPruned(ILayoutContext context, ISubgraphLayout[] subgraph) This method is called when some nodes are pruned in a layout context.
boolean	nodesUnpruned(ILayoutContext context, INodeLayout[] nodes) This method is called when some nodes are unpruned in a layout context, that is they are no longer part of a subgraph.

Method Detail

nodesPruned

boolean nodesPruned(ILayoutContext context,
                    ISubgraphLayout[] subgraph)

This method is called when some nodes are pruned in a layout context. 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.

Parameters:

context - the layout context that fired the event

subgraph - subgraphs that have been created or had nodes added

Returns:

true if no further operations after this event are required

nodesUnpruned

boolean nodesUnpruned(ILayoutContext context,
                      INodeLayout[] nodes)

This method is called when some nodes are unpruned in a layout context, that is they are no longer part of a subgraph. 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.

Parameters:

context - the layout context that fired the event

nodes - nodes that have been unpruned

Returns:

true if no further operations after this event are required