org.jahia.modules.macros.filter

Class MacrosFilter

java.lang.Object

org.jahia.services.render.filter.AbstractFilter

org.jahia.modules.macros.filter.MacrosFilter

All Implemented Interfaces:

Comparable<org.jahia.services.render.filter.RenderFilter>, EventListener, org.jahia.services.render.filter.RenderFilter, org.jahia.services.render.filter.RenderServiceAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.jahia.services.templates.JahiaTemplateManagerService.TemplatePackageRedeployedEvent>

public class MacrosFilter
extends org.jahia.services.render.filter.AbstractFilter
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.jahia.services.templates.JahiaTemplateManagerService.TemplatePackageRedeployedEvent>

Render filter that searches for known macros in the generated HTML output and evaluates them.

Since:

JAHIA 6.5 Created : 21/12/10

Author:

rincevent

Nested Class Summary

Nested classes/interfaces inherited from class org.jahia.services.render.filter.AbstractFilter

org.jahia.services.render.filter.AbstractFilter.AjaxRequestCondition, org.jahia.services.render.filter.AbstractFilter.AnyOfCondition, org.jahia.services.render.filter.AbstractFilter.ConfigurationCondition, org.jahia.services.render.filter.AbstractFilter.EditModeCondition, org.jahia.services.render.filter.AbstractFilter.ExecutionCondition, org.jahia.services.render.filter.AbstractFilter.MainResourceCondition, org.jahia.services.render.filter.AbstractFilter.ModeCondition, org.jahia.services.render.filter.AbstractFilter.ModuleCondition, org.jahia.services.render.filter.AbstractFilter.NodeTypeCondition, org.jahia.services.render.filter.AbstractFilter.NotCondition, org.jahia.services.render.filter.AbstractFilter.PatternCondition, org.jahia.services.render.filter.AbstractFilter.RequestAttributeCondition, org.jahia.services.render.filter.AbstractFilter.RequestCondition, org.jahia.services.render.filter.AbstractFilter.RequestHeaderCondition, org.jahia.services.render.filter.AbstractFilter.RequestParameterCondition, org.jahia.services.render.filter.AbstractFilter.SiteTemplateSetCondition, org.jahia.services.render.filter.AbstractFilter.TemplateCondition, org.jahia.services.render.filter.AbstractFilter.TemplateTypeCondition

Field Summary

Fields inherited from class org.jahia.services.render.filter.AbstractFilter

service

Constructor Summary

Constructors

Constructor and Description
MacrosFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	execute(String previousOut, org.jahia.services.render.RenderContext renderContext, org.jahia.services.render.Resource resource, org.jahia.services.render.filter.RenderChain chain)
protected String[]	getMacro(String macroName, org.jahia.services.render.RenderContext renderContext)
void	onApplicationEvent(org.jahia.services.templates.JahiaTemplateManagerService.TemplatePackageRedeployedEvent event)
void	setMacroLookupPath(String macroLookupPath)
void	setMacrosRegexp(String macrosRegexp)
void	setReplaceByErrorMessageOnMissingMacros(boolean replaceByErrorMessageOnMissingMacros)
void	setScriptEngineUtils(org.jahia.utils.ScriptEngineUtils scriptEngineUtils)

Methods inherited from class org.jahia.services.render.filter.AbstractFilter

addCondition, addCondition, areConditionsMatched, compareTo, equals, finalize, getConditionsSummary, getContentForError, getDescription, getPriority, hashCode, isDisabled, prepare, setApplyOnConfigurations, setApplyOnEditMode, setApplyOnMainResource, setApplyOnModes, setApplyOnModules, setApplyOnNodeTypes, setApplyOnSiteTemplateSets, setApplyOnTemplates, setApplyOnTemplateTypes, setConditions, setDescription, setDisabled, setPriority, setRenderService, setSkipOnAjaxRequest, setSkipOnConfiguration, setSkipOnConfigurations, setSkipOnEditMode, setSkipOnMainResource, setSkipOnModes, setSkipOnModules, setSkipOnNodeTypes, setSkipOnTemplates, setSkipOnTemplateTypes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MacrosFilter

public MacrosFilter()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

execute

public String execute(String previousOut,
             org.jahia.services.render.RenderContext renderContext,
             org.jahia.services.render.Resource resource,
             org.jahia.services.render.filter.RenderChain chain)
               throws Exception

Specified by:

execute in interface org.jahia.services.render.filter.RenderFilter

Overrides:

execute in class org.jahia.services.render.filter.AbstractFilter

Throws:

Exception

getMacro

protected String[] getMacro(String macroName,
                org.jahia.services.render.RenderContext renderContext)

onApplicationEvent

public void onApplicationEvent(org.jahia.services.templates.JahiaTemplateManagerService.TemplatePackageRedeployedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.jahia.services.templates.JahiaTemplateManagerService.TemplatePackageRedeployedEvent>

setMacroLookupPath

public void setMacroLookupPath(String macroLookupPath)

setMacrosRegexp

public void setMacrosRegexp(String macrosRegexp)

setScriptEngineUtils

public void setScriptEngineUtils(org.jahia.utils.ScriptEngineUtils scriptEngineUtils)

setReplaceByErrorMessageOnMissingMacros

public void setReplaceByErrorMessageOnMissingMacros(boolean replaceByErrorMessageOnMissingMacros)