Eclipse GEF
2.1

org.eclipse.gef.tools
Class ConnectionEndpointTracker

java.lang.Object
  |
  +--org.eclipse.gef.util.FlagSupport
        |
        +--org.eclipse.gef.tools.AbstractTool
              |
              +--org.eclipse.gef.tools.TargetingTool
                    |
                    +--org.eclipse.gef.tools.ConnectionEndpointTracker
All Implemented Interfaces:
DragTracker, RequestConstants, Tool

public class ConnectionEndpointTracker
extends TargetingTool
implements DragTracker


Nested Class Summary
 
Nested classes inherited from class org.eclipse.gef.tools.AbstractTool
AbstractTool.Input
 
Field Summary
protected static int MAX_FLAG
           
 
Fields inherited from class org.eclipse.gef.tools.AbstractTool
MAX_STATE, MOUSE_BUTTON_ANY, MOUSE_BUTTON1, MOUSE_BUTTON2, MOUSE_BUTTON3, STATE_ACCESSIBLE_DRAG, STATE_ACCESSIBLE_DRAG_IN_PROGRESS, STATE_DRAG, STATE_DRAG_IN_PROGRESS, STATE_INITIAL, STATE_INVALID, STATE_TERMINAL
 
Fields inherited from interface org.eclipse.gef.RequestConstants
REQ_ADD, REQ_ALIGN, REQ_ALIGN_CHILDREN, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILDREN, REQ_OPEN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_SOURCE, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER
 
Constructor Summary
ConnectionEndpointTracker(ConnectionEditPart cep)
           
 
Method Summary
protected  Cursor calculateCursor()
          Determines (and returns) the appropriate cursur.
 void commitDrag()
          The SelectionTool supports keyboard accessible drags.
protected  Request createTargetRequest()
           
 void deactivate()
          Called when another Tool becomes the active tool for the EditDomain.
protected  void eraseSourceFeedback()
           
protected  String getCommandName()
          Returns the name identifier of the command that the tool is currently looking for.
protected  org.eclipse.draw2d.Connection getConnection()
           
protected  ConnectionEditPart getConnectionEditPart()
           
protected  String getDebugName()
          Returns the debug name for this tool.
protected  Collection getExclusionSet()
          Returns a List of EditParts that should be excluded from the possible Targets for this tools operations Example, when dragging an object, the object should be excluded to prevent you from dropping the object inside itself.
protected  boolean handleButtonUp(int button)
          Handles the high-level processing of a mouse release.
protected  boolean handleDragInProgress()
          Handles high-level processing of a mouse drag once the threshold has been passed.
protected  boolean handleDragStarted()
          Called once when the drag threshold has been passed.
protected  boolean handleKeyDown(KeyEvent e)
          Handles high-level processing of a key down event.
 void setCommandName(String newCommandName)
           
 void setConnectionEditPart(ConnectionEditPart cep)
           
protected  void showSourceFeedback()
           
protected  void updateTargetRequest()
          Subclasses should override to update the target request.
 
Methods inherited from class org.eclipse.gef.tools.TargetingTool
doAutoexpose, eraseTargetFeedback, getCommand, getTargetEditPart, getTargetingConditional, getTargetRequest, handleAutoexpose, handleEnteredEditPart, handleExitingEditPart, handleHoverStop, handleInvalidInput, handleLeavingEditPart, handleViewerExited, isShowingTargetFeedback, isTargetLocked, lockTargetEditPart, setAutoexposeHelper, setTargetEditPart, setTargetRequest, showTargetFeedback, unlockTargetEditPart, updateAutoexposeHelper, updateTargetUnderMouse
 
Methods inherited from class org.eclipse.gef.tools.AbstractTool
activate, addFeedback, createOperationSet, debug, executeCurrentCommand, focusGained, focusLost, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleButtonDown, handleDoubleClick, handleDrag, handleFinished, handleFocusGained, handleFocusLost, handleHover, handleKeyUp, handleMove, handleNativeDragFinished, handleNativeDragStarted, handleViewerEntered, isActive, isHoverActive, isInState, keyDown, keyUp, mouseDoubleClick, mouseDown, mouseDrag, mouseHover, mouseMove, mouseUp, movedPastThreshold, nativeDragFinished, nativeDragStarted, reactivate, refreshCursor, releaseToolCapture, removeFeedback, resetFlags, setCurrentCommand, setCursor, setDefaultCursor, setDisabledCursor, setEditDomain, setHoverActive, setStartLocation, setState, setToolCapture, setUnloadWhenFinished, setViewer, stateTransition, unloadWhenFinished, viewerEntered, viewerExited
 
Methods inherited from class org.eclipse.gef.util.FlagSupport
getFlag, setFlag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.gef.Tool
activate, focusGained, focusLost, keyDown, keyUp, mouseDoubleClick, mouseDown, mouseDrag, mouseHover, mouseMove, mouseUp, nativeDragFinished, nativeDragStarted, setEditDomain, setViewer, viewerEntered, viewerExited
 

Field Detail

MAX_FLAG

protected static final int MAX_FLAG
See Also:
Constant Field Values
Constructor Detail

ConnectionEndpointTracker

public ConnectionEndpointTracker(ConnectionEditPart cep)
Method Detail

calculateCursor

protected Cursor calculateCursor()
Description copied from class: AbstractTool
Determines (and returns) the appropriate cursur.

Overrides:
calculateCursor in class AbstractTool

commitDrag

public void commitDrag()
Description copied from interface: DragTracker
The SelectionTool supports keyboard accessible drags. In such scenarios it is up to the SelectionTool to interpret commit and abort keystrokes. Since the DragTracker cannot do this, this method is used to indicate that the User has committed the drag using the keyboard. Abort is not handled specially, and the DragTracker should peform the usual cleanup in its Tool.deactivate() method.

Specified by:
commitDrag in interface DragTracker
Overrides:
commitDrag in class AbstractTool

createTargetRequest

protected Request createTargetRequest()
Overrides:
createTargetRequest in class TargetingTool

deactivate

public void deactivate()
Description copied from interface: Tool
Called when another Tool becomes the active tool for the EditDomain. implementors can perform state clean-up or to free resources.

Specified by:
deactivate in interface Tool
Overrides:
deactivate in class TargetingTool
See Also:
AbstractTool.activate()

eraseSourceFeedback

protected void eraseSourceFeedback()

getCommandName

protected String getCommandName()
Description copied from class: AbstractTool
Returns the name identifier of the command that the tool is currently looking for.

Specified by:
getCommandName in class AbstractTool

getConnection

protected org.eclipse.draw2d.Connection getConnection()

getConnectionEditPart

protected ConnectionEditPart getConnectionEditPart()

getDebugName

protected String getDebugName()
Description copied from class: AbstractTool
Returns the debug name for this tool.

Specified by:
getDebugName in class AbstractTool

getExclusionSet

protected Collection getExclusionSet()
Description copied from class: TargetingTool
Returns a List of EditParts that should be excluded from the possible Targets for this tools operations Example, when dragging an object, the object should be excluded to prevent you from dropping the object inside itself.

Overrides:
getExclusionSet in class TargetingTool

handleButtonUp

protected boolean handleButtonUp(int button)
Description copied from class: AbstractTool
Handles the high-level processing of a mouse release.

Overrides:
handleButtonUp in class AbstractTool
See Also:
AbstractTool.mouseUp(MouseEvent, EditPartViewer)

handleDragInProgress

protected boolean handleDragInProgress()
Description copied from class: AbstractTool
Handles high-level processing of a mouse drag once the threshold has been passed.

Overrides:
handleDragInProgress in class AbstractTool
See Also:
AbstractTool.movedPastThreshold(), AbstractTool.mouseDrag(MouseEvent, EditPartViewer)

handleDragStarted

protected boolean handleDragStarted()
Description copied from class: AbstractTool
Called once when the drag threshold has been passed.

Overrides:
handleDragStarted in class AbstractTool
See Also:
AbstractTool.movedPastThreshold(), AbstractTool.mouseDrag(MouseEvent, EditPartViewer)

handleKeyDown

protected boolean handleKeyDown(KeyEvent e)
Description copied from class: AbstractTool
Handles high-level processing of a key down event.

Overrides:
handleKeyDown in class AbstractTool
See Also:
AbstractTool.keyDown(KeyEvent, EditPartViewer)

setCommandName

public void setCommandName(String newCommandName)

setConnectionEditPart

public void setConnectionEditPart(ConnectionEditPart cep)

showSourceFeedback

protected void showSourceFeedback()

updateTargetRequest

protected void updateTargetRequest()
Description copied from class: TargetingTool
Subclasses should override to update the target request.

Overrides:
updateTargetRequest in class TargetingTool

Eclipse GEF
2.1

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