info.magnolia.rendering.template

Interface RenderableDefinition

All Superinterfaces:

info.magnolia.config.NamedDefinition

All Known Subinterfaces:

AreaDefinition, TemplateDefinition

All Known Implementing Classes:

ConfiguredAreaDefinition, ConfiguredRenderableDefinition, ConfiguredTemplateDefinition

public interface RenderableDefinition
extends info.magnolia.config.NamedDefinition

Base interface for all renderables. Defines for instance the template's title, template script and render type.

Method Summary

Methods

Modifier and Type	Method and Description
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	setId(String id)

Method Detail

getId

String getId()

setId

void setId(String id)

getName

String getName()

Specified by:

getName in interface info.magnolia.config.NamedDefinition

getRenderType

String getRenderType()

getTitle

String getTitle()

getDescription

String getDescription()

getI18nBasename

@Deprecated
String getI18nBasename()

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

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

getTemplateScript

String getTemplateScript()

getVariations

Map<String,RenderableDefinition> getVariations()

getParameters

Map<String,Object> getParameters()

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

getModelClass

Class getModelClass()

getAutoGeneration

AutoGenerationConfiguration getAutoGeneration()

getAutoPopulateFromRequest

Boolean getAutoPopulateFromRequest()

getFragmentDefinition

FragmentDefinition getFragmentDefinition()