tools.docrobot
Class BaseRobot

java.lang.Object
  extended by tools.docrobot.BaseRobot
Direct Known Subclasses:
ColorSchemeRobot, WatermarkOverlaying, WatermarkRobot

public abstract class BaseRobot
extends java.lang.Object

The base class for taking a single screenshot for Substance documentation.

Author:
Kirill Grouchnikov

Field Summary
protected  java.util.concurrent.CountDownLatch gate
          Used to wait for the rendering.
protected  java.lang.String screenshotFilename
          The screenshot filename.
protected  SampleFrame sf
          The frame instance.
protected  SubstanceSkin skin
          The associated Substance skin.
 
Constructor Summary
BaseRobot(SubstanceSkin skin, java.lang.String screenshotFilename)
          Creates the new screenshot robot.
 
Method Summary
 void makeScreenshot()
          Creates the screenshot and saves it on the disk.
 void run()
          Runs the screenshot process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

skin

protected SubstanceSkin skin
The associated Substance skin.


screenshotFilename

protected java.lang.String screenshotFilename
The screenshot filename.


sf

protected SampleFrame sf
The frame instance.


gate

protected java.util.concurrent.CountDownLatch gate
Used to wait for the rendering.

Constructor Detail

BaseRobot

public BaseRobot(SubstanceSkin skin,
                 java.lang.String screenshotFilename)
Creates the new screenshot robot.

Parameters:
skin - The skin.
screenshotFilename - The screenshot filename.
Method Detail

run

public void run()
Runs the screenshot process.


makeScreenshot

public void makeScreenshot()
Creates the screenshot and saves it on the disk.