## org.das2.event.BoxSelectionEvent

This is the range analog to the DataPointSelectionEvent. The DataPointSelectionEvent is a point, and this is a box. Note that it's acceptable to have null xrange and yrange, so that the same code can support a variety of applications. It's left to the programmer to see that these are used consistently.

## BoxSelectionEvent( Object source, DatumRange xrange, DatumRange yrange )

create the BoxSelectionEvent with additional planes of data.

## BoxSelectionEvent( Object source, DatumRange xrange, DatumRange yrange, java.util.HashMap planes )

create the BoxSelectionEvent with additional planes of data.

## getDataSet

getDataSet( ) → QDataSet

get the dataset attached to this event.

### Returns:

the dataset attached to this event.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getFinishX

getFinishX( ) → Datum

get the X coordinate of the mouse button release

### Returns:

the release coordinate X
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getFinishY

getFinishY( ) → Datum

get the Y coordinate of the mouse button release

### Returns:

the release coordinate Y
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getKeyStroke

getKeyStroke( ) → String

return the keystroke in a one-character string if a key was pressed, or empty string if a mouse motion triggered the event. Note "p" is typically handled elsewhere and is used to "pin" the mouse action. "c" is sometimes handled as "copy" and should also not be used. Also, function keys F1 through F12 will be returned as strings "F1" through "F12", and "insert" and "delete" are returned for those two keys. Note also that keyboards differ internationally, so consider using numbers or letters known to work commonly.

### Returns:

the keystroke or empty string
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getPlane

getPlane( String plane ) → Object

get the data attached to the plane name. This allows applications to attach additional data to the event. For example, the BoxSelectorMouseModule attaches the key pressed.

### Parameters

plane - a String

### Returns:

the value associated with the plane, or null.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getPlaneIds

getPlaneIds( ) → String[]

return the list of additional data planes attached to this event.

### Returns:

a String[]
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getStartX

getStartX( ) → Datum

get the X coordinate or the mouse button press

### Returns:

the X coordinate or the mouse button press
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getStartY

getStartY( ) → Datum

get the Y coordinate or the mouse button press

### Returns:

the Y coordinate or the mouse button press
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getXRange

getXRange( ) → DatumRange

get the X data range of the gesture

### Returns:

the X data range of the gesture
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getYRange

getYRange( ) → DatumRange

get the Y data range of the gesture

### Returns:

the Y data range of the gesture
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setDataSet

setDataSet( QDataSet ds ) → void

attach a dataset to this event.

### Parameters

ds - a dataset for this event.

### Returns:

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

## setFinish

setFinish( Datum x, Datum y ) → void

set the end coordinates of the mouse release.

### Parameters

x - the release coordinate X
y - the release coordinate Y

### Returns:

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

## setStart

setStart( Datum x, Datum y ) → void

set the coordinates of the mouse button press

### Parameters

x - the x coordinate
y - the y coordinate

### Returns:

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

## toString

toString( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc] [view source]