<h2>org.autoplot.ScreenshotsTool</h2><p>Jeremy's experiment that will create automatic documentation.
 This is intended to provide a means for users to more easily communicate and 
 to make it easier to create documentation.
 
 This is being modified a bit, namely to delay work such as screening
 private regions, to improve responsiveness and to allow the user the option
 of screening or not.</p>
<h2>ScreenshotsTool( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Window.html'>java.awt.Window</a> parent, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> outLocationFolder )</h2>
<p>create a new ScreenshotsTool, which will write screenshots to the location.</p>

<h2>ScreenshotsTool( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Window.html'>java.awt.Window</a> parent, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> outLocationFolder, boolean clearFolder )</h2>
<p>create a new ScreenshotsTool, which will write screenshots to the location.  The
 output folder must not exist or be empty, or clearFolder must be set to true.
 This is created and then pushed to the event stack, so that screenshots will
 be taken when activity occurs (see start which manages this), or will takePicture
 is called to manually take screenshots (e.g. from scripts).  When the
 session is done, requestFinish is called to clean up.</p>

<hr>
<a name="dispatchEvent"></a>
<h2>dispatchEvent</h2>
dispatchEvent( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/AWTEvent.html'>java.awt.AWTEvent</a> theEvent ) &rarr; void

<p></p>

<h3>Parameters</h3>
theEvent - an AWTEvent

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=dispatchEvent&unscoped_q=dispatchEvent">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#dispatchEvent">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l1081">[view source]</a>
<br>
<br>
<hr>
<a name="getScreenShot"></a>
<h2>getScreenShot</h2>
getScreenShot(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a>

<p>get a screenshot of the display Autoplot's main UI is running within.</p>

<h3>Returns:</h3>
a java.awt.image.BufferedImage

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getScreenShot&unscoped_q=getScreenShot">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#getScreenShot">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l712">[view source]</a>
<br>
<br>
getScreenShot( int active ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a><br>
<hr>
<a name="getScreenShotNoPointer"></a>
<h2>getScreenShotNoPointer</h2>
getScreenShotNoPointer(  ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a>

<p>get a screenshot of the display Autoplot's main UI is running within, but without the pointer.</p>

<h3>Returns:</h3>
a java.awt.image.BufferedImage

<br><br>
<a href="https://github.com/autoplot/dev/search?q=getScreenShotNoPointer&unscoped_q=getScreenShotNoPointer">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#getScreenShotNoPointer">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l722">[view source]</a>
<br>
<br>
<hr>
<a name="getTrim"></a>
<h2>getTrim</h2>
getTrim( <a href='https://docs.oracle.com/javase/8/docs/api/java/io/File.html'>java.io.File</a> root, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> monitor ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Rectangle.html'>java.awt.Rectangle</a>

<p>return the common bounding rectangle to all png images in the directory.</p>

<h3>Parameters</h3>
root - folder containing png images.
<br>
monitor - progress monitor for the task

<h3>Returns:</h3>
the rectangle common to all images.
<h3>See Also:</h3>
<a href='null'>getTrim(java.awt.image.BufferedImage)</a> <br>
<br><br>
<a href="https://github.com/autoplot/dev/search?q=getTrim&unscoped_q=getTrim">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#getTrim">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l582">[view source]</a>
<br>
<br>
getTrim( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a> source ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Rectangle.html'>java.awt.Rectangle</a><br>
<hr>
<a name="requestFinish"></a>
<h2>requestFinish</h2>
requestFinish( boolean trimAll ) &rarr; void

<p>This was introduced to provide a method for Jemmy tests to record videos 
 (so that videos are tested), but it looks like this won't work.  However
 this would probably be useful from scripts, so I will leave it.</p>

<h3>Parameters</h3>
trimAll - trim off the portions of all screenshots which are not used.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=requestFinish&unscoped_q=requestFinish">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#requestFinish">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l1057">[view source]</a>
<br>
<br>
<hr>
<a name="start"></a>
<h2>start</h2>
start( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Window.html'>java.awt.Window</a> parent ) &rarr; void

<p>start should be called from the event thread.</p>

<h3>Parameters</h3>
parent - the device

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=start&unscoped_q=start">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#start">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l141">[view source]</a>
<br>
<br>
<hr>
<a name="takePicture"></a>
<h2>takePicture</h2>
takePicture( int id ) &rarr; void

<p>manually trigger a screenshot, which is put in the output directory.</p>

<h3>Parameters</h3>
id - user-provided id (&le; 99999) for the image, which is the last part of the filename.

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=takePicture&unscoped_q=takePicture">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#takePicture">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l867">[view source]</a>
<br>
<br>
takePicture( int id, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> caption ) &rarr; void<br>
takePicture( int id, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> caption, <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html'>java.awt.Component</a> c, <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Point.html'>java.awt.Point</a> p, int buttons ) &rarr; void<br>
<hr>
<a name="trim"></a>
<h2>trim</h2>
trim( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a> image ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a>

<p>trim off the excess white to make a smaller image</p>

<h3>Parameters</h3>
image - a BufferedImage

<h3>Returns:</h3>
a java.awt.image.BufferedImage

<br><br>
<a href="https://github.com/autoplot/dev/search?q=trim&unscoped_q=trim">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#trim">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l649">[view source]</a>
<br>
<br>
trim( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a> image, <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Rectangle.html'>java.awt.Rectangle</a> r ) &rarr; <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html'>java.awt.image.BufferedImage</a><br>
<hr>
<a name="trimAll"></a>
<h2>trimAll</h2>
trimAll( <a href='https://docs.oracle.com/javase/8/docs/api/java/io/File.html'>java.io.File</a> dir ) &rarr; void

<p>find the common trim bounding box and trim all the images in the directory.</p>

<h3>Parameters</h3>
dir - a File

<h3>Returns:</h3>
void (returns nothing)

<br><br>
<a href="https://github.com/autoplot/dev/search?q=trimAll&unscoped_q=trimAll">[search for examples]</a>
 <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/ScreenshotsTool.md">[view on GitHub]</a>
 <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/ScreenshotsTool.html#trimAll">[view on old javadoc]</a>
 <a href="https://sourceforge.net/p/autoplot/code/HEAD/tree/autoplot/trunk/Autoplot/src/org/autoplot/ScreenshotsTool.java#l669">[view source]</a>
<br>
<br>
trimAll( <a href='https://docs.oracle.com/javase/8/docs/api/java/io/File.html'>java.io.File</a> dir, <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Rectangle.html'>java.awt.Rectangle</a> r, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/util/monitor/ProgressMonitor.html'>ProgressMonitor</a> monitor ) &rarr; void<br>