Index (Thymeleaf Layout Dialect 2.1.1 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

add(IModel) - Method in ModelBuilder: Appends an existing model to the model being built.
AppendingStrategy - Class in nz.net.ultraq.thymeleaf.decorators.strategies: The standard <head> merging strategy, which simply appends the content elements to the layout ones.
apply() - Method in IAttributeExtensions: Apply extensions to the IAttribute class.
apply() - Method in ICloseElementTagExtensions: Apply extensions to the ICloseElement class.
apply() - Method in IContextExtensions: Apply extensions to the IContext class.
apply() - Method in IModelExtensions: Applies several new methods to the IModel class.
apply() - Method in IOpenElementTagExtensions: Apply extensions to the IOpenElementTag class.
apply() - Method in IStandaloneElementTagExtensions: Apply extensions to the IStandaloneElementTag class.
apply() - Method in ITemplateEventExtensions: Apply extensions to the ITemplateEvent class.
apply() - Method in ITextExtensions: Apply extensions to the IText class.
apply() - Method in TemplateModelExtensions: Apply extensions to the TemplateModel class.
AttributeMerger - Class in nz.net.ultraq.thymeleaf.models: Merges attributes from one element into another.
AttributeMerger(ITemplateContext) - Constructor in AttributeMerger: Constructor, sets up the attribute merger context.

B

build(Closure) - Method in ModelBuilder: Captures the top `build` call so that it doesn't end up as a node in the final model.

C

ChildModelIterator - Class in nz.net.ultraq.thymeleaf.models.extensions: This class provides a way for working with a model's immediate children, by converting events into sub-models of their own.
ChildModelIterator(IModel) - Constructor in ChildModelIterator: Constructor, sets the model to iterate over.
context - Field in XmlDocumentDecorator
ContextCreationProcessor - Class in nz.net.ultraq.thymeleaf.context: A processor whose only job is to initialize the layout context.
ContextCreationProcessor(TemplateMode) - Constructor in ContextCreationProcessor: Constructor, sets the template mode of the processor.
createNode(Object, Map, Object) - Method in ModelBuilder: Create a model for the given element, attributes, and inner text content.

D

decorate(IModel, IModel) - Method in Decorator: Decorate the target model with the contents of the source model, returning a new model that is the result of that decoration.
decorate(IModel, IModel) - Method in HtmlBodyDecorator: Decorate the <body> part.
decorate(IModel, IModel) - Method in HtmlDocumentDecorator: Decorate an entire HTML page.
decorate(IModel, IModel) - Method in HtmlHeadDecorator: Decorate the <head> part.
decorate(IModel, IModel) - Method in HtmlTitleDecorator: Special decorator for the <title> part, accumulates the important processing parts for the layout:title-pattern processor.
decorate(IModel, IModel) - Method in XmlDocumentDecorator: Decorates the target XML document with the source one.
DecorateProcessor - Class in nz.net.ultraq.thymeleaf.decorators: Specifies the name of the template to decorate using the current template.
DecorateProcessor(TemplateMode, String, SortingStrategy, String) - Constructor in DecorateProcessor: Constructor, configurable processor name for the purposes of the deprecated layout:decorator alias.
Decorator - Interface in nz.net.ultraq.thymeleaf.decorators: A decorator performs decoration of a target model, using a source model for all the decorations to apply.
DecoratorProcessor - Class in nz.net.ultraq.thymeleaf.decorators: An alias of the DecorateProcessor to warn people that the layout:decorator/data-layout-decorator processor has been renamed.
DecoratorProcessor(TemplateMode, String, SortingStrategy) - Constructor in DecoratorProcessor: Constructor, configure this processor to work on the old 'decorator' attribute and to use the given sorting strategy.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in DecorateProcessor: Locates the template to decorate and, once decorated, inserts it into the processing chain.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in DecoratorProcessor: Logs a deprecation warning before delegating to the decorate processor.
doProcess(ITemplateContext, IProcessableElementTag, AttributeName, String, IElementTagStructureHandler) - Method in FragmentProcessor: Inserts the content of fragments into the encountered fragment placeholder.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in IncludeProcessor: Locates a page fragment and includes it in the current template.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in InsertProcessor: Locates a page fragment and inserts it in the current template.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in ReplaceProcessor: Locates a page fragment and uses it to replace the current element.
doProcess(ITemplateContext, IProcessableElementTag, AttributeName, String, IElementTagStructureHandler) - Method in TitlePatternProcessor: Process the layout:title-pattern directive, replaces the title text with the titles from the content and layout pages.
doProcessTemplateEnd(ITemplateContext, ITemplateEnd, ITemplateBoundariesStructureHandler) - Method in ContextCreationProcessor: Does nothing.
doProcessTemplateStart(ITemplateContext, ITemplateStart, ITemplateBoundariesStructureHandler) - Method in ContextCreationProcessor: Creates and sets the layout context on the template context so it's available everywhere else on the template.

E

ElementMerger - Class in nz.net.ultraq.thymeleaf.models: Merges an element and all its children into an existing element.
ElementMerger(ITemplateContext) - Constructor in ElementMerger: Constructor, sets up the element merger context.
extract(String) - Method in FragmentParameterNamesExtractor: Returns a list of parameter names for the given fragment definition.

F

findFragment(String, String, String) - Method in TemplateModelFinder: Return the model specified by the template and fragment name parameters.
findFragments(IModel) - Method in FragmentFinder: Find and return models for layout dialect fragments within the scope of the given model, without delving into layout:include or layout:replace elements, mapped by the name of each fragment.
findPositionForModel(IModel, IModel) - Method in AppendingStrategy: Returns the position at the end of the <head> section.
findPositionForModel(IModel, IModel) - Method in GroupingStrategy: Returns the index of the last set of elements that are of the same 'type' as the content node.
findPositionForModel(IModel, IModel) - Method in SortingStrategy: Returns the position in a <head> element model to insert a child model.
findTemplate(String) - Method in TemplateModelFinder: Return a model for the template specified by the given template name.
forContext(IContext) - Method in LayoutContext: Retrieve the layout dialect context on the Thymeleaf context.
FragmentFinder - Class in nz.net.ultraq.thymeleaf.fragments: Searches for and returns layout dialect fragments within a given scope/element.
FragmentFinder(String) - Constructor in FragmentFinder: Constructor, create a new fragment finder to search for fragments using the given prefix as the one configured for the layout dialect.
FragmentMap - Class in nz.net.ultraq.thymeleaf.fragments: Holds the layout fragments encountered across layout and content templates for later use.
FragmentParameterNamesExtractor - Class in nz.net.ultraq.thymeleaf.fragments: Extracts just the parameter names from a fragment definition.
FragmentProcessor - Class in nz.net.ultraq.thymeleaf.fragments: This processor serves a dual purpose: to mark sections of the template that can be replaced, and to do the replacing when they're encountered.
FragmentProcessor(TemplateMode, String) - Constructor in FragmentProcessor: Constructor, sets this processor to work on the 'fragment' attribute.

G

get(IContext) - Method in FragmentMap: Retrieves either the fragment map for the current context, or returns a new fragment map.
getProcessors(String) - Method in LayoutDialect: Returns the layout dialect's processors.
GroupingStrategy - Class in nz.net.ultraq.thymeleaf.decorators.strategies: The <head> merging strategy which groups like elements together.

H

hasNext() - Method in ChildModelIterator: Returns whether or not there is another model to be retrieved.
HtmlBodyDecorator - Class in nz.net.ultraq.thymeleaf.decorators.html: A decorator specific to processing an HTML <body> element.
HtmlBodyDecorator(ITemplateContext) - Constructor in HtmlBodyDecorator: Constructor, sets up the element decorator context.
HtmlDocumentDecorator - Class in nz.net.ultraq.thymeleaf.decorators.html: A decorator made to work over an HTML document.
HtmlDocumentDecorator(ITemplateContext, SortingStrategy) - Constructor in HtmlDocumentDecorator: Constructor, apply the given sorting strategy to the decorator.
HtmlHeadDecorator - Class in nz.net.ultraq.thymeleaf.decorators.html: A decorator specific to processing an HTML <head> element.
HtmlHeadDecorator(ITemplateContext, SortingStrategy) - Constructor in HtmlHeadDecorator: Constructor, sets up the decorator context.
HtmlTitleDecorator - Class in nz.net.ultraq.thymeleaf.decorators.html: Decorator for the <title> part of the template to handle the special processing required for the layout:title-pattern processor.
HtmlTitleDecorator(ITemplateContext) - Constructor in HtmlTitleDecorator: Constructor, sets up the decorator context.

I

IAttributeExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the IAttribute class.
ICloseElementTagExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the ICloseElementTag class.
IContextExtensions - Class in nz.net.ultraq.thymeleaf.context.extensions: Meta-programming extensions to the IContext class.
IModelExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the IModel class.
IncludeProcessor - Class in nz.net.ultraq.thymeleaf.includes: Similar to Thymeleaf's th:include, but allows the passing of entire element fragments to the included template.
IncludeProcessor(TemplateMode, String) - Constructor in IncludeProcessor: Constructor, sets this processor to work on the 'include' attribute.
InsertProcessor - Class in nz.net.ultraq.thymeleaf.includes: Similar to Thymeleaf's th:insert, but allows the passing of entire element fragments to the included template.
InsertProcessor(TemplateMode, String) - Constructor in InsertProcessor: Constructor, sets this processor to work on the 'insert' attribute.
IOpenElementTagExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the IOpenElementTag class.
IStandaloneElementTagExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the IStandaloneElementTag class.
ITemplateEventExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the ITemplateEvent class.
ITextExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the IText class.

J

K

L

LayoutContext - Class in nz.net.ultraq.thymeleaf.context: Map of data and values that are passed around the layout dialect, exposed so that others can make use of the properties.
LayoutDialect - Class in nz.net.ultraq.thymeleaf: A dialect for Thymeleaf that lets you build layouts and reusable templates in order to improve code reuse
LayoutDialect(SortingStrategy) - Constructor in LayoutDialect: Constructor, configure the layout dialect with the given sorting strategy.

M

merge(IModel, IModel) - Method in AttributeMerger: Merge the attributes of the source element with those of the target element.
merge(IModel, IModel) - Method in ElementMerger: Replace the content of the target element, with the content of the source element.
merge(IModel, IModel) - Method in ModelMerger: Merge the source model into the target model.
merge(String, String) - Method in VariableDeclarationMerger: Merge th:with attributes so that names from the source value overwrite the same names in the target value.
ModelBuilder - Class in nz.net.ultraq.thymeleaf.models: Create Thymeleaf 3 models using the Groovy builder syntax.
ModelBuilder(IModelFactory, ElementDefinitions, TemplateMode) - Constructor in ModelBuilder: Constructor, create a new model builder.
ModelMerger - Interface in nz.net.ultraq.thymeleaf.models: Merges template models by applying the source model to the target model, with the result being implementation-dependant.

N

next() - Method in ChildModelIterator: Returns the next immediate child model of this model.
nodeCompleted(Object, Object) - Method in ModelBuilder: Link a parent and child node.

O

P

parse(String) - Method in VariableDeclarationParser: Parse a variable declaration string, returning as many variable declaration objects as there are variable declarations.

Q

R

remove() - Method in ChildModelIterator: Not applicable for this iterator.
ReplaceProcessor - Class in nz.net.ultraq.thymeleaf.includes: Similar to Thymeleaf's th:replace, but allows the passing of entire element fragments to the included template.
ReplaceProcessor(TemplateMode, String) - Constructor in ReplaceProcessor: Constructor, set this processor to work on the 'replace' attribute.

S

setForNode(IContext, IElementModelStructureHandler, Map<String, IModel>) - Method in FragmentMap: Set the fragment collection to contain whatever it initially had, plus the given fragments, just for the scope of the current node.
setParent(Object, Object) - Method in ModelBuilder: Does nothing.
SortingStrategy - Interface in nz.net.ultraq.thymeleaf.decorators: Interface for controlling the sort order in which <head> elements from one source are placed into another.

T

TemplateModelExtensions - Class in nz.net.ultraq.thymeleaf.models.extensions: Meta-programming extensions to the TemplateModel class.
TemplateModelFinder - Class in nz.net.ultraq.thymeleaf.models: A simple API for retrieving (immutable template) models using Thymeleaf's template manager.
TemplateModelFinder(ITemplateContext) - Constructor in TemplateModelFinder: Constructor, set the template context we're working in.
Title - Class in nz.net.ultraq.thymeleaf.decorators: Describes a title component.
TitlePatternProcessor - Class in nz.net.ultraq.thymeleaf.decorators: Allows for greater control of the resulting <title> element by specifying a pattern with some special tokens.
TitlePatternProcessor(TemplateMode, String) - Constructor in TitlePatternProcessor: Constructor, sets this processor to work on the 'title-pattern' attribute.
toString() - Method in VariableDeclaration: Reconstructs the variable for use with th:with.

U

V

VariableDeclaration - Class in nz.net.ultraq.thymeleaf.models: Representation of a scoped variable declaration made through th:with attributes.
VariableDeclaration(Assignation) - Constructor in VariableDeclaration: Constructor, create an instance from a Thymeleaf assignation.
VariableDeclarationMerger - Class in nz.net.ultraq.thymeleaf.models: Merges variable declarations in a th:with attribute processor, taking the declarations in the target and combining them with the declarations in the source, overriding any same-named declarations in the target.
VariableDeclarationMerger(IExpressionContext) - Constructor in VariableDeclarationMerger: Constructor, sets the processing context for the merger.
VariableDeclarationParser - Class in nz.net.ultraq.thymeleaf.models: Parser for variable declaration strings, which are the expressions that are found withing th:with processors.
VariableDeclarationParser(IExpressionContext) - Constructor in VariableDeclarationParser: Constructor, sets the processing context for the parser.

W

X

XmlDocumentDecorator - Class in nz.net.ultraq.thymeleaf.decorators.xml: A decorator made to work over an XML document.
XmlDocumentDecorator(ITemplateContext) - Constructor in XmlDocumentDecorator: Constructor, set up the document decorator context.