<h2>org.das2.event.BoxSelectorMouseModule</h2><p>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: <ul> <li> dragEvents, as the mouse is dragged, <li> keyEvents, when a key is pressed. (The key is the "keyChar" plane of the event) <li> releaseEvents, when the mouse is released. (false by default) </ul> 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.</p> <h2>BoxSelectorMouseModule( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasCanvasComponent.html'>org.das2.graph.DasCanvasComponent</a> parent, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasAxis.html'>org.das2.graph.DasAxis</a> xAxis, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasAxis.html'>org.das2.graph.DasAxis</a> yAxis, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/dataset/DataSetConsumer.html'>org.das2.dataset.DataSetConsumer</a> consumer, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/DragRenderer.html'>org.das2.event.DragRenderer</a> dragRenderer, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> label )</h2> <p>create a new BoxSelectorMouseModule</p> <hr> <a name="addBoxSelectionListener"></a> <h2>addBoxSelectionListener</h2> addBoxSelectionListener( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/BoxSelectionListener.html'>org.das2.event.BoxSelectionListener</a> listener ) → void <p>Registers BoxSelectionListener to receive events.</p> <h3>Parameters</h3> listener - The listener to register. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=addBoxSelectionListener&unscoped_q=addBoxSelectionListener">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#addBoxSelectionListener">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="create"></a> <h2>create</h2> create( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasPlot.html'>org.das2.graph.DasPlot</a> parent, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> label ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/BoxSelectorMouseModule.html'>org.das2.event.BoxSelectorMouseModule</a> <p>create a BoxSelectorMouseModule</p> <h3>Parameters</h3> parent - the plot component <br> label - the label for this mouseModule. <h3>Returns:</h3> new BoxSelectorMouseModule <br><br> <a href="https://github.com/autoplot/dev/search?q=create&unscoped_q=create">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#create">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="isDragEvents"></a> <h2>isDragEvents</h2> isDragEvents( ) → boolean <p>Getter for property dragEvents.</p> <h3>Returns:</h3> Value of property dragEvents. <br><br> <a href="https://github.com/autoplot/dev/search?q=isDragEvents&unscoped_q=isDragEvents">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#isDragEvents">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="isKeyEvents"></a> <h2>isKeyEvents</h2> isKeyEvents( ) → boolean <p>Getter for property keyEvents.</p> <h3>Returns:</h3> Value of property keyEvents. <br><br> <a href="https://github.com/autoplot/dev/search?q=isKeyEvents&unscoped_q=isKeyEvents">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#isKeyEvents">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="isReleaseEvents"></a> <h2>isReleaseEvents</h2> isReleaseEvents( ) → boolean <p>Getter for property releaseEvents.</p> <h3>Returns:</h3> Value of property releaseEvents. <br><br> <a href="https://github.com/autoplot/dev/search?q=isReleaseEvents&unscoped_q=isReleaseEvents">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#isReleaseEvents">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="keyPressed"></a> <h2>keyPressed</h2> keyPressed( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html'>java.awt.event.KeyEvent</a> e ) → void <p></p> <h3>Parameters</h3> e - a KeyEvent <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=keyPressed&unscoped_q=keyPressed">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#keyPressed">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="mouseMoved"></a> <h2>mouseMoved</h2> mouseMoved( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/event/MouseEvent.html'>java.awt.event.MouseEvent</a> e ) → void <p></p> <h3>Parameters</h3> e - a MouseEvent <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=mouseMoved&unscoped_q=mouseMoved">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#mouseMoved">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="mousePressed"></a> <h2>mousePressed</h2> mousePressed( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/event/MouseEvent.html'>java.awt.event.MouseEvent</a> e ) → void <p></p> <h3>Parameters</h3> e - a MouseEvent <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=mousePressed&unscoped_q=mousePressed">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#mousePressed">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="mouseRangeSelected"></a> <h2>mouseRangeSelected</h2> mouseRangeSelected( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/MouseDragEvent.html'>org.das2.event.MouseDragEvent</a> e ) → void <p></p> <h3>Parameters</h3> e - a MouseDragEvent <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=mouseRangeSelected&unscoped_q=mouseRangeSelected">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#mouseRangeSelected">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="mouseReleased"></a> <h2>mouseReleased</h2> mouseReleased( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/event/MouseEvent.html'>java.awt.event.MouseEvent</a> e ) → void <p></p> <h3>Parameters</h3> e - a MouseEvent <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=mouseReleased&unscoped_q=mouseReleased">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#mouseReleased">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="removeBoxSelectionListener"></a> <h2>removeBoxSelectionListener</h2> removeBoxSelectionListener( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/BoxSelectionListener.html'>org.das2.event.BoxSelectionListener</a> listener ) → void <p>Removes BoxSelectionListener from the list of listeners.</p> <h3>Parameters</h3> listener - The listener to remove. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=removeBoxSelectionListener&unscoped_q=removeBoxSelectionListener">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#removeBoxSelectionListener">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="setDragEvents"></a> <h2>setDragEvents</h2> setDragEvents( boolean dragEvents ) → void <p>Setter for property dragEvents.</p> <h3>Parameters</h3> dragEvents - New value of property dragEvents. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setDragEvents&unscoped_q=setDragEvents">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#setDragEvents">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="setKeyEvents"></a> <h2>setKeyEvents</h2> setKeyEvents( boolean keyEvents ) → void <p>Setter for property keyEvents.</p> <h3>Parameters</h3> keyEvents - New value of property keyEvents. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setKeyEvents&unscoped_q=setKeyEvents">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#setKeyEvents">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="setReleaseEvents"></a> <h2>setReleaseEvents</h2> setReleaseEvents( boolean releaseEvents ) → void <p>Setter for property releaseEvents.</p> <h3>Parameters</h3> releaseEvents - New value of property releaseEvents. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setReleaseEvents&unscoped_q=setReleaseEvents">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#setReleaseEvents">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br> <hr> <a name="setTweakable"></a> <h2>setTweakable</h2> setTweakable( boolean b ) → void <p>allow the last selection to be tweaked. It's the client's responsibility to draw the current selection.</p> <h3>Parameters</h3> b - a boolean <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setTweakable&unscoped_q=setTweakable">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectorMouseModule.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectorMouseModule.html#setTweakable">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectorMouseModule.java">[view source]</a> <br> <br>