org.thymeleaf.processor.text

Interface ITextStructureHandler

All Known Implementing Classes:

TextStructureHandler

public interface ITextStructureHandler

Structure handler class meant to be used by ITextProcessor 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.

Since:

3.0.0

Author:

Daniel Fernández

See Also:

ITextProcessor

Method Summary

Modifier and Type	Method and Description
void	removeText() Instructs the engine to remove the entire event that is being processed.
void	replaceWith(IModel model, boolean processable) Instructs the engine to replace the current event with the specified model (a IModel).
void	reset() Resets all actions specified so far for the current processor execution.
void	setText(CharSequence text) Instructs the engine to set a new text for this Text event.

Method Detail

reset

void reset()

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

setText

void setText(CharSequence text)

Instructs the engine to set a new text for this Text event.

Parameters:

text - the new text

replaceWith

void replaceWith(IModel model,
                 boolean processable)

Instructs the engine to replace the current event with the specified model (a IModel).

Parameters:

model - the model to be used as a replacement.

processable - whether the model should be considered processable or not.

removeText

void removeText()

Instructs the engine to remove the entire event that is being processed.