com.yworks.yfiles.graph

Class ExcludingFoldingEdgeConverter

java.lang.Object

com.yworks.yfiles.graph.ExcludingFoldingEdgeConverter

All Implemented Interfaces:

IFoldingEdgeConverter

public class ExcludingFoldingEdgeConverter
extends Object
implements IFoldingEdgeConverter

A simple implementation of the IFoldingEdgeConverter interface for use in the FoldingEdgeConverter property, that will prevent folding edges from appearing in the view.

Constructor Summary

Constructors

Constructor and Description
ExcludingFoldingEdgeConverter()

Method Summary

Modifier and Type	Method and Description
IEdge	addFoldingEdge(IFoldingEdgeFactory factory, IFoldingView foldingView, IEdge masterEdge, INode source, boolean sourceIsCollapsed, INode target, boolean targetIsCollapsed) Always calls IFoldingEdgeFactory.excludeFoldingEdge().
void	initializeFoldingEdgeState(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Does nothing and should not normally be called by the view since all folding edges are excluded from it.
void	updateFoldingEdgeState(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Does nothing and should not normally be called by the view since all folding edges are excluded from it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcludingFoldingEdgeConverter

public ExcludingFoldingEdgeConverter()

Method Detail

addFoldingEdge

public IEdge addFoldingEdge(IFoldingEdgeFactory factory,
                            IFoldingView foldingView,
                            IEdge masterEdge,
                            INode source,
                            boolean sourceIsCollapsed,
                            INode target,
                            boolean targetIsCollapsed)

Always calls IFoldingEdgeFactory.excludeFoldingEdge().

Specified by:

addFoldingEdge in interface IFoldingEdgeConverter

Parameters:

factory - The IFoldingEdgeFactory implementation that needs to be called in order to communicate the results of this query.

foldingView - The instance into which the folding edge is going to be inserted.

masterEdge - The edge from the MasterGraph that needs to be represented by a folding edge. Note that you may not return this instance.

source - The source node that belongs to the IFoldingView graph that will act as the local view node of the actual source node.

sourceIsCollapsed - Determines whether the source is currently a folder node.

target - The target node that belongs to the IFoldingView graph that will act as the local view node of the actual target node.

targetIsCollapsed - Determines whether the target is currently a folder node.

Returns:

The edge as returned by IFoldingEdgeFactory.addAsSeparateEdge(com.yworks.yfiles.graph.IPort, com.yworks.yfiles.graph.IPort), or IFoldingEdgeFactory.addToExistingFoldingEdge(IEdge), or null if the edge will be excluded from the view.

initializeFoldingEdgeState

public void initializeFoldingEdgeState(FoldingEdgeState state,
                                       IFoldingView foldingView,
                                       IEdge foldingEdge,
                                       List<IEdge> masterEdges)

Does nothing and should not normally be called by the view since all folding edges are excluded from it.

Specified by:

initializeFoldingEdgeState in interface IFoldingEdgeConverter

Parameters:

state - The FoldingEdgeState of the edge to change.

foldingView - The graph to which the folding edge belongs.

foldingEdge - The folding edge for which the appearance shall be determined.

masterEdges - The list of master edges, that the folding edge initially represents.

See Also:

IFoldingEdgeConverter.updateFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List)

updateFoldingEdgeState

public void updateFoldingEdgeState(FoldingEdgeState state,
                                   IFoldingView foldingView,
                                   IEdge foldingEdge,
                                   List<IEdge> masterEdges)

Does nothing and should not normally be called by the view since all folding edges are excluded from it.

Specified by:

updateFoldingEdgeState in interface IFoldingEdgeConverter

Parameters:

state - The FoldingEdgeState of the edge to change.

foldingView - The graph to which the folding edge belongs.

foldingEdge - The folding edge for which the appearance might need an update.

masterEdges - The list of master edges, that the folding edge currently represents.

See Also:

IFoldingEdgeConverter.initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List)