info.magnolia.module.templating
Interface RenderableDefinition

All Known Implementing Classes:

AbstractRenderable, Paragraph, Paragraph, SampleTemplate, Template, Template

public interface RenderableDefinition

Abstract rendering definition used for templates and paragraphs.

Version:

$Id: RenderableDefinition.java 41137 2011-01-06 18:19:25Z gjoseph $

Author:

pbracher

Method Summary

String	determineTemplatePath(String actionResult, RenderingModel model) The modules execute() method can return a string which is passed to this method to determine the template to use.
String	getDescription()
String	getDialog()
String	getI18nBasename()
String	getName()
Map	getParameters() An arbitrary list of parameters.
String	getTemplatePath()
String	getTitle()
String	getType()
RenderingModel	newModel(Content content, RenderableDefinition definition, RenderingModel parentModel) Create the model based on the current content.

Method Detail

getName

String getName()

getType

String getType()

getTitle

String getTitle()

getDescription

String getDescription()

getI18nBasename

String getI18nBasename()

getTemplatePath

String getTemplatePath()

getDialog

String getDialog()

getParameters

Map getParameters()

An arbitrary list of parameters. Used to omit subclass with getters and setters for each extra parameter.

newModel

RenderingModel newModel(Content content,
                        RenderableDefinition definition,
                        RenderingModel parentModel)
                        throws IllegalArgumentException,
                               InstantiationException,
                               IllegalAccessException,
                               InvocationTargetException

Create the model based on the current content.

Throws:

IllegalArgumentException

InstantiationException

IllegalAccessException

InvocationTargetException

determineTemplatePath

String determineTemplatePath(String actionResult,
                             RenderingModel model)

The modules execute() method can return a string which is passed to this method to determine the template to use.