Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - ConnectionEndpointLocator (Eclipse Draw2d API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Draw2d
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.draw2d
Class ConnectionEndpointLocator

java.lang.Object
  
org.eclipse.draw2d.ConnectionEndpointLocator

All Implemented Interfaces:: Locator

public class ConnectionEndpointLocator
extends java.lang.Object
implements Locator

Used to place IFigures along the endpoint or starting point of a Connection. uDistance represents the distance from the Connection's owner to the IFigure. vDistance represents the distance from the IFigure to the Connection itself.

Field Summary

protected Transposer transposer
          Transposes the location if the connection point is along the top or bottom of its owner figure.

Constructor Summary

ConnectionEndpointLocator ( Connection c, boolean isEnd)
          Constructs a ConnectionEndpointLocator using the given Connection.

Method Summary

int getUDistance ()
          Returns the distance in pixels from the anchor's owner.

int getVDistance ()
          Returns the distance in pixels from the connection

void relocate ( IFigure figure)
          Relocates the given IFigure at either the source or target end of the Connection, based on the boolean given in the constructor ConnectionEndpointLocator(Connection, boolean).

void setUDistance (int distance)
          Sets the distance in pixels from the Connection's owner.

void setVDistance (int distance)
          Sets the distance in pixels from the Connection.

Methods inherited from class java.lang.Object

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

Field Detail

transposer

protected 
Transposer transposer

Transposes the location if the connection point is along the top or bottom of its owner figure.

Constructor Detail

ConnectionEndpointLocator

public ConnectionEndpointLocator(
Connection c,
                                 boolean isEnd)

Constructs a ConnectionEndpointLocator using the given Connection. If isEnd is true, the location is relative to the Connection's end (or target) point. If isEnd is false, the location is relative to the Connection's start (or source) point.
Parameters:: c - The Connection; isEnd - true is location is relative to end point
Since:: 2.0

Method Detail

getUDistance

public int getUDistance()

Returns the distance in pixels from the anchor's owner.

Returns:: the offset distance from the endpoint figure

getVDistance

public int getVDistance()

Returns the distance in pixels from the connection

Returns:: the offset from the connection itself

relocate

public void relocate(
IFigure figure)

Relocates the given IFigure at either the source or target end of the Connection, based on the boolean given in the constructor ConnectionEndpointLocator(Connection, boolean).

Specified by:: relocate in interface Locator

Parameters:: figure - The figure to relocate

setUDistance

public void setUDistance(int distance)

Sets the distance in pixels from the Connection's owner.

Parameters:: distance - Number of pixels to place the ConnectionEndpointLocator from its owner.
Since:: 2.0

setVDistance

public void setVDistance(int distance)

Sets the distance in pixels from the Connection.

Parameters:: distance - Number of pixels to place the ConnectionEndpointLocator from its Connection.
Since:: 2.0