org.eclipse.gef.tools
Class SimpleDragTracker

java.lang.Object
  |
  +--org.eclipse.gef.internal.FlagSupport
        |
        +--org.eclipse.gef.tools.AbstractTool
              |
              +--org.eclipse.gef.tools.SimpleDragTracker

All Implemented Interfaces:

DragTracker, RequestConstants, Tool

Direct Known Subclasses:

ConnectionBendpointTracker, ResizeTracker

public abstract class SimpleDragTracker

extends AbstractTool

implements DragTracker

A tool that interacts with one or more sources only. For example, bending a connection involves only that connection.

Inner 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_CHILD, REQ_ALIGN_CHILDREN, REQ_ANCESTOR_DELETED, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_BENDPOINT, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILD, REQ_MOVE_CHILDREN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_END, REQ_RECONNECT_SOURCE, REQ_RECONNECT_START, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILD, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER, REQ_SOURCE_DELETED, REQ_TARGET_DELETED

Constructor Summary

protected

SimpleDragTracker() Null constructor.

Method Summary

protected Cursor	calculateCursor() Calculates and returns the current cursor based on the tool's current state.
void	commitDrag()
protected Request	createSourceRequest() Creates and returns a new Request.
void	deactivate() Deactivates the tool.
protected void	eraseSourceFeedback() Show the source drag feedback for the drag occurring within the viewer.
protected Request	getSourceRequest() Returns the request for the source of the drag, creating it if necessary.
protected boolean	handleButtonDown(int button) Handles the button down event.
protected boolean	handleButtonUp(int button) Handles the button up event.
protected boolean	handleDragInProgress() Called after the mouse has been dragged past the threshold.
protected boolean	handleDragStarted() Called once when the drag starts.
protected boolean	handleInvalidInput() Called when the mouse and/or keyboard input is invalid.
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	isShowingFeedback() Returns true if feedback is being shown.
protected void	performDrag()
protected void	showSourceFeedback() Show the source drag feedback for the drag occurring within the viewer.
protected void	updateSourceRequest() Updates the source request.

Methods inherited from class org.eclipse.gef.tools.AbstractTool

activate, addFeedback, createOperationSet, debug, executeCurrentCommand, focusGained, focusLost, getCommand, getCommandName, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugName, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleDoubleClick, handleDrag, handleFinished, handleFocusGained, handleFocusLost, handleHover, handleMove, handleViewerEntered, handleViewerExited, isActive, isHoverActive, isInState, keyDown, keyUp, mouseDoubleClick, mouseDown, mouseDrag, mouseHover, mouseMove, mouseUp, movedPastThreshold, 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.internal.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, setEditDomain, setViewer, viewerEntered, viewerExited

Field Detail

MAX_FLAG

protected static final int MAX_FLAG

Constructor Detail

SimpleDragTracker

protected SimpleDragTracker()

Null constructor.

Method Detail

calculateCursor

protected Cursor calculateCursor()

Calculates and returns the current cursor based on the tool's current state.

Overrides:

calculateCursor in class AbstractTool

commitDrag

public void commitDrag()

Specified by:

commitDrag in interface DragTracker

Overrides:

commitDrag in class AbstractTool

createSourceRequest

protected Request createSourceRequest()

Creates and returns a new Request.

deactivate

public void deactivate()

Deactivates the tool. This method is called whenever the user switches to another tool. Use this method to do some clean-up when the tool is switched.

Specified by:

deactivate in interface Tool

Overrides:

deactivate in class AbstractTool

Following copied from class: org.eclipse.gef.tools.AbstractTool

See Also:

AbstractTool.activate()

eraseSourceFeedback

protected void eraseSourceFeedback()

Show the source drag feedback for the drag occurring within the viewer.

getSourceRequest

protected Request getSourceRequest()

Returns the request for the source of the drag, creating it if necessary.

handleButtonDown

protected boolean handleButtonDown(int button)

Handles the button down event. Transitions the tool into the drag state.

Overrides:

handleButtonDown in class AbstractTool

handleButtonUp

protected boolean handleButtonUp(int button)

Handles the button up event. Gets the current command and executes it.

Overrides:

handleButtonUp in class AbstractTool

Following copied from class: org.eclipse.gef.tools.AbstractTool

See Also:

AbstractTool.mouseUp(MouseEvent, EditPartViewer)

handleDragInProgress

protected boolean handleDragInProgress()

Called after the mouse has been dragged past the threshold. Updates the request and sets the current command.

Overrides:

handleDragInProgress in class AbstractTool

Following copied from class: org.eclipse.gef.tools.AbstractTool

See Also:

AbstractTool.movedPastThreshold(), AbstractTool.mouseDrag(MouseEvent, EditPartViewer)

handleDragStarted

protected boolean handleDragStarted()

Called once when the drag starts. Transistions the tool into the drag-in-progress state.

Overrides:

handleDragStarted in class AbstractTool

Following copied from class: org.eclipse.gef.tools.AbstractTool

See Also:

AbstractTool.movedPastThreshold(), AbstractTool.mouseDrag(MouseEvent, EditPartViewer)

handleInvalidInput

protected boolean handleInvalidInput()

Called when the mouse and/or keyboard input is invalid.

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

Following copied from class: org.eclipse.gef.tools.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

Following copied from class: org.eclipse.gef.tools.AbstractTool

See Also:

AbstractTool.keyUp(KeyEvent, EditPartViewer)

isShowingFeedback

protected boolean isShowingFeedback()

Returns true if feedback is being shown.

performDrag

protected void performDrag()

showSourceFeedback

protected void showSourceFeedback()

Show the source drag feedback for the drag occurring within the viewer.

updateSourceRequest

protected void updateSourceRequest()

Updates the source request.