Eclipse Draw2d
2.1

org.eclipse.draw2d
Class PolylineConnection

java.lang.Object
  |
  +--org.eclipse.draw2d.Figure
        |
        +--org.eclipse.draw2d.Shape
              |
              +--org.eclipse.draw2d.Polyline
                    |
                    +--org.eclipse.draw2d.PolylineConnection
All Implemented Interfaces:
AnchorListener, Connection, IFigure

public class PolylineConnection
extends Polyline
implements Connection, AnchorListener

Connection based on polyline. The layout of the connection is handled by routers.


Nested Class Summary
 
Nested classes inherited from class org.eclipse.draw2d.Figure
Figure.FigureIterator
 
Nested classes inherited from class org.eclipse.draw2d.IFigure
IFigure.NoInsets
 
Field Summary
 
Fields inherited from class org.eclipse.draw2d.Shape
lineStyle, lineWidth
 
Fields inherited from class org.eclipse.draw2d.Figure
bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip
 
Fields inherited from interface org.eclipse.draw2d.Connection
PROPERTY_CONNECTION_ROUTER, PROPERTY_POINTS
 
Fields inherited from interface org.eclipse.draw2d.IFigure
MAX_DIMENSION, MIN_DIMENSION, NO_INSETS
 
Constructor Summary
PolylineConnection()
           
 
Method Summary
 void addNotify()
          Called after this IFigure is added to its parent.
 void anchorMoved(ConnectionAnchor anchor)
          Called when an anchor has moved to a new location.
 Rectangle getBounds()
          Returns the smallest rectangle completely enclosing the IFigure.
 ConnectionRouter getConnectionRouter()
          Returns the ConnectionRouter used to route this Connection.
 Object getRoutingConstraint()
          Returns the routing constraint.
 ConnectionAnchor getSourceAnchor()
          Returns the ConnectionAnchor at the source end of this Connection.
protected  RotatableDecoration getSourceDecoration()
           
 ConnectionAnchor getTargetAnchor()
          Returns the ConnectionAnchor at the target end of this Connection.
protected  RotatableDecoration getTargetDecoration()
          Returns the RotatableDecoration at the target end of the Connection.
 void layout()
          Lays out this Figure using its LayoutManager.
 void removeNotify()
          Called just before the receiver is being removed from its parent.
 void setConnectionRouter(ConnectionRouter cr)
          Sets the ConnectionRouter for this Connection.
 void setRoutingConstraint(Object cons)
          Sets the routing constraint used by the router.
 void setSourceAnchor(ConnectionAnchor anchor)
          Sets the ConnectionAnchor to be used at the source end of this Connection.
 void setSourceDecoration(RotatableDecoration dec)
          Sets the decoration to be used at the start of the Connection.
 void setTargetAnchor(ConnectionAnchor anchor)
          Sets the ConnectionAnchor to be used at the target end of this Connection.
 void setTargetDecoration(RotatableDecoration dec)
          Sets the decoration to be used at the end of the Connection.
 
Methods inherited from class org.eclipse.draw2d.Polyline
addPoint, containsPoint, fillShape, getEnd, getPoints, getStart, insertPoint, isOpaque, outlineShape, primTranslate, removeAllPoints, removePoint, setEnd, setEndpoints, setLineWidth, setPoint, setPoints, setStart, useLocalCoordinates
 
Methods inherited from class org.eclipse.draw2d.Shape
getLineStyle, getLineWidth, paintFigure, setFill, setFillXOR, setLineStyle, setOutline, setOutlineXOR, setXOR
 
Methods inherited from class org.eclipse.draw2d.Figure
add, add, add, add, addAncestorListener, addFigureListener, addFocusListener, addKeyListener, addListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getChildren, getClientArea, getClientArea, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isEnabled, isFocusTraversable, isMouseEventTarget, isRequestFocusEnabled, isValid, isValidationRoot, isVisible, paint, paintBorder, paintChildren, paintClientArea, remove, removeAll, removeAncestorListener, removeFigureListener, removeFocusListener, removeListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.draw2d.Connection
getPoints, setPoints
 
Methods inherited from interface org.eclipse.draw2d.IFigure
add, add, add, add, addAncestorListener, addFigureListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getChildren, getClientArea, getClientArea, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalBackgroundColor, getLocalForegroundColor, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isEnabled, isFocusTraversable, isOpaque, isRequestFocusEnabled, isVisible, paint, remove, removeAncestorListener, removeFigureListener, removeFocusListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
 

Constructor Detail

PolylineConnection

public PolylineConnection()
Method Detail

addNotify

public void addNotify()
Description copied from interface: IFigure
Called after this IFigure is added to its parent.

Specified by:
addNotify in interface IFigure
Overrides:
addNotify in class Figure

anchorMoved

public void anchorMoved(ConnectionAnchor anchor)
Description copied from interface: AnchorListener
Called when an anchor has moved to a new location.

Specified by:
anchorMoved in interface AnchorListener
Parameters:
anchor - The anchor that has moved.

getBounds

public Rectangle getBounds()
Description copied from interface: IFigure
Returns the smallest rectangle completely enclosing the IFigure. Implementation may return the Rectangle by reference. For this reason, callers of this method must not modify the returned Rectangle. The Rectangle's values may change in the future.

Specified by:
getBounds in interface IFigure
Overrides:
getBounds in class Polyline
Returns:
This IFigure's bounds

getConnectionRouter

public ConnectionRouter getConnectionRouter()
Description copied from interface: Connection
Returns the ConnectionRouter used to route this Connection. Does not return null.

Specified by:
getConnectionRouter in interface Connection
Returns:
The ConnectionRouter for this Connection

getRoutingConstraint

public Object getRoutingConstraint()
Description copied from interface: Connection
Returns the routing constraint. May be null.

Specified by:
getRoutingConstraint in interface Connection
Returns:
The routing constraint

getSourceAnchor

public ConnectionAnchor getSourceAnchor()
Description copied from interface: Connection
Returns the ConnectionAnchor at the source end of this Connection.

Specified by:
getSourceAnchor in interface Connection
Returns:
The ConnectionAnchor at the source end of this Connection

getSourceDecoration

protected RotatableDecoration getSourceDecoration()

getTargetAnchor

public ConnectionAnchor getTargetAnchor()
Description copied from interface: Connection
Returns the ConnectionAnchor at the target end of this Connection.

Specified by:
getTargetAnchor in interface Connection
Returns:
The ConnectionAnchor at the target end of this Connection

getTargetDecoration

protected RotatableDecoration getTargetDecoration()
Returns the RotatableDecoration at the target end of the Connection.

Since:
2.0

layout

public void layout()
Description copied from class: Figure
Lays out this Figure using its LayoutManager.

Overrides:
layout in class Figure

removeNotify

public void removeNotify()
Called just before the receiver is being removed from its parent. Results in removing itself from the connection router.

Specified by:
removeNotify in interface IFigure
Overrides:
removeNotify in class Figure
Since:
2.0

setConnectionRouter

public void setConnectionRouter(ConnectionRouter cr)
Description copied from interface: Connection
Sets the ConnectionRouter for this Connection.

Specified by:
setConnectionRouter in interface Connection
Parameters:
cr - The ConnectionRouter to set for this Connection

setRoutingConstraint

public void setRoutingConstraint(Object cons)
Description copied from interface: Connection
Sets the routing constraint used by the router.

Specified by:
setRoutingConstraint in interface Connection
Parameters:
cons - The routing constraint

setSourceAnchor

public void setSourceAnchor(ConnectionAnchor anchor)
Description copied from interface: Connection
Sets the ConnectionAnchor to be used at the source end of this Connection.

Specified by:
setSourceAnchor in interface Connection
Parameters:
anchor - The source anchor

setSourceDecoration

public void setSourceDecoration(RotatableDecoration dec)
Sets the decoration to be used at the start of the Connection.

Since:
2.0

setTargetAnchor

public void setTargetAnchor(ConnectionAnchor anchor)
Description copied from interface: Connection
Sets the ConnectionAnchor to be used at the target end of this Connection.

Specified by:
setTargetAnchor in interface Connection
Parameters:
anchor - The target anchor

setTargetDecoration

public void setTargetDecoration(RotatableDecoration dec)
Sets the decoration to be used at the end of the Connection.


Eclipse Draw2d
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.