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

java.lang.Object
- com.yworks.yfiles.layout.LayoutData
- - com.yworks.yfiles.layout.router.polyline.PolylineEdgeRouterData

public class PolylineEdgeRouterData
extends LayoutData

Specifies custom data for the EdgeRouter.

Constructor Summary

Constructors
Constructor and Description

PolylineEdgeRouterData()

Constructors
Constructor and Description
`PolylineEdgeRouterData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph)` Applies this layout data to the specified `layoutGraphAdapter`.
`AbortHandler`	`getAbortHandler()` Gets the AbortHandler used during the layout.
`DpKeyItemCollection<IEdge>`	`getAffectedEdges()` Gets the collection of affected edges.
`DpKeyItemCollection<INode>`	`getAffectedNodes()` Gets the collection of affected nodes.
`ItemMapping<IEdge,EdgeLayoutDescriptor>`	`getEdgeLayoutDescriptors()` Gets the mapping of edges to their `EdgeLayoutDescriptor`.
`ItemCollection<ILabel>`	`getIgnoredLabels()` Gets the collection of labels of nodes or fixed edges that are ignored by the router.
`ItemMapping<ILabel,Double>`	`getLabelCrossingPenaltyFactors()` Gets a mapping from labels to a crossing penalty factor.
`ItemMapping<INode,NodeHalo>`	`getNodeHalos()` Gets the mapping from nodes to their `NodeHalo`.
`ItemMapping<INode,PortCandidateSet>`	`getNodePortCandidateSets()` Gets a mapping from nodes to their `PortCandidateSet`.
`PartitionGridData`	`getPartitionGridData()` Gets the partition grid layout data.
`ItemMapping<IEdge,Object>`	`getSourceGroupIds()` Gets a mapping from edges to an object representing their source edge group.
`ItemMapping<IEdge,Collection<PortCandidate>>`	`getSourcePortCandidates()` Gets a mapping from edges to a collection of their source port `candidates`.
`ItemMapping<IEdge,PortConstraint>`	`getSourcePortConstraints()` Gets a mapping from edges to their source `PortConstraint`.
`ItemMapping<IEdge,Object>`	`getTargetGroupIds()` Gets a mapping from edges to an object representing their target edge group.
`ItemMapping<IEdge,Collection<PortCandidate>>`	`getTargetPortCandidates()` Gets a mapping from edges to a collection of their target port `candidates`.
`ItemMapping<IEdge,PortConstraint>`	`getTargetPortConstraints()` Gets a mapping from edges to their target `PortConstraint`.
`void`	`setAbortHandler(AbortHandler value)` Sets the AbortHandler used during the layout.
`void`	`setAffectedEdges(DpKeyItemCollection<IEdge> value)` Sets the collection of affected edges.
`void`	`setAffectedNodes(DpKeyItemCollection<INode> value)` Sets the collection of affected nodes.
`void`	`setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value)` Sets the mapping of edges to their `EdgeLayoutDescriptor`.
`void`	`setIgnoredLabels(ItemCollection<ILabel> value)` Sets the collection of labels of nodes or fixed edges that are ignored by the router.
`void`	`setLabelCrossingPenaltyFactors(ItemMapping<ILabel,Double> value)` Sets a mapping from labels to a crossing penalty factor.
`void`	`setNodeHalos(ItemMapping<INode,NodeHalo> value)` Sets the mapping from nodes to their `NodeHalo`.
`void`	`setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value)` Sets a mapping from nodes to their `PortCandidateSet`.
`void`	`setPartitionGridData(PartitionGridData value)` Sets the partition grid layout data.
`void`	`setSourceGroupIds(ItemMapping<IEdge,Object> value)` Sets a mapping from edges to an object representing their source edge group.
`void`	`setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)` Sets a mapping from edges to a collection of their source port `candidates`.
`void`	`setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)` Sets a mapping from edges to their source `PortConstraint`.
`void`	`setTargetGroupIds(ItemMapping<IEdge,Object> value)` Sets a mapping from edges to an object representing their target edge group.
`void`	`setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)` Sets a mapping from edges to a collection of their target port `candidates`.
`void`	`setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)` Sets a mapping from edges to their target `PortConstraint`.

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

- Constructor Detail
  - PolylineEdgeRouterData
```
public PolylineEdgeRouterData()
```
- Method Detail
  - apply
```
public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)
```
    Description copied from class: LayoutData
    
    Applies this layout data to the specified layoutGraphAdapter.
    
    Specified by:
    
    apply in class LayoutData
    
    Parameters:
    
    adapter - The adapter to add the layout data to.
    
    layout - The layout that shall use this layout data.
    
    layoutGraph - The layout graph used for the layout calculation.
  - getAbortHandler
```
public final AbortHandler getAbortHandler()
```
    Gets the AbortHandler used during the layout.
    
    Returns:
    
    The AbortHandler.
    
    See Also:
    
    AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)
  - getAffectedEdges
```
public final DpKeyItemCollection<IEdge> getAffectedEdges()
```
    Gets the collection of affected edges.
    This collection is only used by the router if the Scope is set to Scope.ROUTE_AFFECTED_EDGES.
    
    Returns:
    
    The AffectedEdges.
    
    See Also:
    
    EdgeRouter.getAffectedEdgesDpKey(), setAffectedEdges(DpKeyItemCollection)
  - getAffectedNodes
```
public final DpKeyItemCollection<INode> getAffectedNodes()
```
    Gets the collection of affected nodes.
    This collection is only used by the router if the Scope is set to Scope.ROUTE_EDGES_AT_AFFECTED_NODES.
    
    Returns:
    
    The AffectedNodes.
    
    See Also:
    
    EdgeRouter.getAffectedNodesDpKey(), setAffectedNodes(DpKeyItemCollection)
  - getEdgeLayoutDescriptors
```
public final ItemMapping<IEdge,EdgeLayoutDescriptor> getEdgeLayoutDescriptors()
```
    Gets the mapping of edges to their EdgeLayoutDescriptor.
    If an edge is mapped to null, the default descriptor is used.
    
    Returns:
    
    The EdgeLayoutDescriptors.
    
    See Also:
    
    EdgeRouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY, setEdgeLayoutDescriptors(ItemMapping)
  - getIgnoredLabels
```
public final ItemCollection<ILabel> getIgnoredLabels()
```
    Gets the collection of labels of nodes or fixed edges that are ignored by the router.
    
    Returns:
    
    The IgnoredLabels.
    
    See Also:
    
    LabelLayoutKeys.IGNORED_LABELS_DPKEY, setIgnoredLabels(ItemCollection)
  - getLabelCrossingPenaltyFactors
```
public final ItemMapping<ILabel,Double> getLabelCrossingPenaltyFactors()
```
    Gets a mapping from labels to a crossing penalty factor.
    The crossing penalty factor of a label is multiplied with the basic penalty for an edge crossing the label so crossing a label with a higher cost factor is stronger avoided then crossing one with a lower factor.
    
    Returns:
    
    The LabelCrossingPenaltyFactors.
    
    See Also:
    
    PenaltySettings.getEdgeLabelCrossingPenalty(), PenaltySettings.getNodeLabelCrossingPenalty(), EdgeRouter.LABEL_CROSSING_PENALTY_FACTOR_DPKEY, setLabelCrossingPenaltyFactors(ItemMapping)
  - getNodeHalos
```
public final ItemMapping<INode,NodeHalo> getNodeHalos()
```
    Gets the mapping from nodes to their NodeHalo.
    
    Returns:
    
    The NodeHalos.
    
    See Also:
    
    NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)
  - getNodePortCandidateSets
```
public final ItemMapping<INode,PortCandidateSet> getNodePortCandidateSets()
```
    Gets a mapping from nodes to their PortCandidateSet.
    
    Returns:
    
    The NodePortCandidateSets.
    
    See Also:
    
    PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, setNodePortCandidateSets(ItemMapping)
  - getPartitionGridData
```
public final PartitionGridData getPartitionGridData()
```
    Gets the partition grid layout data.
    
    Returns:
    
    The PartitionGridData.
    
    See Also:
    
    setPartitionGridData(PartitionGridData)
  - getSourceGroupIds
```
public final ItemMapping<IEdge,Object> getSourceGroupIds()
```
    Gets a mapping from edges to an object representing their source edge group.
    
    Returns:
    
    The SourceGroupIds.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, setSourceGroupIds(ItemMapping)
  - getSourcePortCandidates
```
public final ItemMapping<IEdge,Collection<PortCandidate>> getSourcePortCandidates()
```
    Gets a mapping from edges to a collection of their source port candidates.
    
    Returns:
    
    The SourcePortCandidates.
    
    See Also:
    
    PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, setSourcePortCandidates(ItemMapping)
  - getSourcePortConstraints
```
public final ItemMapping<IEdge,PortConstraint> getSourcePortConstraints()
```
    Gets a mapping from edges to their source PortConstraint.
    
    Returns:
    
    The SourcePortConstraints.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, setSourcePortConstraints(ItemMapping)
  - getTargetGroupIds
```
public final ItemMapping<IEdge,Object> getTargetGroupIds()
```
    Gets a mapping from edges to an object representing their target edge group.
    
    Returns:
    
    The TargetGroupIds.
    
    See Also:
    
    PortConstraintKeys.TARGET_GROUP_ID_DPKEY, setTargetGroupIds(ItemMapping)
  - getTargetPortCandidates
```
public final ItemMapping<IEdge,Collection<PortCandidate>> getTargetPortCandidates()
```
    Gets a mapping from edges to a collection of their target port candidates.
    
    Returns:
    
    The TargetPortCandidates.
    
    See Also:
    
    PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, setTargetPortCandidates(ItemMapping)
  - getTargetPortConstraints
```
public final ItemMapping<IEdge,PortConstraint> getTargetPortConstraints()
```
    Gets a mapping from edges to their target PortConstraint.
    
    Returns:
    
    The TargetPortConstraints.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, setTargetPortConstraints(ItemMapping)
  - setAbortHandler
```
public final void setAbortHandler(AbortHandler value)
```
    Sets the AbortHandler used during the layout.
    
    Parameters:
    
    value - The AbortHandler to set.
    
    See Also:
    
    AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()
  - setAffectedEdges
```
public final void setAffectedEdges(DpKeyItemCollection<IEdge> value)
```
    Sets the collection of affected edges.
    This collection is only used by the router if the Scope is set to Scope.ROUTE_AFFECTED_EDGES.
    
    Parameters:
    
    value - The AffectedEdges to set.
    
    See Also:
    
    EdgeRouter.getAffectedEdgesDpKey(), getAffectedEdges()
  - setAffectedNodes
```
public final void setAffectedNodes(DpKeyItemCollection<INode> value)
```
    Sets the collection of affected nodes.
    This collection is only used by the router if the Scope is set to Scope.ROUTE_EDGES_AT_AFFECTED_NODES.
    
    Parameters:
    
    value - The AffectedNodes to set.
    
    See Also:
    
    EdgeRouter.getAffectedNodesDpKey(), getAffectedNodes()
  - setEdgeLayoutDescriptors
```
public final void setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value)
```
    Sets the mapping of edges to their EdgeLayoutDescriptor.
    If an edge is mapped to null, the default descriptor is used.
    
    Parameters:
    
    value - The EdgeLayoutDescriptors to set.
    
    See Also:
    
    EdgeRouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY, getEdgeLayoutDescriptors()
  - setIgnoredLabels
```
public final void setIgnoredLabels(ItemCollection<ILabel> value)
```
    Sets the collection of labels of nodes or fixed edges that are ignored by the router.
    
    Parameters:
    
    value - The IgnoredLabels to set.
    
    See Also:
    
    LabelLayoutKeys.IGNORED_LABELS_DPKEY, getIgnoredLabels()
  - setLabelCrossingPenaltyFactors
```
public final void setLabelCrossingPenaltyFactors(ItemMapping<ILabel,Double> value)
```
    Sets a mapping from labels to a crossing penalty factor.
    The crossing penalty factor of a label is multiplied with the basic penalty for an edge crossing the label so crossing a label with a higher cost factor is stronger avoided then crossing one with a lower factor.
    
    Parameters:
    
    value - The LabelCrossingPenaltyFactors to set.
    
    See Also:
    
    PenaltySettings.getEdgeLabelCrossingPenalty(), PenaltySettings.getNodeLabelCrossingPenalty(), EdgeRouter.LABEL_CROSSING_PENALTY_FACTOR_DPKEY, getLabelCrossingPenaltyFactors()
  - setNodeHalos
```
public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)
```
    Sets the mapping from nodes to their NodeHalo.
    
    Parameters:
    
    value - The NodeHalos to set.
    
    See Also:
    
    NodeHalo.NODE_HALO_DPKEY, getNodeHalos()
  - setNodePortCandidateSets
```
public final void setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value)
```
    Sets a mapping from nodes to their PortCandidateSet.
    
    Parameters:
    
    value - The NodePortCandidateSets to set.
    
    See Also:
    
    PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, getNodePortCandidateSets()
  - setPartitionGridData
```
public final void setPartitionGridData(PartitionGridData value)
```
    Sets the partition grid layout data.
    
    Parameters:
    
    value - The PartitionGridData to set.
    
    See Also:
    
    getPartitionGridData()
  - setSourceGroupIds
```
public final void setSourceGroupIds(ItemMapping<IEdge,Object> value)
```
    Sets a mapping from edges to an object representing their source edge group.
    
    Parameters:
    
    value - The SourceGroupIds to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, getSourceGroupIds()
  - setSourcePortCandidates
```
public final void setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)
```
    Sets a mapping from edges to a collection of their source port candidates.
    
    Parameters:
    
    value - The SourcePortCandidates to set.
    
    See Also:
    
    PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, getSourcePortCandidates()
  - setSourcePortConstraints
```
public final void setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)
```
    Sets a mapping from edges to their source PortConstraint.
    
    Parameters:
    
    value - The SourcePortConstraints to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, getSourcePortConstraints()
  - setTargetGroupIds
```
public final void setTargetGroupIds(ItemMapping<IEdge,Object> value)
```
    Sets a mapping from edges to an object representing their target edge group.
    
    Parameters:
    
    value - The TargetGroupIds to set.
    
    See Also:
    
    PortConstraintKeys.TARGET_GROUP_ID_DPKEY, getTargetGroupIds()
  - setTargetPortCandidates
```
public final void setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)
```
    Sets a mapping from edges to a collection of their target port candidates.
    
    Parameters:
    
    value - The TargetPortCandidates to set.
    
    See Also:
    
    PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, getTargetPortCandidates()
  - setTargetPortConstraints
```
public final void setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)
```
    Sets a mapping from edges to their target PortConstraint.
    
    Parameters:
    
    value - The TargetPortConstraints to set.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, getTargetPortConstraints()

Class PolylineEdgeRouterData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolylineEdgeRouterData

Method Detail

apply

getAbortHandler

getAffectedEdges

getAffectedNodes

getEdgeLayoutDescriptors

getIgnoredLabels

getLabelCrossingPenaltyFactors

getNodeHalos

getNodePortCandidateSets

getPartitionGridData

getSourceGroupIds

getSourcePortCandidates

getSourcePortConstraints

getTargetGroupIds

getTargetPortCandidates

getTargetPortConstraints

setAbortHandler

setAffectedEdges

setAffectedNodes

setEdgeLayoutDescriptors

setIgnoredLabels

setLabelCrossingPenaltyFactors

setNodeHalos

setNodePortCandidateSets

setPartitionGridData

setSourceGroupIds

setSourcePortCandidates

setSourcePortConstraints

setTargetGroupIds

setTargetPortCandidates

setTargetPortConstraints