org.eclipse.gef.tools
Class CreationTool

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

All Implemented Interfaces:

RequestConstants, Tool

public class CreationTool

extends TargetingTool

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

AbstractTool.Input

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

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

CreationTool()

CreationTool(CreateRequest.Factory aFactory)

Method Summary

protected Request	createTargetRequest()
protected String	getCommandName() Returns the name identifier of the command that the tool is currently looking for.
protected CreateRequest	getCreateRequest()
protected String	getDebugName() Returns the debug name for this tool.
protected CreateRequest.Factory	getFactory()
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	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	handleMove() Handles high-level processing of a mouse move.
protected void	performCreation(int button)
void	setFactory(CreateRequest.Factory factory)
protected void	updateTargetRequest()

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

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

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

activate, addFeedback, calculateCursor, commitDrag, createOperationSet, debug, executeCurrentCommand, focusGained, focusLost, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleDoubleClick, handleDrag, 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

Constructor Detail

CreationTool

public CreationTool()

CreationTool

public CreationTool(CreateRequest.Factory aFactory)

Method Detail

createTargetRequest

protected Request createTargetRequest()

Overrides:

createTargetRequest 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 AbstractTool

getCreateRequest

protected CreateRequest getCreateRequest()

getDebugName

protected String getDebugName()

Description copied from class: AbstractTool

Returns the debug name for this tool.

Overrides:

getDebugName in class AbstractTool

getFactory

protected CreateRequest.Factory getFactory()

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)

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

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

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

See Also:

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

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)

performCreation

protected void performCreation(int button)

setFactory

public void setFactory(CreateRequest.Factory factory)

updateTargetRequest

protected void updateTargetRequest()

Overrides:

updateTargetRequest in class TargetingTool