docrobot
Class BaseRobot

java.lang.Object
  extended by docrobot.BaseRobot
Direct Known Subclasses:
AquaShadedTheme, AquaTheme, AquaTintedTheme, AquaTonedTheme, BarbyPinkTheme, BinaryWatermark, BottleGreenTheme, BrownTheme, BubblesWatermark, CharcoalTheme, CremeTheme, CrosshatchWatermark, DarkVioletTheme, DesaturatedActiveAquaTheme, DesaturatedActiveFieldOfWheatSkin, DesaturatedActiveMixedBottleGreenLimeGreen, DesaturatedAquaTheme, DesaturatedFieldOfWheatSkin, DesaturatedMixedBottleGreenLimeGreen, DesertSandTheme, EbonyTheme, HueShiftGreenMagicSkin10, HueShiftGreenMagicSkin50, InvertedAquaTheme, InvertedAquaTonedTheme, InvertedBarbyPinkTheme, InvertedFieldOfWheatSkin, InvertedMixedBrownSunGlareTheme, InvertedSteelBlueTheme, InvertedSunsetTheme, JadeForestTheme, LatchWatermark, LightAquaTheme, LimeGreenTheme, MetalWallWatermark, MixedAquaLightAquaTheme, MixedBarbyPinkRaspberryTheme, MixedBottleGreenLimeGreenTheme, MixedBrownSunGlareTheme, MixedSunsetOrangeTheme, NegatedAquaTheme, NegatedAquaTonedTheme, NegatedBarbyPinkTheme, NegatedFieldOfWheatSkin, NegatedMixedBrownSunGlareTheme, NegatedSteelBlueTheme, NegatedSunsetTheme, NoiseCopperplateEngravingWatermark, NoiseFabricWatermark, NoiseMagneticFieldWatermark, NoiseMarbleVeinWatermark, NoiseMazeWatermark, NoisePlanktonWatermark, NoiseWoodWatermark, NoneWatermark, NullWatermark, OliveTheme, OrangeTheme, PurpleTheme, RaspberryTheme, SaturatedActiveAquaTheme, SaturatedActiveFieldOfWheatSkin, SaturatedActiveMixedBottleGreenLimeGreen, SaturatedAquaTheme, SaturatedFieldOfWheatSkin, SaturatedMixedBottleGreenLimeGreen, SepiaTheme, ShadedFieldOfWheatSkin, ShadedMixedBottleGreenLimeGreenTheme, SquareMosaicWatermark, SteelBlueTheme, StripesWatermark, SunGlareTheme, SunsetTheme, TerracottaTheme, TintedFieldOfWheatSkin, TintedMixedBottleGreenLimeGreenTheme, TonedFieldOfWheatSkin, TonedMixedBottleGreenLimeGreenTheme, UltramarineTheme

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  boolean done
          Indicates whether the screenshot process is complete.
protected  java.lang.String screenshotFilename
          The screenshot filename.
protected  SampleFrame sf
          The frame instance.
 
Constructor Summary
BaseRobot(java.lang.String screenshotFilename)
          Creates the new screenshot robot.
 
Method Summary
protected abstract  void apply()
          Applies instance-specific Substance settings before taking the screenshot.
 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

screenshotFilename

protected java.lang.String screenshotFilename
The screenshot filename.


sf

protected SampleFrame sf
The frame instance.


done

protected boolean done
Indicates whether the screenshot process is complete.

Constructor Detail

BaseRobot

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

Parameters:
screenshotFilename - The screenshot filename.
Method Detail

run

public void run()
Runs the screenshot process.


apply

protected abstract void apply()
Applies instance-specific Substance settings before taking the screenshot.


makeScreenshot

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