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

java.lang.Object
- com.yworks.yfiles.layout.LayoutData
- - com.yworks.yfiles.layout.partial.PartialLayoutData

public class PartialLayoutData
extends LayoutData

Specifies custom data for the PartialLayout.

Constructor Summary

Constructors
Constructor and Description

PartialLayoutData()

Constructors
Constructor and Description
`PartialLayoutData()`

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.
`ItemCollection<IEdge>`	`getAffectedEdges()` Gets the collection of edges placed by the layout.
`ItemCollection<INode>`	`getAffectedNodes()` Gets the collection of nodes placed by the layout.
`ItemMapping<INode,Object>`	`getComponentIds()` Gets the mapping from partial nodes to an object defining their component assignment.
`ItemCollection<IEdge>`	`getDirectedEdges()` Gets the collection of edges that are considered as directed by the layout.
`ItemMapping<INode,NodeHalo>`	`getNodeHalos()` Gets the mapping from nodes to their `NodeHalo`.
`PartitionGridData`	`getPartitionGridData()` Gets the partition grid layout data.
`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,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(ItemCollection<IEdge> value)` Sets the collection of edges placed by the layout.
`void`	`setAffectedNodes(ItemCollection<INode> value)` Sets the collection of nodes placed by the layout.
`void`	`setComponentIds(ItemMapping<INode,Object> value)` Sets the mapping from partial nodes to an object defining their component assignment.
`void`	`setDirectedEdges(ItemCollection<IEdge> value)` Sets the collection of edges that are considered as directed by the layout.
`void`	`setNodeHalos(ItemMapping<INode,NodeHalo> value)` Sets the mapping from nodes to their `NodeHalo`.
`void`	`setPartitionGridData(PartitionGridData value)` Sets the partition grid layout data.
`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`	`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
  - PartialLayoutData
```
public PartialLayoutData()
```
- 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 ItemCollection<IEdge> getAffectedEdges()
```
    Gets the collection of edges placed by the layout.
    
    Returns:
    
    The AffectedEdges.
    
    See Also:
    
    PartialLayout.AFFECTED_EDGES_DPKEY, setAffectedEdges(ItemCollection)
  - getAffectedNodes
```
public final ItemCollection<INode> getAffectedNodes()
```
    Gets the collection of nodes placed by the layout.
    
    Returns:
    
    The AffectedNodes.
    
    See Also:
    
    PartialLayout.AFFECTED_NODES_DPKEY, setAffectedNodes(ItemCollection)
  - getComponentIds
```
public final ItemMapping<INode,Object> getComponentIds()
```
    Gets the mapping from partial nodes to an object defining their component assignment.
    All partial nodes associated with the same object are assigned to the same subgraph component.
    
    Returns:
    
    The ComponentIds.
    
    See Also:
    
    PartialLayout.COMPONENT_ID_DPKEY, ComponentAssignmentStrategy.CUSTOMIZED, PartialLayout.getComponentAssignmentStrategy(), setComponentIds(ItemMapping)
  - getDirectedEdges
```
public final ItemCollection<IEdge> getDirectedEdges()
```
    Gets the collection of edges that are considered as directed by the layout.
    Only if the LayoutOrientation is not LayoutOrientation.NONE the directedness of edges has an effect.
    
    Returns:
    
    The DirectedEdges.
    
    See Also:
    
    PartialLayout.DIRECTED_EDGES_DPKEY, setDirectedEdges(ItemCollection)
  - 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)
  - getPartitionGridData
```
public final PartitionGridData getPartitionGridData()
```
    Gets the partition grid layout data.
    
    Returns:
    
    The PartitionGridData.
    
    See Also:
    
    setPartitionGridData(PartitionGridData)
  - 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)
  - 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(ItemCollection<IEdge> value)
```
    Sets the collection of edges placed by the layout.
    
    Parameters:
    
    value - The AffectedEdges to set.
    
    See Also:
    
    PartialLayout.AFFECTED_EDGES_DPKEY, getAffectedEdges()
  - setAffectedNodes
```
public final void setAffectedNodes(ItemCollection<INode> value)
```
    Sets the collection of nodes placed by the layout.
    
    Parameters:
    
    value - The AffectedNodes to set.
    
    See Also:
    
    PartialLayout.AFFECTED_NODES_DPKEY, getAffectedNodes()
  - setComponentIds
```
public final void setComponentIds(ItemMapping<INode,Object> value)
```
    Sets the mapping from partial nodes to an object defining their component assignment.
    All partial nodes associated with the same object are assigned to the same subgraph component.
    
    Parameters:
    
    value - The ComponentIds to set.
    
    See Also:
    
    PartialLayout.COMPONENT_ID_DPKEY, ComponentAssignmentStrategy.CUSTOMIZED, PartialLayout.getComponentAssignmentStrategy(), getComponentIds()
  - setDirectedEdges
```
public final void setDirectedEdges(ItemCollection<IEdge> value)
```
    Sets the collection of edges that are considered as directed by the layout.
    Only if the LayoutOrientation is not LayoutOrientation.NONE the directedness of edges has an effect.
    
    Parameters:
    
    value - The DirectedEdges to set.
    
    See Also:
    
    PartialLayout.DIRECTED_EDGES_DPKEY, getDirectedEdges()
  - 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()
  - setPartitionGridData
```
public final void setPartitionGridData(PartitionGridData value)
```
    Sets the partition grid layout data.
    
    Parameters:
    
    value - The PartitionGridData to set.
    
    See Also:
    
    getPartitionGridData()
  - 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()
  - 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 PartialLayoutData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartialLayoutData

Method Detail

apply

getAbortHandler

getAffectedEdges

getAffectedNodes

getComponentIds

getDirectedEdges

getNodeHalos

getPartitionGridData

getSourcePortCandidates

getSourcePortConstraints

getTargetPortCandidates

getTargetPortConstraints

setAbortHandler

setAffectedEdges

setAffectedNodes

setComponentIds

setDirectedEdges

setNodeHalos

setPartitionGridData

setSourcePortCandidates

setSourcePortConstraints

setTargetPortCandidates

setTargetPortConstraints