Eclipse GEF
2.1

org.eclipse.gef.tools
Class CreationTool

java.lang.Object
  |
  +--org.eclipse.gef.util.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


Nested Class Summary
 
Nested classes inherited from class org.eclipse.gef.tools.AbstractTool
AbstractTool.Input
 
Field Summary
 
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_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
CreationTool()
           
CreationTool(CreationFactory 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  CreationFactory 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 handleFocusLost()
          Handles high-level processing of a focus lost event.
protected  boolean handleMove()
          Handles high-level processing of a mouse move.
protected  void performCreation(int button)
           
 void setFactory(CreationFactory factory)
           
protected  void updateTargetRequest()
          Subclasses should override to update the target request.
 
Methods inherited from class org.eclipse.gef.tools.TargetingTool
deactivate, doAutoexpose, eraseTargetFeedback, getCommand, getExclusionSet, 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, calculateCursor, commitDrag, createOperationSet, debug, executeCurrentCommand, focusGained, focusLost, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleDoubleClick, handleDrag, handleFinished, handleFocusGained, handleHover, handleKeyDown, handleKeyUp, 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
 

Constructor Detail

CreationTool

public CreationTool()

CreationTool

public CreationTool(CreationFactory 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.

Specified by:
getCommandName in class AbstractTool

getCreateRequest

protected CreateRequest getCreateRequest()

getDebugName

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

Specified by:
getDebugName in class AbstractTool

getFactory

protected CreationFactory 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
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)

handleFocusLost

protected boolean handleFocusLost()
Description copied from class: AbstractTool
Handles high-level processing of a focus lost event.

Overrides:
handleFocusLost in class AbstractTool
See Also:
AbstractTool.focusLost(FocusEvent, EditPartViewer)

handleMove

protected boolean handleMove()
Description copied from class: AbstractTool
Handles high-level processing of a mouse move.

Overrides:
handleMove in class AbstractTool
See Also:
AbstractTool.mouseMove(MouseEvent, EditPartViewer)

performCreation

protected void performCreation(int button)

setFactory

public void setFactory(CreationFactory factory)

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.