diva.canvas.connector

Interface Terminal

All Superinterfaces:

CanvasComponent, Figure, UserObjectContainer, VisibleComponent

All Known Implementing Classes:

PortTerminal, StraightTerminal, TerminalFigure

public interface Terminal
extends Figure

A Terminal is a figure that provides a visible place for connectors to connect to. In general, connectors are able to connect to anything, but in certain types of diagrams, such as circuit schematics, connectors are expected to connect to objects that are clearly identifiable as a "connection point." Terminals serve this purpose.

The terminal interface exposes access to two sites: The "attach" site is the site on some other figure that the terminal positions itself on, and the "connect" site is the site that connectors can connect to.

Version:

$Id$

Author:

John Reekie

Method Summary

Modifier and Type	Method and Description
Site	getAttachSite() Get the site that the terminal is attached to.
Site	getConnectSite() Get the site that a connector can connect to.
void	relocate() Tell the terminal to relocate itself because the attachment site (or the figure that owns it) has moved.
void	setAttachSite(Site s) Set the site that the terminal is attached to.

Methods inherited from interface diva.canvas.Figure

contains, getBounds, getInteractor, getLayer, getOrigin, getParent, getShape, getToolTipText, hit, intersects, setInteractor, setParent, setToolTipText, transform, translate

Methods inherited from interface diva.canvas.VisibleComponent

isVisible, paint, paint, setVisible

Methods inherited from interface diva.canvas.CanvasComponent

getTransformContext, repaint, repaint

Methods inherited from interface diva.util.UserObjectContainer

getUserObject, setUserObject

Method Detail

getAttachSite

Site getAttachSite()

Get the site that the terminal is attached to.

getConnectSite

Site getConnectSite()

Get the site that a connector can connect to.

relocate

void relocate()

Tell the terminal to relocate itself because the attachment site (or the figure that owns it) has moved.

setAttachSite

void setAttachSite(Site s)

Set the site that the terminal is attached to.