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

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

All Implemented Interfaces:

com.yworks.yfiles.algorithms.IGraphInterface, com.yworks.yfiles.layout.IGraphLayout
```
public class LayoutGraphAdapter
extends Object
implements com.yworks.yfiles.layout.IGraphLayout, com.yworks.yfiles.algorithms.IGraphInterface
```
Adapter class that can be used to obtain an LayoutGraph from an IGraph.
Typically, this class is not used directly but through the convenience class LayoutExecutor or the convenience methods IGraph.applyLayout(ILayoutAlgorithm, LayoutData) and GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler)

This class will use the provided SelectionModel to register corresponding IDataProviders for the data provider keys LayoutKeys.AFFECTED_NODES_DPKEY and LayoutKeys.AFFECTED_EDGES_DPKEY to the layout graph. Moreover, it will automatically convert IMapper instances registered with the IMapperRegistry of the AdaptedGraph into corresponding IDataProvider instances of the layout graph.

In addition, this class supports IGraphs with edge to edge connections, i.e., edges that are adjacent to other edges. Since such edges are not allowed in an LayoutGraph, the property HidingEdgesAtEdgesEnabled specifies whether these edges shouldn't be converted into the layout graph at all or converted into a corresponding structure with dummy nodes.

The chapter Applying an Automatic Layout describes how automatic layout and graph analysis algorithms from the yFiles Layout and yFiles Basic library components can be accessed from @COMPONENT_NAME@.

See Also:

CopiedLayoutGraph, ILayoutAlgorithm

Field Summary

Fields
Modifier and Type	Field and Description
`static IEdgeLabelLayoutDpKey<PreferredPlacementDescriptor>`	`EDGE_LABEL_LAYOUT_PREFERRED_PLACEMENT_DESCRIPTOR_DPKEY` An `IMapperRegistry` tag for an `IMapper` that provides for the edge `ILabel`s in the `AdaptedGraph` a `PreferredPlacementDescriptor` instance.
`static EdgeDpKey<IEdge>`	`ORIGINAL_EDGE_DPKEY` A data provider key that can be used to look up the original `IEdge` of an `Edge`.
`static IEdgeLabelLayoutDpKey<ILabel>`	`ORIGINAL_EDGE_LABEL_DPKEY` A data provider key that can be used to look up the original `ILabel` of an `IEdgeLabelLayout`.
`static NodeDpKey<INode>`	`ORIGINAL_NODE_DPKEY` A data provider key that can be used to look up the original `INode` of a `Node`.
`static INodeLabelLayoutDpKey<ILabel>`	`ORIGINAL_NODE_LABEL_DPKEY` A data provider key that can be used to look up the original `ILabel` of an `INodeLabelLayout`.
`static EdgeDpKey<IPort>`	`ORIGINAL_SOURCE_PORT_DPKEY` A data provider key that can be used to look up the `source port` of the original `IEdge` of an `Edge`.
`static EdgeDpKey<IPort>`	`ORIGINAL_TARGET_PORT_DPKEY` A data provider key that can be used to look up the `target port` of the original `IEdge` of an `Edge`.
`static NodeDpKey<IEdge>`	`PORT_DUMMY_NODE_DPKEY` This key is used to provide information about dummy nodes that have been inserted into the graph to model edges at edges.
`static GraphObjectDpKey<Iterable<IPort>>`	`UNCONNECTED_PORTS_DPKEY` A data provider key that can be used to look up the original unconnected`ports` of the original `IPortOwner` of an `Node` or, in the case of edge-to-edge connections, an `Edge`.

Constructor Summary

Constructors
Constructor and Description
`LayoutGraphAdapter()` Creates the adapter with no initial `IGraph` and no `ISelectionModel`.
`LayoutGraphAdapter(IGraph graph)` Creates the adapter using a given `IGraph` and `ISelectionModel`.
`LayoutGraphAdapter(IGraph graph, ISelectionModel<IModelItem> selectionModel)` Creates the adapter using a given `IGraph` and `ISelectionModel`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<K,V> IDataProvider`	`addDataProvider(Object dataKey, IMapper<K,V> mapper)` Registers a data provider with the graph using the given look-up key and wrapping the given mapper.
`static void`	`applyLayout(IGraph graph, ILayoutAlgorithm layout)` Static convenience method that applies a `layout algorithm` to an `IGraph`.
`static void`	`applyLayout(IGraph graph, ILayoutAlgorithm layout, LayoutData layoutData)` Static convenience method that applies a `layout algorithm` to an `IGraph`.
`void`	`applyLayout(ILayoutAlgorithm layout)` Convenience method that applies a `layout algorithm` to an `IGraph`.
`void`	`applyLayout(ILayoutAlgorithm layout, LayoutData layoutData)` Convenience method that applies a `layout algorithm` to an `IGraph`.
`protected IEdgeStyle`	`copyStyle(IEdgeStyle style)` Creates a copy of an `IEdgeStyle` instance that is used during the layout for path calculations and the like.
`protected INodeStyle`	`copyStyle(INodeStyle style)` Creates a copy of an `INodeStyle` instance that is used during the layout.
`CopiedLayoutGraph`	`createCopiedLayoutGraph()` Creates a `CopiedLayoutGraph` for this instance.
`protected EdgeLabelCandidate`	`createEdgeLabelCandidate(ILabel originalLabel, ILabel dummyLabel, ILabelModelParameter layoutParameter, IEdgeLabelLayout labelLayout)` Creates the `EdgeLabelCandidate` for a given label and `ILabelModelParameter` combination.
`protected IEdgeLayout`	`createEdgeLayout(IEdge edge)` Factory method that creates an `IEdgeLayout` implementation that wraps the given `IEdge`.
`protected INodeLayout`	`createEdgePortLayout(IPort port)` Callback factory method that creates the `INodeLayout` for the given `IPort` that is used as a dummy to represent the port at the `IEdge` that owns `port`.
`protected NodeLabelCandidate`	`createNodeLabelCandidate(ILabel originalLabel, ILabel dummyLabel, ILabelModelParameter layoutParameter, INodeLabelLayout ownerLayout)` Creates a `NodeLabelCandidate` for a given label and `ILabelModelParameter` combination.
`protected INodeLayout`	`createNodeLayout(INode node)` Factory method that creates a `INodeLayout` implementation that wraps the given `INode`.
`Iterable<Object>`	`edgeObjects()`
`IGraph`	`getAdaptedGraph()` Gets or yields the original `IGraph` instance that is adapted by this instance.
`Rectangle2D`	`getBoundingBox()`
`IDataProvider`	`getDataProvider(Object dataKey)`
`Object[]`	`getDataProviderKeys()`
`IEdgeLabelLayout[]`	`getEdgeLabelLayout(Object edge)`
`IEdgeLayout`	`getEdgeLayout(Object edge)`
`SizeD`	`getEdgePortNodeSize()` Gets the size of the nodes that are inserted for the ports that are created for `IEdge`s that are connected at other `IEdge`s.
`protected ILabelCandidateDescriptor`	`getLabelCandidateDescriptor(ILabel originalLabel, ILabel dummyLabel, ILabelModelParameter layoutParameter)` Callback that retrieves the label candidate descriptor for the given label and parameter.
`protected ILabelCandidateDescriptorProvider`	`getLabelCandidateDescriptorProvider(IGraph graph)` Callback method that gets the label candidate descriptor provider for the given `IGraph`.
`INodeLabelLayout[]`	`getNodeLabelLayout(Object node)`
`INodeLayout`	`getNodeLayout(Object o)`
`ISelectionModel<IModelItem>`	`getSelectionModel()` Gets the `ISelectionModel` to use for the automatically registered `IDataProvider` instances for the keys `LayoutKeys.AFFECTED_NODES_DPKEY` and `LayoutKeys.AFFECTED_EDGES_DPKEY`.
`Object`	`getSource(Object edgeObject)`
`Object`	`getTarget(Object edgeObject)`
`boolean`	`isAutomaticEdgeGrouping()` Controls whether edge groups are automatically created for edges that are connected to the same port.
`boolean`	`isCopyingStylesEnabled()` Controls whether node and edge styles should be copied during creation of the layout graph, or if the original instances should be used.
`boolean`	`isFixPorts()` Controls whether strong port constraints are automatically created.
`boolean`	`isHidingEdgesAtEdgesEnabled()` Determines whether edges at other edges will be hidden from the layout graph or included.
`Iterable<Object>`	`nodeObjects()`
`void`	`setAdaptedGraph(IGraph value)` Sets or yields the original `IGraph` instance that is adapted by this instance.
`void`	`setAutomaticEdgeGrouping(boolean value)` Controls whether edge groups are automatically created for edges that are connected to the same port.
`void`	`setCopyingStylesEnabled(boolean value)` Controls whether node and edge styles should be copied during creation of the layout graph, or if the original instances should be used.
`protected void`	`setEdgePortLocation(IPort port, PointD newLocation)` Callback method that assigns a new location that matches `newLocation` to `port`.
`void`	`setEdgePortNodeSize(SizeD value)` Sets the size of the nodes that are inserted for the ports that are created for `IEdge`s that are connected at other `IEdge`s.
`void`	`setFixPorts(boolean value)` Controls whether strong port constraints are automatically created.
`void`	`setHidingEdgesAtEdgesEnabled(boolean value)` Determines whether edges at other edges will be hidden from the layout graph or included.
`protected void`	`setRelativePortLocation(IPort port, PointD newRelativeLocation)` Callback method that assigns a new relative location to `port`.
`void`	`setSelectionModel(ISelectionModel<IModelItem> value)` Sets the `ISelectionModel` to use for the automatically registered `IDataProvider` instances for the keys `LayoutKeys.AFFECTED_NODES_DPKEY` and `LayoutKeys.AFFECTED_EDGES_DPKEY`.

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

- Field Detail
  - EDGE_LABEL_LAYOUT_PREFERRED_PLACEMENT_DESCRIPTOR_DPKEY
```
public static final IEdgeLabelLayoutDpKey<PreferredPlacementDescriptor> EDGE_LABEL_LAYOUT_PREFERRED_PLACEMENT_DESCRIPTOR_DPKEY
```
    An IMapperRegistry tag for an IMapper that provides for the edge ILabels in the AdaptedGraph a PreferredPlacementDescriptor instance.
    If there is a IMapper in the MapperRegistry it will be queried for each edge label to set the PreferredPlacementDescriptor property of the adapted implementation.
  - ORIGINAL_EDGE_DPKEY
```
public static final EdgeDpKey<IEdge> ORIGINAL_EDGE_DPKEY
```
    A data provider key that can be used to look up the original IEdge of an Edge.
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
  - ORIGINAL_EDGE_LABEL_DPKEY
```
public static final IEdgeLabelLayoutDpKey<ILabel> ORIGINAL_EDGE_LABEL_DPKEY
```
    A data provider key that can be used to look up the original ILabel of an IEdgeLabelLayout.
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
  - ORIGINAL_NODE_DPKEY
```
public static final NodeDpKey<INode> ORIGINAL_NODE_DPKEY
```
    A data provider key that can be used to look up the original INode of a Node.
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
  - ORIGINAL_NODE_LABEL_DPKEY
```
public static final INodeLabelLayoutDpKey<ILabel> ORIGINAL_NODE_LABEL_DPKEY
```
    A data provider key that can be used to look up the original ILabel of an INodeLabelLayout.
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
  - ORIGINAL_SOURCE_PORT_DPKEY
```
public static final EdgeDpKey<IPort> ORIGINAL_SOURCE_PORT_DPKEY
```
    A data provider key that can be used to look up the source port of the original IEdge of an Edge.
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
  - ORIGINAL_TARGET_PORT_DPKEY
```
public static final EdgeDpKey<IPort> ORIGINAL_TARGET_PORT_DPKEY
```
    A data provider key that can be used to look up the target port of the original IEdge of an Edge.
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
  - PORT_DUMMY_NODE_DPKEY
```
public static final NodeDpKey<IEdge> PORT_DUMMY_NODE_DPKEY
```
    This key is used to provide information about dummy nodes that have been inserted into the graph to model edges at edges.
    This key can be used to query an IDataProvider that yields true for IDataProvider.getBool(Object) for nodes that are actually representatives of IPorts at IEdges. Also the IDataProvider.get(Object) method will yield the corresponding original IEdge.
  - UNCONNECTED_PORTS_DPKEY
```
public static final GraphObjectDpKey<Iterable<IPort>> UNCONNECTED_PORTS_DPKEY
```
    A data provider key that can be used to look up the original unconnectedports of the original IPortOwner of an Node or, in the case of edge-to-edge connections, an Edge.
    You can access all (connected and unconnected) ports through the Ports property of the original IGraph elements, which can be retrieved through the ORIGINAL_NODE_DPKEY and ORIGINAL_EDGE_DPKEY data providers. The information about whether a port is connected or not is not readily accessible from there, though. You can use this data provider to specifically find these port, e.g. to create additional PortCandidates or just reserve space for them.
    
    This data provider is created automatically for a CopiedLayoutGraph that is created as a copy of an IGraph with the help of a LayoutGraphAdapter. Especially, it is available if the layout is run with a LayoutExecutor or the convenience methods GraphControl.morphLayout(ILayoutAlgorithm, java.time.Duration, com.yworks.yfiles.utils.IEventHandler) and IGraph.applyLayout(ILayoutAlgorithm, LayoutData).
- Constructor Detail
  - LayoutGraphAdapter
```
public LayoutGraphAdapter()
```
    Creates the adapter with no initial IGraph and no ISelectionModel.
    Before this instance can be used for automatic layouts, you mus assign a value to the AdaptedGraph property.
  - LayoutGraphAdapter
```
public LayoutGraphAdapter(IGraph graph)
```
    Creates the adapter using a given IGraph and ISelectionModel.
    
    Throws:
    
    NullPointerException - graph is null.
    
    Parameters:
    
    graph - The graph to build an adapter for.
  - LayoutGraphAdapter
```
public LayoutGraphAdapter(IGraph graph,
                          ISelectionModel<IModelItem> selectionModel)
```
    Creates the adapter using a given IGraph and ISelectionModel.
    
    Throws:
    
    NullPointerException - graph is null.
    
    Parameters:
    
    graph - The graph to build an adapter for.
    
    selectionModel - The optional selection model to use by the LayoutKeys.AFFECTED_NODES_DPKEY and LayoutKeys.AFFECTED_EDGES_DPKEY IDataProvider instances that are automatically bound to this adapter.
- Method Detail
  - addDataProvider
```
public <K,V> IDataProvider addDataProvider(Object dataKey,
                                           IMapper<K,V> mapper)
```
    Registers a data provider with the graph using the given look-up key and wrapping the given mapper.
    If a mapper is already registered under the given key, it is overwritten.
    
    Type Parameters:
    
    K - The type of the key to use.
    
    V - The type of the value to use.
    
    Parameters:
    
    dataKey - The look-up key to register the data provider with.
    
    mapper - The mapper wrapped as data provider.
  - applyLayout
```
public static final void applyLayout(IGraph graph,
                                     ILayoutAlgorithm layout)
```
    Static convenience method that applies a layout algorithm to an IGraph.
    
    Parameters:
    
    graph - The graph to compute the layout on.
    
    layout - The layout algorithm to apply.
  - applyLayout
```
public static final void applyLayout(IGraph graph,
                                     ILayoutAlgorithm layout,
                                     LayoutData layoutData)
```
    Static convenience method that applies a layout algorithm to an IGraph.
    
    Parameters:
    
    layout - The layout algorithm to apply.
    
    graph - The graph to compute the layout on.
    
    layoutData - The layout data.
  - applyLayout
```
public final void applyLayout(ILayoutAlgorithm layout)
```
    Convenience method that applies a layout algorithm to an IGraph.
    
    Parameters:
    
    layout - The layout algorithm to apply.
  - applyLayout
```
public final void applyLayout(ILayoutAlgorithm layout,
                              LayoutData layoutData)
```
    Convenience method that applies a layout algorithm to an IGraph.
    
    Parameters:
    
    layout - The layout algorithm to apply.
    
    layoutData - The layout data.
  - copyStyle
```
protected IEdgeStyle copyStyle(IEdgeStyle style)
```
    Creates a copy of an IEdgeStyle instance that is used during the layout for path calculations and the like.
    This method creates suitable copies of style for the following IEdgeStyle implementations:
    All other style implementations are replaced by instances of PolylineEdgeStyle. If you use a custom style where the edge path calculation depends on the style, you should overwrite this method and create a copy of your style instance.
    Parameters:
    
    style - The style to copy.
    
    Returns:
    
    A replacement of style that is used during layout calculation.
  - copyStyle
```
protected INodeStyle copyStyle(INodeStyle style)
```
    Creates a copy of an INodeStyle instance that is used during the layout.
    This method creates suitable copies of style for the following INodeStyle implementations:
    All other style implementations are replaced by instances of ShapeNodeStyle. If you use a custom style where the layout calculation depends on the style, you should overwrite this method and create a copy of your style instance.
    Parameters:
    
    style - The style to copy.
    
    Returns:
    
    A replacement of style that is used during layout calculation.
  - createCopiedLayoutGraph
```
public final CopiedLayoutGraph createCopiedLayoutGraph()
```
    Creates a CopiedLayoutGraph for this instance.
    
    Returns:
    
    An instance whose CopiedLayoutGraph.commitLayoutToOriginalGraph() will update this instance.
  - createEdgeLabelCandidate
```
protected EdgeLabelCandidate createEdgeLabelCandidate(ILabel originalLabel,
                                                      ILabel dummyLabel,
                                                      ILabelModelParameter layoutParameter,
                                                      IEdgeLabelLayout labelLayout)
```
    Creates the EdgeLabelCandidate for a given label and ILabelModelParameter combination.
    
    Parameters:
    
    originalLabel - The original label.
    
    dummyLabel - The dummy label that describes the current laid out label.
    
    layoutParameter - The parameter to create a candidate for.
    
    labelLayout - The IEdgeLabelLayout of the label to pass to the candidate.
    
    Returns:
    
    A candidate to yield for the labeling algorithms or null.
  - createEdgeLayout
```
protected IEdgeLayout createEdgeLayout(IEdge edge)
```
    Factory method that creates an IEdgeLayout implementation that wraps the given IEdge.
    
    Parameters:
    
    edge - The edge to wrap.
    
    Returns:
    
    A wrapper instance.
  - createEdgePortLayout
```
protected INodeLayout createEdgePortLayout(IPort port)
```
    Callback factory method that creates the INodeLayout for the given IPort that is used as a dummy to represent the port at the IEdge that owns port.
    
    Parameters:
    
    port - The port to create the layout for.
    
    Returns:
    
    A suitable implementation of INodeLayout that uses the port's location as the center of the node.
    
    See Also:
    
    getEdgePortNodeSize(), isHidingEdgesAtEdgesEnabled()
  - createNodeLabelCandidate
```
protected NodeLabelCandidate createNodeLabelCandidate(ILabel originalLabel,
                                                      ILabel dummyLabel,
                                                      ILabelModelParameter layoutParameter,
                                                      INodeLabelLayout ownerLayout)
```
    Creates a NodeLabelCandidate for a given label and ILabelModelParameter combination.
    
    Parameters:
    
    originalLabel - The original label.
    
    dummyLabel - The dummy label that describes the current laid out label.
    
    layoutParameter - The parameter to create a candidate for.
    
    ownerLayout - The INodeLabelLayout of the label to pass to the candidate.
    
    Returns:
    
    A candidate to yield for the labeling algorithms or null.
  - createNodeLayout
```
protected INodeLayout createNodeLayout(INode node)
```
    Factory method that creates a INodeLayout implementation that wraps the given INode.
    
    Parameters:
    
    node - The node to wrap.
    
    Returns:
    
    A wrapper instance.
  - edgeObjects
```
public final Iterable<Object> edgeObjects()
```
    Specified by:
    
    edgeObjects in interface com.yworks.yfiles.algorithms.IGraphInterface
  - getAdaptedGraph
```
public final IGraph getAdaptedGraph()
```
    Gets or yields the original IGraph instance that is adapted by this instance.
    Before performing a layout, this property must be set or the adapter must have been created with LayoutGraphAdapter(IGraph, ISelectionModel). Note that this property cannot be assigned again if its value is already non null.
    
    Throws:
    
    IllegalArgumentException - if the value of this property is already non null
    
    Returns:
    
    The AdaptedGraph.
    
    See Also:
    
    setAdaptedGraph(IGraph)
  - getBoundingBox
```
public final Rectangle2D getBoundingBox()
```
    Specified by:
    
    getBoundingBox in interface com.yworks.yfiles.layout.IGraphLayout
  - getDataProvider
```
public final IDataProvider getDataProvider(Object dataKey)
```
    Specified by:
    
    getDataProvider in interface com.yworks.yfiles.algorithms.IGraphInterface
  - getDataProviderKeys
```
public final Object[] getDataProviderKeys()
```
    Specified by:
    
    getDataProviderKeys in interface com.yworks.yfiles.algorithms.IGraphInterface
  - getEdgeLabelLayout
```
public final IEdgeLabelLayout[] getEdgeLabelLayout(Object edge)
```
    Specified by:
    
    getEdgeLabelLayout in interface com.yworks.yfiles.layout.IGraphLayout
  - getEdgeLayout
```
public final IEdgeLayout getEdgeLayout(Object edge)
```
    Specified by:
    
    getEdgeLayout in interface com.yworks.yfiles.layout.IGraphLayout
  - getEdgePortNodeSize
```
public final SizeD getEdgePortNodeSize()
```
    Gets the size of the nodes that are inserted for the ports that are created for IEdges that are connected at other IEdges.
    If this instance is configured to create dummy nodes for ports at edges, this will be the initial size of the dummy nodes with the center of the node always being the location of the port. The default is 3x3.
    
    Returns:
    
    The EdgePortNodeSize.
    
    See Also:
    
    isHidingEdgesAtEdgesEnabled(), setEdgePortNodeSize(SizeD)
  - getLabelCandidateDescriptor
```
protected ILabelCandidateDescriptor getLabelCandidateDescriptor(ILabel originalLabel,
                                                                ILabel dummyLabel,
                                                                ILabelModelParameter layoutParameter)
```
    Callback that retrieves the label candidate descriptor for the given label and parameter.
    
    Parameters:
    
    originalLabel - The original label to which a parameter will be applied.
    
    dummyLabel - The dummy label to which the parameter will be applied.
    
    layoutParameter - The parameter to apply.
    
    Returns:
    
    A descriptor or null.
    
    See Also:
    
    createNodeLabelCandidate(ILabel, ILabel, ILabelModelParameter, INodeLabelLayout), createEdgeLabelCandidate(ILabel, ILabel, ILabelModelParameter, IEdgeLabelLayout), getLabelCandidateDescriptorProvider(IGraph)
  - getLabelCandidateDescriptorProvider
```
protected ILabelCandidateDescriptorProvider getLabelCandidateDescriptorProvider(IGraph graph)
```
    Callback method that gets the label candidate descriptor provider for the given IGraph.
    This implementation uses the IGraph's ILookup to find an implementation of the ILabelCandidateDescriptorProvider.
    
    Parameters:
    
    graph - The graph.
    
    Returns:
    
    The result of a ILookup.lookup(Class) query on graph for the ILabelCandidateDescriptorProvider type.
  - getNodeLabelLayout
```
public final INodeLabelLayout[] getNodeLabelLayout(Object node)
```
    Specified by:
    
    getNodeLabelLayout in interface com.yworks.yfiles.layout.IGraphLayout
  - getNodeLayout
```
public final INodeLayout getNodeLayout(Object o)
```
    Specified by:
    
    getNodeLayout in interface com.yworks.yfiles.layout.IGraphLayout
  - getSelectionModel
```
public final ISelectionModel<IModelItem> getSelectionModel()
```
    Gets the ISelectionModel to use for the automatically registered IDataProvider instances for the keys LayoutKeys.AFFECTED_NODES_DPKEY and LayoutKeys.AFFECTED_EDGES_DPKEY.
    
    Returns:
    
    The SelectionModel.
    
    See Also:
    
    setSelectionModel(ISelectionModel)
  - getSource
```
public final Object getSource(Object edgeObject)
```
    Specified by:
    
    getSource in interface com.yworks.yfiles.algorithms.IGraphInterface
  - getTarget
```
public final Object getTarget(Object edgeObject)
```
    Specified by:
    
    getTarget in interface com.yworks.yfiles.algorithms.IGraphInterface
  - isAutomaticEdgeGrouping
```
public final boolean isAutomaticEdgeGrouping()
```
    Controls whether edge groups are automatically created for edges that are connected to the same port.
    If this property is enabled and no edge groups are explicitly created (PortConstraintKeys.SOURCE_GROUP_ID_DPKEY and PortConstraintKeys.TARGET_GROUP_ID_DPKEY), for all ports with multiple outgoing resp. incoming edges these edges will be assigned to the same edge group. The necessary IDataProviders will be created automatically.
    
    This features requires edge group support from the ILayoutAlgorithm.
    
    Default value is true
    
    Returns:
    
    The AutomaticEdgeGrouping.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY, LayoutExecutor.isAutomaticEdgeGrouping(), isFixPorts(), setAutomaticEdgeGrouping(boolean)
  - isCopyingStylesEnabled
```
public final boolean isCopyingStylesEnabled()
```
    Controls whether node and edge styles should be copied during creation of the layout graph, or if the original instances should be used.
    Using the original instances can lead to race conditions if the layout is calculated on a different thread. If true, node and edge styles are copied, otherwise, the original instances are used. Default value is false.
    
    Returns:
    
    The CopyingStylesEnabled.
    
    See Also:
    
    copyStyle(IEdgeStyle), copyStyle(INodeStyle), setCopyingStylesEnabled(boolean)
  - isFixPorts
```
public final boolean isFixPorts()
```
    Controls whether strong port constraints are automatically created.
    If this property is enabled and no port constraints are explicitly created (PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY and PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY), for all edges strong source and target point constraints with PortSide.ANY are created. The necessary IDataProviders will be created automatically.
    
    This ensures that view IPorts are not moved during the layout, if the ILayoutAlgorithm supports port constraints.
    
    Default value is false
    
    Returns:
    
    The FixPorts.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY, LayoutExecutor.isFixPorts(), isAutomaticEdgeGrouping(), setFixPorts(boolean)
  - isHidingEdgesAtEdgesEnabled
```
public final boolean isHidingEdgesAtEdgesEnabled()
```
    Determines whether edges at other edges will be hidden from the layout graph or included.
    If this property is set to true, edges at other edges are simply ignored and not part of the layout graph. The default is false in which case dummy nodes are inserted into the layout graph for each source and target port of an IEdge that is owned by an IEdge.
    
    Returns:
    
    The HidingEdgesAtEdgesEnabled.
    
    See Also:
    
    getEdgePortNodeSize(), setHidingEdgesAtEdgesEnabled(boolean)
  - nodeObjects
```
public final Iterable<Object> nodeObjects()
```
    Specified by:
    
    nodeObjects in interface com.yworks.yfiles.algorithms.IGraphInterface
  - setAdaptedGraph
```
public final void setAdaptedGraph(IGraph value)
```
    Sets or yields the original IGraph instance that is adapted by this instance.
    Before performing a layout, this property must be set or the adapter must have been created with LayoutGraphAdapter(IGraph, ISelectionModel). Note that this property cannot be assigned again if its value is already non null.
    
    Throws:
    
    IllegalArgumentException - if the value of this property is already non null
    
    Parameters:
    
    value - The AdaptedGraph to set.
    
    See Also:
    
    getAdaptedGraph()
  - setAutomaticEdgeGrouping
```
public final void setAutomaticEdgeGrouping(boolean value)
```
    Controls whether edge groups are automatically created for edges that are connected to the same port.
    If this property is enabled and no edge groups are explicitly created (PortConstraintKeys.SOURCE_GROUP_ID_DPKEY and PortConstraintKeys.TARGET_GROUP_ID_DPKEY), for all ports with multiple outgoing resp. incoming edges these edges will be assigned to the same edge group. The necessary IDataProviders will be created automatically.
    
    This features requires edge group support from the ILayoutAlgorithm.
    
    Default value is true
    
    Parameters:
    
    value - The AutomaticEdgeGrouping to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY, LayoutExecutor.isAutomaticEdgeGrouping(), isFixPorts(), isAutomaticEdgeGrouping()
  - setCopyingStylesEnabled
```
public final void setCopyingStylesEnabled(boolean value)
```
    Controls whether node and edge styles should be copied during creation of the layout graph, or if the original instances should be used.
    Using the original instances can lead to race conditions if the layout is calculated on a different thread. If true, node and edge styles are copied, otherwise, the original instances are used. Default value is false.
    
    Parameters:
    
    value - The CopyingStylesEnabled to set.
    
    See Also:
    
    copyStyle(IEdgeStyle), copyStyle(INodeStyle), isCopyingStylesEnabled()
  - setEdgePortLocation
```
protected void setEdgePortLocation(IPort port,
                                   PointD newLocation)
```
    Callback method that assigns a new location that matches newLocation to port.
    This method is called only for ports which are owned by edges. These are represented by dummy nodes during the layout, and newLocation is the position of the dummy node after the layout.
    
    Parameters:
    
    port - The edge port that should be placed.
    
    newLocation - The new location of the port as calculated by the layout algorithm.
  - setEdgePortNodeSize
```
public final void setEdgePortNodeSize(SizeD value)
```
    Sets the size of the nodes that are inserted for the ports that are created for IEdges that are connected at other IEdges.
    If this instance is configured to create dummy nodes for ports at edges, this will be the initial size of the dummy nodes with the center of the node always being the location of the port. The default is 3x3.
    
    Parameters:
    
    value - The EdgePortNodeSize to set.
    
    See Also:
    
    isHidingEdgesAtEdgesEnabled(), getEdgePortNodeSize()
  - setFixPorts
```
public final void setFixPorts(boolean value)
```
    Controls whether strong port constraints are automatically created.
    If this property is enabled and no port constraints are explicitly created (PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY and PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY), for all edges strong source and target point constraints with PortSide.ANY are created. The necessary IDataProviders will be created automatically.
    
    This ensures that view IPorts are not moved during the layout, if the ILayoutAlgorithm supports port constraints.
    
    Default value is false
    
    Parameters:
    
    value - The FixPorts to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, PortConstraintKeys.TARGET_GROUP_ID_DPKEY, LayoutExecutor.isFixPorts(), isAutomaticEdgeGrouping(), isFixPorts()
  - setHidingEdgesAtEdgesEnabled
```
public final void setHidingEdgesAtEdgesEnabled(boolean value)
```
    Determines whether edges at other edges will be hidden from the layout graph or included.
    If this property is set to true, edges at other edges are simply ignored and not part of the layout graph. The default is false in which case dummy nodes are inserted into the layout graph for each source and target port of an IEdge that is owned by an IEdge.
    
    Parameters:
    
    value - The HidingEdgesAtEdgesEnabled to set.
    
    See Also:
    
    getEdgePortNodeSize(), isHidingEdgesAtEdgesEnabled()
  - setRelativePortLocation
```
protected void setRelativePortLocation(IPort port,
                                       PointD newRelativeLocation)
```
    Callback method that assigns a new relative location to port.
    The default implementation calls IGraph.setRelativePortLocation(IPort, PointD) with newRelativeLocation. Depending on the port location model, the actual resulting port location may be different.
    
    Parameters:
    
    port - The port that should be placed.
    
    newRelativeLocation - The new coordinate offsets relative to the center of the node's Layout's center.
  - setSelectionModel
```
public final void setSelectionModel(ISelectionModel<IModelItem> value)
```
    Sets the ISelectionModel to use for the automatically registered IDataProvider instances for the keys LayoutKeys.AFFECTED_NODES_DPKEY and LayoutKeys.AFFECTED_EDGES_DPKEY.
    
    Parameters:
    
    value - The SelectionModel to set.
    
    See Also:
    
    getSelectionModel()

Class LayoutGraphAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EDGE_LABEL_LAYOUT_PREFERRED_PLACEMENT_DESCRIPTOR_DPKEY

ORIGINAL_EDGE_DPKEY

ORIGINAL_EDGE_LABEL_DPKEY

ORIGINAL_NODE_DPKEY

ORIGINAL_NODE_LABEL_DPKEY

ORIGINAL_SOURCE_PORT_DPKEY

ORIGINAL_TARGET_PORT_DPKEY

PORT_DUMMY_NODE_DPKEY

UNCONNECTED_PORTS_DPKEY

Constructor Detail

LayoutGraphAdapter

LayoutGraphAdapter

LayoutGraphAdapter

Method Detail

addDataProvider

applyLayout

applyLayout

applyLayout

applyLayout

copyStyle

copyStyle

createCopiedLayoutGraph

createEdgeLabelCandidate

createEdgeLayout

createEdgePortLayout

createNodeLabelCandidate

createNodeLayout

edgeObjects

getAdaptedGraph

getBoundingBox

getDataProvider

getDataProviderKeys

getEdgeLabelLayout

getEdgeLayout

getEdgePortNodeSize

getLabelCandidateDescriptor

getLabelCandidateDescriptorProvider

getNodeLabelLayout

getNodeLayout

getSelectionModel

getSource

getTarget

isAutomaticEdgeGrouping

isCopyingStylesEnabled

isFixPorts

isHidingEdgesAtEdgesEnabled

nodeObjects

setAdaptedGraph

setAutomaticEdgeGrouping

setCopyingStylesEnabled

setEdgePortLocation

setEdgePortNodeSize

setFixPorts

setHidingEdgesAtEdgesEnabled

setRelativePortLocation

setSelectionModel