BendConverter (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.layout.BendConverter

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage
```
public class BendConverter
extends Object
implements ILayoutStage
```
BendConverter replaces edge bends with dummy nodes for the core layout algorithm.

Concept
Replacing the bends works in three steps:
1. Replacing the bends and the edge segments between them with dummy nodes and edges
2. Invoking the core layout algorithm on the altered graph
3. Recreating the bends and removing all dummy elements
When the dummy elements have been inserted, edge information about port constraints, edge groups and selection state can be adopted from the original edges. That way, the core layout algorithm can access the mentioned information.

Field Summary

Fields
Modifier and Type	Field and Description
`static EdgeDpKey<Boolean>`	`DEFAULT_AFFECTED_EDGES_DPKEY` A `DataProvider` key for specifying the set of edges for which this stage will replace bends Only the bends of the marked edges will be replaced with dummy nodes.

Constructor Summary

Constructors
Constructor and Description
`BendConverter()` Creates a new `BendConverter` instance with default settings.
`BendConverter(double size)` Creates a new `BendConverter` instance with the given size as the width and height for the dummy nodes.
`BendConverter(ILayoutAlgorithm core)` Creates a new instance of `BendConverter` with the given `core layout algorithm`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addedPathForEdge(LayoutGraph graph, Edge edge, NodeList dummyNodes)` Adds information to newly created dummy nodes.
`void`	`applyLayout(LayoutGraph graph)` Replaces all bends in the current `scope` with dummy nodes before invoking the `core layout algorithm`.
`Object`	`getAffectedEdgesDpKey()` Gets the key to register a `IDataProvider` which identifies edges as selected.
`ILayoutAlgorithm`	`getCoreLayout()` Gets the core layout algorithm that is wrapped by this `ILayoutStage`.
`boolean`	`isAffectedEdgesAdoptionEnabled()` Gets whether or not the selection state of the original edge should be adopted by its replacement edges.
`boolean`	`isEdgeGroupAdoptionEnabled()` Gets whether or not edge grouping information of the original edge should be adopted by its replacement edges.
`boolean`	`isPortConstraintAdoptionEnabled()` Gets whether or not the associated `PortConstraint`s of the original edge should be adopted by its replacement edges.
`protected void`	`prepare(LayoutGraph graph)` Prepares the graph before calling the `core layout algorithm`.
`protected void`	`restore(LayoutGraph graph)` Restores the structure of the graph after the `core layout algorithm` has finished.
`void`	`setAffectedEdgesAdoptionEnabled(boolean value)` Sets whether or not the selection state of the original edge should be adopted by its replacement edges.
`void`	`setAffectedEdgesDpKey(Object value)` Sets the key to register a `IDataProvider` which identifies edges as selected.
`void`	`setCoreLayout(ILayoutAlgorithm value)` Sets the core layout algorithm that is wrapped by this `ILayoutStage`.
`void`	`setEdgeGroupAdoptionEnabled(boolean value)` Sets whether or not edge grouping information of the original edge should be adopted by its replacement edges.
`void`	`setPortConstraintAdoptionEnabled(boolean value)` Sets whether or not the associated `PortConstraint`s of the original edge should be adopted by its replacement edges.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_AFFECTED_EDGES_DPKEY
```
public static final EdgeDpKey<Boolean> DEFAULT_AFFECTED_EDGES_DPKEY
```
    A DataProvider key for specifying the set of edges for which this stage will replace bends
    Only the bends of the marked edges will be replaced with dummy nodes.
    
    If no IDataProvider is registered with this key, the bends of all edges are replaced.
- Constructor Detail
  - BendConverter
```
public BendConverter()
```
    Creates a new BendConverter instance with default settings.
  - BendConverter
```
public BendConverter(double size)
```
    Creates a new BendConverter instance with the given size as the width and height for the dummy nodes.
    
    Throws:
    
    IllegalArgumentException - if the given size is negative
    
    Parameters:
    
    size - the size for the dummy nodes
  - BendConverter
```
public BendConverter(ILayoutAlgorithm core)
```
    Creates a new instance of BendConverter with the given core layout algorithm.
    
    Parameters:
    
    core - the core layout algorithm
- Method Detail
  - addedPathForEdge
```
protected void addedPathForEdge(LayoutGraph graph,
                                Edge edge,
                                NodeList dummyNodes)
```
    Adds information to newly created dummy nodes.
    This is a callback method that will be invoked after new elements for the given edge have been added to the given graph by prepare(LayoutGraph). At this point, the original edge is still in the graph.
    
    The current implementation does nothing.
    
    Parameters:
    
    graph - the input graph
    
    edge - the edge whose bends were replaced by the given dummy nodes
    
    dummyNodes - the dummy nodes representing the bends of the edge
  - applyLayout
```
public void applyLayout(LayoutGraph graph)
```
    Replaces all bends in the current scope with dummy nodes before invoking the core layout algorithm.
    After the core layout algorithm has finished, the edges between the dummy nodes are reconnected and the dummy nodes are replaced by bends again.
    
    Specified by:
    
    applyLayout in interface ILayoutAlgorithm
    
    Parameters:
    
    graph - the input graph
  - getAffectedEdgesDpKey
```
public Object getAffectedEdgesDpKey()
```
    Gets the key to register a IDataProvider which identifies edges as selected.
    If the selection is conserved, the selection state described by the IDataProvider registered with this key is applied to the according dummy edges.
    
    Throws:
    
    IllegalArgumentException - if the specified key is null
    
    Default Value:
    The default value is LayoutKeys.AFFECTED_EDGES_DPKEY
    
    Returns:
    
    the IDataProvider key
    
    See Also:
    
    setAffectedEdgesAdoptionEnabled(boolean), setAffectedEdgesDpKey(Object)
  - getCoreLayout
```
public ILayoutAlgorithm getCoreLayout()
```
    Gets the core layout algorithm that is wrapped by this ILayoutStage.
    
    Specified by:
    
    getCoreLayout in interface ILayoutStage
    
    Default Value:
    The default value is null.
    
    Returns:
    
    the core layout routine
    
    See Also:
    
    setCoreLayout(ILayoutAlgorithm)
  - isAffectedEdgesAdoptionEnabled
```
public boolean isAffectedEdgesAdoptionEnabled()
```
    Gets whether or not the selection state of the original edge should be adopted by its replacement edges.
    The selection state is looked up in a IDataProvider registered with the key returned by AffectedEdgesDpKey.
    
    Default Value:
    The default value is true. The selection state of the original edge is applied to all corresponding dummy edges.
    
    Returns:
    
    true if dummy edges get the selection state of their corresponding original edge, false otherwise
    
    See Also:
    
    getAffectedEdgesDpKey(), setAffectedEdgesAdoptionEnabled(boolean)
  - isEdgeGroupAdoptionEnabled
```
public boolean isEdgeGroupAdoptionEnabled()
```
    Gets whether or not edge grouping information of the original edge should be adopted by its replacement edges.
    
    Default Value:
    The default value is true. Original edge grouping information is applied to the dummy edges.
    
    Returns:
    
    true if dummy edges get the edge grouping information from their corresponding originals, false otherwise
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY, setEdgeGroupAdoptionEnabled(boolean)
  - isPortConstraintAdoptionEnabled
```
public boolean isPortConstraintAdoptionEnabled()
```
    Gets whether or not the associated PortConstraints of the original edge should be adopted by its replacement edges.
    
    Default Value:
    The default value is true. PortConstraints of the original edges are applied to the dummy edges.
    
    Returns:
    
    true if dummy edges get the PortConstraints of their corresponding originals, false otherwise
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, setPortConstraintAdoptionEnabled(boolean)
  - prepare
```
protected void prepare(LayoutGraph graph)
```
    Prepares the graph before calling the core layout algorithm.
    The bends of the edges belonging to the current scope are replaced by dummy nodes and the segments between those dummy nodes are replaced by dummy edges.
    
    Edge-specific information like PortConstraints, edge groups or selection state can be applied to the dummy edges to keep this information for the core layout algorithm.
    
    This method is called by applyLayout(LayoutGraph) before invoking the core layout algorithm. It may be overridden to extend the edge-specific information that should be adopted by the dummy edges.
    
    All changes to the graph should be reverted in restore(LayoutGraph).
    
    Parameters:
    
    graph - the input graph
    
    See Also:
    
    restore(LayoutGraph), setAffectedEdgesAdoptionEnabled(boolean), setPortConstraintAdoptionEnabled(boolean), setEdgeGroupAdoptionEnabled(boolean)
  - restore
```
protected void restore(LayoutGraph graph)
```
    Restores the structure of the graph after the core layout algorithm has finished.
    This method is called by applyLayout(LayoutGraph) after invoking the core layout algorithm. It may be overridden to clean up all additional information added in prepare(LayoutGraph).
    
    All changes to the graph made in prepare(LayoutGraph) should be reverted by this method.
    
    Parameters:
    
    graph - the graph arranged by the core layout algorithm
    
    See Also:
    
    prepare(LayoutGraph), setAffectedEdgesAdoptionEnabled(boolean), setPortConstraintAdoptionEnabled(boolean), setEdgeGroupAdoptionEnabled(boolean)
  - setAffectedEdgesAdoptionEnabled
```
public void setAffectedEdgesAdoptionEnabled(boolean value)
```
    Sets whether or not the selection state of the original edge should be adopted by its replacement edges.
    The selection state is looked up in a IDataProvider registered with the key returned by AffectedEdgesDpKey.
    
    Default Value:
    The default value is true. The selection state of the original edge is applied to all corresponding dummy edges.
    
    Parameters:
    
    value - true if dummy edges get the selection state of their corresponding original edge, false otherwise
    
    See Also:
    
    getAffectedEdgesDpKey(), isAffectedEdgesAdoptionEnabled()
  - setAffectedEdgesDpKey
```
public void setAffectedEdgesDpKey(Object value)
```
    Sets the key to register a IDataProvider which identifies edges as selected.
    If the selection is conserved, the selection state described by the IDataProvider registered with this key is applied to the according dummy edges.
    
    Throws:
    
    IllegalArgumentException - if the specified key is null
    
    Default Value:
    The default value is LayoutKeys.AFFECTED_EDGES_DPKEY
    
    Parameters:
    
    value - the IDataProvider key
    
    See Also:
    
    setAffectedEdgesAdoptionEnabled(boolean), getAffectedEdgesDpKey()
  - setCoreLayout
```
public void setCoreLayout(ILayoutAlgorithm value)
```
    Sets the core layout algorithm that is wrapped by this ILayoutStage.
    
    Specified by:
    
    setCoreLayout in interface ILayoutStage
    
    Default Value:
    The default value is null.
    
    Parameters:
    
    value - the core layout routine
    
    See Also:
    
    getCoreLayout()
  - setEdgeGroupAdoptionEnabled
```
public void setEdgeGroupAdoptionEnabled(boolean value)
```
    Sets whether or not edge grouping information of the original edge should be adopted by its replacement edges.
    
    Default Value:
    The default value is true. Original edge grouping information is applied to the dummy edges.
    
    Parameters:
    
    value - true if dummy edges get the edge grouping information from their corresponding originals, false otherwise
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY, isEdgeGroupAdoptionEnabled()
  - setPortConstraintAdoptionEnabled
```
public void setPortConstraintAdoptionEnabled(boolean value)
```
    Sets whether or not the associated PortConstraints of the original edge should be adopted by its replacement edges.
    
    Default Value:
    The default value is true. PortConstraints of the original edges are applied to the dummy edges.
    
    Parameters:
    
    value - true if dummy edges get the PortConstraints of their corresponding originals, false otherwise
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, isPortConstraintAdoptionEnabled()

Class BendConverter

Concept

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_AFFECTED_EDGES_DPKEY

Constructor Detail

BendConverter

BendConverter

BendConverter

Method Detail

addedPathForEdge

applyLayout

getAffectedEdgesDpKey

getCoreLayout

isAffectedEdgesAdoptionEnabled

isEdgeGroupAdoptionEnabled

isPortConstraintAdoptionEnabled

prepare

restore

setAffectedEdgesAdoptionEnabled

setAffectedEdgesDpKey

setCoreLayout

setEdgeGroupAdoptionEnabled

setPortConstraintAdoptionEnabled