org.eclipse.gef.tools
Class AbstractConnectionCreationTool

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

All Implemented Interfaces:

RequestConstants, Tool

Direct Known Subclasses:

ConnectionCreationTool, ConnectionDragCreationTool

public class AbstractConnectionCreationTool

extends TargetingTool

Inner classes inherited from class org.eclipse.gef.tools.AbstractTool

AbstractTool.Input

Field Summary

protected static int	MAX_FLAG
protected static int	MAX_STATE
protected static int	STATE_CONNECTION_STARTED

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

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

AbstractConnectionCreationTool()

AbstractConnectionCreationTool(CreateRequest.Factory factory)

Method Summary

protected Cursor	calculateCursor() Determines (and returns) the appropriate cursur.
protected Request	createTargetRequest()
void	deactivate() Deactivates the tool.
protected void	eraseSourceFeedback()
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 String	getDebugNameForState(int s) Returns a String representation of the given state for debug purposes.
protected CreateRequest.Factory	getFactory()
protected Request	getSourceRequest()
protected boolean	handleButtonDown(int button) Called when the mouse button has been pressed.
protected boolean	handleButtonUp(int button) Handles the high-level processing of a mouse release.
protected boolean	handleCreateConnection()
protected boolean	handleDrag() Handles high-level processing of a mouse drag.
protected boolean	handleInvalidInput()
protected boolean	handleMove() Handles high-level processing of a mouse move.
protected boolean	isShowingSourceFeedback()
void	setFactory(CreateRequest.Factory factory)
protected void	showSourceFeedback()
protected void	updateTargetRequest()

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

eraseTargetFeedback, getCommand, getExclusionSet, getTargetEditPart, getTargetRequest, handleEnteredEditPart, handleExitingEditPart, handleHoverStop, handleLeavingEditPart, handleViewerExited, isShowingTargetFeedback, isTargetLocked, lockTargetEditPart, setTargetEditPart, setTargetRequest, showTargetFeedback, unlockTargetEditPart, updateTargetUnderMouse

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

activate, addFeedback, commitDrag, createOperationSet, debug, executeCurrentCommand, focusGained, focusLost, getCurrentCommand, getCurrentInput, getCurrentViewer, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleDoubleClick, handleDragInProgress, handleDragStarted, handleFinished, handleFocusGained, handleFocusLost, handleHover, handleKeyDown, handleKeyUp, handleViewerEntered, 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

Field Detail

STATE_CONNECTION_STARTED

protected static final int STATE_CONNECTION_STARTED

MAX_STATE

protected static final int MAX_STATE

MAX_FLAG

protected static final int MAX_FLAG

Constructor Detail

AbstractConnectionCreationTool

public AbstractConnectionCreationTool()

AbstractConnectionCreationTool

public AbstractConnectionCreationTool(CreateRequest.Factory factory)

Method Detail

calculateCursor

protected Cursor calculateCursor()

Description copied from class: AbstractTool

Determines (and returns) the appropriate cursur.

Overrides:

calculateCursor in class AbstractTool

createTargetRequest

protected Request createTargetRequest()

Overrides:

createTargetRequest in class TargetingTool

deactivate

public void deactivate()

Description copied from class: AbstractTool

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. The abstract tool allows cursors for viewers to be changed. When the tool is deactivated it must revert to normal the cursor of the last tool it changed.

Overrides:

deactivate in class TargetingTool

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

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.

Overrides:

getCommandName in class AbstractTool

getDebugName

protected String getDebugName()

Description copied from class: AbstractTool

Returns the debug name for this tool.

Overrides:

getDebugName in class AbstractTool

getDebugNameForState

protected String getDebugNameForState(int s)

Description copied from class: AbstractTool

Returns a String representation of the given state for debug purposes.

Overrides:

getDebugNameForState in class AbstractTool

getFactory

protected CreateRequest.Factory getFactory()

getSourceRequest

protected Request getSourceRequest()

handleButtonDown

protected boolean handleButtonDown(int button)

Description copied from class: AbstractTool

Called when the mouse button has been pressed. Should be implemented to process the users input correctly. Boolean should be used to indicate to your subclasses if you processed the event (true) or you didn't process it (false) and the subclass might process it. Key presses are a good example of this type of behavior.

Overrides:

handleButtonDown in class AbstractTool

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

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

See Also:

AbstractTool.mouseUp(MouseEvent, EditPartViewer)

handleCreateConnection

protected boolean handleCreateConnection()

handleDrag

protected boolean handleDrag()

Description copied from class: AbstractTool

Handles high-level processing of a mouse drag.

Overrides:

handleDrag in class AbstractTool

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

See Also:

AbstractTool.mouseDrag(MouseEvent, EditPartViewer)

handleInvalidInput

protected boolean handleInvalidInput()

Overrides:

handleInvalidInput in class TargetingTool

handleMove

protected boolean handleMove()

Description copied from class: AbstractTool

Handles high-level processing of a mouse move.

Overrides:

handleMove in class AbstractTool

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

See Also:

AbstractTool.mouseMove(MouseEvent, EditPartViewer)

isShowingSourceFeedback

protected boolean isShowingSourceFeedback()

setFactory

public void setFactory(CreateRequest.Factory factory)

showSourceFeedback

protected void showSourceFeedback()

updateTargetRequest

protected void updateTargetRequest()

Overrides:

updateTargetRequest in class TargetingTool