public interface ITemplateBoundariesStructureHandler
Structure handler class meant to be used by ITemplateBoundariesProcessor
implementations.
Structure handlers allow processors to instruct the engine to perform a series of actions that cannot be done directly from the processors themselves, usually because these actions are applied or have effects on scopes broader than the processed events themselves.
ITemplateBoundariesProcessor
Modifier and Type | Method and Description |
---|---|
void |
insert(IModel model,
boolean processable)
Instructs the engine to insert the specified model.
|
void |
insert(String text,
boolean processable)
Instructs the engine to insert the specified text.
|
void |
removeLocalVariable(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(String name,
Object value)
Instructs the engine to set a new local variable.
|
void |
setSelectionTarget(Object selectionTarget)
Instructs the engine to set a new selection target.
|
void reset()
Resets all actions specified so far for the current processor execution.
void setLocalVariable(String name, Object value)
Instructs the engine to set a new local variable.
name
- the name of the variable.value
- the value of the variable.void removeLocalVariable(String name)
Instructs the engine to remove a local variable.
name
- the name of the variable.void setSelectionTarget(Object selectionTarget)
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.
selectionTarget
- the selection target to be set.void setInliner(IInliner inliner)
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).
inliner
- the inliner.void insert(String text, boolean processable)
Instructs the engine to insert the specified text.
If the processed event is a ITemplateStart
event, then the text will
be inserted at the beginning of the template (just after the template start event). On the other
hand, if the processed event is a ITemplateEnd
event, then the text
will be inserted at the end of the template (just before the template end event).
text
- the text to be inserted.processable
- whether the inserted text should be considered processable or not.void insert(IModel model, boolean processable)
Instructs the engine to insert the specified model.
If the processed event is a ITemplateStart
event, then the model will
be inserted at the beginning of the template (just after the template start event). On the other
hand, if the processed event is a ITemplateEnd
event, then the model
will be inserted at the end of the template (just before the template end event).
model
- the model to be inserted.processable
- whether the inserted text should be considered processable or not.Copyright © 2017 The THYMELEAF team. All rights reserved.