org.concordion.ext.storyboard

Class Card

java.lang.Object

org.concordion.ext.storyboard.StoryboardItem

org.concordion.ext.storyboard.Card

Direct Known Subclasses:

NotificationCard, ScreenshotCard

public abstract class Card
extends StoryboardItem

Base class for all cards that can be added to the storyboard

Field Summary

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

container, listener

Constructor Summary

Constructors

Constructor and Description
Card()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addHTMLToContainer(org.concordion.api.Element listItem) Add HTML to the storyboard to display the card details
protected abstract 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
java.lang.String	getDescription()
protected java.lang.String	getFileName(java.lang.String specificationName, java.lang.String cardNumber, java.lang.String fileExtension) Gets a unique file name for data that is to be stored alongside a card
void	setDescription(java.lang.String description)
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.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

Card

public Card()

Method Detail

captureData

protected abstract void captureData()

Write the data to a file

addHTMLToContainer

protected abstract void addHTMLToContainer(org.concordion.api.Element listItem)

Add HTML to the storyboard to display the card details

Parameters:

listItem - The card element

getFileName

protected java.lang.String getFileName(java.lang.String specificationName,
                                       java.lang.String cardNumber,
                                       java.lang.String fileExtension)

Gets a unique file name for data that is to be stored alongside a card

Parameters:

specificationName - The name of the specification

cardNumber - Index of the card in the list

fileExtension - Extension of the file

Returns:

A unique filename

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

shouldAppend

protected boolean shouldAppend(boolean hasFailure)

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

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()

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