ilog.views.linkconnector

Class IlvClippingLinkConnector

java.lang.Object

ilog.views.IlvLinkConnector

ilog.views.linkconnector.IlvCachingLinkConnector

ilog.views.linkconnector.IlvFreeLinkConnector

ilog.views.linkconnector.IlvClippingLinkConnector

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvSDMClippingLinkConnector

public class IlvClippingLinkConnector
extends IlvFreeLinkConnector

A link connector that clips the link at the border of a node. Similar to the free link connector, the clipping link connector allows the link to be attached to any point inside the node. This attachment point will be preserved relative to the bounding box of the node, as specified using the method IlvFreeLinkConnector.connectLink(IlvLinkImage, IlvPoint, boolean, IlvTransformer); that is, if the node moves, grows, or shrinks, the attachment point moves proportionally.

However, unlike the free link connector, the link segment towards the attachment point is clipped at the border of the node if the node is one of the standard graphic objects. This is useful if the links have arrowheads that should be drawn exactly at the node border and the shape of the node is nonrectangular, for example a triangle, circle, or polygon.

How it works	Result

It can clip at the border of the following objects:

• All rectangular objects that fill the bounding box completely.
• All objects that implement the IlvShapePath interface.
• IlvPolygon
• IlvEllipse
• IlvArc
• IlvRectangle
• IlvSpline with a small border line width and smoothness larger than zero. It does not work with IlvGraphicUtil.COMPATIBLE_SMOOTHNESS. If the line width is very large, rounding errors will become visible.
• IlvGeneralPath with a stroke width of 0.

All other objects are clipped against their bounding box.

This link connector can be used with the graph layout algorithms that need to change the connection points of the links.

Since:

JViews 6.0

See Also:

IlvShapePath, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvClippingLinkConnector() Creates an empty IlvClippingLinkConnector.
IlvClippingLinkConnector(IlvGraphic node) Creates an IlvClippingLinkConnector attached to the node node.
IlvClippingLinkConnector(IlvInputStream stream) Reads the object from an IlvInputStream.
IlvClippingLinkConnector(IlvLinkImage link, boolean origin) Creates an IlvClippingLinkConnector attached to the origin or destination of the link link.

Method Summary

Modifier and Type	Method and Description
protected IlvPoint	calcConnectionPoint(IlvLinkImage link, boolean origin, IlvTransformer transformer) Calculates the clipped connection point.
IlvPoint	getClippedPoint(IlvGraphic node, IlvTransformer t, Object link, IlvPoint attachPoint, IlvPoint controlPoint, boolean origin) Returns the clipped connection point of a link that starts at the proposed connection point inside the node and goes through the auxiliary control point.
IlvPoint	getUnclippedConnectionPoint(IlvLinkImage link, boolean origin, IlvTransformer transformer) Returns the unclipped connection point of link.
protected boolean	useCache() Return true because this link connector uses the cache.
protected boolean	zoomable() Indicates that this link connector is nonzoomable.

Methods inherited from class ilog.views.linkconnector.IlvFreeLinkConnector

allLinksRemoved, allowsConnectionPointMove, connectionPointMoveAllowed, connectLink, detach, detach, disconnectAllLinks, disconnectLink, getClosestConnectionPoint, getGhostBoundingBox, getNodeBoundingBox, isConnectionPointMoveAllowed, isPersistent, linkRemoved, read, setConnectionPointMoveAllowed, write, write

Methods inherited from class ilog.views.linkconnector.IlvCachingLinkConnector

cleanCache, cleanCache, getCacheSize, getConnectionPoint, linkChanged, LinkChanged, LinkRemoved, setCacheSize, useCache

Methods inherited from class ilog.views.IlvLinkConnector

attach, attach, attach, drawGhost, Get, Get, GetAttached, GetAttached, getNode, supportsDrawGhost

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvClippingLinkConnector

public IlvClippingLinkConnector()

Creates an empty IlvClippingLinkConnector. It can be attached either to a node (using IlvLinkConnector.attach(ilog.views.IlvGraphic,boolean)) or to an extremity of a link (using IlvLinkConnector.attach(ilog.views.IlvLinkImage,boolean,boolean)).

IlvClippingLinkConnector

public IlvClippingLinkConnector(IlvGraphic node)

Creates an IlvClippingLinkConnector attached to the node node.

See Also:

IlvLinkConnector.attach(ilog.views.IlvGraphic,boolean), IlvFreeLinkConnector.detach(boolean)

IlvClippingLinkConnector

public IlvClippingLinkConnector(IlvLinkImage link,
                                boolean origin)

Creates an IlvClippingLinkConnector attached to the origin or destination of the link link. If the argument origin is true, this creates a link connector for the origin of link. If the argument origin is false, this creates a link connector for the destination of link.

See Also:

IlvLinkConnector.attach(ilog.views.IlvLinkImage, boolean, boolean), IlvFreeLinkConnector.detach(IlvLinkImage, boolean, boolean)

IlvClippingLinkConnector

public IlvClippingLinkConnector(IlvInputStream stream)
                         throws IlvReadFileException

Reads the object from an IlvInputStream.

Note that any subclass (except one that overrides the method IlvFreeLinkConnector.isPersistent() to return false) must provide a constructor with an IlvInputStream argument. The first line of the constructor must be super(stream).

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

See Also:

IlvFreeLinkConnector.write(ilog.views.io.IlvOutputStream), IlvFreeLinkConnector.isPersistent(), IlvLinkConnector.attach(IlvGraphic, boolean), IlvFreeLinkConnector.detach(boolean)

Method Detail

useCache

protected boolean useCache()

Return true because this link connector uses the cache.

Overrides:

useCache in class IlvFreeLinkConnector

Since:

JViews 8.7

zoomable

protected boolean zoomable()

Indicates that this link connector is nonzoomable. It always returns false.

Even if the node assigned to the link connector is considered zoomable, the shape of the node may depend on the zoom level (for instance, the rounding of the corners of an IlvRectangle). Since the clipping link connector calculates the connection points depending on the precise shape, the returned connection points may depend on the zoom level.

Overrides:

zoomable in class IlvFreeLinkConnector

calcConnectionPoint

protected IlvPoint calcConnectionPoint(IlvLinkImage link,
                                       boolean origin,
                                       IlvTransformer transformer)

Calculates the clipped connection point.

Overrides:

calcConnectionPoint in class IlvFreeLinkConnector

Parameters:

link - The link.

origin - Whether the connection point at the origin side or at the destination side is calculated.

transformer - The transformer that is used to draw the node to which is connected the corresponding extremity of the link.

getUnclippedConnectionPoint

public IlvPoint getUnclippedConnectionPoint(IlvLinkImage link,
                                            boolean origin,
                                            IlvTransformer transformer)

Returns the unclipped connection point of link. The real connection point of the link (provided by getConnectionPoint is the point that clips the link segment that starts or ends at the unclipped connection point with the border of the end node. The returned point is transformed in the coordinate system used to draw the link.

Parameters:

link - The link.

origin - If true, the position of the link connection point for the link origin is determined. Otherwise, the position of the connection point for the link destination is found.

transformer - The transformer that is used to draw the node.

Returns:

The unclipped connection point.

getClippedPoint

public IlvPoint getClippedPoint(IlvGraphic node,
                                IlvTransformer t,
                                Object link,
                                IlvPoint attachPoint,
                                IlvPoint controlPoint,
                                boolean origin)

Returns the clipped connection point of a link that starts at the proposed connection point inside the node and goes through the auxiliary control point. The attach point, control point and the returned point are transformed in the coordinate system used to draw the link. If attachPoint and controlPoint are equal, the attachPoint is returned.

Parameters:

node - The source or target node of the link.

t - The transformer that is used to draw the node.

link - The link to be clipped.

attachPoint - The point to which the unclipped link is attached.

controlPoint - The auxiliary control point. For the purpose of clipping, the link can be considered as a ray that starts at the attach point and goes through the control point.

origin - true if the node is the source of the link, false if it is the target of the link.

Returns:

The point to which the link should connect.