com.yworks.yfiles.graph.styles

Class DefaultEdgePathCropper

java.lang.Object

com.yworks.yfiles.graph.styles.DefaultEdgePathCropper

All Implemented Interfaces:

IEdgePathCropper

public class DefaultEdgePathCropper
extends Object
implements IEdgePathCropper

The default implementation of the IEdgePathCropper.

Field Summary

Fields

Modifier and Type	Field and Description
static IEdgePathCropper	INSTANCE A singleton instance.

Constructor Summary

Constructors

Constructor and Description
DefaultEdgePathCropper()

Method Summary

Modifier and Type	Method and Description
protected double	calculateTotalCropLength(IArrow arrow, boolean atSource) Calculates the total length the edge path is cropped.
GeneralPath	cropEdgePath(IEdge edge, boolean atSource, IArrow arrow, GeneralPath path) Crops the provided path at one end of an edge.
GeneralPath	cropEdgePathAtArrow(boolean atSource, IArrow arrow, GeneralPath path) Crops an edge's path at the source or target side with respect to the given arrow.
protected GeneralPath	cropEdgePathAtPortGeometry(IEdge edge, boolean atSource, IArrow arrow, GeneralPath path) Crops an edge's path at the source or target side at the port geometry with respect to the given arrow.
double	getExtraCropLength() Gets an extra length the edge is cropped.
protected PointD	getIntersection(INode node, IShapeGeometry nodeShapeGeometry, IEdge edge, PointD inner, PointD outer) Finds the intersection between a node and the edge.
protected IShapeGeometry	getNodeGeometry(INode node) Returns the geometry that is used to crop the edge at the node outline.
protected IShapeGeometry	getPortGeometry(IPort port) Returns the geometry that is used to crop the edge at the port outline if CroppingAtPortEnabled is set to true.
protected GeneralPath	handleEmptyPath(IEdge edge, boolean atSource, IArrow arrow, GeneralPath path) Handles the edge path cropping if cropEdgePath(IEdge, boolean, IArrow, GeneralPath) would result in a cleared path.
boolean	isCroppingAtPortEnabled() Gets the value that determines if the edge path is cropped at the port or at the node bounds.
protected boolean	isInside(PointD location, INode node, IShapeGeometry nodeShapeGeometry, IEdge edge) Checks whether a given point is inside a node's shape geometry with respect to the edge that is being calculated.
void	setCroppingAtPortEnabled(boolean value) Sets the value that determines if the edge path is cropped at the port or at the node bounds.
void	setExtraCropLength(double value) Sets an extra length the edge is cropped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final IEdgePathCropper INSTANCE

A singleton instance.

Note that this is an immutable instance that cannot be cast to the DefaultEdgePathCropper type.

Constructor Detail

DefaultEdgePathCropper

public DefaultEdgePathCropper()

Method Detail

calculateTotalCropLength

protected double calculateTotalCropLength(IArrow arrow,
                                          boolean atSource)

Calculates the total length the edge path is cropped.

This method can be overridden to change the length that is cropped from an edge. The default implementation returns the sum of ExtraCropLength, arrow length and arrow crop length

Parameters:

arrow - The arrow at this edge end.

atSource - True if the crop length should be calculated at the edge source. False otherwise.

Returns:

The total length the edge path is cropped.

See Also:

cropEdgePath(IEdge, boolean, IArrow, GeneralPath), cropEdgePathAtArrow(boolean, IArrow, GeneralPath)

cropEdgePath

public final GeneralPath cropEdgePath(IEdge edge,
                                      boolean atSource,
                                      IArrow arrow,
                                      GeneralPath path)

Crops the provided path at one end of an edge.

If CroppingAtPortEnabled is True this implementation delegates to cropEdgePathAtPortGeometry(IEdge, boolean, IArrow, GeneralPath). Otherwise the edge path is cropped at the node geometry. If this would result in an empty path, the cropping is delegated to handleEmptyPath(IEdge, boolean, IArrow, GeneralPath) instead.

Specified by:

cropEdgePath in interface IEdgePathCropper

Parameters:

edge - The edge whose path is to be cropped.

atSource - Whether to crop the source or target side of the path.

arrow - The arrow that is used at the end of the edge.

path - The path to crop.

Returns:

The cropped path. This is can be either the same instance of the given path or a newly created instance.

cropEdgePathAtArrow

public final GeneralPath cropEdgePathAtArrow(boolean atSource,
                                             IArrow arrow,
                                             GeneralPath path)

Crops an edge's path at the source or target side with respect to the given arrow.

The path is cropped by the length calculateTotalCropLength(IArrow, boolean) returns for arrow and atSource.

Parameters:

atSource - if set to true the source side is cropped.

arrow - The arrow to consider for the cropping.

path - The edge's path to crop.

Returns:

The cropped path. This is can be either the same instance of the given path or a newly created instance.

cropEdgePathAtPortGeometry

protected GeneralPath cropEdgePathAtPortGeometry(IEdge edge,
                                                 boolean atSource,
                                                 IArrow arrow,
                                                 GeneralPath path)

Crops an edge's path at the source or target side at the port geometry with respect to the given arrow.

Parameters:

edge - The edge whose path is to be cropped.

atSource - Whether to crop the source or target side of the path.

arrow - The arrow that is used at the end of the edge.

path - The path to crop.

Returns:

The cropped path. This is can be either the same instance of the given path or a newly created instance.

getExtraCropLength

public final double getExtraCropLength()

Gets an extra length the edge is cropped.

The default value is 0.

Returns:

The ExtraCropLength.

See Also:

setExtraCropLength(double)

getIntersection

protected PointD getIntersection(INode node,
                                 IShapeGeometry nodeShapeGeometry,
                                 IEdge edge,
                                 PointD inner,
                                 PointD outer)

Finds the intersection between a node and the edge.

getNodeGeometry

protected IShapeGeometry getNodeGeometry(INode node)

Returns the geometry that is used to crop the edge at the node outline.

The default implementation queries the node style renderer for an implementation of IShapeGeometry. This method can be overridden to return an arbitrary geometry for a node.

Parameters:

node - The node the edge should be cropped at.

Returns:

The geometry of the node.

getPortGeometry

protected IShapeGeometry getPortGeometry(IPort port)

Returns the geometry that is used to crop the edge at the port outline if CroppingAtPortEnabled is set to true.

The default implementation returns null. This method can be overridden to return an arbitrary geometry for a port.

Parameters:

port - The port the edge should be cropped at.

Returns:

The geometry of the port.

See Also:

isCroppingAtPortEnabled()

handleEmptyPath

protected GeneralPath handleEmptyPath(IEdge edge,
                                      boolean atSource,
                                      IArrow arrow,
                                      GeneralPath path)

Handles the edge path cropping if cropEdgePath(IEdge, boolean, IArrow, GeneralPath) would result in a cleared path.

This method is called by cropEdgePath(IEdge, boolean, IArrow, GeneralPath) if CroppingAtPortEnabled is False and cropping the edge path at the node geometry would result in an empty path.

The default implementation is to GeneralPath.clear() the edge path.

Parameters:

edge - The edge whose path is to be cropped.

atSource - Whether to crop the source or target side of the path.

arrow - The arrow that is used at the end of the edge.

path - The path to crop.

Returns:

The cropped path. This is can be either the same instance of the given path or a newly created instance.

isCroppingAtPortEnabled

public final boolean isCroppingAtPortEnabled()

Gets the value that determines if the edge path is cropped at the port or at the node bounds.

The default is false.

Returns:

The CroppingAtPortEnabled.

See Also:

setCroppingAtPortEnabled(boolean)

isInside

protected boolean isInside(PointD location,
                           INode node,
                           IShapeGeometry nodeShapeGeometry,
                           IEdge edge)

Checks whether a given point is inside a node's shape geometry with respect to the edge that is being calculated.

setCroppingAtPortEnabled

public final void setCroppingAtPortEnabled(boolean value)

Sets the value that determines if the edge path is cropped at the port or at the node bounds.

The default is false.

Parameters:

value - The CroppingAtPortEnabled to set.

See Also:

isCroppingAtPortEnabled()

setExtraCropLength

public final void setExtraCropLength(double value)

Sets an extra length the edge is cropped.

The default value is 0.

Parameters:

value - The ExtraCropLength to set.

See Also:

getExtraCropLength()