org.eclipse.gef.tools
Class MarqueeSelectionTool

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

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

AbstractTool.Input

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_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

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	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, handleFocusLost, handleHover, handleKeyDown, handleKeyUp, 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, 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

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.

Overrides:

deactivate in class AbstractTool

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

See Also:

AbstractTool.activate()

getCommandName

protected String getCommandName()

Returns the name identifier of the command that the tool is currently looking for.

Overrides:

getCommandName in class AbstractTool

getDebugName

protected String getDebugName()

Returns the debug name for this tool.

Overrides:

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

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

See Also:

AbstractTool.mouseUp(MouseEvent, EditPartViewer)

handleDragInProgress

protected boolean handleDragInProgress()

Calculates the selection and updates the feedback.

Overrides:

handleDragInProgress in class AbstractTool

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

See Also:

AbstractTool.movedPastThreshold(), AbstractTool.mouseDrag(MouseEvent, 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.

Overrides:

setViewer in class AbstractTool