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

Class ComposerTemplate

java.lang.Object
com.aquima.interactions.test.templates.AbstractReportingTemplate
com.aquima.interactions.test.templates.composer.ComposerTemplate
public class ComposerTemplate extends AbstractReportingTemplate
Template that may be used to initialize a composer.
Since:
7.0
Author:
Jon van Leuven

  • Constructor Details

    • ComposerTemplate

      public ComposerTemplate(ProjectTemplate project, MetaModelTemplate model, ConfigurationTemplate config)
      Constructs the composer template with the required arguments.
      Parameters:
      project - Template containing the project wide definitions
      model - Template containing the meta model definitions.
      config - Template containing the configuration settings.

    • ComposerTemplate

      public ComposerTemplate(com.aquima.interactions.foundation.report.IInitializationReport report, ProjectTemplate project, MetaModelTemplate model, ConfigurationTemplate config)
      Constructs the composer template with the required arguments.
      Parameters:
      report - The initialization report that should be used for errors and warnings.
      project - Template containing the project wide definitions
      model - Template containing the meta model definitions.
      config - Template containing the configuration settings.

  • Method Details

    • getConfiguration

      protected ConfigurationTemplate getConfiguration()

    • getFields

      protected Iterator<FieldTemplate> getFields()

    • addField

      public FieldTemplate addField(String fieldName)
      This method may be used to add a field definition.
      Parameters:
      fieldName - The attribute for which the field definition should be added.
      Returns:
      Field template representing the added field.

    • getButtons

      protected Iterator<ButtonTemplate> getButtons()

    • getButton

      protected ButtonTemplate getButton(String name)

    • addButton

      public ButtonTemplate addButton(String name)
      This method may be used to add a button definition.
      Parameters:
      name - The name of the button that should be added.
      Returns:
      Button template representing the added button.

    • getContainersIterator

      protected Iterator<ContainerTemplate> getContainersIterator()

    • getContainer

      protected ContainerTemplate getContainer(String name)

    • getPage

      protected PageTemplate getPage(String name)

    • addPage

      public PageTemplate addPage(String name)
      This method may be used to add a page definition.
      Parameters:
      name - The name of the page that should be added.
      Returns:
      Page template representing the added page.

    • addContainer

      public ContainerTemplate addContainer(String name)
      This method may be used to add a container definition.
      Parameters:
      name - The name of the container that should be added.
      Returns:
      Container template representing the added container.

    • addContentStyle

      public ContentStyleTemplate addContentStyle(String name)
      This method may be used to add a content style definition.
      Parameters:
      name - The name of the content style.
      Returns:
      Template representing the content style that was added.

    • getContentStyles

      protected Iterator<ContentStyleTemplate> getContentStyles()

    • getText

      protected TextTemplate getText(String name)

    • getImage

      protected ImageTemplate getImage(String name)

    • addText

      public TextTemplate addText(String name)
      This method may be used to add a text definition.
      Parameters:
      name - The name of the text definition.
      Returns:
      Text template representing the added text.

    • addImage

      public ImageTemplate addImage(String name)
      This method may be used to add an image definition.
      Parameters:
      name - The name of the image definition.
      Returns:
      Image template representing the added image.

    • getTexts

      protected Iterator<TextTemplate> getTexts()

    • getContent

      protected ContentTemplate getContent(String name)

    • addContent

      public ContentTemplate addContent(String name)
      This method may be used to add a content definition.
      Parameters:
      name - The name of the content definition.
      Returns:
      Content template representing the added content.

    • getContents

      protected Iterator<ContentTemplate> getContents()

    • getDocument

      protected DocumentTemplate getDocument(String name)

    • addDocument

      public DocumentTemplate addDocument(String name)
      This method may be used to add a document definition.
      Parameters:
      name - The name of the document that should be added.
      Returns:
      Document template representing the added document.

    • getDocuments

      protected Iterator<DocumentTemplate> getDocuments()

    • getImages

      protected Iterator<ImageTemplate> getImages()

    • getAssets

      protected Iterator<AssetTemplate> getAssets()

    • getPages

      protected Iterator<PageTemplate> getPages()

    • getAsset

      protected AssetTemplate getAsset(String name)

    • addAsset

      public AssetTemplate addAsset(String name)
      This method may be used to add an asset definition.
      Parameters:
      name - The name of the asset that should be added.
      Returns:
      Asset template representing the added asset.

    • toDataSource

      public com.aquima.interactions.composer.ds.IComposerDS toDataSource()
      This method converts the template to a data source that can be used to initialize a composer.
      Returns:
      a data source that can be used to initialize a composer.

    • getProjectTemplate

      protected ProjectTemplate getProjectTemplate()

    • getContainers

      public ContainerTemplate[] getContainers()
      This method returns all the containers registered in the composer.
      Returns:
      The container templates, never null.

    • getMetaModel

      protected MetaModelTemplate getMetaModel()