ilog.tgo.graphic
Class IltLinkPort

java.lang.Object
  ilog.util.IlEnum
      ilog.tgo.graphic.IltLinkPort

public class IltLinkPort
extends IlEnum

This enumeration describes and enumerates the link connection ports that can be used to customize the way links connect to nodes.

There are two kinds of link connection ports: those having a direction where links go out as a parallel bundle, and those without direction where the links go out from a specific point.

A link connection port is described by

• a point, relative to the node's link connection rectangle,
• a direction for outgoing links (optional),
• a distance between adjacent outgoing links (optional).

Since:

JTGO 2.6

Nested Class Summary

static class	IltLinkPort.LinkPortArrayEditor Static property editor for the IltLinkPort enum class.
static class	IltLinkPort.LinkPortEditor Static property editor for the IltLinkPort enum class.

Field Summary

static IltLinkPort	Bottom The port at the center of the bottom side of nodes.
static IltLinkPort	Center The undirected port at the center of nodes.
static IltLinkPort	Left The port at the center of the left side of nodes.
static IlEnumInfo	metainfo Contains metainformation about this IlEnum class.
static IltLinkPort	Right The port at the center of the right side of nodes.
static IltLinkPort	Top The port at the center of the top side of nodes.

Constructor Summary

IltLinkPort(String name, float fx, float fy)
Creates a new link connection port without direction.

IltLinkPort(String name, float fx, float fy, float rx, float ry, float dist)
Creates a new link connection port with direction.

Method Summary

float	getFx() Returns the main point's x coordinate, relative to the bounding box.
float	getFy() Returns the main point's y coordinate, relative to the bounding box.
IltNodeSide	getNodeSide() Deprecated. This function will probably change in the next ILOG JTGO release.
float	getOffset() Returns the offset between adjacent outgoing links.
float	getRx() Returns the outgoing direction's x coordinate.
float	getRy() Returns the outgoing direction's y coordinate.

Methods inherited from class ilog.util.IlEnum

getName, intern, setName, toString

Methods inherited from class java.lang.Object

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

Field Detail

metainfo

public static IlEnumInfo metainfo

Contains metainformation about this IlEnum class.

Top

public static IltLinkPort Top

The port at the center of the top side of nodes.

Bottom

public static IltLinkPort Bottom

The port at the center of the bottom side of nodes.

Left

public static IltLinkPort Left

The port at the center of the left side of nodes.

Right

public static IltLinkPort Right

The port at the center of the right side of nodes.

Center

public static IltLinkPort Center

The undirected port at the center of nodes.

Constructor Detail

IltLinkPort

public IltLinkPort(String name,
                   float fx,
                   float fy)

Creates a new link connection port without direction.

Parameters:

fx - main point's x coordinate, relative to the bounding box (0 = left, 1 = right)

fy - main point's y coordinate, relative to the bounding box (0 = top, 1 = bottom)

IltLinkPort

public IltLinkPort(String name,
                   float fx,
                   float fy,
                   float rx,
                   float ry,
                   float dist)

Creates a new link connection port with direction.

Parameters:

fx - main point's x coordinate, relative to the bounding box (0 = left, 1 = right)

fy - main point's y coordinate, relative to the bounding box (0 = top, 1 = bottom)

rx - outgoing direction's x coordinate

ry - outgoing direction's y coordinate

dist - distance between adjacent outgoing links

Method Detail

getFx

public float getFx()

Returns the main point's x coordinate, relative to the bounding box.

Since:

JTGO 4.5

getFy

public float getFy()

Returns the main point's y coordinate, relative to the bounding box.

Since:

JTGO 4.5

getRx

public float getRx()

Returns the outgoing direction's x coordinate.

Returns:

1 = right, -1 = left

Since:

JTGO 4.5

getRy

public float getRy()

Returns the outgoing direction's y coordinate.

Returns:

1 = bottom, -1 = top

Since:

JTGO 4.5

getOffset

public float getOffset()

Returns the offset between adjacent outgoing links.

Returns:

offset between adjacent outgoing links

Since:

JTGO 4.5

getNodeSide

public IltNodeSide getNodeSide()

Deprecated. This function will probably change in the next ILOG JTGO release.

Returns the IltNodeSide associated with this link connection port.

Internal method or field: do not use!