Eclipse GEF
2.1

org.eclipse.gef.tools
Class MarqueeSelectionTool

java.lang.Object
  |
  +--org.eclipse.gef.util.FlagSupport
        |
        +--org.eclipse.gef.tools.AbstractTool
              |
              +--org.eclipse.gef.tools.MarqueeSelectionTool
All Implemented Interfaces:
RequestConstants, Tool
Direct Known Subclasses:
MarqueeDragTracker

public class MarqueeSelectionTool
extends AbstractTool

This tool implements the selection of multiple objects in rectangular area.


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.AbstractTool
MAX_FLAG, 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
MarqueeSelectionTool()
          Creates a new MarqueeSelectionTool.
 
Method Summary
 void deactivate()
          Erases feedback if necessary and puts the tool into the terminal state.
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  boolean handleButtonDown(int button)
          Sets the selection mode to TOGGLE_MODE or APPEND_MODE depending on the keyboard input.
protected  boolean handleButtonUp(int button)
          Erases feedback and performs the selection.
protected  boolean handleDragInProgress()
          Calculates the selection and updates the feedback.
protected  boolean handleFocusLost()
          Handles high-level processing of a focus lost event.
protected  boolean handleInvalidInput()
          This method is called when mouse or keyboard input is invalid and erases the feedback.
 void setViewer(EditPartViewer viewer)
          Sets the EditPartViewer.
 
Methods inherited from class org.eclipse.gef.tools.AbstractTool
activate, addFeedback, calculateCursor, commitDrag, createOperationSet, debug, executeCurrentCommand, focusGained, focusLost, getCommand, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleDoubleClick, handleDrag, handleDragStarted, handleFinished, handleFocusGained, handleHover, handleKeyDown, handleKeyUp, handleMove, handleNativeDragFinished, handleNativeDragStarted, handleViewerEntered, handleViewerExited, 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, 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

MarqueeSelectionTool

public MarqueeSelectionTool()
Creates a new MarqueeSelectionTool.

Method Detail

deactivate

public void deactivate()
Erases feedback if necessary and puts the tool into the terminal state.

Specified by:
deactivate in interface Tool
Overrides:
deactivate in class AbstractTool
See Also:
AbstractTool.activate()

getCommandName

protected String getCommandName()
Returns the name identifier of the command that the tool is currently looking for.

Specified by:
getCommandName in class AbstractTool

getDebugName

protected String getDebugName()
Returns the debug name for this tool.

Specified by:
getDebugName in class AbstractTool

handleButtonDown

protected boolean handleButtonDown(int button)
Sets the selection mode to TOGGLE_MODE or APPEND_MODE depending on the keyboard input.

Overrides:
handleButtonDown in class AbstractTool

handleButtonUp

protected boolean handleButtonUp(int button)
Erases feedback and performs the selection.

Overrides:
handleButtonUp in class AbstractTool
See Also:
AbstractTool.mouseUp(MouseEvent, EditPartViewer)

handleDragInProgress

protected boolean handleDragInProgress()
Calculates the selection and updates the feedback.

Overrides:
handleDragInProgress 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)

handleInvalidInput

protected boolean handleInvalidInput()
This method is called when mouse or keyboard input is invalid and erases the feedback.


setViewer

public void setViewer(EditPartViewer viewer)
Sets the EditPartViewer. Also sets the appropriate default cursor based on the type of viewer.

Specified by:
setViewer in interface Tool
Overrides:
setViewer in class AbstractTool
Parameters:
viewer - The current Viewer

Eclipse GEF
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.