docrobot
Class SkinRobot

java.lang.Object
  docrobot.SkinRobot

Direct Known Subclasses:

Autumn, Business, BusinessBlackSteel, BusinessBlueSteel, ChallengerDeep, Creme, CremeCoffee, EmeraldDusk, FieldOfWheat, FindingNemo, GreenMagic, Magma, Mango, MistAqua, MistSilver, Moderate, Nebula, NebulaBrickWall, OfficeBlue2007, OfficeSilver2007, Raven, RavenGraphite, RavenGraphiteGlass, Sahara

public abstract class SkinRobot
extends java.lang.Object

The base class for taking screenshots of skins 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.
protected SubstanceSkin	skin The associated Substance skin.

Constructor Summary

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

Method Summary

void	makeScreenshot(int count) 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.

done

protected boolean done

Indicates whether the screenshot process is complete.

Constructor Detail

SkinRobot

public SkinRobot(SubstanceSkin skin,
                 java.lang.String screenshotFilename)

Creates the new screenshot robot.

Parameters:

skin - Substance skin.

screenshotFilename - The screenshot filename.

Method Detail

run

public void run()

Runs the screenshot process.

makeScreenshot

public void makeScreenshot(int count)

Creates the screenshot and saves it on the disk.

Parameters:

count - Sequence number for the screenshot.