com.yworks.yfiles.graph

Class AbstractFoldingEdgeConverter

java.lang.Object

com.yworks.yfiles.graph.AbstractFoldingEdgeConverter

All Implemented Interfaces:

IFoldingEdgeConverter

Direct Known Subclasses:

DefaultFoldingEdgeConverter, MergingFoldingEdgeConverter

public abstract class AbstractFoldingEdgeConverter
extends Object
implements IFoldingEdgeConverter

An abstract basic implementation of the IFoldingEdgeConverter interface that may be derived from to create a customized FoldingEdgeConverter.

This class provides default mechanisms and callbacks that can be used to set another style for folding edges, for the ports of folding edges, synchronizing the first label of a folding edge with the master edge, etc. Subclasses need to implement the addFoldingEdge(IFoldingEdgeFactory, IFoldingView, IEdge, INode, boolean, INode, boolean) method, only.

See Also:

DefaultFoldingEdgeConverter, FoldingManager

Constructor Summary

Constructors

Constructor and Description
AbstractFoldingEdgeConverter()

Method Summary

Modifier and Type	Method and Description
abstract IEdge	addFoldingEdge(IFoldingEdgeFactory factory, IFoldingView foldingView, IEdge masterEdge, INode source, boolean sourceIsCollapsed, INode target, boolean targetIsCollapsed) This method gets called by the IFoldingView implementation to determine whether a given edge in the MasterGraph should be represented by a folding edge in the given view.
protected IEdgeStyle	createEdgeStyle(IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Callback factory method that creates the IEdgeStyle for use in initializeFoldingEdgeStyle(FoldingEdgeState, IFoldingView, IEdge, List).
protected ILabelModelParameter	createLabelLayoutParameter(IFoldingView foldingView, ILabel localLabel, ILabel masterLabel) Callback factory method that creates the ILabelModelParameter for use in initializeFoldingEdgeLabels(FoldingEdgeState, IFoldingView, IEdge, List).
protected ILabelStyle	createLabelStyle(IFoldingView foldingView, ILabel localLabel, ILabel masterLabel) Callback factory method that creates the ILabelStyle for use in initializeFoldingEdgeLabels(FoldingEdgeState, IFoldingView, IEdge, List).
protected IPortLocationModelParameter	createSourcePortLocationParameter(IFoldingView foldingView, IEdge localEdge, List<IEdge> masterEdges) Callback factory method that creates the IPortLocationModelParameter of the source port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).
protected IPortStyle	createSourcePortStyle(IFoldingView foldingView, IEdge localEdge, List<IEdge> masterEdges) Callback factory method that creates the IPortStyle of the source port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).
protected IPortLocationModelParameter	createTargetPortLocationParameter(IFoldingView foldingView, IEdge localEdge, List<IEdge> masterEdges) Callback factory method that creates the IPortLocationModelParameter of the target port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).
protected IPortStyle	createTargetPortStyle(IFoldingView foldingView, IEdge localEdge, List<IEdge> masterEdges) Callback factory method that creates the IPortStyle of the target port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).
IEdgeStyle	getFoldingEdgeStyle() Gets the IEdgeStyle to use for the folding edge.
ILabelModelParameter	getLabelLayoutParameter() Gets the ILabelModelParameter to use for the first label of the folding edge.
ILabelStyle	getLabelStyle() Gets the ILabelStyle to use for the first label of the folding edge.
IPortLocationModelParameter	getSourcePortLocationParameter() Gets the IPortLocationModelParameter to use for the source port of the folding edge.
IPortStyle	getSourcePortStyle() Gets the IPortStyle to use for the folding source port.
IPortLocationModelParameter	getTargetPortLocationParameter() Gets the IPortLocationModelParameter to use for the target port of the folding edge.
IPortStyle	getTargetPortStyle() Gets the IPortStyle to use for the folding target port.
protected void	initializeFoldingEdgeBends(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Callback method that initializes the bends of the folding edge.
protected void	initializeFoldingEdgeLabels(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Callback method that initializes the initial labels of the folding edge.
protected void	initializeFoldingEdgePorts(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Callback method that initializes the ports of the folding edge.
void	initializeFoldingEdgeState(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Implements the IFoldingEdgeConverter.initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) method and initializes the folding edge appearance.
protected void	initializeFoldingEdgeStyle(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Callback method that initializes the style property of the folding edge.
boolean	isBendsResettingEnabled() Gets a value indicating whether to reset and clear the bends of a folding edge initially.
boolean	isCopyingFirstLabelEnabled() Gets a value indicating whether the first label of the master edge should be recreated for the folding edge.
boolean	isEdgeStyleCloningEnabled() Gets a value indicating whether the FoldingEdgeStyle instance should be assigned as a ICloneable.clone()clone or not.
boolean	isLabelLayoutParameterCloningEnabled() Gets a value indicating whether the LabelLayoutParameter instance should be assigned as a ICloneable.clone()clone or not.
boolean	isLabelStyleCloningEnabled() Gets a value indicating whether the LabelStyle instance should be assigned as a ICloneable.clone()clone or not.
boolean	isSourcePortLocationParameterCloningEnabled() Gets a value indicating whether the SourcePortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.
boolean	isSourcePortStyleCloningEnabled() Gets a value indicating whether the SourcePortStyle instance should be assigned as a clone or not.
boolean	isTargetPortLocationParameterCloningEnabled() Gets a value indicating whether the TargetPortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.
boolean	isTargetPortStyleCloningEnabled() Gets a value indicating whether the TargetPortStyle instance should be assigned as a ICloneable.clone()clone or not.
void	setBendsResettingEnabled(boolean value) Sets a value indicating whether to reset and clear the bends of a folding edge initially.
void	setCopyingFirstLabelEnabled(boolean value) Sets a value indicating whether the first label of the master edge should be recreated for the folding edge.
void	setEdgeStyleCloningEnabled(boolean value) Sets a value indicating whether the FoldingEdgeStyle instance should be assigned as a ICloneable.clone()clone or not.
void	setFoldingEdgeStyle(IEdgeStyle value) Sets the IEdgeStyle to use for the folding edge.
void	setLabelLayoutParameter(ILabelModelParameter value) Sets the ILabelModelParameter to use for the first label of the folding edge.
void	setLabelLayoutParameterCloningEnabled(boolean value) Sets a value indicating whether the LabelLayoutParameter instance should be assigned as a ICloneable.clone()clone or not.
void	setLabelStyle(ILabelStyle value) Sets the ILabelStyle to use for the first label of the folding edge.
void	setLabelStyleCloningEnabled(boolean value) Sets a value indicating whether the LabelStyle instance should be assigned as a ICloneable.clone()clone or not.
void	setSourcePortLocationParameter(IPortLocationModelParameter value) Sets the IPortLocationModelParameter to use for the source port of the folding edge.
void	setSourcePortLocationParameterCloningEnabled(boolean value) Sets a value indicating whether the SourcePortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.
void	setSourcePortStyle(IPortStyle value) Sets the IPortStyle to use for the folding source port.
void	setSourcePortStyleCloningEnabled(boolean value) Sets a value indicating whether the SourcePortStyle instance should be assigned as a clone or not.
void	setTargetPortLocationParameter(IPortLocationModelParameter value) Sets the IPortLocationModelParameter to use for the target port of the folding edge.
void	setTargetPortLocationParameterCloningEnabled(boolean value) Sets a value indicating whether the TargetPortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.
void	setTargetPortStyle(IPortStyle value) Sets the IPortStyle to use for the folding target port.
void	setTargetPortStyleCloningEnabled(boolean value) Sets a value indicating whether the TargetPortStyle instance should be assigned as a ICloneable.clone()clone or not.
protected void	synchronizeLabels(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Called by updateFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) to synchronize the first label if CopyingFirstLabelEnabled is enabled.
void	updateFoldingEdgeState(FoldingEdgeState state, IFoldingView foldingView, IEdge foldingEdge, List<IEdge> masterEdges) Implements the IFoldingEdgeConverter.updateFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) method and changes the folding edge appearance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFoldingEdgeConverter

public AbstractFoldingEdgeConverter()

Method Detail

addFoldingEdge

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

Description copied from interface: IFoldingEdgeConverter

This method gets called by the IFoldingView implementation to determine whether a given edge in the MasterGraph should be represented by a folding edge in the given view.

The implementation will be passed in a factory object that implements the IFoldingEdgeFactory interface, which needs to be used by the implementation to communicate the result of the query. The implementation needs to either call IFoldingEdgeFactory.addAsSeparateEdge(com.yworks.yfiles.graph.IPort, com.yworks.yfiles.graph.IPort), IFoldingEdgeFactory.addToExistingFoldingEdge(IEdge), or IFoldingEdgeFactory.excludeFoldingEdge() and return the values that these implementation yields to the caller. The implementation can optionally query the existing folding edges between the source and target node and decide whether to add the edge to the existing folding edge.

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.

createEdgeStyle

protected IEdgeStyle createEdgeStyle(IFoldingView foldingView,
                                     IEdge foldingEdge,
                                     List<IEdge> masterEdges)

Callback factory method that creates the IEdgeStyle for use in initializeFoldingEdgeStyle(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

foldingEdge - The folding edge in the view whose Style should be initialized.

masterEdges - The edges that are being represented by the folding edge.

Returns:

The FoldingEdgeStyle or a ICloneable.clone() of it depending on the EdgeStyleCloningEnabled property. This method may return null to indicate that the default style should not be changed.

createLabelLayoutParameter

protected ILabelModelParameter createLabelLayoutParameter(IFoldingView foldingView,
                                                          ILabel localLabel,
                                                          ILabel masterLabel)

Callback factory method that creates the ILabelModelParameter for use in initializeFoldingEdgeLabels(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

localLabel - The local label in the view whose LayoutParameter should be initialized. May be null if the label layout parameter is requested for the label creation.

masterLabel - The label that is being represented by the folding label.

Returns:

The LabelLayoutParameter or a ICloneable.clone() of it depending on the LabelLayoutParameterCloningEnabled property. This method may return null to indicate that the default label layout parameter should not be changed.

createLabelStyle

protected ILabelStyle createLabelStyle(IFoldingView foldingView,
                                       ILabel localLabel,
                                       ILabel masterLabel)

Callback factory method that creates the ILabelStyle for use in initializeFoldingEdgeLabels(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

localLabel - The local label in the view whose Style should be initialized. May be null if the label style is requested for the label creation.

masterLabel - The label that is being represented by the folding label.

Returns:

The LabelStyle or a ICloneable.clone() of it depending on the LabelStyleCloningEnabled property. This method may return null to indicate that the default style should not be changed.

createSourcePortLocationParameter

protected IPortLocationModelParameter createSourcePortLocationParameter(IFoldingView foldingView,
                                                                        IEdge localEdge,
                                                                        List<IEdge> masterEdges)

Callback factory method that creates the IPortLocationModelParameter of the source port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

localEdge - The local edge in the view whose source port's LocationParameter should be initialized.

masterEdges - The master edges that the folding edge represents.

Returns:

The SourcePortLocationParameter or a ICloneable.clone() of it depending on the SourcePortLocationParameterCloningEnabled property. This method may return null to indicate that the default port location parameter should not be changed.

createSourcePortStyle

protected IPortStyle createSourcePortStyle(IFoldingView foldingView,
                                           IEdge localEdge,
                                           List<IEdge> masterEdges)

Callback factory method that creates the IPortStyle of the source port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

localEdge - The local edge in the view whose source port's Style should be initialized.

masterEdges - The master edges that the folding edge represents.

Returns:

The SourcePortStyle or a ICloneable.clone() of it depending on the SourcePortStyleCloningEnabled property. This method may return null to indicate that the default style should not be changed.

createTargetPortLocationParameter

protected IPortLocationModelParameter createTargetPortLocationParameter(IFoldingView foldingView,
                                                                        IEdge localEdge,
                                                                        List<IEdge> masterEdges)

Callback factory method that creates the IPortLocationModelParameter of the target port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

localEdge - The local edge in the view whose target port's LocationParameter should be initialized.

masterEdges - The master edges that the folding edge represents.

Returns:

The TargetPortLocationParameter or a ICloneable.clone() of it depending on the TargetPortLocationParameterCloningEnabled property. This method may return null to indicate that the default port location parameter should not be changed.

createTargetPortStyle

protected IPortStyle createTargetPortStyle(IFoldingView foldingView,
                                           IEdge localEdge,
                                           List<IEdge> masterEdges)

Callback factory method that creates the IPortStyle of the target port for use in initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List).

Parameters:

foldingView - The folding view instance.

localEdge - The local edge in the view whose target port's Style should be initialized.

masterEdges - The master edges that the folding edge represents.

Returns:

The TargetPortStyle or a ICloneable.clone() of it depending on the TargetPortStyleCloningEnabled property. This method may return null to indicate that the default style should not be changed.

getFoldingEdgeStyle

public final IEdgeStyle getFoldingEdgeStyle()

Gets the IEdgeStyle to use for the folding edge.

Depending on the EdgeStyleCloningEnabled property this implementation will assign a ICloneable.clone() to the property or this instance.

A value of null (the default) will leave the style property unmodified.

Returns:

The FoldingEdgeStyle.

See Also:

setFoldingEdgeStyle(IEdgeStyle)

getLabelLayoutParameter

public final ILabelModelParameter getLabelLayoutParameter()

Gets the ILabelModelParameter to use for the first label of the folding edge.

This will only affect the folding edge if the CopyingFirstLabelEnabled property is set to true.

A value of null will leave the label model parameter property unmodified.

Returns:

The LabelLayoutParameter.

See Also:

setLabelLayoutParameter(ILabelModelParameter)

getLabelStyle

public final ILabelStyle getLabelStyle()

Gets the ILabelStyle to use for the first label of the folding edge.

This will only affect the folding edge if the CopyingFirstLabelEnabled property is set to true.

A value of null will leave the style property unmodified.

Returns:

The LabelStyle.

See Also:

setLabelStyle(ILabelStyle)

getSourcePortLocationParameter

public final IPortLocationModelParameter getSourcePortLocationParameter()

Gets the IPortLocationModelParameter to use for the source port of the folding edge.

Since the appearance of the folding edge may totally differ from the appearance of the master edge, the location of the source port may also be different. This property can be used to assign a different specific location parameter to the source port if the edge is in folding state. A value of null will leave the location parameter property unmodified. The default is null

Returns:

The SourcePortLocationParameter.

See Also:

createSourcePortLocationParameter(IFoldingView, IEdge, List), setSourcePortLocationParameter(IPortLocationModelParameter)

getSourcePortStyle

public final IPortStyle getSourcePortStyle()

Gets the IPortStyle to use for the folding source port.

A value of null will leave the style property unmodified.

Returns:

The SourcePortStyle.

See Also:

setSourcePortStyle(IPortStyle)

getTargetPortLocationParameter

public final IPortLocationModelParameter getTargetPortLocationParameter()

Gets the IPortLocationModelParameter to use for the target port of the folding edge.

Since the appearance of the folding edge may totally differ from the appearance of the master edge, the location of the target port may also be different. This property can be used to assign a different specific location parameter to the target port if the edge is in folding state. A value of null will leave the location parameter property unmodified. The default is null

Returns:

The TargetPortLocationParameter.

See Also:

createTargetPortLocationParameter(IFoldingView, IEdge, List), setTargetPortLocationParameter(IPortLocationModelParameter)

getTargetPortStyle

public final IPortStyle getTargetPortStyle()

Gets the IPortStyle to use for the folding target port.

A value of null will leave the style property unmodified.

Returns:

The TargetPortStyle.

See Also:

setTargetPortStyle(IPortStyle)

initializeFoldingEdgeBends

protected void initializeFoldingEdgeBends(FoldingEdgeState state,
                                          IFoldingView foldingView,
                                          IEdge foldingEdge,
                                          List<IEdge> masterEdges)

Callback method that initializes the bends of the folding edge.

This will call the FoldingEdgeState.clearBends() callback if BendsResettingEnabled is enabled.

Parameters:

state - The viewstate to change.

foldingView - The folding view instance that has triggered the initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) call.

foldingEdge - The folding edge in the view that may be changed using the state.

masterEdges - The master edges that the folding edge represents.

initializeFoldingEdgeLabels

protected void initializeFoldingEdgeLabels(FoldingEdgeState state,
                                           IFoldingView foldingView,
                                           IEdge foldingEdge,
                                           List<IEdge> masterEdges)

Callback method that initializes the initial labels of the folding edge.

This will first clear all the labels and then try to copy the first label of the single master edge if CopyingFirstLabelEnabled is enabled. It will call createLabelStyle(IFoldingView, ILabel, ILabel) and createLabelLayoutParameter(IFoldingView, ILabel, ILabel) and use the returned style and layout parameter if they are non-null when adding the label on the folding edge.

Parameters:

state - The viewstate to change.

foldingView - The folding view instance that has triggered the initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) call.

foldingEdge - The folding edge in the view that may be changed using the state.

masterEdges - The master edges that the folding edge represents.

See Also:

getLabelStyle(), getLabelLayoutParameter()

initializeFoldingEdgePorts

protected void initializeFoldingEdgePorts(FoldingEdgeState state,
                                          IFoldingView foldingView,
                                          IEdge foldingEdge,
                                          List<IEdge> masterEdges)

Callback method that initializes the ports of the folding edge.

If the source port of the foldingEdge is in folding state, this implementation calls createSourcePortStyle(IFoldingView, IEdge, List) and createSourcePortLocationParameter(IFoldingView, IEdge, List) and assigns the style and location parameter to the folding source port if non-null values have been returned. The same holds true for the target port where the createTargetPortStyle(IFoldingView, IEdge, List) and createTargetPortLocationParameter(IFoldingView, IEdge, List) callbacks are used.

Parameters:

state - The viewState to change.

foldingView - The folding view instance that has triggered the initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) call.

foldingEdge - The folding edge in the view that may be changed using the state.

masterEdges - The master edges that the folding edge represents.

See Also:

getSourcePortStyle(), getTargetPortStyle(), getSourcePortLocationParameter(), getTargetPortLocationParameter(), createSourcePortStyle(IFoldingView, IEdge, List), createTargetPortStyle(IFoldingView, IEdge, List), createSourcePortLocationParameter(IFoldingView, IEdge, List), createTargetPortLocationParameter(IFoldingView, IEdge, List)

initializeFoldingEdgeState

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

Implements the IFoldingEdgeConverter.initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) method and initializes the folding edge appearance.

This method calls initializeFoldingEdgeStyle(FoldingEdgeState, IFoldingView, IEdge, List), initializeFoldingEdgePorts(FoldingEdgeState, IFoldingView, IEdge, List), initializeFoldingEdgeBends(FoldingEdgeState, IFoldingView, IEdge, List), initializeFoldingEdgeLabels(FoldingEdgeState, IFoldingView, IEdge, List).

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)

initializeFoldingEdgeStyle

protected void initializeFoldingEdgeStyle(FoldingEdgeState state,
                                          IFoldingView foldingView,
                                          IEdge foldingEdge,
                                          List<IEdge> masterEdges)

Callback method that initializes the style property of the folding edge.

This implementation calls createEdgeStyle(IFoldingView, IEdge, List) and assigns the style to the folding edge if a non-null value has been returned.

Parameters:

state - The viewstate to change.

foldingView - The folding view instance that has triggered the initializeFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) call.

foldingEdge - The folding edge in the view that may be changed using the state.

masterEdges - The master edges that the folding edge represents.

isBendsResettingEnabled

public final boolean isBendsResettingEnabled()

Gets a value indicating whether to reset and clear the bends of a folding edge initially.

Returns:

true if the folding edge should initially not contain any bends; false otherwise, which is the default.

See Also:

setBendsResettingEnabled(boolean)

isCopyingFirstLabelEnabled

public final boolean isCopyingFirstLabelEnabled()

Gets a value indicating whether the first label of the master edge should be recreated for the folding edge.

This setting can be used to initially create a copy of the first label of the master edge (if any) and subsequently synchronize the Text property with the master's edge label text.

Returns:

true if the first label should be copied; false otherwise.

See Also:

getLabelStyle(), getLabelLayoutParameter(), setCopyingFirstLabelEnabled(boolean)

isEdgeStyleCloningEnabled

public final boolean isEdgeStyleCloningEnabled()

Gets a value indicating whether the FoldingEdgeStyle instance should be assigned as a ICloneable.clone()clone or not.

Returns:

true if the folding edge style should be cloned; false otherwise.

See Also:

setEdgeStyleCloningEnabled(boolean)

isLabelLayoutParameterCloningEnabled

public final boolean isLabelLayoutParameterCloningEnabled()

Gets a value indicating whether the LabelLayoutParameter instance should be assigned as a ICloneable.clone()clone or not.

Returns:

true if the label layout parameter should be cloned; false otherwise. The default is false

See Also:

setLabelLayoutParameterCloningEnabled(boolean)

isLabelStyleCloningEnabled

public final boolean isLabelStyleCloningEnabled()

Gets a value indicating whether the LabelStyle instance should be assigned as a ICloneable.clone()clone or not.

Returns:

true if the label style should be cloned; false otherwise. The default is false

See Also:

setLabelStyleCloningEnabled(boolean)

isSourcePortLocationParameterCloningEnabled

public final boolean isSourcePortLocationParameterCloningEnabled()

Gets a value indicating whether the SourcePortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.

Returns:

true if the port location parameter should be cloned; false otherwise. The default is false

See Also:

setSourcePortLocationParameterCloningEnabled(boolean)

isSourcePortStyleCloningEnabled

public final boolean isSourcePortStyleCloningEnabled()

Gets a value indicating whether the SourcePortStyle instance should be assigned as a clone or not.

Returns:

true if the port style should be cloned; false otherwise. The default is false

See Also:

setSourcePortStyleCloningEnabled(boolean)

isTargetPortLocationParameterCloningEnabled

public final boolean isTargetPortLocationParameterCloningEnabled()

Gets a value indicating whether the TargetPortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.

Returns:

true if the port location parameter should be cloned; false otherwise. The default is false

See Also:

setTargetPortLocationParameterCloningEnabled(boolean)

isTargetPortStyleCloningEnabled

public final boolean isTargetPortStyleCloningEnabled()

Gets a value indicating whether the TargetPortStyle instance should be assigned as a ICloneable.clone()clone or not.

Returns:

true if the port style should be cloned; false otherwise. The default is false

See Also:

setTargetPortStyleCloningEnabled(boolean)

setBendsResettingEnabled

public final void setBendsResettingEnabled(boolean value)

Sets a value indicating whether to reset and clear the bends of a folding edge initially.

Parameters:

value - true if the folding edge should initially not contain any bends; false otherwise, which is the default.

See Also:

isBendsResettingEnabled()

setCopyingFirstLabelEnabled

public final void setCopyingFirstLabelEnabled(boolean value)

Sets a value indicating whether the first label of the master edge should be recreated for the folding edge.

This setting can be used to initially create a copy of the first label of the master edge (if any) and subsequently synchronize the Text property with the master's edge label text.

Parameters:

value - true if the first label should be copied; false otherwise.

See Also:

getLabelStyle(), getLabelLayoutParameter(), isCopyingFirstLabelEnabled()

setEdgeStyleCloningEnabled

public final void setEdgeStyleCloningEnabled(boolean value)

Sets a value indicating whether the FoldingEdgeStyle instance should be assigned as a ICloneable.clone()clone or not.

Parameters:

value - true if the folding edge style should be cloned; false otherwise.

See Also:

isEdgeStyleCloningEnabled()

setFoldingEdgeStyle

public final void setFoldingEdgeStyle(IEdgeStyle value)

Sets the IEdgeStyle to use for the folding edge.

Depending on the EdgeStyleCloningEnabled property this implementation will assign a ICloneable.clone() to the property or this instance.

A value of null (the default) will leave the style property unmodified.

Parameters:

value - The FoldingEdgeStyle to set.

See Also:

getFoldingEdgeStyle()

setLabelLayoutParameter

public final void setLabelLayoutParameter(ILabelModelParameter value)

Sets the ILabelModelParameter to use for the first label of the folding edge.

This will only affect the folding edge if the CopyingFirstLabelEnabled property is set to true.

A value of null will leave the label model parameter property unmodified.

Parameters:

value - The LabelLayoutParameter to set.

See Also:

getLabelLayoutParameter()

setLabelLayoutParameterCloningEnabled

public final void setLabelLayoutParameterCloningEnabled(boolean value)

Sets a value indicating whether the LabelLayoutParameter instance should be assigned as a ICloneable.clone()clone or not.

Parameters:

value - true if the label layout parameter should be cloned; false otherwise. The default is false

See Also:

isLabelLayoutParameterCloningEnabled()

setLabelStyle

public final void setLabelStyle(ILabelStyle value)

Sets the ILabelStyle to use for the first label of the folding edge.

This will only affect the folding edge if the CopyingFirstLabelEnabled property is set to true.

A value of null will leave the style property unmodified.

Parameters:

value - The LabelStyle to set.

See Also:

getLabelStyle()

setLabelStyleCloningEnabled

public final void setLabelStyleCloningEnabled(boolean value)

Sets a value indicating whether the LabelStyle instance should be assigned as a ICloneable.clone()clone or not.

Parameters:

value - true if the label style should be cloned; false otherwise. The default is false

See Also:

isLabelStyleCloningEnabled()

setSourcePortLocationParameter

public final void setSourcePortLocationParameter(IPortLocationModelParameter value)

Sets the IPortLocationModelParameter to use for the source port of the folding edge.

Since the appearance of the folding edge may totally differ from the appearance of the master edge, the location of the source port may also be different. This property can be used to assign a different specific location parameter to the source port if the edge is in folding state. A value of null will leave the location parameter property unmodified. The default is null

Parameters:

value - The SourcePortLocationParameter to set.

See Also:

createSourcePortLocationParameter(IFoldingView, IEdge, List), getSourcePortLocationParameter()

setSourcePortLocationParameterCloningEnabled

public final void setSourcePortLocationParameterCloningEnabled(boolean value)

Sets a value indicating whether the SourcePortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.

Parameters:

value - true if the port location parameter should be cloned; false otherwise. The default is false

See Also:

isSourcePortLocationParameterCloningEnabled()

setSourcePortStyle

public final void setSourcePortStyle(IPortStyle value)

Sets the IPortStyle to use for the folding source port.

A value of null will leave the style property unmodified.

Parameters:

value - The SourcePortStyle to set.

See Also:

getSourcePortStyle()

setSourcePortStyleCloningEnabled

public final void setSourcePortStyleCloningEnabled(boolean value)

Sets a value indicating whether the SourcePortStyle instance should be assigned as a clone or not.

Parameters:

value - true if the port style should be cloned; false otherwise. The default is false

See Also:

isSourcePortStyleCloningEnabled()

setTargetPortLocationParameter

public final void setTargetPortLocationParameter(IPortLocationModelParameter value)

Sets the IPortLocationModelParameter to use for the target port of the folding edge.

Since the appearance of the folding edge may totally differ from the appearance of the master edge, the location of the target port may also be different. This property can be used to assign a different specific location parameter to the target port if the edge is in folding state. A value of null will leave the location parameter property unmodified. The default is null

Parameters:

value - The TargetPortLocationParameter to set.

See Also:

createTargetPortLocationParameter(IFoldingView, IEdge, List), getTargetPortLocationParameter()

setTargetPortLocationParameterCloningEnabled

public final void setTargetPortLocationParameterCloningEnabled(boolean value)

Sets a value indicating whether the TargetPortLocationParameter instance should be assigned as a ICloneable.clone()clone or not.

Parameters:

value - true if the port location parameter should be cloned; false otherwise. The default is false

See Also:

isTargetPortLocationParameterCloningEnabled()

setTargetPortStyle

public final void setTargetPortStyle(IPortStyle value)

Sets the IPortStyle to use for the folding target port.

A value of null will leave the style property unmodified.

Parameters:

value - The TargetPortStyle to set.

See Also:

getTargetPortStyle()

setTargetPortStyleCloningEnabled

public final void setTargetPortStyleCloningEnabled(boolean value)

Sets a value indicating whether the TargetPortStyle instance should be assigned as a ICloneable.clone()clone or not.

Parameters:

value - true if the port style should be cloned; false otherwise. The default is false

See Also:

isTargetPortStyleCloningEnabled()

synchronizeLabels

protected void synchronizeLabels(FoldingEdgeState state,
                                 IFoldingView foldingView,
                                 IEdge foldingEdge,
                                 List<IEdge> masterEdges)

Called by updateFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) to synchronize the first label if CopyingFirstLabelEnabled is enabled.

This will adjust the label's text, preferred size and tag properties or remove the label if there is no master label or there is more than one master edge.

Parameters:

state - The viewstate of the edge to change.

foldingView - The folding view.

foldingEdge - The folding edge.

masterEdges - The master edges.

updateFoldingEdgeState

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

Implements the IFoldingEdgeConverter.updateFoldingEdgeState(FoldingEdgeState, IFoldingView, IEdge, List) method and changes the folding edge appearance.

This method calls synchronizeLabels(FoldingEdgeState, IFoldingView, IEdge, List), only.

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)