Package org.thymeleaf.engine

Class ElementModelStructureHandler

java.lang.Object

org.thymeleaf.engine.ElementModelStructureHandler

All Implemented Interfaces:

IElementModelStructureHandler

public final class ElementModelStructureHandler
extends java.lang.Object
implements IElementModelStructureHandler

Structure handler implementation, internally used by the engine.

This class should not be directly used from outside the engine.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.Map<java.lang.String,java.lang.Object>	addedLocalVariables
(package private) java.util.Set<java.lang.String>	removedLocalVariableNames
(package private) boolean	removeLocalVariable
(package private) java.lang.Object	selectionTargetObject
(package private) boolean	setInliner
(package private) IInliner	setInlinerValue
(package private) boolean	setLocalVariable
(package private) boolean	setSelectionTarget
(package private) boolean	setTemplateData
(package private) TemplateData	setTemplateDataValue

Constructor Summary

Constructors

Constructor	Description
ElementModelStructureHandler()

Method Summary

Modifier and Type	Method	Description
(package private) void	applyContextModifications(IEngineContext engineContext)
void	removeLocalVariable(java.lang.String name)	Instructs the engine to remove a local variable.
void	reset()	Resets all actions specified so far for the current processor execution.
void	setInliner(IInliner inliner)	Instructs the engine to set a new inliner.
void	setLocalVariable(java.lang.String name, java.lang.Object value)	Instructs the engine to set a new local variable.
void	setSelectionTarget(java.lang.Object selectionTarget)	Instructs the engine to set a new selection target.
void	setTemplateData(TemplateData templateData)	Instructs the engine to set a new template data.

Methods inherited from class java.lang.Object

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

Field Detail

setLocalVariable

boolean setLocalVariable

addedLocalVariables

java.util.Map<java.lang.String,java.lang.Object> addedLocalVariables

removeLocalVariable

boolean removeLocalVariable

removedLocalVariableNames

java.util.Set<java.lang.String> removedLocalVariableNames

setSelectionTarget

boolean setSelectionTarget

selectionTargetObject

java.lang.Object selectionTargetObject

setInliner

boolean setInliner

setInlinerValue

IInliner setInlinerValue

setTemplateData

boolean setTemplateData

setTemplateDataValue

TemplateData setTemplateDataValue

Constructor Detail

ElementModelStructureHandler

ElementModelStructureHandler()

Method Detail

removeLocalVariable

public void removeLocalVariable(java.lang.String name)

Description copied from interface: IElementModelStructureHandler

Instructs the engine to remove a local variable.

Specified by:

removeLocalVariable in interface IElementModelStructureHandler

Parameters:

name - the name of the variable.

setLocalVariable

public void setLocalVariable(java.lang.String name,
                             java.lang.Object value)

Description copied from interface: IElementModelStructureHandler

Instructs the engine to set a new local variable.

Specified by:

setLocalVariable in interface IElementModelStructureHandler

Parameters:

name - the name of the variable.

value - the value of the variable.

setSelectionTarget

public void setSelectionTarget(java.lang.Object selectionTarget)

Description copied from interface: IElementModelStructureHandler

Instructs the engine to set a new selection target.

The selection target is the object on which selection expressions (*{...}) are executed. In the Standard Dialect, this selection target is usually modified by means of the th:object attribute, but custom processors can do it too. Note the selection target has the same scope as a local variable, and will therefore be accessible only inside the body of the element being processed.

See ITemplateContext.getSelectionTarget()

Specified by:

setSelectionTarget in interface IElementModelStructureHandler

Parameters:

selectionTarget - the selection target to be set.

setInliner

public void setInliner(IInliner inliner)

Description copied from interface: IElementModelStructureHandler

Instructs the engine to set a new inliner.

Inliners are used for processing all text nodes (IText events) appearing in the body of the element being processed. This is the mechanism used by the th:inline attribute to enable inlining in any of the specified modes (text, javascript, etc).

See ITemplateContext.getInliner()

Specified by:

setInliner in interface IElementModelStructureHandler

Parameters:

inliner - the inliner.

setTemplateData

public void setTemplateData(TemplateData templateData)

Description copied from interface: IElementModelStructureHandler

Instructs the engine to set a new template data.

This method modifies the metadata about the template that is actually being processed. When inserting fragments, this allows the engine to know data about the specific fragment being processed, and also the complete stack of fragments being nested.

See ITemplateContext.getTemplateData()

Specified by:

setTemplateData in interface IElementModelStructureHandler

Parameters:

templateData - the template data.

reset

public void reset()

Description copied from interface: IElementModelStructureHandler

Resets all actions specified so far for the current processor execution.

Specified by:

reset in interface IElementModelStructureHandler

applyContextModifications

void applyContextModifications(IEngineContext engineContext)