info.magnolia.module.resources.renderers

Class ResourcesTextTemplateRenderer

java.lang.Object

info.magnolia.rendering.renderer.AbstractRenderer

info.magnolia.rendering.renderer.FreemarkerRenderer

info.magnolia.module.resources.renderers.ResourcesTextTemplateRenderer

All Implemented Interfaces:

info.magnolia.rendering.renderer.Renderer, info.magnolia.rendering.renderer.RenderingModelBasedRenderer

public class ResourcesTextTemplateRenderer
extends info.magnolia.rendering.renderer.FreemarkerRenderer

This renderer uses the content and its subnodes as a Freemarker template source. Subnodes are appended to the content of the current node. Note that this doesn't work recursively. This can be useful for css or javascript resources, and the post-processing by Freemarker makes these dynamic, allowing one to use all of Freemarker's niceness right in their css or javascript (thus getting hold of Magnolia content and configuration, or simply using variables, etc...)

Field Summary

Fields inherited from class info.magnolia.rendering.renderer.AbstractRenderer

MODEL_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
ResourcesTextTemplateRenderer(info.magnolia.freemarker.FreemarkerHelper fmRenderer, info.magnolia.rendering.engine.RenderingEngine renderingEngine) Deprecated. since 2.4, use ResourcesTextTemplateRenderer(FreemarkerHelper, RenderingEngine, Provider).
ResourcesTextTemplateRenderer(info.magnolia.freemarker.FreemarkerHelper fmRenderer, info.magnolia.rendering.engine.RenderingEngine renderingEngine, javax.inject.Provider<ResourcesModule> resourcesModule)

Method Summary

Modifier and Type	Method and Description
info.magnolia.rendering.model.RenderingModel<?>	newModel(javax.jcr.Node content, info.magnolia.rendering.template.RenderableDefinition definition, info.magnolia.rendering.model.RenderingModel<?> parentModel) Creates the model for this rendering process.
protected void	onRender(javax.jcr.Node content, info.magnolia.rendering.template.RenderableDefinition definition, info.magnolia.rendering.context.RenderingContext renderingCtx, Map<String,Object> ctx, String templateScript)
protected String	resolveTemplateScript(javax.jcr.Node content, info.magnolia.rendering.template.RenderableDefinition definition, info.magnolia.rendering.model.RenderingModel<?> model, String actionResult) The template is stored in the content node.
protected boolean	shouldBypass(javax.jcr.Node content)

Methods inherited from class info.magnolia.rendering.renderer.FreemarkerRenderer

getFmHelper, newContext

Methods inherited from class info.magnolia.rendering.renderer.AbstractRenderer

addContextAttribute, getAggregationStateSafely, getContextAttributes, getMainContentSafely, newModel, render, restoreContext, saveAttribute, saveContextState, setContextAttribute, setContextAttributes, setupContext, wrapNodeForModel, wrapNodeForTemplate

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourcesTextTemplateRenderer

@Deprecated
public ResourcesTextTemplateRenderer(info.magnolia.freemarker.FreemarkerHelper fmRenderer,
                                                 info.magnolia.rendering.engine.RenderingEngine renderingEngine)

Deprecated. since 2.4, use ResourcesTextTemplateRenderer(FreemarkerHelper, RenderingEngine, Provider).

ResourcesTextTemplateRenderer

@Inject
public ResourcesTextTemplateRenderer(info.magnolia.freemarker.FreemarkerHelper fmRenderer,
                                             info.magnolia.rendering.engine.RenderingEngine renderingEngine,
                                             javax.inject.Provider<ResourcesModule> resourcesModule)

Method Detail

onRender

protected void onRender(javax.jcr.Node content,
                        info.magnolia.rendering.template.RenderableDefinition definition,
                        info.magnolia.rendering.context.RenderingContext renderingCtx,
                        Map<String,Object> ctx,
                        String templateScript)
                 throws info.magnolia.rendering.engine.RenderException

Overrides:

onRender in class info.magnolia.rendering.renderer.FreemarkerRenderer

Throws:

info.magnolia.rendering.engine.RenderException

resolveTemplateScript

protected String resolveTemplateScript(javax.jcr.Node content,
                                       info.magnolia.rendering.template.RenderableDefinition definition,
                                       info.magnolia.rendering.model.RenderingModel<?> model,
                                       String actionResult)

The template is stored in the content node. So we don't need a templatePath.

Overrides:

resolveTemplateScript in class info.magnolia.rendering.renderer.AbstractRenderer

newModel

public info.magnolia.rendering.model.RenderingModel<?> newModel(javax.jcr.Node content,
                                                                info.magnolia.rendering.template.RenderableDefinition definition,
                                                                info.magnolia.rendering.model.RenderingModel<?> parentModel)
                                                         throws info.magnolia.rendering.engine.RenderException

Creates the model for this rendering process. Will set the properties.

Specified by:

newModel in interface info.magnolia.rendering.renderer.RenderingModelBasedRenderer

Overrides:

newModel in class info.magnolia.rendering.renderer.AbstractRenderer

Throws:

info.magnolia.rendering.engine.RenderException

shouldBypass

protected boolean shouldBypass(javax.jcr.Node content)