ilog.views.graphic.composite.layout

Class IlvLinkAttachmentLocation

java.lang.Object

ilog.views.graphic.composite.layout.IlvAttachmentLocation

ilog.views.graphic.composite.layout.IlvLinkAttachmentLocation

All Implemented Interfaces:

IlvPersistentObject

public abstract class IlvLinkAttachmentLocation
extends IlvAttachmentLocation

This class contains the code to manipulate the (x,y) value of a given attachment point (for example, upper-right corner) of an IlvAttachable

Since:

JViews 6.0

See Also:

IlvAttachable

Field Summary

Fields

Modifier and Type	Field and Description
static IlvAttachmentLocation	FromLink This is the point on the first segment of the link, at a distance of 17 from the origin.
static IlvAttachmentLocation	MiddleLink This is the "midpoint" of the polyline, that is, the midpoint of the segment which is closest to the midpoint of the segment lengths.
static IlvLinkAttachmentLocation	NearFromLink This location is used together with FromLink to attach an IlvGraphic to the origin of a link.
static IlvLinkAttachmentLocation	NearToLink This location is used together with ToLink to attach an IlvGraphic to the destination of a link.
static IlvAttachmentLocation	ToLink This is the point on the last segment of the link, at a distance of 17 from the destination.

Fields inherited from class ilog.views.graphic.composite.layout.IlvAttachmentLocation

BottomCenter, BottomLeft, BottomRight, Center, CenterPostOrderFirst, HotSpot, LeftCenter, LeftHotSpot, RightCenter, TopCenter, TopLeft, TopRight

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvLinkAttachmentLocation(String description) Creates a new link attachment location with the given name.

Method Summary

Modifier and Type	Method and Description
static IlvAttachmentLocation	atFromLink(float distance) This is the point on the first segment of the link, at a given distance from the origin.
static IlvAttachmentLocation	atToLink(float distance) This is the point on the last segment of the link, at a given distance from the destination.
boolean	setValue(IlvAttachable graphic, IlvPoint value) Sets the value of the location.

Methods inherited from class ilog.views.graphic.composite.layout.IlvAttachmentLocation

getName, getValue, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.io.IlvPersistentObject

write

Field Detail

NearFromLink

public static IlvLinkAttachmentLocation NearFromLink

This location is used together with FromLink to attach an IlvGraphic to the origin of a link. Its value, depending on the shape of the link, can be:

• IlvAttachmentLocation.RightCenter
• IlvAttachmentLocation.LeftCenter
• IlvAttachmentLocation.TopCenter
• IlvAttachmentLocation.BottomCenter

NearToLink

public static IlvLinkAttachmentLocation NearToLink

This location is used together with ToLink to attach an IlvGraphic to the destination of a link. Its value, depending on the shape of the link, can be:

• IlvAttachmentLocation.RightCenter
• IlvAttachmentLocation.LeftCenter
• IlvAttachmentLocation.TopCenter
• IlvAttachmentLocation.BottomCenter

FromLink

public static IlvAttachmentLocation FromLink

This is the point on the first segment of the link, at a distance of 17 from the origin. If the length of the first segment is smaller than 17, then this is the first bend point.

ToLink

public static IlvAttachmentLocation ToLink

This is the point on the last segment of the link, at a distance of 17 from the destination. If the length of the last segment is smaller than 17, then this is the last bend point.

MiddleLink

public static IlvAttachmentLocation MiddleLink

This is the "midpoint" of the polyline, that is, the midpoint of the segment which is closest to the midpoint of the segment lengths.

Constructor Detail

IlvLinkAttachmentLocation

protected IlvLinkAttachmentLocation(String description)

Creates a new link attachment location with the given name.

Method Detail

setValue

public boolean setValue(IlvAttachable graphic,
                        IlvPoint value)

Sets the value of the location. By default, it raises an Error exception.

Specified by:

setValue in class IlvAttachmentLocation

Returns:

true if the element's position has changed.

atFromLink

public static IlvAttachmentLocation atFromLink(float distance)

This is the point on the first segment of the link, at a given distance from the origin. If the length of the first segment is smaller than the given distance, then this is the first bend point.

Parameters:

distance - The distance on the first segment.

Since:

JViews 8.5

atToLink

public static IlvAttachmentLocation atToLink(float distance)

This is the point on the last segment of the link, at a given distance from the destination. If the length of the last segment is smaller than the given distance, then this is the last bend point.

Parameters:

distance - The distance on the last segment.

Since:

JViews 8.5