Package com.aquima.interactions.test.templates.composer

Class ContentTemplate

java.lang.Object

com.aquima.interactions.test.templates.AbstractReportingTemplate

com.aquima.interactions.test.templates.composer.ContentTemplate

Direct Known Subclasses:

DocumentTemplate

public class ContentTemplate
extends AbstractReportingTemplate

This template can be used to initialize a content definition.

Since:

6.0

Author:

O. Kerpershoek

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContentTemplate(ComposerTemplate composer, String name)	Constructs the content template with the required parameters.
protected	ContentTemplate(ComposerTemplate composer, String name, com.aquima.interactions.foundation.report.IInitializationReport report)

Method Summary

Modifier and Type	Method	Description
ContainerReference	addContainer(String name)	This method may be used to add a container to the content template.
ContentReference	addContent(String name)	This method may be used to add a content to the content template.
ImageReference	addImage(String name)	This method may be used to add an image to the content template.
TextReference	addText(String name)	This method may be used to add a text to the content template.
protected Iterator<Reference>	getContents()
protected String	getContentStyle()
protected String	getDescription()
protected String	getName()
protected String	getPresentationStyle()
void	setContentStyle(String contentStyle)	This method may be used to override the content style of the content definition.
void	setDescription(String description)	This method may be used to override the description of the content definition.
void	setPresentationStyle(String presentationStyle)	This method may be used to override the presentation style of the content definition.
com.aquima.interactions.composer.ds.IContentDS	toDataSource()	This method converts the template to a data source that can be used to initialize a content definition.

Methods inherited from class com.aquima.interactions.test.templates.AbstractReportingTemplate

getInitializationReport

Methods inherited from class java.lang.Object

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

Constructor Details

ContentTemplate

protected ContentTemplate(ComposerTemplate composer,
 String name)

Constructs the content template with the required parameters.

Parameters:

name - The name of the content definition.

ContentTemplate

protected ContentTemplate(ComposerTemplate composer,
 String name,
 com.aquima.interactions.foundation.report.IInitializationReport report)

Method Details

getName

protected String getName()

getDescription

protected String getDescription()

setDescription

public void setDescription(String description)

This method may be used to override the description of the content definition.

Parameters:

description - The description of the content definition.

getContentStyle

protected String getContentStyle()

setContentStyle

public void setContentStyle(String contentStyle)

This method may be used to override the content style of the content definition.

Parameters:

contentStyle - the content style of the content definition.

getPresentationStyle

protected String getPresentationStyle()

setPresentationStyle

public void setPresentationStyle(String presentationStyle)

This method may be used to override the presentation style of the content definition.

Parameters:

presentationStyle - the presentation style of the content definition.

addContent

public ContentReference addContent(String name)

This method may be used to add a content to the content template. When the supplied name is null an inline content definition will be created.

Parameters:

name - The name of the content definition that is referred to.

Returns:

The reference template to the content template.

addContainer

public ContainerReference addContainer(String name)

This method may be used to add a container to the content template. The supplied name may not be null.

Parameters:

name - The name of the container definition that is referred to.

Returns:

The reference template to the container template.

addText

public TextReference addText(String name)

This method may be used to add a text to the content template. When the supplied name is null an inline text definition will be created.

Parameters:

name - The name of the text definition that is referred to.

Returns:

The reference template to the text template.

addImage

public ImageReference addImage(String name)

This method may be used to add an image to the content template.

Parameters:

name - The name of the image definition that is referred to.

Returns:

The reference template to the image template.

getContents

protected Iterator<Reference> getContents()

toDataSource

public com.aquima.interactions.composer.ds.IContentDS toDataSource()

This method converts the template to a data source that can be used to initialize a content definition.

Returns:

a data source that can be used to initialize a content definition.