Index (Thymeleaf Layout Dialect 2.0.0 API)

A C D E F G H I L M N P R S T V X

A

AppendingStrategy - Class in nz.net.ultraq.thymeleaf.decorators.strategies: The standard <head> merging strategy, which simply appends the content elements to the layout ones.
AppendingStrategy() - Constructor for class nz.net.ultraq.thymeleaf.decorators.strategies.AppendingStrategy
AttributeMerger - Class in nz.net.ultraq.thymeleaf.models: Merges attributes from one element into another.
AttributeMerger(IModelFactory) - Constructor for class nz.net.ultraq.thymeleaf.models.AttributeMerger: Constructor, sets up the attribute merger tools.

C

ChildEventIterator - Class in nz.net.ultraq.thymeleaf.models.extensions: An iterator over a model's child events, if that model represents an element with open/close tags at either end.
ChildEventIterator(IModel) - Constructor for class nz.net.ultraq.thymeleaf.models.extensions.ChildEventIterator: Constructor, sets the model to iterate over.
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 for class nz.net.ultraq.thymeleaf.models.extensions.ChildModelIterator: Constructor, sets the model to iterate over.
CONTENT_TITLE_ATTRIBUTE - Static variable in class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor
context - Variable in class nz.net.ultraq.thymeleaf.decorators.xml.XmlDocumentDecorator
CONTEXT_KEY - Static variable in class nz.net.ultraq.thymeleaf.context.LayoutContext
CONTEXT_RESULTING_TITLE - Static variable in class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor
ContextCreationProcessor - Class in nz.net.ultraq.thymeleaf.context: A processor whose only job is to initialize the layout context.
ContextCreationProcessor(TemplateMode) - Constructor for class nz.net.ultraq.thymeleaf.context.ContextCreationProcessor: Constructor, sets the template mode of the processor.

D

decorate(IModel, IModel) - Method in interface nz.net.ultraq.thymeleaf.decorators.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 class nz.net.ultraq.thymeleaf.decorators.html.HtmlBodyDecorator: Decorate the <body> part.
decorate(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.decorators.html.HtmlDocumentDecorator: Decorate an entire HTML page.
decorate(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.decorators.html.HtmlHeadDecorator: Decorate the <head> part.
decorate(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.decorators.html.HtmlTitleDecorator: Special decorator for the <title> part, accumulates the important processing parts for the layout:title-pattern processor.
decorate(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.decorators.xml.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) - Constructor for class nz.net.ultraq.thymeleaf.decorators.DecorateProcessor: Constructor, configure this processor to work on the 'decorate' attribute and to use the given sorting strategy.
DecorateProcessor(TemplateMode, String, SortingStrategy, String) - Constructor for class nz.net.ultraq.thymeleaf.decorators.DecorateProcessor: Constructor, configurable processor name so that I could support 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: Deprecated.
DecoratorProcessor(TemplateMode, String, SortingStrategy) - Constructor for class nz.net.ultraq.thymeleaf.decorators.DecoratorProcessor: Deprecated.

Constructor, configure this processor to work on the old 'decorator' attribute and to use the given sorting strategy.
DIALECT_NAME - Static variable in class nz.net.ultraq.thymeleaf.LayoutDialect
DIALECT_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.LayoutDialect
DIALECT_PREFIX - Static variable in class nz.net.ultraq.thymeleaf.LayoutDialect
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in class nz.net.ultraq.thymeleaf.decorators.DecorateProcessor: Locates the template to decorate and, once decorated, inserts it into the processing chain.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in class nz.net.ultraq.thymeleaf.decorators.DecoratorProcessor: Deprecated.

Logs a deprecation warning before delegating to the decorate processor.
doProcess(ITemplateContext, IProcessableElementTag, AttributeName, String, IElementTagStructureHandler) - Method in class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor: Process the layout:title-pattern directive, replaces the title text with the titles from the content and layout pages.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in class nz.net.ultraq.thymeleaf.fragments.FragmentProcessor: Inserts the content of fragments into the encountered fragment placeholder.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in class nz.net.ultraq.thymeleaf.includes.IncludeProcessor: Deprecated.

Locates a page fragment and includes it in the current template.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in class nz.net.ultraq.thymeleaf.includes.InsertProcessor: Locates a page fragment and inserts it in the current template.
doProcess(ITemplateContext, IModel, AttributeName, String, IElementModelStructureHandler) - Method in class nz.net.ultraq.thymeleaf.includes.ReplaceProcessor: Locates a page fragment and uses it to replace the current element.
doProcessTemplateEnd(ITemplateContext, ITemplateEnd, ITemplateBoundariesStructureHandler) - Method in class nz.net.ultraq.thymeleaf.context.ContextCreationProcessor: Does nothing.
doProcessTemplateStart(ITemplateContext, ITemplateStart, ITemplateBoundariesStructureHandler) - Method in class nz.net.ultraq.thymeleaf.context.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(IModelFactory) - Constructor for class nz.net.ultraq.thymeleaf.models.ElementMerger: Constructor, sets up the element merger tools.
ExpressionProcessor - Class in nz.net.ultraq.thymeleaf.expressions: A simplified API for working with Thymeleaf expressions.
ExpressionProcessor(IExpressionContext) - Constructor for class nz.net.ultraq.thymeleaf.expressions.ExpressionProcessor: Constructor, sets the execution context.
extract(String) - Method in class nz.net.ultraq.thymeleaf.fragments.FragmentParameterNamesExtractor: Returns a list of parameter names for the given fragment definition.

F

findFragment(FragmentExpression, String) - Method in class nz.net.ultraq.thymeleaf.models.TemplateModelFinder: Return the model specified by the given fragment expression.
findFragment(String, String, String) - Method in class nz.net.ultraq.thymeleaf.models.TemplateModelFinder: Return the model specified by the given fragment expression.
findFragments(IModel) - Method in class nz.net.ultraq.thymeleaf.fragments.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 interface nz.net.ultraq.thymeleaf.decorators.SortingStrategy: Returns the position in a <head> element model to insert a child model.
findPositionForModel(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.decorators.strategies.AppendingStrategy: Returns the position at the end of the <head> section.
findPositionForModel(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.decorators.strategies.GroupingStrategy: Returns the index of the last set of elements that are of the same 'type' as the content node.
findTemplate(FragmentExpression) - Method in class nz.net.ultraq.thymeleaf.models.TemplateModelFinder: Return a model for the template specified by the given fragment expression.
findTemplate(String) - Method in class nz.net.ultraq.thymeleaf.models.TemplateModelFinder: Return a model for the template specified by the given template name.
forContext(IContext) - Static method in class nz.net.ultraq.thymeleaf.context.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 for class nz.net.ultraq.thymeleaf.fragments.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/decorator and content templates for use later.
FragmentMap() - Constructor for class nz.net.ultraq.thymeleaf.fragments.FragmentMap
FragmentParameterNamesExtractor - Class in nz.net.ultraq.thymeleaf.fragments: Extracts just the parameter names from a fragment definition.
FragmentParameterNamesExtractor() - Constructor for class nz.net.ultraq.thymeleaf.fragments.FragmentParameterNamesExtractor
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 for class nz.net.ultraq.thymeleaf.fragments.FragmentProcessor: Constructor, sets this processor to work on the 'fragment' attribute.

G

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

H

hasNext() - Method in class nz.net.ultraq.thymeleaf.models.extensions.ChildEventIterator: Returns whether or not there is another event to be retrieved.
hasNext() - Method in class nz.net.ultraq.thymeleaf.models.extensions.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(IModelFactory) - Constructor for class nz.net.ultraq.thymeleaf.decorators.html.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 for class nz.net.ultraq.thymeleaf.decorators.html.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 for class nz.net.ultraq.thymeleaf.decorators.html.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 for class nz.net.ultraq.thymeleaf.decorators.html.HtmlTitleDecorator: Constructor, sets up the decorator context.

I

IncludeProcessor - Class in nz.net.ultraq.thymeleaf.includes: Deprecated.
Use InsertProcessor (layout:insert) instead.
IncludeProcessor(TemplateMode, String) - Constructor for class nz.net.ultraq.thymeleaf.includes.IncludeProcessor: Deprecated.

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 for class nz.net.ultraq.thymeleaf.includes.InsertProcessor: Constructor, sets this processor to work on the 'insert' attribute.

L

LAYOUT_TITLE_ATTRIBUTE - Static variable in class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor
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.
LayoutContext() - Constructor for class nz.net.ultraq.thymeleaf.context.LayoutContext
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 for class nz.net.ultraq.thymeleaf.LayoutDialect: Constructor, configure the layout dialect with the given sorting strategy.
LayoutDialect() - Constructor for class nz.net.ultraq.thymeleaf.LayoutDialect

M

merge(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.models.AttributeMerger: Merge the attributes of the source element with those of the target element.
merge(IModel, IModel) - Method in class nz.net.ultraq.thymeleaf.models.ElementMerger: Replace the content of the target element, with the content of the source element.
merge(IModel, IModel) - Method in interface nz.net.ultraq.thymeleaf.models.ModelMerger: Merge the source model into the target model.
merge(String, String) - Method in class nz.net.ultraq.thymeleaf.models.VariableDeclarationMerger: Merge th:with attributes so that names from the source value overwrite the same names in the target value.
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 class nz.net.ultraq.thymeleaf.models.extensions.ChildEventIterator: Returns the next event of this model.
next() - Method in class nz.net.ultraq.thymeleaf.models.extensions.ChildModelIterator: Returns the next immediate child model of this model.
nz.net.ultraq.thymeleaf - package nz.net.ultraq.thymeleaf
nz.net.ultraq.thymeleaf.context - package nz.net.ultraq.thymeleaf.context
nz.net.ultraq.thymeleaf.decorators - package nz.net.ultraq.thymeleaf.decorators
nz.net.ultraq.thymeleaf.decorators.html - package nz.net.ultraq.thymeleaf.decorators.html
nz.net.ultraq.thymeleaf.decorators.strategies - package nz.net.ultraq.thymeleaf.decorators.strategies
nz.net.ultraq.thymeleaf.decorators.xml - package nz.net.ultraq.thymeleaf.decorators.xml
nz.net.ultraq.thymeleaf.expressions - package nz.net.ultraq.thymeleaf.expressions
nz.net.ultraq.thymeleaf.fragments - package nz.net.ultraq.thymeleaf.fragments
nz.net.ultraq.thymeleaf.includes - package nz.net.ultraq.thymeleaf.includes
nz.net.ultraq.thymeleaf.models - package nz.net.ultraq.thymeleaf.models
nz.net.ultraq.thymeleaf.models.extensions - package nz.net.ultraq.thymeleaf.models.extensions

P

parse(String) - Method in class nz.net.ultraq.thymeleaf.expressions.ExpressionProcessor: Parses an expression, returning the matching expression type.
parseFragmentExpression(String) - Method in class nz.net.ultraq.thymeleaf.expressions.ExpressionProcessor: Parses an expression under the assumption it is a fragment expression.
process(String) - Method in class nz.net.ultraq.thymeleaf.expressions.ExpressionProcessor: Parses and executes an expression, returning the result of the expression having been parsed and executed.
processAsString(String) - Method in class nz.net.ultraq.thymeleaf.expressions.ExpressionProcessor: Parse and execute an expression, returning the result as a string.
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.decorators.DecorateProcessor
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.decorators.DecoratorProcessor: Deprecated.
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.fragments.FragmentProcessor
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.includes.IncludeProcessor: Deprecated.
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.includes.InsertProcessor
PROCESSOR_NAME - Static variable in class nz.net.ultraq.thymeleaf.includes.ReplaceProcessor
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.context.ContextCreationProcessor
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.decorators.DecorateProcessor
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.fragments.FragmentProcessor
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.includes.IncludeProcessor: Deprecated.
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.includes.InsertProcessor
PROCESSOR_PRECEDENCE - Static variable in class nz.net.ultraq.thymeleaf.includes.ReplaceProcessor

R

remove() - Method in class nz.net.ultraq.thymeleaf.models.extensions.ChildEventIterator: Not applicable for this iterator.
remove() - Method in class nz.net.ultraq.thymeleaf.models.extensions.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 for class nz.net.ultraq.thymeleaf.includes.ReplaceProcessor: Constructor, set this processor to work on the 'replace' attribute.

S

setForNode(IContext, IElementModelStructureHandler, Map<String, IModel>) - Static method in class nz.net.ultraq.thymeleaf.fragments.FragmentMap: Set the fragment collection to contain whatever it initially had, plus the given fragments, just for the scope of the current node.
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

TemplateModelFinder - Class in nz.net.ultraq.thymeleaf.models: A simple API for retrieving (immutable template) models using Thymeleaf's template manager.
TemplateModelFinder(ITemplateContext) - Constructor for class nz.net.ultraq.thymeleaf.models.TemplateModelFinder: Constructor, set the template context we're working in.
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 for class nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor: Constructor, sets this processor to work on the 'title-pattern' attribute.
toString() - Method in class nz.net.ultraq.thymeleaf.models.VariableDeclaration: Reconstructs the variable for use with th:with.

V

VariableDeclaration - Class in nz.net.ultraq.thymeleaf.models: Representation of a scoped variable declaration made through th:with attributes.
VariableDeclaration(String) - Constructor for class nz.net.ultraq.thymeleaf.models.VariableDeclaration: Constructor, create an instance from the declaration string.
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() - Constructor for class nz.net.ultraq.thymeleaf.models.VariableDeclarationMerger

X

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

A C D E F G H I L M N P R S T V X