Uses of Class
com.yworks.yfiles.layout.PortCandidate

Packages that use PortCandidate

Package	Description
com.yworks.yfiles.layout	Provides essential classes and interfaces that constitute the infrastructure for automatic graph layout generation.
com.yworks.yfiles.layout.hierarchic	Provides hierarchic layout style algorithms.
com.yworks.yfiles.layout.partial	Provides class PartialLayout that enables layout of user-specified, distinct parts of a diagram without altering the existing layout of the remainder of the diagram.
com.yworks.yfiles.layout.router	Provides classes for automatic routing of the edges in a graph.
com.yworks.yfiles.layout.router.polyline	Provides classes and interfaces for automatic polyline routing of the edges of a graph.

Uses of PortCandidate in com.yworks.yfiles.layout

Fields in com.yworks.yfiles.layout with type parameters of type PortCandidate

Modifier and Type	Field and Description
static EdgeDpKey<Collection<PortCandidate>>	PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY A DataProvider key for specifying source port candidates for each edge.
static EdgeDpKey<Collection<PortCandidate>>	PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY A DataProvider key for specifying target port candidates for each edge.

Methods in com.yworks.yfiles.layout that return PortCandidate

Modifier and Type	Method and Description
static PortCandidate	PortCandidate.createCandidate(double xOffset, double yOffset, PortDirections directionMask) Factory method that creates a fixed PortCandidate instance with the given cost of usage, direction and offset values.
static PortCandidate	PortCandidate.createCandidate(double xOffset, double yOffset, PortDirections directionMask, double cost) Factory method that creates a fixed PortCandidate instance with the given cost of usage, direction and offset values.
static PortCandidate	PortCandidate.createCandidate(PortConstraint fromPortConstraint) Factory method that returns a free PortCandidate instance with zero cost of usage and the direction specified by the side of the given PortConstraint.
static PortCandidate	PortCandidate.createCandidate(PortDirections directionMask) Factory method that creates a free PortCandidate instance with the given direction and zero cost of usage.
static PortCandidate	PortCandidate.createCandidate(PortDirections directionMask, double cost) Factory method that creates a free PortCandidate instance with the given direction and cost of usage.
PortCandidate	PortCandidateSet.IEntry.getPortCandidate() Gets the actual PortCandidate associated with this PortCandidateSet.IEntry.

Methods in com.yworks.yfiles.layout that return types with arguments of type PortCandidate

Modifier and Type	Method and Description
ItemMapping<IEdge,Collection<PortCandidate>>	RecursiveGroupLayoutData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	PartitionLayoutData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	RecursiveGroupLayoutData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	PartitionLayoutData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.

Methods in com.yworks.yfiles.layout with parameters of type PortCandidate

Modifier and Type	Method and Description
void	PortCandidateSet.add(PortCandidate p) Adds a PortCandidate with the given capacity to this PortCandidateSet.
void	PortCandidateSet.add(PortCandidate p, int connections) Adds a PortCandidate with the given capacity to this PortCandidateSet.

Method parameters in com.yworks.yfiles.layout with type arguments of type PortCandidate

Modifier and Type	Method and Description
void	RecursiveGroupLayoutData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	PartitionLayoutData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	RecursiveGroupLayoutData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.
void	PartitionLayoutData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.

Uses of PortCandidate in com.yworks.yfiles.layout.hierarchic

Methods in com.yworks.yfiles.layout.hierarchic that return types with arguments of type PortCandidate

Modifier and Type	Method and Description
ItemMapping<IEdge,Collection<PortCandidate>>	HierarchicLayoutData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	HierarchicLayoutData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.

Method parameters in com.yworks.yfiles.layout.hierarchic with type arguments of type PortCandidate

Modifier and Type	Method and Description
void	HierarchicLayoutData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	HierarchicLayoutData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.

Uses of PortCandidate in com.yworks.yfiles.layout.partial

Methods in com.yworks.yfiles.layout.partial that return types with arguments of type PortCandidate

Modifier and Type	Method and Description
ItemMapping<IEdge,Collection<PortCandidate>>	PartialLayoutData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	PartialLayoutData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.

Method parameters in com.yworks.yfiles.layout.partial with type arguments of type PortCandidate

Modifier and Type	Method and Description
void	PartialLayoutData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	PartialLayoutData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.

Uses of PortCandidate in com.yworks.yfiles.layout.router

Methods in com.yworks.yfiles.layout.router that return types with arguments of type PortCandidate

Modifier and Type	Method and Description
ItemMapping<IEdge,Collection<PortCandidate>>	OrthogonalPatternEdgeRouterData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	BusRouterData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	OrthogonalPatternEdgeRouterData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	BusRouterData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.

Methods in com.yworks.yfiles.layout.router with parameters of type PortCandidate

Modifier and Type	Method and Description
protected double	OrthogonalPatternEdgeRouter.calculateBendCost(Edge edge, YList path, PortCandidate spc, PortCandidate tpc) Calculates the costs for all bends of the given path.
protected double	OrthogonalPatternEdgeRouter.calculateCost(Edge edge, YList path, PortCandidate spc, PortCandidate tpc) Calculates the edge cost of a possible edge path, in order to determine which path is the best, i.e., the cheapest.
protected double	OrthogonalPatternEdgeRouter.calculateCrossingCosts(Edge edge, YList path, PortCandidate spc, PortCandidate tpc) Calculates the overall crossing costs of the given path, including edge crossings, edge overlaps and node crossings.
protected double	OrthogonalPatternEdgeRouter.calculateEdgeLength(Edge edge, YList path, PortCandidate spc, PortCandidate tpc) Calculates the costs for the length of the given path.
protected double	OrthogonalPatternEdgeRouter.calculatePortCandidateCost(Edge edge, YList path, PortCandidate spc, PortCandidate tpc) Calculates the costs for the chosen PortCandidates.
protected double	OrthogonalPatternEdgeRouter.calculateSelfLoopSelfSidePenaltyCost(Edge edge, YList path, PortCandidate spc, PortCandidate tpc) Calculates the extra penalty that is added to the path's cost if the edge is a self-loop and source and target ports have the same direction.

Method parameters in com.yworks.yfiles.layout.router with type arguments of type PortCandidate

Modifier and Type	Method and Description
void	OrthogonalPatternEdgeRouterData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	BusRouterData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	OrthogonalPatternEdgeRouterData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.
void	BusRouterData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.

Uses of PortCandidate in com.yworks.yfiles.layout.router.polyline

Methods in com.yworks.yfiles.layout.router.polyline that return types with arguments of type PortCandidate

Modifier and Type	Method and Description
ItemMapping<IEdge,Collection<PortCandidate>>	PolylineEdgeRouterData.getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,Collection<PortCandidate>>	PolylineEdgeRouterData.getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.

Methods in com.yworks.yfiles.layout.router.polyline with parameters of type PortCandidate

Modifier and Type	Method and Description
static PartitionCell.PartitionCellBorder	PartitionCell.PartitionCellBorder.valueOfPortCandidate(PortCandidate pc) Returns the type of the border that is defined by the given PortCandidate.

Method parameters in com.yworks.yfiles.layout.router.polyline with type arguments of type PortCandidate

Modifier and Type	Method and Description
void	PolylineEdgeRouterData.setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	PolylineEdgeRouterData.setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.