<h2>org.das2.graph.DasCanvasComponent</h2><p>Super class providing base functionality for all canvas components such as DasAxis, DasPlot, and DasLabel.</p> <h2>DasCanvasComponent( )</h2> <p>constructs a DasCanvasComponent, creating the DasMouseInputAdapter for it and assigning a default name to it.</p> <hr> <a name="PROPERTIES_ACTION"></a> <h2>PROPERTIES_ACTION</h2> <p>action for entering the properties editor.</p> <hr> <a name="PROP_OPAQUEBACKGROUND"></a> <h2>PROP_OPAQUEBACKGROUND</h2> <p></p> <hr> <a name="acceptContext"></a> <h2>acceptContext</h2> acceptContext( int x, int y ) → boolean <p>returns true if the component is suitable context for the point. For example, the operator right-clicks at the point, is this point a transparent region of the component, and accepting context would be confusing to the operator? This was first introduced to support the annotation component, which draws a compact background bubble around a message, which is typically smaller than its bounds, plus an arrow.</p> <h3>Parameters</h3> x - the x location on the canvas, with (0,0) being the upper-left corner. <br> y - the y location on the canvas, with (0,0) being the upper-left corner. <h3>Returns:</h3> true if the component accepts the context at this point. <br><br> <a href="https://github.com/autoplot/dev/search?q=acceptContext&unscoped_q=acceptContext">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#acceptContext">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="addMouseModule"></a> <h2>addMouseModule</h2> addMouseModule( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/MouseModule.html'>org.das2.event.MouseModule</a> module ) → void <p>Add the MouseModule to the list of MouseModules attached to the component via the DasMouseInputAdapter. MouseModules will appear the in the order that they are added.</p> <h3>Parameters</h3> module - the mouse module to add <h3>Returns:</h3> void (returns nothing) <h3>See Also:</h3> <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/MouseModule.html'>org.das2.event.MouseModule</a> <br> <br><br> <a href="https://github.com/autoplot/dev/search?q=addMouseModule&unscoped_q=addMouseModule">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#addMouseModule">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getActions"></a> <h2>getActions</h2> getActions( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/javax/swing/Action.html'>javax.swing.Action[]</a> <p>return a list of actions. This is used by the DasMouseInputAdapter.</p> <h3>Returns:</h3> the actions this provides. <br><br> <a href="https://github.com/autoplot/dev/search?q=getActions&unscoped_q=getActions">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getActions">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getActiveRegion"></a> <h2>getActiveRegion</h2> getActiveRegion( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Shape.html'>java.awt.Shape</a> <p>returns the active region of the canvas component, which is not necessarily the bounds.</p> <h3>Returns:</h3> the active region of the canvas component <br><br> <a href="https://github.com/autoplot/dev/search?q=getActiveRegion&unscoped_q=getActiveRegion">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getActiveRegion">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getCanvas"></a> <h2>getCanvas</h2> getCanvas( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasCanvas.html'>org.das2.graph.DasCanvas</a> <p>get the DasCanvas which contains this DasCanvasComponent.</p> <h3>Returns:</h3> the DasCanvas which contains this DasCanvasComponent. <br><br> <a href="https://github.com/autoplot/dev/search?q=getCanvas&unscoped_q=getCanvas">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getCanvas">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getColumn"></a> <h2>getColumn</h2> getColumn( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasColumn.html'>org.das2.graph.DasColumn</a> <p>accessor for the DasColumn used for positioning the component.</p> <h3>Returns:</h3> DasColumn used for positioning the component. <br><br> <a href="https://github.com/autoplot/dev/search?q=getColumn&unscoped_q=getColumn">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getColumn">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getDasMouseInputAdapter"></a> <h2>getDasMouseInputAdapter</h2> getDasMouseInputAdapter( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/DasMouseInputAdapter.html'>org.das2.event.DasMouseInputAdapter</a> <p>Get the DasMouseInputAdapter, which handles mouse input for the component.</p> <h3>Returns:</h3> the dasMouseInputAdapter. <br><br> <a href="https://github.com/autoplot/dev/search?q=getDasMouseInputAdapter&unscoped_q=getDasMouseInputAdapter">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getDasMouseInputAdapter">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getDasName"></a> <h2>getDasName</h2> getDasName( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p>Get the String identifier for the component which identifies the component within the application. This name should be consistent between sessions of an application, where applicable, for persistent state support.</p> <h3>Returns:</h3> the name of the component. <br><br> <a href="https://github.com/autoplot/dev/search?q=getDasName&unscoped_q=getDasName">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getDasName">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getEmSize"></a> <h2>getEmSize</h2> getEmSize( ) → double <p>convenient method intended to encourage use of em's. returns the em size for the canvas. We define the em size as the height of the component's font.</p> <h3>Returns:</h3> the height of the component's font. <br><br> <a href="https://github.com/autoplot/dev/search?q=getEmSize&unscoped_q=getEmSize">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getEmSize">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getFont"></a> <h2>getFont</h2> getFont( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Font.html'>java.awt.Font</a> <p>return the font used to paint the component.</p> <h3>Returns:</h3> the font. <br><br> <a href="https://github.com/autoplot/dev/search?q=getFont&unscoped_q=getFont">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getFont">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getLineThicknessDouble"></a> <h2>getLineThicknessDouble</h2> getLineThicknessDouble( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> lineThickness ) → double <p>return the thickness of the lines (in points or pixels), as specified in the lineThickness parameter. Example inputs include "", "1px", and ".1em".</p> <h3>Parameters</h3> lineThickness - a String <h3>Returns:</h3> a double <br><br> <a href="https://github.com/autoplot/dev/search?q=getLineThicknessDouble&unscoped_q=getLineThicknessDouble">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getLineThicknessDouble">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="getRow"></a> <h2>getRow</h2> getRow( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasRow.html'>org.das2.graph.DasRow</a> <p>accessor for the DasRow used for positioning the component.</p> <h3>Returns:</h3> DasRow used for positioning the component. <br><br> <a href="https://github.com/autoplot/dev/search?q=getRow&unscoped_q=getRow">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#getRow">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="isOpaqueBackground"></a> <h2>isOpaqueBackground</h2> isOpaqueBackground( ) → boolean <p></p> <h3>Returns:</h3> boolean <br><br> <a href="https://github.com/autoplot/dev/search?q=isOpaqueBackground&unscoped_q=isOpaqueBackground">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#isOpaqueBackground">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="removeMouseModule"></a> <h2>removeMouseModule</h2> removeMouseModule( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/MouseModule.html'>org.das2.event.MouseModule</a> module ) → void <p>Remove the MouseModule from the list of MouseModules attached to the component via the DasMouseInputAdapter.</p> <h3>Parameters</h3> module - the mouse module to remove <h3>Returns:</h3> void (returns nothing) <h3>See Also:</h3> <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/event/MouseModule.html'>org.das2.event.MouseModule</a> <br> <br><br> <a href="https://github.com/autoplot/dev/search?q=removeMouseModule&unscoped_q=removeMouseModule">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#removeMouseModule">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="resize"></a> <h2>resize</h2> resize( ) → void <p>Called by the DasCanvas layout manager to request this component to set its bounds.</p> <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=resize&unscoped_q=resize">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#resize">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="setColumn"></a> <h2>setColumn</h2> setColumn( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasColumn.html'>org.das2.graph.DasColumn</a> c ) → void <p>set the DasColumn for positioning the component horizontally. The current column is disconnected, and a propertyChange is fired.</p> <h3>Parameters</h3> c - the DasColumn <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setColumn&unscoped_q=setColumn">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#setColumn">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="setDasName"></a> <h2>setDasName</h2> setDasName( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> name ) → void <p>Set the String identifier for the component which identifies the component within the application. This name should be consistent between sessions of an application, where applicable, for persistent state support. For example, "timeAxis1" or "theTimeAxis"</p> <h3>Parameters</h3> name - unique String identifying the component within the application. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setDasName&unscoped_q=setDasName">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#setDasName">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="setOpaqueBackground"></a> <h2>setOpaqueBackground</h2> setOpaqueBackground( boolean opaqueBackground ) → void <p></p> <h3>Parameters</h3> opaqueBackground - a boolean <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setOpaqueBackground&unscoped_q=setOpaqueBackground">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#setOpaqueBackground">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="setRow"></a> <h2>setRow</h2> setRow( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/graph/DasRow.html'>org.das2.graph.DasRow</a> r ) → void <p>set the DasRow for positioning the component vertically. The current row is disconnected, and a propertyChange is fired.</p> <h3>Parameters</h3> r - the DasRow <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setRow&unscoped_q=setRow">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#setRow">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="showProperties"></a> <h2>showProperties</h2> showProperties( ) → void <p>popup the PropertyEditor for editing the state of this component.</p> <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=showProperties&unscoped_q=showProperties">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#showProperties">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="toString"></a> <h2>toString</h2> toString( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p></p> <h3>Returns:</h3> a concise String representation of the object. <br><br> <a href="https://github.com/autoplot/dev/search?q=toString&unscoped_q=toString">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#toString">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br> <hr> <a name="update"></a> <h2>update</h2> update( ) → void <p>posts an update event on the SystemEventQueue, indicating that work needs to be done to get the get the component back into a valid state.</p> <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=update&unscoped_q=update">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/graph/DasCanvasComponent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/graph/DasCanvasComponent.html#update">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/graph/DasCanvasComponent.java">[view source]</a> <br> <br>