## org.das2.event.BoxSelectorMouseModule

General purpose mouse module for getting data point selections. The client provides the DragRenderer, generally a vertical line, horizontal line or a crosshair. Three properties control when BoxSelectionEvents are to be fired:

- dragEvents, as the mouse is dragged,
- keyEvents, when a key is pressed. (The key is the "keyChar" plane of the event)
- releaseEvents, when the mouse is released. (false by default)

This is intended to be used as a base class for other slicers which need a range to be selected in X, Y, or both.

## BoxSelectorMouseModule( org.das2.graph.DasCanvasComponent parent, org.das2.graph.DasAxis xAxis, org.das2.graph.DasAxis yAxis, org.das2.dataset.DataSetConsumer consumer, org.das2.event.DragRenderer dragRenderer, String label )

create a new BoxSelectorMouseModule

## addBoxSelectionListener

addBoxSelectionListener( org.das2.event.BoxSelectionListener listener ) → void

Registers BoxSelectionListener to receive events.

### Parameters

listener - The listener to register.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## create

create( org.das2.graph.DasPlot parent, String label ) → org.das2.event.BoxSelectorMouseModule

create a BoxSelectorMouseModule

### Parameters

parent - the plot component
label - the label for this mouseModule.

### Returns:

new BoxSelectorMouseModule
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isDragEvents

isDragEvents( ) → boolean

Getter for property dragEvents.

### Returns:

Value of property dragEvents.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isKeyEvents

isKeyEvents( ) → boolean

Getter for property keyEvents.

### Returns:

Value of property keyEvents.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isReleaseEvents

isReleaseEvents( ) → boolean

Getter for property releaseEvents.

### Returns:

Value of property releaseEvents.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## keyPressed

keyPressed( java.awt.event.KeyEvent e ) → void

### Parameters

e - a KeyEvent

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## mouseMoved

mouseMoved( java.awt.event.MouseEvent e ) → void

### Parameters

e - a MouseEvent

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## mousePressed

mousePressed( java.awt.event.MouseEvent e ) → void

### Parameters

e - a MouseEvent

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## mouseRangeSelected

mouseRangeSelected( org.das2.event.MouseDragEvent e ) → void

### Parameters

e - a MouseDragEvent

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## mouseReleased

mouseReleased( java.awt.event.MouseEvent e ) → void

### Parameters

e - a MouseEvent

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## removeBoxSelectionListener

removeBoxSelectionListener( org.das2.event.BoxSelectionListener listener ) → void

Removes BoxSelectionListener from the list of listeners.

### Parameters

listener - The listener to remove.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setDragEvents

setDragEvents( boolean dragEvents ) → void

Setter for property dragEvents.

### Parameters

dragEvents - New value of property dragEvents.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setKeyEvents

setKeyEvents( boolean keyEvents ) → void

Setter for property keyEvents.

### Parameters

keyEvents - New value of property keyEvents.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setReleaseEvents

setReleaseEvents( boolean releaseEvents ) → void

Setter for property releaseEvents.

### Parameters

releaseEvents - New value of property releaseEvents.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setTweakable

setTweakable( boolean b ) → void

allow the last selection to be tweaked. It's the client's responsibility to draw the current selection.

### Parameters

b - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]