Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - ConnectionRouter (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
Interface ConnectionRouter

All Known Implementing Classes:: AbstractRouter

public interface ConnectionRouter

Routes a Connection, possibly using a constraint.

Nested Class Summary

static class ConnectionRouter.NullConnectionRouter
          Routes Connections directly from the source anchor to the target anchor with no bendpoints in between.

Field Summary

static ConnectionRouter NULL
          The default router for Connections.

Method Summary

java.lang.Object getConstraint ( Connection connection)
          Returns the constraint for the Connection.

void invalidate ( Connection connection)
          Invalidates the given Connection.

void remove ( Connection connection)
          Removes the Connection from this router.

void route ( Connection connection)
          Routes the Connection.

void setConstraint ( Connection connection, java.lang.Object constraint)
          Maps the given constraint to the given Connection.

Field Detail

NULL

public static final 
ConnectionRouter NULL

The default router for Connections.

Method Detail

getConstraint

public java.lang.Object getConstraint(
Connection connection)

Returns the constraint for the Connection.

Parameters:: connection - The connection
Returns:: The constraint

invalidate

public void invalidate(
Connection connection)

Invalidates the given Connection.

Parameters:: connection - The connection to be invalidated

route

public void route(
Connection connection)

Routes the Connection.

Parameters:: connection - The Connection to route

remove

public void remove(
Connection connection)

Removes the Connection from this router.

Parameters:: connection - The Connection to remove

setConstraint

public void setConstraint(
Connection connection,
                          java.lang.Object constraint)

Maps the given constraint to the given Connection.

Parameters:: connection - The Connection; constraint - The constraint