Eclipse GEF
2.1

org.eclipse.gef.tools
Class DragEditPartsTracker

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

public class DragEditPartsTracker
extends SelectEditPartTracker


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.SelectEditPartTracker
FLAG_SELECTION_PERFORMED
 
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
DragEditPartsTracker(EditPart sourceEditPart)
           
 
Method Summary
 void commitDrag()
          The SelectionTool supports keyboard accessible drags.
protected  List createOperationSet()
          Creates and returns a List of EditParts that the tool will be working with.
protected  Request createTargetRequest()
           
 void deactivate()
          Called when another Tool becomes the active tool for the EditDomain.
protected  void eraseSourceFeedback()
           
protected  Command getCommand()
          Re-queries the target viewer object for a command
protected  String getCommandName()
          Returns the name identifier of the command that the tool is currently looking for.
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  void handleAutoexpose()
           
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 handleHover()
          Handles high-level processing of a mouse hover event.
protected  boolean handleInvalidInput()
           
protected  boolean handleKeyDown(KeyEvent e)
          Handles high-level processing of a key down event.
protected  boolean handleKeyUp(KeyEvent e)
          Handles high-level processing of a key up event.
protected  boolean isMove()
           
protected  void performDrag()
           
protected  void repairStartLocation()
           
protected  void showSourceFeedback()
           
protected  void updateTargetRequest()
          Subclasses should override to update the target request.
 
Methods inherited from class org.eclipse.gef.tools.SelectEditPartTracker
calculateCursor, getSourceEditPart, handleButtonDown, handleDoubleClick, handleDragStarted, hasSelectionOccurred, performConditionalSelection, performDirectEdit, performOpen, performSelection, resetFlags, setSourceEditPart
 
Methods inherited from class org.eclipse.gef.tools.TargetingTool
doAutoexpose, eraseTargetFeedback, getTargetEditPart, getTargetingConditional, getTargetRequest, handleEnteredEditPart, handleExitingEditPart, handleHoverStop, handleLeavingEditPart, handleViewerExited, isShowingTargetFeedback, isTargetLocked, lockTargetEditPart, setAutoexposeHelper, setTargetEditPart, setTargetRequest, showTargetFeedback, unlockTargetEditPart, updateAutoexposeHelper, updateTargetUnderMouse
 
Methods inherited from class org.eclipse.gef.tools.AbstractTool
activate, addFeedback, debug, executeCurrentCommand, focusGained, focusLost, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleDrag, handleFinished, handleFocusGained, handleFocusLost, handleMove, handleNativeDragFinished, handleNativeDragStarted, handleViewerEntered, isActive, isHoverActive, isInState, keyDown, keyUp, mouseDoubleClick, mouseDown, mouseDrag, mouseHover, mouseMove, mouseUp, movedPastThreshold, nativeDragFinished, nativeDragStarted, reactivate, refreshCursor, releaseToolCapture, removeFeedback, 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

DragEditPartsTracker

public DragEditPartsTracker(EditPart sourceEditPart)
Method Detail

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

createOperationSet

protected List createOperationSet()
Description copied from class: AbstractTool
Creates and returns a List of EditParts that the tool will be working with.

Overrides:
createOperationSet 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()

getCommand

protected Command getCommand()
Description copied from class: AbstractTool
Re-queries the target viewer object for a command

Overrides:
getCommand in class TargetingTool

getCommandName

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

Overrides:
getCommandName in class SelectEditPartTracker

getDebugName

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

Overrides:
getDebugName in class SelectEditPartTracker

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

handleAutoexpose

protected void handleAutoexpose()
Overrides:
handleAutoexpose in class TargetingTool
See Also:
TargetingTool.handleAutoexpose()

handleButtonUp

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

Overrides:
handleButtonUp in class SelectEditPartTracker
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)

handleHover

protected boolean handleHover()
Description copied from class: AbstractTool
Handles high-level processing of a mouse hover event.

Overrides:
handleHover in class AbstractTool
See Also:
AbstractTool.handleHover()

handleInvalidInput

protected boolean handleInvalidInput()
Overrides:
handleInvalidInput in class TargetingTool

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)

handleKeyUp

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

Overrides:
handleKeyUp in class AbstractTool
See Also:
AbstractTool.keyUp(KeyEvent, EditPartViewer)

isMove

protected boolean isMove()

performDrag

protected void performDrag()

repairStartLocation

protected void repairStartLocation()

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.