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.