org.das2.event

Class BoxSelectionEvent

java.lang.Object

java.util.EventObject

org.das2.event.DasEvent

org.das2.event.BoxSelectionEvent

All Implemented Interfaces:

java.io.Serializable

public class BoxSelectionEvent
extends DasEvent

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BoxSelectionEvent(java.lang.Object source, DatumRange xrange, DatumRange yrange) create the BoxSelectionEvent with additional planes of data.
BoxSelectionEvent(java.lang.Object source, DatumRange xrange, DatumRange yrange, java.util.HashMap planes) create the BoxSelectionEvent with additional planes of data.

Method Summary

Modifier and Type	Method and Description
QDataSet	getDataSet() get the dataset attached to this event.
Datum	getFinishX() get the X coordinate of the mouse button release
Datum	getFinishY() get the Y coordinate of the mouse button release
java.lang.Object	getPlane(java.lang.String plane) get the data attached to the plane name.
java.lang.String[]	getPlaneIds() return the list of additional data planes attached to this event.
Datum	getStartX() get the X coordinate or the mouse button press
Datum	getStartY() get the Y coordinate or the mouse button press
DatumRange	getXRange() get the X data range of the gesture
DatumRange	getYRange() get the Y data range of the gesture
void	setDataSet(QDataSet ds) attach a dataset to this event.
void	setFinish(Datum x, Datum y) set the end coordinates of the mouse release.
void	setStart(Datum x, Datum y) set the coordinates of the mouse button press
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BoxSelectionEvent

public BoxSelectionEvent(java.lang.Object source,
                         DatumRange xrange,
                         DatumRange yrange)

create the BoxSelectionEvent with additional planes of data.

Parameters:

source - the object creating this event, for example the BoxSelectorMouseModule.

xrange - the horizontal range

yrange - the vertical range

BoxSelectionEvent

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

create the BoxSelectionEvent with additional planes of data.

Parameters:

source - the object creating this event, for example the BoxSelectorMouseModule.

xrange - the horizontal range

yrange - the vertical range

planes - a map from String to Object containing arbitrary metadata.

Method Detail

setFinish

public void setFinish(Datum x,
                      Datum y)

set the end coordinates of the mouse release.

Parameters:

x - the release coordinate X

y - the release coordinate Y

getFinishX

public Datum getFinishX()

get the X coordinate of the mouse button release

Returns:

the release coordinate X

getFinishY

public Datum getFinishY()

get the Y coordinate of the mouse button release

Returns:

the release coordinate Y

setStart

public void setStart(Datum x,
                     Datum y)

set the coordinates of the mouse button press

Parameters:

x - the x coordinate

y - the y coordinate

getStartX

public Datum getStartX()

get the X coordinate or the mouse button press

Returns:

the X coordinate or the mouse button press

getStartY

public Datum getStartY()

get the Y coordinate or the mouse button press

Returns:

the Y coordinate or the mouse button press

getXRange

public DatumRange getXRange()

get the X data range of the gesture

Returns:

the X data range of the gesture

getYRange

public DatumRange getYRange()

get the Y data range of the gesture

Returns:

the Y data range of the gesture

getPlane

public java.lang.Object getPlane(java.lang.String plane)

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, - e.g. 'keyChar'

Returns:

the value associated with the plane, or null.

getPlaneIds

public java.lang.String[] getPlaneIds()

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

Returns:

setDataSet

public void setDataSet(QDataSet ds)

attach a dataset to this event.

Parameters:

ds - a dataset for this event.

getDataSet

public QDataSet getDataSet()

get the dataset attached to this event.

Returns:

the dataset attached to this event.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject