SelectionManager (JOSM)

java.lang.Object
- org.openstreetmap.josm.gui.SelectionManager

All Implemented Interfaces:

MouseListener, MouseMotionListener, PropertyChangeListener, EventListener
```
public class SelectionManager
extends Object
implements MouseListener, MouseMotionListener, PropertyChangeListener
```
Manages the selection of a rectangle. Listening to left and right mouse button presses and to mouse motions and draw the rectangle accordingly. Left mouse button selects a rectangle from the press until release. Pressing right mouse button while left is still pressed enable the rectangle to move around. Releasing the left button fires an action event to the listener given at constructor, except if the right is still pressed, which just remove the selection rectangle and does nothing. The point where the left mouse button was pressed and the current mouse position are two opposite corners of the selection rectangle. It is possible to specify an aspect ratio (width per height) which the selection rectangle always must have. In this case, the selection rectangle will be the largest window with this aspect ratio, where the position the left mouse button was pressed and the corner of the current mouse position are at opposite sites (the mouse position corner is the corner nearest to the mouse cursor). When the left mouse button was released, an ActionEvent is send to the ActionListener given at constructor. The source of this event is this manager.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SelectionManager.SelectionEnded` This is the interface that an user of SelectionManager has to implement to get informed when a selection closes.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`aspectRatio` Whether the selection rectangle must obtain the aspect ratio of the drawComponent.
`private Polygon`	`lasso`
`private boolean`	`lassoMode`
`private Point`	`mousePos` Position of the map when the selection rectangle was last drawn.
`private Point`	`mousePosStart` Position of the map when the mouse button was pressed.
`private NavigatableComponent`	`nc` The Component, the selection rectangle is drawn onto.
`private SelectionManager.SelectionEnded`	`selectionEndedListener` The listener that receives the events after left mouse button is released.

Constructor Summary

Constructors
Constructor and Description
`SelectionManager(SelectionManager.SelectionEnded selectionEndedListener, boolean aspectRatio, NavigatableComponent navComp)` Create a new SelectionManager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<OsmPrimitive>`	`getSelectedObjects(boolean alt)` Return a list of all objects in the selection, respecting the different modifier.
`private Rectangle`	`getSelectionRectangle()` Calculate and return the current selection rectangle
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseDragged(MouseEvent e)` If the correct button is hold, draw the rectangle.
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)` If the correct button, from the "drawing rectangle" mode
`void`	`mouseReleased(MouseEvent e)` Check the state of the keys and buttons and set the selection accordingly.
`private void`	`paintLasso()`
`private void`	`paintRect()` Draws a selection rectangle on screen.
`void`	`propertyChange(PropertyChangeEvent evt)` If the action goes inactive, remove the selection rectangle from screen
`private Polygon`	`rectToPolygon(Rectangle r)`
`void`	`register(NavigatableComponent eventSource, boolean lassoMode)` Register itself at the given event source.
`void`	`setLassoMode(boolean lassoMode)` Enables or disables the lasso mode.
`void`	`unregister(Component eventSource)` Unregister itself from the given event source.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - selectionEndedListener
```
private final SelectionManager.SelectionEnded selectionEndedListener
```
    The listener that receives the events after left mouse button is released.
  - mousePosStart
```
private Point mousePosStart
```
    Position of the map when the mouse button was pressed. If this is not null, a rectangle is drawn on screen.
  - mousePos
```
private Point mousePos
```
    Position of the map when the selection rectangle was last drawn.
  - nc
```
private final NavigatableComponent nc
```
    The Component, the selection rectangle is drawn onto.
  - aspectRatio
```
private boolean aspectRatio
```
    Whether the selection rectangle must obtain the aspect ratio of the drawComponent.
  - lassoMode
```
private boolean lassoMode
```
  - lasso
```
private Polygon lasso
```
- Constructor Detail
  - SelectionManager
```
public SelectionManager(SelectionManager.SelectionEnded selectionEndedListener,
                        boolean aspectRatio,
                        NavigatableComponent navComp)
```
    Create a new SelectionManager.
    
    Parameters:
    
    selectionEndedListener - The action listener that receives the event when the left button is released.
    
    aspectRatio - If true, the selection window must obtain the aspect ratio of the drawComponent.
    
    navComp - The component, the rectangle is drawn onto.
- Method Detail
  - register
```
public void register(NavigatableComponent eventSource,
                     boolean lassoMode)
```
    Register itself at the given event source.
    
    Parameters:
    
    eventSource - The emitter of the mouse events.
    
    lassoMode - true to enable lasso mode, false to disable it.
  - unregister
```
public void unregister(Component eventSource)
```
    Unregister itself from the given event source. If a selection rectangle is shown, hide it first.
    
    Parameters:
    
    eventSource - The emitter of the mouse events.
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
    If the correct button, from the "drawing rectangle" mode
    
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
    If the correct button is hold, draw the rectangle.
    
    Specified by:
    
    mouseDragged in interface MouseMotionListener
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    Check the state of the keys and buttons and set the selection accordingly.
    
    Specified by:
    
    mouseReleased in interface MouseListener
  - paintRect
```
private void paintRect()
```
    Draws a selection rectangle on screen.
  - paintLasso
```
private void paintLasso()
```
  - getSelectionRectangle
```
private Rectangle getSelectionRectangle()
```
    Calculate and return the current selection rectangle
    
    Returns:
    
    A rectangle that spans from mousePos to mouseStartPos
  - propertyChange
```
public void propertyChange(PropertyChangeEvent evt)
```
    If the action goes inactive, remove the selection rectangle from screen
    
    Specified by:
    
    propertyChange in interface PropertyChangeListener
  - getSelectedObjects
```
public Collection<OsmPrimitive> getSelectedObjects(boolean alt)
```
    Return a list of all objects in the selection, respecting the different modifier.
    
    Parameters:
    
    alt - Whether the alt key was pressed, which means select all objects that are touched, instead those which are completely covered.
    
    Returns:
    
    The collection of selected objects.
  - rectToPolygon
```
private Polygon rectToPolygon(Rectangle r)
```
  - setLassoMode
```
public void setLassoMode(boolean lassoMode)
```
    Enables or disables the lasso mode.
    
    Parameters:
    
    lassoMode - true to enable lasso mode, false to disable it.
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface MouseListener
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface MouseMotionListener

Class SelectionManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

selectionEndedListener

mousePosStart

mousePos

nc

aspectRatio

lassoMode

lasso

Constructor Detail

SelectionManager

Method Detail

register

unregister

mousePressed

mouseDragged

mouseReleased

paintRect

paintLasso

getSelectionRectangle

propertyChange

getSelectedObjects

rectToPolygon

setLassoMode

mouseClicked

mouseEntered

mouseExited

mouseMoved