ilog.views.linkconnector

Class IlvDefaultGrapherPin

java.lang.Object

ilog.views.linkconnector.IlvGrapherPin

ilog.views.linkconnector.IlvDefaultGrapherPin

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvDefaultGrapherPin
extends IlvGrapherPin

This class is a convenient concrete implementation of the abstract class IlvGrapherPin. It provides the following features:

• This pin ensures that the relative position of the pin with respect to the bounding box of the node, as specified using the constructor or the method setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer), will be preserved for any change of the bounding box of the node. If the node is translated, the location of the pin is translated with the same distance. If the node grows or shrinks, the location of the pin moves proportionally.
• This pin allows you to specify its location either as absolute coordinates (see setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer)) or in proportion to the bounding rectangle of the node. If the location is specified as absolute coordinates, the coordinates are internally translated into proportional coordinates.
• The location of the pin can be changed after creation, either by code or interactively using the class IlvGrapherPinInteractor.
• This pin is persistent, that is, it can be saved in IVL files.

The pins are managed by the class IlvPinLinkConnector.

This pin class is persistent, that is, IlvDefaultGrapherPin pins are saved into IVL when saving an IlvGrapher. Therefore, subclasses must be public and must implement the constructor with IlvInputStream. Otherwise, the subclass must override the method isPersistent() to return false.

Since:

JViews 5.5

See Also:

IlvPinLinkConnector, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDefaultGrapherPin(IlvInputStream stream) Reads the object from an IlvInputStream.
IlvDefaultGrapherPin(IlvPinLinkConnector connector, IlvPoint proportionalLocation) Creates a new IlvDefaultGrapherPin at a specified proportional location and adds it to the pin link connector.
IlvDefaultGrapherPin(IlvPinLinkConnector connector, IlvPoint p, IlvTransformer t) Creates a new IlvDefaultGrapherPin at a specified absolution location and adds it to the pin link connector.

Method Summary

Modifier and Type	Method and Description
boolean	allowsMove() Overridden implementation of the method from the superclass to always return true.
protected IlvRect	getNodeBoundingBox(IlvTransformer t) Called by the IlvDefaultGrapherPin when it needs to compute the bounding rectangle of the node.
IlvPoint	getPosition(IlvTransformer transformer) Returns the position of the pin.
IlvPoint	getProportionalPosition() Returns the proportional position of the pin.
boolean	isPersistent() Indicates whether the grapher pin must be saved to an IVL file.
void	setPosition(IlvPoint p, IlvTransformer t) Sets the absolute position of the pin.
void	setProportionalPosition(IlvPoint proportionalLocation) Sets the proportional location of the pin.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class ilog.views.linkconnector.IlvGrapherPin

allow, drawGhost, getColor, getNode, getPinLinkConnector, getSize, getType, isConnected, zoomable

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultGrapherPin

public IlvDefaultGrapherPin(IlvPinLinkConnector connector,
                            IlvPoint p,
                            IlvTransformer t)

Creates a new IlvDefaultGrapherPin at a specified absolution location and adds it to the pin link connector. This constructor stores the location using the method setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer).

Parameters:

connector - The link connector where the pin is added.

p - The point where the pin must be located, in absolute coordinates. The point must be transformed by transformer t.

t - The transformer that is used to draw the node associated with the pin link connector.

IlvDefaultGrapherPin

public IlvDefaultGrapherPin(IlvPinLinkConnector connector,
                            IlvPoint proportionalLocation)

Creates a new IlvDefaultGrapherPin at a specified proportional location and adds it to the pin link connector. This constructor stores the location using the method setProportionalPosition(ilog.views.IlvPoint).

The x and y coordinates of the point proportionalLocation represent the relative location of the pin in the two axis system. For example, the point (0, 0) means the top-left corner, (1,1) means the bottom-right corner, and (0.5, 0.5) means the center of the bounding box of the node, as returned by the method getNodeBoundingBox(ilog.views.IlvTransformer).

Parameters:

connector - The link connector where the pin is added.

proportionalLocation - The proportional location of the pin.

IlvDefaultGrapherPin

public IlvDefaultGrapherPin(IlvInputStream stream)
                     throws IlvReadFileException

Reads the object from an IlvInputStream. The default implementation of the method does nothing.

Note that a subclass that overrides the method isPersistent() to return true must be public and 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:

write(ilog.views.io.IlvOutputStream), isPersistent()

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream. The default implementation of the method does nothing.

You should not call this method directly; instead, you should use the write methods of the IlvGrapher that contains the node to which the link connector is attached.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvGrapherPin

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

isPersistent

public boolean isPersistent()

Indicates whether the grapher pin must be saved to an IVL file. If this method returns true, the grapher pin is saved; otherwise it is not saved.

This overridden implementation always returns true.

Overrides:

isPersistent in class IlvGrapherPin

See Also:

write(ilog.views.io.IlvOutputStream)

getNodeBoundingBox

protected IlvRect getNodeBoundingBox(IlvTransformer t)

Called by the IlvDefaultGrapherPin when it needs to compute the bounding rectangle of the node. By default, it returns getNode().boundingBox(t). You can override this method to return a different bounding rectangle. This is useful, in particular, if you use a link layout algorithm and you specified an IlvNodeBoxInterface.

Parameters:

t - The transformer used to compute the bounding rectangle of the node.

setPosition

public void setPosition(IlvPoint p,
                        IlvTransformer t)

Sets the absolute position of the pin. The method must be called only for pins that have been already added to a IlvPinLinkConnector.

Note that changing the position of a pin can change the bounding box of the links attached to the pin. Therefore, the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean) must be used for the node returned by the method IlvGrapherPin.getNode().

Overrides:

setPosition in class IlvGrapherPin

Parameters:

p - The point where the pin must be located. The point must be transformed by transformer t.

t - The transformer that is used to draw the node associated with the pin link connector.

See Also:

IlvGrapherPin.getPosition(ilog.views.IlvTransformer), IlvGrapherPin.allowsMove()

getPosition

public IlvPoint getPosition(IlvTransformer transformer)

Returns the position of the pin.

Specified by:

getPosition in class IlvGrapherPin

Parameters:

transformer - The transformer used to draw the node.

Returns:

The position of the pin.

See Also:

IlvGrapherPin.setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer)

setProportionalPosition

public void setProportionalPosition(IlvPoint proportionalLocation)

Sets the proportional location of the pin.

The x and y coordinates of the point proportionalLocation represent the relative location of the pin in the two axis system. For example, the point (0, 0) means the top-left corner, (1,1) means the bottom-right corner, and (0.5, 0.5) means the center of the bounding box of the node, as returned by the method getNodeBoundingBox(ilog.views.IlvTransformer).

Parameters:

proportionalLocation - The proportional location of the pin.

getProportionalPosition

public IlvPoint getProportionalPosition()

Returns the proportional position of the pin.

See Also:

setProportionalPosition(ilog.views.IlvPoint)

allowsMove

public boolean allowsMove()

Overridden implementation of the method from the superclass to always return true. This indicates that the location of the pin can be changed using the method setPosition(ilog.views.IlvPoint, ilog.views.IlvTransformer).

Overrides:

allowsMove in class IlvGrapherPin