info.magnolia.rendering.template.configured

Class ConfiguredRenderableDefinition

java.lang.Object

info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition

All Implemented Interfaces:

NamedDefinition, RenderableDefinition

Direct Known Subclasses:

ConfiguredTemplateDefinition

public class ConfiguredRenderableDefinition
extends Object
implements RenderableDefinition

A RenderableDefinition configured in the configuration workspace.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	parameters

Constructor Summary

Constructors

Constructor and Description
ConfiguredRenderableDefinition()

Method Summary

Modifier and Type	Method and Description
void	addParameter(String name, Object parameter)
void	addVariation(String name, RenderableDefinition variation)
AutoGenerationConfiguration	getAutoGeneration()
Boolean	getAutoPopulateFromRequest()
String	getDescription()
FragmentDefinition	getFragmentDefinition()
String	getI18nBasename() Deprecated. since 5.4.4. I18nBasename is deprecated and will be removed in a future version.
String	getId()
Class	getModelClass()
String	getName()
Map<String,Object>	getParameters() An arbitrary list of parameters.
String	getRenderType()
String	getTemplateScript()
String	getTitle()
Map<String,RenderableDefinition>	getVariations()
void	setAutoGeneration(AutoGenerationConfiguration autoGeneration)
void	setAutoPopulateFromRequest(Boolean autoPopulateFromRequest)
void	setDescription(String description)
void	setFragmentDefinition(FragmentDefinition fragmentDefinition)
void	setI18nBasename(String basename) Deprecated. since 5.4.4. I18nBasename is deprecated and will be removed in a future version.
void	setId(String id)
void	setModelClass(Class modelClass)
void	setName(String name)
void	setParameters(Map<String,Object> params)
void	setRenderType(String renderType)
void	setTemplateScript(String templateScript)
void	setTitle(String title)
void	setVariations(Map<String,RenderableDefinition> variations)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected Map<String,Object> parameters

Constructor Detail

ConfiguredRenderableDefinition

public ConfiguredRenderableDefinition()

Method Detail

getId

public String getId()

Specified by:

getId in interface RenderableDefinition

setId

public void setId(String id)

Specified by:

setId in interface RenderableDefinition

getName

public String getName()

Specified by:

getName in interface NamedDefinition

Specified by:

getName in interface RenderableDefinition

getTitle

public String getTitle()

Specified by:

getTitle in interface RenderableDefinition

getTemplateScript

public String getTemplateScript()

Specified by:

getTemplateScript in interface RenderableDefinition

getRenderType

public String getRenderType()

Specified by:

getRenderType in interface RenderableDefinition

getDescription

public String getDescription()

Specified by:

getDescription in interface RenderableDefinition

setDescription

public void setDescription(String description)

setName

public void setName(String name)

setTemplateScript

public void setTemplateScript(String templateScript)

setRenderType

public void setRenderType(String renderType)

setTitle

public void setTitle(String title)

getI18nBasename

@Deprecated
public String getI18nBasename()

Deprecated. since 5.4.4. I18nBasename is deprecated and will be removed in a future version.

Description copied from interface: RenderableDefinition

This is support for old I18n mechanism where you need to provide keys RenderableDefinition.getTitle() and RenderableDefinition.getDescription(). The new i18n mechanism generates the keys via RenderableDefinitionKeyGenerator automatically.

Specified by:

getI18nBasename in interface RenderableDefinition

setI18nBasename

@Deprecated
public void setI18nBasename(String basename)

Deprecated. since 5.4.4. I18nBasename is deprecated and will be removed in a future version.

getModelClass

public Class getModelClass()

Specified by:

getModelClass in interface RenderableDefinition

setModelClass

public void setModelClass(Class modelClass)

getVariations

public Map<String,RenderableDefinition> getVariations()

Specified by:

getVariations in interface RenderableDefinition

setVariations

public void setVariations(Map<String,RenderableDefinition> variations)

addVariation

public void addVariation(String name,
                         RenderableDefinition variation)

getParameters

public Map<String,Object> getParameters()

Description copied from interface: RenderableDefinition

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

Specified by:

getParameters in interface RenderableDefinition

setParameters

public void setParameters(Map<String,Object> params)

addParameter

public void addParameter(String name,
                         Object parameter)

getAutoGeneration

public AutoGenerationConfiguration getAutoGeneration()

Specified by:

getAutoGeneration in interface RenderableDefinition

setAutoGeneration

public void setAutoGeneration(AutoGenerationConfiguration autoGeneration)

toString

public String toString()

Overrides:

toString in class Object

getAutoPopulateFromRequest

public Boolean getAutoPopulateFromRequest()

Specified by:

getAutoPopulateFromRequest in interface RenderableDefinition

setAutoPopulateFromRequest

public void setAutoPopulateFromRequest(Boolean autoPopulateFromRequest)

getFragmentDefinition

public FragmentDefinition getFragmentDefinition()

Specified by:

getFragmentDefinition in interface RenderableDefinition

setFragmentDefinition

public void setFragmentDefinition(FragmentDefinition fragmentDefinition)