org.concordion.ext.storyboard

Class ScreenshotCard

java.lang.Object

org.concordion.ext.storyboard.StoryboardItem

org.concordion.ext.storyboard.Card

org.concordion.ext.storyboard.ScreenshotCard

public class ScreenshotCard
extends Card

Card that takes and presents screenshots of the system under test.

Field Summary

Fields inherited from class org.concordion.ext.storyboard.StoryboardItem

container, listener

Constructor Summary

Constructors

Constructor and Description
ScreenshotCard()

Method Summary

Modifier and Type	Method and Description
protected void	addHTMLToContainer(org.concordion.api.Element container) Add HTML to the storyboard to display the card details
protected void	captureData() Write the data to a file
protected void	cleanupData() Override this method to clean up data belonging to this card - likely to be used in conjunction with the shouldAppend() method
boolean	isDeleteIfSuccessful()
void	setDeleteIfSuccessful(boolean deleteIfSuccessful)
void	setImageName(java.lang.String imageName, java.awt.Dimension imageSize) Use an existing image rather than have this class attempt to capture a screenshot.
protected void	setScreenshotTaker(org.concordion.ext.ScreenshotTaker screenshotTaker)
protected boolean	shouldAppend(boolean hasFailure) Override this method to update whether the card should be added to the storyboard or not.

Methods inherited from class org.concordion.ext.storyboard.Card

getDescription, getFileName, setDescription

Methods inherited from class org.concordion.ext.storyboard.StoryboardItem

getItemIndex, getResource, getResult, getTarget, getTitle, setContainer, setResult, setStoryboardListener, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScreenshotCard

public ScreenshotCard()

Method Detail

setScreenshotTaker

protected void setScreenshotTaker(org.concordion.ext.ScreenshotTaker screenshotTaker)

isDeleteIfSuccessful

public boolean isDeleteIfSuccessful()

setDeleteIfSuccessful

public void setDeleteIfSuccessful(boolean deleteIfSuccessful)

captureData

protected void captureData()

Description copied from class: Card

Write the data to a file

Specified by:

captureData in class Card

shouldAppend

protected boolean shouldAppend(boolean hasFailure)

Description copied from class: Card

Override this method to update whether the card should be added to the storyboard or not.

Overrides:

shouldAppend in class Card

Parameters:

hasFailure - True if the test failed, or if within a section break, the section was marked as failure

Returns:

True to append card to storyboard, false to ignore card

cleanupData

protected void cleanupData()

Description copied from class: Card

Override this method to clean up data belonging to this card - likely to be used in conjunction with the shouldAppend() method

Overrides:

cleanupData in class Card

addHTMLToContainer

protected void addHTMLToContainer(org.concordion.api.Element container)

Description copied from class: Card

Add HTML to the storyboard to display the card details

Specified by:

addHTMLToContainer in class Card

Parameters:

container - The card element

setImageName

public void setImageName(java.lang.String imageName,
                         java.awt.Dimension imageSize)

Use an existing image rather than have this class attempt to capture a screenshot.

Parameters:

imageName - Relative path to the image

imageSize - Dimesion of image