info.magnolia.module.templating
Interface RenderableDefinition

All Known Implementing Classes:

AbstractRenderable, Paragraph, Paragraph, 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

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

Method Detail

getName

java.lang.String getName()

getType

java.lang.String getType()

getTitle

java.lang.String getTitle()

getDescription

java.lang.String getDescription()

getI18nBasename

java.lang.String getI18nBasename()

getTemplatePath

java.lang.String getTemplatePath()

getDialog

java.lang.String getDialog()

getParameters

java.util.Map getParameters()

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

newModel

RenderingModel newModel(info.magnolia.cms.core.Content content,
                        RenderableDefinition definition,
                        RenderingModel parentModel)
                        throws java.lang.IllegalArgumentException,
                               java.lang.InstantiationException,
                               java.lang.IllegalAccessException,
                               java.lang.reflect.InvocationTargetException

Create the model based on the current content.

Throws:

java.lang.IllegalArgumentException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

determineTemplatePath

java.lang.String determineTemplatePath(java.lang.String actionResult,
                                       RenderingModel model)

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