Package org.craftercms.engine.freemarker

Class RenderComponentDirective

java.lang.Object

org.craftercms.engine.freemarker.RenderComponentDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class RenderComponentDirective
extends Object
implements freemarker.template.TemplateDirectiveModel

Custom directive to render a component by processing the template defined in the component element's template name sub-element.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_MODEL_PARAM_NAME
static final String	COMPONENT_PARAM_NAME
static final String	COMPONENT_PARENT_PARAM_NAME
static final String	COMPONENT_PATH_PARAM_NAME
protected String	componentElementName
protected String	includeElementName
static final String	KEY_CONTENT_MODEL
static final String	KEY_MODEL	Deprecated.
protected org.springframework.beans.factory.ObjectFactory<freemarker.template.SimpleHash>	modelFactory
protected SiteItemScriptResolver	scriptResolver
protected jakarta.servlet.ServletContext	servletContext
protected SiteItemService	siteItemService
protected String	templateNamePrefix
protected String	templateNameSuffix
protected String	templateXPathQuery

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor	Description
RenderComponentDirective(jakarta.servlet.ServletContext servletContext, SiteItemService siteItemService, org.springframework.beans.factory.ObjectFactory<freemarker.template.SimpleHash> modelFactory, String templateXPathQuery, String templateNamePrefix, String templateNameSuffix, String includeElementName, String componentElementName, SiteItemScriptResolver scriptResolver)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createScriptVariables(SiteItem component, Map<String,Object> templateModel, Map<String,Object> additionalModel)
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body)
protected void	executeScript(Script script, Map<String,Object> scriptVariables, freemarker.core.Environment env)
protected Map<String,Object>	executeScripts(SiteItem component, Map<String,Object> additionalModel, freemarker.core.Environment env)
protected SiteItem	getComponent(String componentPath, freemarker.core.Environment env)
protected SiteItem	getComponentFromNode(freemarker.template.TemplateModel parentParam, freemarker.template.TemplateModel componentParam, freemarker.core.Environment env)
protected SiteItem	getComponentFromPath(freemarker.template.TemplateModel componentPathParam, freemarker.core.Environment env)
protected String	getComponentTemplateName(SiteItem component, freemarker.core.Environment env)
protected freemarker.template.SimpleHash	getFullModel(SiteItem component, Map<String,Object> templateModel, Map<String,Object> additionalModel)
protected freemarker.template.Template	getTemplate(SiteItem component, freemarker.core.Environment env)
protected void	processComponentTemplate(freemarker.template.Template template, freemarker.template.SimpleHash model, Writer output, freemarker.core.Environment env)
protected <T> T	unwrap(String name, freemarker.template.TemplateModel value, Class<T> expectedClass, freemarker.core.Environment env)

Methods inherited from class java.lang.Object

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

Field Details

KEY_MODEL

@Deprecated
public static final String KEY_MODEL

Deprecated.

See Also:

• Constant Field Values

KEY_CONTENT_MODEL

public static final String KEY_CONTENT_MODEL

See Also:

• Constant Field Values

COMPONENT_PARENT_PARAM_NAME

public static final String COMPONENT_PARENT_PARAM_NAME

See Also:

• Constant Field Values

COMPONENT_PARAM_NAME

public static final String COMPONENT_PARAM_NAME

See Also:

• Constant Field Values

COMPONENT_PATH_PARAM_NAME

public static final String COMPONENT_PATH_PARAM_NAME

See Also:

• Constant Field Values

ADDITIONAL_MODEL_PARAM_NAME

public static final String ADDITIONAL_MODEL_PARAM_NAME

See Also:

• Constant Field Values

servletContext

protected jakarta.servlet.ServletContext servletContext

siteItemService

protected SiteItemService siteItemService

modelFactory

protected org.springframework.beans.factory.ObjectFactory<freemarker.template.SimpleHash> modelFactory

templateXPathQuery

protected String templateXPathQuery

templateNamePrefix

protected String templateNamePrefix

templateNameSuffix

protected String templateNameSuffix

includeElementName

protected String includeElementName

componentElementName

protected String componentElementName

scriptResolver

protected SiteItemScriptResolver scriptResolver

Constructor Details

RenderComponentDirective

public RenderComponentDirective(jakarta.servlet.ServletContext servletContext,
 SiteItemService siteItemService,
 org.springframework.beans.factory.ObjectFactory<freemarker.template.SimpleHash> modelFactory,
 String templateXPathQuery,
 String templateNamePrefix,
 String templateNameSuffix,
 String includeElementName,
 String componentElementName,
 SiteItemScriptResolver scriptResolver)

Method Details

execute

public void execute(freemarker.core.Environment env,
 Map params,
 freemarker.template.TemplateModel[] loopVars,
 freemarker.template.TemplateDirectiveBody body)
             throws freemarker.template.TemplateException

Specified by:

execute in interface freemarker.template.TemplateDirectiveModel

Throws:

freemarker.template.TemplateException

getComponentFromNode

protected SiteItem getComponentFromNode(freemarker.template.TemplateModel parentParam,
 freemarker.template.TemplateModel componentParam,
 freemarker.core.Environment env)
                                 throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getComponentFromPath

protected SiteItem getComponentFromPath(freemarker.template.TemplateModel componentPathParam,
 freemarker.core.Environment env)
                                 throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getComponent

protected SiteItem getComponent(String componentPath,
 freemarker.core.Environment env)
                         throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

executeScripts

protected Map<String,Object> executeScripts(SiteItem component,
 Map<String,Object> additionalModel,
 freemarker.core.Environment env)
                                     throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

createScriptVariables

protected Map<String,Object> createScriptVariables(SiteItem component,
 Map<String,Object> templateModel,
 Map<String,Object> additionalModel)

executeScript

protected void executeScript(Script script,
 Map<String,Object> scriptVariables,
 freemarker.core.Environment env)
                      throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getTemplate

protected freemarker.template.Template getTemplate(SiteItem component,
 freemarker.core.Environment env)
                                            throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getComponentTemplateName

protected String getComponentTemplateName(SiteItem component,
 freemarker.core.Environment env)
                                   throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

getFullModel

protected freemarker.template.SimpleHash getFullModel(SiteItem component,
 Map<String,Object> templateModel,
 Map<String,Object> additionalModel)
                                               throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

processComponentTemplate

protected void processComponentTemplate(freemarker.template.Template template,
 freemarker.template.SimpleHash model,
 Writer output,
 freemarker.core.Environment env)
                                 throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException

unwrap

protected <T> T unwrap(String name,
 freemarker.template.TemplateModel value,
 Class<T> expectedClass,
 freemarker.core.Environment env)
                throws freemarker.template.TemplateException

Throws:

freemarker.template.TemplateException