ilog.views.graphlayout.bus

Class IlvBusLinkConnector

java.lang.Object

ilog.views.IlvLinkConnector

ilog.views.graphlayout.bus.IlvBusLinkConnector

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvBusLinkConnector
extends IlvLinkConnector

A link connector dedicated to connecting links to a bus node. The link connector can be used with the Bus Layout algorithm to display vertical links in bus network topologies.

This link connector must be attached to the bus object. The bus object must be a graphic object (subclass of IlvGraphic) that implements the interface IlvPolyPointsInterface. Usually, an IlvPolyline is used for the bus object.

Note that the bus link connector should be installed only on the bus node. For the nodes connected to the bus, you usually do not need link connectors because the default connection points are appropriate.

Since:

JViews 2.0

See Also:

IlvBusLayout, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvBusLinkConnector() Creates an IlvBusLinkConnector.
IlvBusLinkConnector(IlvInputStream stream) Reads the link connector from an IlvInputStream.
IlvBusLinkConnector(IlvPolyPointsInterface busNode) Creates an IlvBusLinkConnector and installs it on the busNode.

Method Summary

Modifier and Type	Method and Description
void	attach(IlvGraphic busNode, boolean redraw) Installs the link connector on the node busNode.
void	connectLink(IlvLinkImage link, IlvPoint p, boolean origin, IlvTransformer t) This implementation of the abstract method does nothing.
IlvPoint	getClosestConnectionPoint(IlvPoint p, Object orig, Object dest, Object linkOrClass, boolean origin, IlvTransformer transformer) Implements an abstract method to return the center of the bus object.
IlvPoint	getConnectionPoint(IlvLinkImage link, boolean origin, IlvTransformer transformer) Returns the connection point of link on the bus.
IlvRect	getGhostBoundingBox(IlvTransformer t) Implements an abstract method of IlvLinkConnector to return an empty IlvRect.
double	getMargin() Returns the horizontal offset between the first/last connection point on a given level and the left/right margin of the level.
boolean	isPersistent() Indicates whether the link connector must be saved to an .ivl file.
void	setMargin(double margin) Sets the horizontal offset between the first/last node on a given level and the left/right margin of the level.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.
protected boolean	zoomable() Indicates that this link connector is zoomable.

Methods inherited from class ilog.views.IlvLinkConnector

allLinksRemoved, allowsConnectionPointMove, attach, attach, detach, detach, disconnectLink, drawGhost, Get, Get, GetAttached, GetAttached, getNode, linkRemoved, read, supportsDrawGhost, write

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBusLinkConnector

public IlvBusLinkConnector()

Creates an IlvBusLinkConnector.

IlvBusLinkConnector

public IlvBusLinkConnector(IlvPolyPointsInterface busNode)

Creates an IlvBusLinkConnector and installs it on the busNode. The bus node must be a graphic object (that is, a subclass of IlvGraphic) that implements the interface IlvPolyPointsInterface.

Parameters:

busNode - The bus node on which the link connector is installed.

IlvBusLinkConnector

public IlvBusLinkConnector(IlvInputStream stream)
                    throws IlvReadFileException

Reads the link connector from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Since:

JViews 3.5

Method Detail

isPersistent

public boolean isPersistent()

Indicates whether the link connector must be saved to an .ivl file. If this method returns true, the link connector is saved; otherwise, it is not saved.

The default implementation always returns true.

Overrides:

isPersistent in class IlvLinkConnector

Since:

JViews 3.5

See Also:

write(ilog.views.io.IlvOutputStream)

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvLinkConnector

Parameters:

stream - The output stream.

Throws:

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

Since:

JViews 3.5

See Also:

IlvLinkConnector.read(ilog.views.io.IlvInputStream, IlvLinkImage, boolean), IlvLinkConnector.write(ilog.views.io.IlvOutputStream, IlvLinkImage, boolean), IlvLinkConnector.isPersistent()

attach

public void attach(IlvGraphic busNode,
                   boolean redraw)

Installs the link connector on the node busNode. The method detach is automatically called to detach the old attached node, if it exists.

Overrides:

attach in class IlvLinkConnector

Parameters:

busNode - The bus node on which the link connector is installed. This node must be an instance of IlvPolyPointsInterface.

redraw - If true, the node to which the connector is attached and the links connected to the node will be redrawn.

Throws:

IllegalArgumentException - if busNode is not an instance of IlvPolyPointsInterface.

Since:

JViews 3.5

See Also:

IlvLinkConnector.detach(boolean)

getConnectionPoint

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

Returns the connection point of link on the bus.

Specified by:

getConnectionPoint in class IlvLinkConnector

Parameters:

link - The link.

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

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

Returns:

The connection point or null.

zoomable

protected boolean zoomable()

Indicates that this link connector is zoomable. It always returns true.

Specified by:

zoomable in class IlvLinkConnector

getClosestConnectionPoint

public IlvPoint getClosestConnectionPoint(IlvPoint p,
                                          Object orig,
                                          Object dest,
                                          Object linkOrClass,
                                          boolean origin,
                                          IlvTransformer transformer)

Implements an abstract method to return the center of the bus object.

Specified by:

getClosestConnectionPoint in class IlvLinkConnector

Parameters:

p - The transformed point.

orig - The graphic object origin of the link or the class of the origin object. This depends on whether the link has already been created or not.

dest - The graphic object destination of the link or the class of the destination object. This depends on whether the link has already been created or not.

linkOrClass - An instance of IlvLinkImage or an instance of the class. This parameter enables you to allow or inhibit connection points, depending on the link or the class of link. The class is useful when the link is not already created.

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

transformer - The transformer used to draw the node.

Returns:

The closest connection point already transformed.

connectLink

public void connectLink(IlvLinkImage link,
                        IlvPoint p,
                        boolean origin,
                        IlvTransformer t)

This implementation of the abstract method does nothing.

Specified by:

connectLink in class IlvLinkConnector

Parameters:

link - The link to be connected.

p - The point where the link must be connected. The point must be transformed by the transformer t.

origin - If true, the origin of the link will be connected; otherwise, it is the destination.

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

See Also:

IlvLinkConnector.allowsConnectionPointMove(ilog.views.IlvLinkImage, boolean)

setMargin

public final void setMargin(double margin)

Sets the horizontal offset between the first/last node on a given level and the left/right margin of the level. Note that the connection points are updated using the new value of the margin the first time the links are redrawn. You can call the method IlvGrapher.reDraw().

See Also:

getMargin()

getMargin

public final double getMargin()

Returns the horizontal offset between the first/last connection point on a given level and the left/right margin of the level.

See Also:

setMargin(double)

getGhostBoundingBox

public IlvRect getGhostBoundingBox(IlvTransformer t)

Implements an abstract method of IlvLinkConnector to return an empty IlvRect. This method is not called since IlvLinkConnector.supportsDrawGhost() returns false for this class.

Specified by:

getGhostBoundingBox in class IlvLinkConnector

Parameters:

t - The transformer used to draw the connection points.

Since:

JViews 5.0

See Also:

IlvLinkConnector.supportsDrawGhost(), IlvLinkConnector.drawGhost(java.awt.Graphics, ilog.views.IlvTransformer, java.lang.Object, java.lang.Object, java.lang.Object, boolean)