com.yworks.yfiles.layout

Class PartitionLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.PartitionLayoutData

public class PartitionLayoutData
extends LayoutData

Specifies custom data for the PartitionLayout.

Constructor Summary

Constructors

Constructor and Description
PartitionLayoutData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
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	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

PartitionLayoutData

public PartitionLayoutData()

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.

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)

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()