com.yworks.yfiles.layout.tree

Interface IProcessor

public interface IProcessor

A IProcessor provides the possibility for each INodePlacer to prepare (and clean up) the graph for the children of the local root.

It is created by INodePlacer.createProcessor(TreeLayout, com.yworks.yfiles.layout.LayoutGraph, com.yworks.yfiles.algorithms.Node) and called by the TreeLayout before and after the actual arrangement of the nodes.

A IProcessor may change values within the IDataMaps for its children. It can also temporarily change the graph by hiding nodes or adding dummy nodes.

Method Summary

Modifier and Type	Method and Description
void	postProcess() This method is called by the TreeLayout after the layout has finished.
void	preProcess(IDataMap nodePlacerDataProvider, IDataMap portAssignmentDataProvider, IDataMap childComparatorProvider) Performs preparations for the actual tree layout in a pre-processing step.

Method Detail

postProcess

void postProcess()

This method is called by the TreeLayout after the layout has finished.

It can be used for cleanup tasks.

Changes on the graph structure that have been made in preProcess(IDataMap, IDataMap, IDataMap) can be undone here.

preProcess

void preProcess(IDataMap nodePlacerDataProvider,
                IDataMap portAssignmentDataProvider,
                IDataMap childComparatorProvider)

Performs preparations for the actual tree layout in a pre-processing step.

This method is called by TreeLayout before the INodePlacers are called recursively. A IProcessor may change some settings within this method. This can be used for specifying values for the children of the local root, manipulate the graph structure or do anything else that needs to be done.

Only changes regarding the descendants of the current root node are allowed.

Parameters:

nodePlacerDataProvider - the map that stores a INodePlacer instance for each node

portAssignmentDataProvider - The map that stores a IPortAssignment instance for each node

childComparatorProvider - the map that stores a Comparator instance for each node