org.concordion.ext.storyboard

Class NotificationCard

java.lang.Object

org.concordion.ext.storyboard.StoryboardItem

org.concordion.ext.storyboard.Card

org.concordion.ext.storyboard.NotificationCard

public class NotificationCard
extends Card

Generic card that can optionally provide data to the user. This data can be text based data such as: xml, json, html, etc.

Field Summary

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

container, listener

Constructor Summary

Constructors

Constructor and Description
NotificationCard()

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
void	setCardImage(CardImage cardImage) S Override the default card image of XML_REQUEST
void	setData(java.lang.String data) Set the data that you wish the card to display
void	setFileExtension(java.lang.String fileExtension) Set the file type for the data.
void	setFilePath(java.lang.String file) Use an existing file rather than have this class attempt to create one.

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

cleanupData, getDescription, getFileName, setDescription, shouldAppend

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

NotificationCard

public NotificationCard()

Method Detail

setCardImage

public void setCardImage(CardImage cardImage)

S Override the default card image of XML_REQUEST

Parameters:

cardImage - A card image - can be StockCardImage or a custom image

setData

public void setData(java.lang.String data)

Set the data that you wish the card to display

Parameters:

data - Data

captureData

protected void captureData()

Description copied from class: Card

Write the data to a file

Specified by:

captureData 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

setFileExtension

public void setFileExtension(java.lang.String fileExtension)

Set the file type for the data. This helps with formatting/display. Defaults to 'txt'.

Parameters:

fileExtension - File extension

setFilePath

public void setFilePath(java.lang.String file)

Use an existing file rather than have this class attempt to create one.

Parameters:

file - Relative path to the file