From bcce46838c125e4b0b40e3b91984ec35bf9f1f18 Mon Sep 17 00:00:00 2001 From: Emanuel Rabina Date: Sat, 1 Feb 2025 16:19:09 +1300 Subject: [PATCH] 'Update docs' --- Gemfile | 8 + Gemfile.lock | 87 + _config.yml | 15 + _sass/color_schemes/thymeleaf.scss | 2 + _sass/custom/custom.scss | 21 + configuration-options.md | 102 + favicon.ico | Bin 0 -> 5430 bytes getting-started.md | 62 + groovydoc/allclasses-frame.html | 81 + groovydoc/deprecated-list.html | 130 + groovydoc/groovy.ico | Bin 0 -> 9662 bytes groovydoc/help-doc.html | 196 ++ groovydoc/index-all.html | 886 +++++++ groovydoc/index.html | 90 + groovydoc/inherit.gif | Bin 0 -> 57 bytes .../layoutdialect/LayoutDialect.html | 424 +++ .../layoutdialect/PojoLoggerFactory.html | 310 +++ .../decorators/DecorateProcessor.html | 371 +++ .../layoutdialect/decorators/Decorator.html | 244 ++ .../decorators/SortingStrategy.html | 243 ++ .../decorators/TitlePatternProcessor.html | 383 +++ .../decorators/TitleProcessor.html | 384 +++ .../decorators/html/HtmlBodyDecorator.html | 346 +++ .../html/HtmlDocumentDecorator.html | 384 +++ .../decorators/html/HtmlHeadDecorator.html | 372 +++ .../decorators/html/HtmlTitleDecorator.html | 361 +++ .../decorators/html/package-frame.html | 58 + .../decorators/html/package-summary.html | 170 ++ .../decorators/package-frame.html | 66 + .../decorators/package-summary.html | 199 ++ .../strategies/AppendingStrategy.html | 306 +++ .../strategies/GroupingStrategy.html | 308 +++ .../decorators/strategies/package-frame.html | 58 + .../strategies/package-summary.html | 153 ++ .../decorators/xml/XmlDocumentDecorator.html | 346 +++ .../decorators/xml/package-frame.html | 58 + .../decorators/xml/package-summary.html | 144 + .../extensions/FragmentExtensions.html | 359 +++ .../extensions/IAttributeExtensions.html | 304 +++ .../ICloseElementTagExtensions.html | 300 +++ .../extensions/IContextExtensions.html | 334 +++ .../extensions/IModelExtensions.html | 696 +++++ .../IProcessableElementTagExtensions.html | 318 +++ .../IStandaloneElementTagExtensions.html | 300 +++ .../extensions/ITemplateEventExtensions.html | 333 +++ .../extensions/ITextExtensions.html | 313 +++ .../extensions/package-frame.html | 58 + .../extensions/package-summary.html | 208 ++ .../fragments/CollectFragmentProcessor.html | 369 +++ .../fragments/FragmentFinder.html | 345 +++ .../FragmentParameterNamesExtractor.html | 300 +++ .../FragmentParameterVariableUpdater.html | 356 +++ .../fragments/FragmentProcessor.html | 353 +++ .../fragments/package-frame.html | 58 + .../fragments/package-summary.html | 180 ++ .../includes/IncludeProcessor.html | 356 +++ .../includes/InsertProcessor.html | 355 +++ .../includes/ReplaceProcessor.html | 355 +++ .../layoutdialect/includes/package-frame.html | 58 + .../includes/package-summary.html | 163 ++ .../layoutdialect/models/AttributeMerger.html | 351 +++ .../models/ChildModelIterator.html | 320 +++ .../layoutdialect/models/ElementMerger.html | 348 +++ .../layoutdialect/models/EventIterator.html | 319 +++ .../layoutdialect/models/ModelBuilder.html | 418 +++ .../layoutdialect/models/ModelMerger.html | 241 ++ .../models/TemplateModelFinder.html | 383 +++ .../layoutdialect/models/TitleExtractor.html | 356 +++ .../models/VariableDeclaration.html | 355 +++ .../models/VariableDeclarationMerger.html | 344 +++ .../models/VariableDeclarationParser.html | 345 +++ .../layoutdialect/models/package-frame.html | 66 + .../layoutdialect/models/package-summary.html | 249 ++ .../layoutdialect/package-frame.html | 58 + .../layoutdialect/package-summary.html | 154 ++ groovydoc/overview-frame.html | 69 + groovydoc/overview-summary.html | 178 ++ groovydoc/package-list | 9 + groovydoc/stylesheet.css | 2306 +++++++++++++++++ index.md | 105 + migrating-to-2.0.md | 76 + migrating-to-3.0.md | 95 + processors/decorate.md | 393 +++ processors/fragment.md | 22 + processors/index.md | 20 + processors/insert.md | 63 + processors/replace.md | 59 + processors/title-pattern.md | 63 + 88 files changed, 21904 insertions(+) create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _config.yml create mode 100644 _sass/color_schemes/thymeleaf.scss create mode 100644 _sass/custom/custom.scss create mode 100644 configuration-options.md create mode 100644 favicon.ico create mode 100644 getting-started.md create mode 100644 groovydoc/allclasses-frame.html create mode 100644 groovydoc/deprecated-list.html create mode 100644 groovydoc/groovy.ico create mode 100644 groovydoc/help-doc.html create mode 100644 groovydoc/index-all.html create mode 100644 groovydoc/index.html create mode 100644 groovydoc/inherit.gif create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/LayoutDialect.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/PojoLoggerFactory.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/DecorateProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/Decorator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/SortingStrategy.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitlePatternProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitleProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlBodyDecorator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlDocumentDecorator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlHeadDecorator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlTitleDecorator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/AppendingStrategy.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/GroupingStrategy.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/XmlDocumentDecorator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/FragmentExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IAttributeExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ICloseElementTagExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IContextExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IModelExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IProcessableElementTagExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IStandaloneElementTagExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITemplateEventExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITextExtensions.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/CollectFragmentProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentFinder.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterNamesExtractor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterVariableUpdater.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/IncludeProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/InsertProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/ReplaceProcessor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/AttributeMerger.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ChildModelIterator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ElementMerger.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/EventIterator.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelBuilder.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelMerger.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TemplateModelFinder.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TitleExtractor.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclaration.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationMerger.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationParser.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-summary.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-frame.html create mode 100644 groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-summary.html create mode 100644 groovydoc/overview-frame.html create mode 100644 groovydoc/overview-summary.html create mode 100644 groovydoc/package-list create mode 100644 groovydoc/stylesheet.css create mode 100644 index.md create mode 100644 migrating-to-2.0.md create mode 100644 migrating-to-3.0.md create mode 100644 processors/decorate.md create mode 100644 processors/fragment.md create mode 100644 processors/index.md create mode 100644 processors/insert.md create mode 100644 processors/replace.md create mode 100644 processors/title-pattern.md diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..023d42341 --- /dev/null +++ b/Gemfile @@ -0,0 +1,8 @@ +source 'https://rubygems.org' + +gem "jekyll" +gem "jekyll-redirect-from" +gem "jekyll-remote-theme" +gem "jekyll-seo-tag" +gem "rake" +gem "webrick" diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..8158718e0 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,87 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) + colorator (1.1.0) + concurrent-ruby (1.1.9) + em-websocket (0.5.2) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + eventmachine (1.2.7) + ffi (1.15.3) + forwardable-extended (2.6.0) + http_parser.rb (0.6.0) + i18n (1.8.10) + concurrent-ruby (~> 1.0) + jekyll (4.2.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (~> 2.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (~> 0.4.0) + pathutil (~> 0.9) + rouge (~> 3.0) + safe_yaml (~> 1.0) + terminal-table (~> 2.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.3) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (2.1.0) + sassc (> 2.0.1, < 3.0) + jekyll-seo-tag (2.7.1) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.3.1) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.5.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.6) + rake (13.0.6) + rb-fsevent (0.11.0) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (3.26.0) + rubyzip (2.3.2) + safe_yaml (1.0.5) + sassc (2.4.0) + ffi (~> 1.9) + terminal-table (2.0.0) + unicode-display_width (~> 1.1, >= 1.1.1) + unicode-display_width (1.7.0) + webrick (1.7.0) + +PLATFORMS + arm64-darwin-21 + x64-mingw32 + x86_64-darwin-19 + x86_64-darwin-20 + +DEPENDENCIES + jekyll + jekyll-redirect-from + jekyll-remote-theme + jekyll-seo-tag + rake + webrick + +BUNDLED WITH + 2.3.5 diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..1691300fc --- /dev/null +++ b/_config.yml @@ -0,0 +1,15 @@ +title: Thymeleaf Layout Dialect +description: A dialect for Thymeleaf that lets you build layouts and reusable templates in order to improve code reuse +lang: en-NZ +baseurl: /thymeleaf-layout-dialect +permalink: pretty +remote_theme: pmarsceill/just-the-docs@v0.3.1-r +color_scheme: thymeleaf +aux_links: + "GitHub": + - https://github.com/ultraq/thymeleaf-layout-dialect + "GroovyDoc/API": + - /thymeleaf-layout-dialect/groovydoc/ +plugins: + - jekyll-redirect-from + - jekyll-remote-theme diff --git a/_sass/color_schemes/thymeleaf.scss b/_sass/color_schemes/thymeleaf.scss new file mode 100644 index 000000000..6624e15a5 --- /dev/null +++ b/_sass/color_schemes/thymeleaf.scss @@ -0,0 +1,2 @@ + +$link-color: lighten(#005f0f, 10%); // The Thymeleaf link colour diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss new file mode 100644 index 000000000..a984de2e4 --- /dev/null +++ b/_sass/custom/custom.scss @@ -0,0 +1,21 @@ + +blockquote { + border-left: 0.25em solid $border-color; + margin: 0; + padding: 0 1em; +} + +code { + font-size: 0.8em; +} + +.site-title { + @media (min-width: 50rem) { + font-size: 17px !important; + padding-right: 1rem; + } +} + +.navigation-list-child-list { + display: block !important; +} diff --git a/configuration-options.md b/configuration-options.md new file mode 100644 index 000000000..5df7b52ea --- /dev/null +++ b/configuration-options.md @@ -0,0 +1,102 @@ +--- +layout: default +title: Configuration options +nav_order: 4 +--- + +Configuration options +===================== +{: .no_toc } + + +On this page +------------ +{: .no_toc .text-delta } + +1. TOC +{:toc} + + +To configure the layout dialect, you have 2 options: + - the constructor with arguments, `LayoutDialect(SortingStrategy, boolean)` + - the fluent API methods `withAutoHeadMerging`, `withExperimentalTitleTokens`, + and `withSortingStrategy` + +> Note that the fluent API is currently the only way to enable the `experimentatlTitleTokens` +> setting. With the number of options growing, the constructor might be +> deprecated in favour of the fluent API methods in a future release. + + +`sortingStrategy` +----------------- + +Default: `ApendingStrategy` + +```java +new LayoutDialect(new AppendingStrategy()); +// or +new LayoutDialect().withSortingStrategy(new AppendingStrategy()); +``` + +Sets how `` elements will be sorted when combined from the layout and +content templates. See [the decorate processor page]({{ site.baseurl }}{% link processors/decorate.md %}) +for more details and examples. + + +`autoHeadMerging` +----------------- + +Default: `true` + +```java +new LayoutDialect(null, true); +// or +new LayoutDialect().withAutoHeadMerging(true); +``` + +Bypass the layout dialect prforming any `` element merging altogether. +See [Bypassing element merging altogether]({{ site.baseurl }}{% link processors/decorate.md %}#bypassing-head-element-merging-altogether) +for more details. + + +`experimentalTitleTokens` +------------------------- + +Default: `false` + +```java +new LayoutDialect().withExperimentalTitleTokens(false); +``` + +An experimental option added in 3.4.0 to use standard Thymeleaf expression +syntax for title patterns and to have access to the title parts in templates as +the variables `layoutDialectLayoutTitle` and `layoutDialectContentTitle` (the +names are pretty verbose but I want to avoid any potential clashes while I +either come up with new ones or some way to configure the names). + +So instead of the example in [Processors > title-pattern]({{ site.baseurl }}{% link processors/title-pattern.md %}) +for setting what the final title will look like: + +```html +... +``` + +You can do this instead: + +```html +... +``` + +The title parts will also be made available anywhere in the template as the +variables above, so you can reference them as necessary: + +```html + +

The title of my page is + (title here) +

+ +``` + +Any feedback for this experimental option can be made in +[thymeleaf-layout-dialect/issues/172](https://github.com/ultraq/thymeleaf-layout-dialect/issues/172) diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..6cd57d8a8b233f732e76bcb2dd873d46d7cf5834 GIT binary patch literal 5430 zcmeHLYe*DP6doi5?wq~%`@T6d_sqS^ zFlLN7V`aq-sd!$-0WS&Czjlt^*A^#+TfxK^mw zc<#Aak!R_ixEApRNvOW7#Nf~%7RNY@34>zI4Vnh;6fejdi*fW)=9tHGdYr=TkzSLG z`Fku4#;_teUZ!UrIbI!pJae#ts{@95T4w~r))S-kh&@Q*(Nbqtlly4ZaW4kvbrjq- z@*Cx*ej@Po!89eeKKlOmG2OfI&*a`#WPy;v9gtl;j*6RdBvr;?>0ZZ4(YH$MjF;~^ z)ZZ(v@nh%*@-JuW_5B;q{BC%Bk)zb=A9X&!!bqD5$;CX;Ok90_MJq2q__V7Tj$yNm zt|2Bj9=q~{er4VNO;O(bgKHZ4+_rY&i8Si8i4K$az;s`+Ui6jf&toE3_QlHK_H{S%*7qa9G-Zxju5%^sN(tD%AF$du>9>wr7% zw5!&S8sy}n>q94O4Orvz-#>oaW8XStmlkU1kX4?6|3N=wo=?N@@W}ZgJ{fJ49B?|U z1E;_>!3A-7V#t)$YAp$5e(cQkL;u%4jWoRf@(%VPy7vYg{#g8iusIMO5+c8%l+}@4 zT7<1>9%y;}OhbeCRE$w`@V7=AQX}YoB9F`yx-apTc;d>FdbNh${vNW|n>L{us3zOs z=_DW9Sq=1^D7{gv)({~Jns9zDFAKx%*m@b58HAkr3|2$?n-`$_C9cn8c+aE_2*?OT z#<>Hm24T*&N#&>aNOQ3z*%Nesd#~g6r1Mh^bAqN~QG^4E8uPI^-OVH#s1903qZA^O k@ly@77TJoXn^XhU@ei6Q_kfh!g_tQcu-vLY226MU1C_kWumAu6 literal 0 HcmV?d00001 diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 000000000..1f9fb31e8 --- /dev/null +++ b/getting-started.md @@ -0,0 +1,62 @@ +--- +layout: default +title: Getting started +nav_order: 2 +redirect_from: + - /Installation.html +--- + +Getting started +=============== +{: .no_toc } + + +On this page +------------ +{: .no_toc .text-delta } + +1. TOC +{:toc} + + +Installation +------------ + +A minimum of Java 8 and Thymeleaf 3.x is required. Add the layout dialect by +configuring Maven or your Maven-compatible dependency manager to the following +co-ordinates: + + - GroupId: `nz.net.ultraq.thymeleaf` + - ArtifactId: `thymeleaf-layout-dialect` + - Version: `3.4.0` + +Check the [project releases](https://github.com/ultraq/thymeleaf-layout-dialect/releases) +for a list of available versions. Each release page also includes a +downloadable JAR if you want to manually add it to your project classpath. + + +Usage +----- + +Configure Thymeleaf to include the layout dialect using one of the methods below: + + - Spring or Spring Boot w/ Java/annotation config: + ```java + @Bean + public LayoutDialect layoutDialect() { + return new LayoutDialect(); + } + ``` + + - DIY management of the Thymeleaf template engine: + ```java + TemplateEngine templateEngine = new TemplateEngine(); + templateEngine.addDialect(new LayoutDialect()); + ``` + +This will introduce the `layout` namespace, and 5 new attribute processors that +you can use in your templates: `decorate`, `title-pattern`, `insert`, `replace`, +and `fragment`. + +Continue on to the [processors]({{ site.baseurl }}{% link processors/index.md %}) +section to learn how to use these in your templates. diff --git a/groovydoc/allclasses-frame.html b/groovydoc/allclasses-frame.html new file mode 100644 index 000000000..3f96ef7f1 --- /dev/null +++ b/groovydoc/allclasses-frame.html @@ -0,0 +1,81 @@ + + + + +All Classes + + + + + + + +

All Classes

+
+ +
+ + diff --git a/groovydoc/deprecated-list.html b/groovydoc/deprecated-list.html new file mode 100644 index 000000000..576a4634e --- /dev/null +++ b/groovydoc/deprecated-list.html @@ -0,0 +1,130 @@ + + + + + + + + Deprecated API (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
+ + + + + +
+ + +
+

Deprecated API

+

Contents

+ +
+
+ + + + + + +
+ +
+ + + + + +
+ + + + + diff --git a/groovydoc/groovy.ico b/groovydoc/groovy.ico new file mode 100644 index 0000000000000000000000000000000000000000..9e9b8d81a21db6c99daf3cd76320407a45a1b0d5 GIT binary patch literal 9662 zcmeHMd0fuv7JqxQju}i0qd^U!MD}4y`@Ygb`=*7`UX+R!T9s1LN(PmZrHyQnjA76e zm5NdsJC$|ZJI1-^{HC}2zOUEFa_`(f?$77z`Tc(H^PJ~<&U4Or&hv}K62gBoXR`2r zan_zmEY>I%izSJ`S1daOz5oC9UKS9--fV<0ALt$Z_P=%!r~Zhc2vGzr|91!lgklfq zp5D=K)Q9@gn7>mWvM2GFh)_l74;t9t@T)IBcM=^n-20nRUj~0OYIw-kBZv8q9RB(8 zA%h243keA=!G6v?pfNO-WRR@?)a+>X(z7LNr_P>IJw-;ML1Ln4hq&m-m)N&^>}ZjrUymFbjJlek3>SnQ$wH9K|D+zY z)`JmJLk17jm6iqVB(1(T$40k$!W6Okv7^8Ihv-+sONW2)nKjDf=pofJ$EWryvWrOne!{Y|B*%v@ zkeS%|z3j9GGpCGOuJWB!m&#JL8s*fWSGq-sVEp3_Fu%O_ zPtM5KrnMAoZj}8su#a^M>W2D|E~GcDi9vY^C`7uoj~z4OHpY7)o824d<3B{$o$C5ngliRr;}riv|Iq&(}X`WpK-m2Dx6uXA&M8>bI> zPkN9~nO`Xc<1^Wyl^^p@@k!$vF(!5+Z;A(sY074oUElr zijDFKey_C(Vi}uQH0)=5=50L4mnk19rmTUv!A>CKVGh$>mx7F&8O#Z=2e~*OAXyZ% zZ&qW~IB}g~|rkE{a$3d6Gx` zNIw7E6vLEDrI(w)WOJ=|!%_$4t#by0qp1Sr(HxYADM#oQCxYaHX|>}{unEbSp$u)xfhSr*F+b7-vbej|Cz~ml&o6uae-bPj1 zK_xY?TU>O+3*4s-khdLz>Lo!JTX~-30!JhHmr7CY&s4XEGX6k&sUX{v{287WZ*oWb z&P84nH55EKXf?H9?# zEwk6DlTTa)nt9Po9KFr&7i?Jh26ys%T6cbX(lc=~tlS3QN4djf)R9{kL1Q>;Ky`^i zw8!lUW50TW^@|>IS49j!@LU7?_Z#MFs@!CVbr{)B=U@UX!J379k>BqrCMH{G^Kh6S z?!xS6g1Ga)o9Sc4GnRamzYh}!xGxX~&HNacgf%SIuFH@#?P>fzB&4%&`YbO?^?xYF zc>a^}J=Kns?YsmMhCMLfloAT!!%JJO3OZST_G6eFc zxThRQd6?Fe18FBC9vOoChxDd(r#g$`MmfpM`UN}bAGZv1Zc<40XZA^|rKmRKw?E}WZVr;R`fv2%aFLDm;_1shj&na1*Mee< zGlsk6@TVG^e0sX%_KE#=sLCwN`Rcp)E2ReUaFVn$cq6_!9H^$0 zi}zvb3CgY9n77uMsVT^|oc{bRKmQrh;_Z0uv_aBJ2yXtu8{CX4tk*AZqBW;{MgAkm z{^ZLX+fhrg{5JdX^LgKA4u3i;sqF}dS<>RSkw4Yb{Qkp^@-*JRV*T<4&fY~aBPf1# z4r~HR3muTcJxJP052UU2!Qx^bIJTAd84lQ&u&nJc13QdW0>6I5pW>J5QI)I^m@`%U z8GgHNZe@--(OFHYjGx+1bgzp^Y|_ZyZz%|BBZ?% zEH|y=8Mm@H3qo;R(5)(F{b()h(XYsND6Z(-q+PfXl&rLCzMnC14|1nEl)rvpEs&Wo zC}W-NEsGfU4%!1a=N5`#`_?jMo&At|^xbn1-SHzhC5D52WMD6r#RNm}+5HfE_h*5K zx%Crx=B4!Z=Zp2*EciA^YJK*!idqc0H=^ zMb>rnr~Nx2JbP=O5w$lPvRcmd%HYV`@vsh(?_C1d)^f0@!MH`+W8Qg*-=Df?ONr6G z`>yjND>KASw;;~7TP4EnCGEv}`xC(CLLLO(sDPY@^^o6r6$&~Vd656;D(q-H3n>*v zu&Hn-#N};&6ZzSYTwVyl*Z; zvl$BS)Iok*HSB4*2>Gp-VDHUZIPkFX-+iz@zl{ATw*c+1vEwY*p3ei_{qdl_(d&_c z(##jLCCBR`ufBdiVQmStk|^5j-szIy-Ab{ny*mnQt9C(B`%iH2Q4^GOU5C={7AX4! zAUUPo*P#gYF1S|@-nGSGT$TbVX~D0IbQZMeDa?pR?zGJFI zPWgCWFeumvuICFN@6Kf?>%0c#-K}us@r{oL$vM>30!0rRA-bso%#Ngk`nFIovDUh5 zqCWTRXM+YTK+^B~{gCuzA53%$Ka}coS0~#2xxywtFx(pt-WT@4-n(^h1m`@C{Et6w zgA-5Mq2fJo0>{ue8h@m-1rFVBg3V2pU{Rh9npht$aa&Svu08(-o)_hj2ko^2^Cgjd z$Hgv5@<=F8_q}Jb(X&&2qYo^~i2;|YT-ecm5su;972R!c@^L$ydeYI0O1x+Aw5R3z z?G)-s{VTfK;Mk)UD8ADG;WdZBv?K*IvO-^5x){~k=*xECUPau;BR-TnqZ)pX6D~>i z3_hCf`@}cd_nKU!2WVx6fn`}5tg9)5J-2G1qO%oFb+^Om#~pAQxpGkT_ z^dx;Bq0iiHWb(iB$(^t`KMr(K);x8z(Q0rol)r+1<5`H4e~jH3?p*(|46`MbESk;V6ZC+EDxoF_xXL0*nArDeyxSW51OH}vkgvnp*{@o9-mJmU>Je&{b{u(p;^}$w)C5zjsoO|CE0};;12%8e}!LEX6Cg zJk95M(pJA3y*TgZ3JHFowJnT^4fC>8u&c-hr>Y$AIJXzPf8GaPsGG}=d0>C?2e2&9 z028dW^>U&?Gkx7_ix`jVK90IA`0b$GMo*T`RbmLrGu+=sIP-t1mc1*&QLZ@2qoj0; z=gVDNyy|_Dd>VB(`8`v_HBrWIDH^zEXzo}KT0d++tOw2P^`Mp!0_v$juT2wuZ+ZmV zRR^swxVOeZr^C%mWsTUF5fVs_>Vl8*_4ibey*0>667y_mVZ7_5y>YI;=f>tN*Dltf6ZcrQ2P=S1hw5*2vXaI z2B!8D8kX8n)Pq`VSRpJH4rAI^)GD%AOe@A>p%^C9FfCS;D2}NtdD?+J@3C#8-#?&b z}m;ecO8UN5KQ>Jqlv%!?72H3NiMBSBihO MWNGZjTrAeV03kgoZ~y=R literal 0 HcmV?d00001 diff --git a/groovydoc/help-doc.html b/groovydoc/help-doc.html new file mode 100644 index 000000000..879ad2196 --- /dev/null +++ b/groovydoc/help-doc.html @@ -0,0 +1,196 @@ + + + + + + + + + API Help (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + +
+ + + + + +
+ + + +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
  • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
    • +
    • Classes
    • +
    • Enums
    • +
    • Exceptions
    • +
    • Errors
    • +
    • Annotation Types
    • +
    +
  • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
    • +
    • Direct Subclasses
    • +
    • All Known Subinterfaces
    • +
    • All Known Implementing Classes
    • +
    • Class/interface declaration
    • +
    • Class/interface description
    • +
    +
      +
    • Nested Class Summary
    • +
    • Field Summary
    • +
    • Constructor Summary
    • +
    • Method Summary
    • +
    +
      +
    • Field Detail
    • +
    • Constructor Detail
    • +
    • Method Detail
    • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
  • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
    • +
    • Annotation Type description
    • +
    • Required Element Summary
    • +
    • Optional Element Summary
    • +
    • Element Detail
    • +
    +
  • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
    • +
    • Enum description
    • +
    • Enum Constant Summary
    • +
    • Enum Constant Detail
    • +
    +
  • + +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
  • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
  • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
  • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
  • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
  • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
  • +
+ This help file applies to API documentation generated using the standard doclet.
+ +
+ + + + + +
+ + + + diff --git a/groovydoc/index-all.html b/groovydoc/index-all.html new file mode 100644 index 000000000..532b5e7ee --- /dev/null +++ b/groovydoc/index-all.html @@ -0,0 +1,886 @@ + + + + + + + + Index (thymeleaf-layout-dialect 3.4.0 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(org.thymeleaf.model.IModel) - Method in ModelBuilder +
Appends an existing model to the model being built.
+
AppendingStrategy - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies +
The standard <head> merging strategy, which simply appends the + content elements to the layout ones.
+
AppendingStrategy() - Constructor in AppendingStrategy +
+
asBoolean(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Set that a model evaluates to 'false' if it has no events.
+
AttributeMerger - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
Merges attributes from one element into another.
+
AttributeMerger() - Constructor in AttributeMerger +
+
autoHeadMerging - Property in HtmlDocumentDecorator +
+
+ + + +

B

+
+ +
build(Closure<IModel>) - 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.layoutdialect.models +
An iterator that works with a model's immediate children, returning each one + as a model of its own.
+
ChildModelIterator(org.thymeleaf.model.IModel) - Constructor in ChildModelIterator +
+
childModelIterator(org.thymeleaf.model.IModel) - Method in IModelExtensions +
If this model represents an element, then this method returns an + iterator over any potential child items as models of their own.
+
CollectFragmentProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.fragments +
Processor produced from FragmentProcessor in order to separate include and + define logic to avoid ambiguity.
+
CollectFragmentProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in CollectFragmentProcessor +
Constructor, sets this processor to work on the 'collect' attribute.
+
CONTENT_TITLE_KEY - Property in TitlePatternProcessor +
+
CONTENT_TITLE_KEY - Property in TitleProcessor +
+
context - Property in AttributeMerger +
+
context - Property in ElementMerger +
+
context - Property in FragmentParameterVariableUpdater +
+
context - Property in HtmlBodyDecorator +
+
context - Property in HtmlHeadDecorator +
+
context - Property in HtmlTitleDecorator +
+
context - Property in TemplateModelFinder +
+
context - Property in TitleExtractor +
+
context - Property in VariableDeclarationMerger +
+
context - Property in VariableDeclarationParser +
+
context - Property in XmlDocumentDecorator +
+
createNode(java.lang.Object, java.util.Map, java.lang.Object) - Method in ModelBuilder +
Create a model for the given element, attributes, and inner text content.
+
+ + + +

D

+
+ +
decorate(org.thymeleaf.model.IModel, org.thymeleaf.model.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(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in HtmlBodyDecorator +
Decorate the <body> part.
+
decorate(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in HtmlDocumentDecorator +
+
decorate(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in HtmlHeadDecorator +
+
decorate(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in HtmlTitleDecorator +
+
decorate(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in XmlDocumentDecorator +
+
DecorateProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators +
Specifies the name of the template to decorate using the current template.
+
DecorateProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String, nz.net.ultraq.thymeleaf.layoutdialect.decorators.SortingStrategy, boolean, boolean, java.lang.String) - Constructor in DecorateProcessor +
Constructor, configurable processor name for the purposes of the + deprecated layout:decorator alias.
+
Decorator - Interface in nz.net.ultraq.thymeleaf.layoutdialect.decorators +
A decorator performs decoration of a target model, using a source model for + all the decorations to apply.
+
DIALECT_NAME - Property in LayoutDialect +
+
DIALECT_PRECEDENCE - Property in LayoutDialect +
+
DIALECT_PREFIX - Property in LayoutDialect +
+
dialectPrefix - Property in FragmentFinder +
+
dialectPrefix - Property in FragmentParameterVariableUpdater +
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IProcessableElementTag, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementTagStructureHandler) - Method in CollectFragmentProcessor +
Inserts the content of :define fragments into the encountered + collect placeholder.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IModel, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementModelStructureHandler) - Method in DecorateProcessor +
Locates the template to decorate and, once decorated, inserts it into the + processing chain.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IProcessableElementTag, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementTagStructureHandler) - Method in FragmentProcessor +
Inserts the content of fragments into the encountered fragment placeholder.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IModel, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementModelStructureHandler) - Method in IncludeProcessor +
Locates a page fragment and includes it in the current template.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IModel, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementModelStructureHandler) - Method in InsertProcessor +
Locates a page fragment and inserts it in the current template.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IModel, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementModelStructureHandler) - Method in ReplaceProcessor +
Locates a page fragment and uses it to replace the current element.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IProcessableElementTag, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementTagStructureHandler) - Method in TitlePatternProcessor +
Process the layout:title-pattern directive, replaces the title text + with the titles from the content and layout pages.
+
doProcess(org.thymeleaf.context.ITemplateContext, org.thymeleaf.model.IProcessableElementTag, org.thymeleaf.engine.AttributeName, java.lang.String, org.thymeleaf.processor.element.IElementTagStructureHandler) - Method in TitleProcessor +
Process the layout:title directive, replaces the title text using + values extracted from the layout and content templates and emitted with + standard Thymeleaf expression syntax.
+
+ + + +

E

+
+ +
each(org.thymeleaf.model.IModel, groovy.lang.Closure) - Method in IModelExtensions +
Iterate through each event in the model.
+
ElementMerger - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
Merges an element and all its children into an existing element.
+
ElementMerger() - Constructor in ElementMerger +
+
equals(org.thymeleaf.model.ICloseElementTag, java.lang.Object) - Method in ICloseElementTagExtensions +
Compares this close tag with another.
+
equals(org.thymeleaf.model.IModel, java.lang.Object) - Method in IModelExtensions +
Compare 2 models, returning true if all of the model's events + are equal.
+
equals(org.thymeleaf.model.IProcessableElementTag, java.lang.Object) - Method in IProcessableElementTagExtensions +
Compare processable elements for equality.
+
equals(org.thymeleaf.model.IStandaloneElementTag, java.lang.Object) - Method in IStandaloneElementTagExtensions +
Compares this standalone tag with another.
+
equals(org.thymeleaf.model.IText, java.lang.Object) - Method in ITextExtensions +
Compares this text with another.
+
equalsIgnoreXmlnsAndWith(org.thymeleaf.model.IProcessableElementTag, org.thymeleaf.model.IProcessableElementTag, org.thymeleaf.context.IContext) - Method in IProcessableElementTagExtensions +
Compare elements, ignoring XML namespace declarations and Thymeleaf's + th:with processor.
+
equalsName(org.thymeleaf.model.IAttribute, java.lang.String, java.lang.String) - Method in IAttributeExtensions +
Returns whether or not an attribute is an attribute processor of + the given name, checks both prefix:processor and + data-prefix-processor variants.
+
EventIterator - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
An iterator that treats a model as a queue of events.
+
EventIterator(org.thymeleaf.model.IModel) - Constructor in EventIterator +
+
everyWithIndex(org.thymeleaf.model.IModel, Closure<Boolean>) - Method in IModelExtensions +
Return true only if all the events in the model return + true for the given closure.
+
extract(java.lang.String) - Method in FragmentParameterNamesExtractor +
Returns a list of parameter names for the given fragment definition.
+
extract(org.thymeleaf.model.IModel, java.lang.String) - Method in TitleExtractor +
Locate and extract title data from the given template model, saving it to + the template context as the given context key.
+
+ + + +

F

+
+ +
find(org.thymeleaf.model.IModel, Closure<Boolean>) - Method in IModelExtensions +
Returns the first event in the model that meets the criteria of the + given closure.
+
findAll(org.thymeleaf.model.IModel, Closure<Boolean>) - Method in IModelExtensions +
Find all events in the model that match the given closure.
+
findFragment(java.lang.String, java.lang.String, java.lang.String) - Method in TemplateModelFinder +
Return the model specified by the template and fragment name parameters.
+
findFragments(org.thymeleaf.model.IModel) - Method in FragmentFinder +
Find and return models for layout dialect fragments within the scope of the + given model, without delving into layout:insert or + layout:replace elements, mapped by the name of each fragment.
+
findIndexOf(org.thymeleaf.model.IModel, Closure<Boolean>) - Method in IModelExtensions +
Returns the index of the first event in the model that meets the + criteria of the given closure.
+
findIndexOfModel(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in IModelExtensions +
A special variant of findIndexOf that uses models, as I seem to + be using those a lot.
+
findModel(org.thymeleaf.model.IModel, Closure<Boolean>) - Method in IModelExtensions +
Returns the first instance of a model that meets the given closure + criteria.
+
findPositionForModel(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in AppendingStrategy +
Returns the position at the end of the <head> section.
+
findPositionForModel(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in GroupingStrategy +
Returns the index of the last set of elements that are of the same 'type' + as the content node.
+
findPositionForModel(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in SortingStrategy +
Returns the position in a <head> element model to insert a child + model.
+
findTemplate(java.lang.String) - Method in TemplateModelFinder +
Return a model for the template specified by the given template name.
+
first(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Returns the first event on the model.
+
FRAGMENT_COLLECTION_KEY - Property in FragmentExtensions +
+
FragmentExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Extensions to Thymeleaf for working with fragments.
+
FragmentExtensions() - Constructor in FragmentExtensions +
+
FragmentFinder - Class in nz.net.ultraq.thymeleaf.layoutdialect.fragments +
Searches for and returns layout dialect fragments within a given + scope/element.
+
FragmentFinder() - Constructor in FragmentFinder +
+
FragmentParameterNamesExtractor - Class in nz.net.ultraq.thymeleaf.layoutdialect.fragments +
Extracts just the parameter names from a fragment definition.
+
FragmentParameterNamesExtractor() - Constructor in FragmentParameterNamesExtractor +
+
FragmentParameterVariableUpdater - Class in nz.net.ultraq.thymeleaf.layoutdialect.fragments +
Updates the variables at a given element/fragment scope to include those in + a fragment expression.
+
FragmentParameterVariableUpdater() - Constructor in FragmentParameterVariableUpdater +
+
FragmentProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.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(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in FragmentProcessor +
Constructor, sets this processor to work on the 'fragment' attribute.
+
+ + + +

G

+
+ +
getAt(org.thymeleaf.context.IContext, java.lang.String) - Method in IContextExtensions +
Enables use of the value = context[key] syntax over the context + object, is a synonym for the getVariable method.
+
getFragmentCollection(org.thymeleaf.context.ITemplateContext, boolean) - Method in FragmentExtensions +
Retrieves the fragment collection for the current context.
+
getLogger(Class<?>) - Method in PojoLoggerFactory +
+
getModel(org.thymeleaf.model.IModel, int) - Method in IModelExtensions +
Returns the model at the given index.
+
getPrefixForDialect(org.thymeleaf.context.IContext, Class<IProcessorDialect>) - Method in IContextExtensions +
Returns the configured prefix for the given dialect.
+
getProcessors(java.lang.String) - Method in LayoutDialect +
Returns the layout dialect's processors.
+
GroupingStrategy - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies +
The <head> merging strategy which groups like elements together.
+
GroupingStrategy() - Constructor in GroupingStrategy +
+
+ + + +

H

+
+ +
hasNext() - Method in ChildModelIterator +
+
hasNext() - Method in EventIterator +
+
HtmlBodyDecorator - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.html +
A decorator specific to processing an HTML <body> element.
+
HtmlBodyDecorator() - Constructor in HtmlBodyDecorator +
+
HtmlDocumentDecorator - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.html +
A decorator made to work over an HTML document.
+
HtmlDocumentDecorator(org.thymeleaf.context.ITemplateContext, nz.net.ultraq.thymeleaf.layoutdialect.decorators.SortingStrategy, boolean, boolean) - Constructor in HtmlDocumentDecorator +
Constructor, builds a decorator with the given configuration.
+
HtmlHeadDecorator - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.html +
A decorator specific to processing an HTML <head> element.
+
HtmlHeadDecorator() - Constructor in HtmlHeadDecorator +
+
HtmlTitleDecorator - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.html +
Decorator for the <title> part of the template to handle the special + processing required for the layout:title-pattern and + layout:title processors.
+
HtmlTitleDecorator() - Constructor in HtmlTitleDecorator +
+
+ + + +

I

+
+ +
IAttributeExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the IAttribute class.
+
IAttributeExtensions() - Constructor in IAttributeExtensions +
+
ICloseElementTagExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the ICloseElementTag class.
+
ICloseElementTagExtensions() - Constructor in ICloseElementTagExtensions +
+
IContextExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the IContext class.
+
IContextExtensions() - Constructor in IContextExtensions +
+
IModelExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the IModel class.
+
IModelExtensions() - Constructor in IModelExtensions +
+
IncludeProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.includes +
Similar to Thymeleaf's th:include, but allows the passing of entire + element fragments to the included template.
+
IncludeProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in IncludeProcessor +
Constructor, sets this processor to work on the 'include' attribute.
+
insertModelWithWhitespace(org.thymeleaf.model.IModel, int, org.thymeleaf.model.IModel, org.thymeleaf.model.IModelFactory) - Method in IModelExtensions +
Inserts a model, creating whitespace events around it so that it appears in + line with all the existing events.
+
InsertProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.includes +
Similar to Thymeleaf's th:insert, but allows the passing of entire + element fragments to the included template.
+
InsertProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in InsertProcessor +
Constructor, sets this processor to work on the 'insert' attribute.
+
insertWithWhitespace(org.thymeleaf.model.IModel, int, org.thymeleaf.model.ITemplateEvent, org.thymeleaf.model.IModelFactory) - Method in IModelExtensions +
Inserts an event, creating a whitespace event before it so that it + appears in line with all the existing events.
+
IProcessableElementTagExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the IProcessableElementTag class.
+
IProcessableElementTagExtensions() - Constructor in IProcessableElementTagExtensions +
+
isClosingElementOf(org.thymeleaf.model.ITemplateEvent, java.lang.String) - Method in ITemplateEventExtensions +
Returns whether or not this event represents a closing element of the + given name.
+
isElement(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Returns whether or not this model represents a single HTML element.
+
isOpeningElementOf(org.thymeleaf.model.ITemplateEvent, java.lang.String) - Method in ITemplateEventExtensions +
Returns whether or not this event represents an opening element of the + given name.
+
IStandaloneElementTagExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the IStandaloneElementTag class.
+
IStandaloneElementTagExtensions() - Constructor in IStandaloneElementTagExtensions +
+
isWhitespace(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Returns whether or not this model represents collapsible whitespace.
+
isWhitespace(org.thymeleaf.model.ITemplateEvent) - Method in ITemplateEventExtensions +
Returns whether or not this event represents collapsible whitespace.
+
isWhitespace(org.thymeleaf.model.IText) - Method in ITextExtensions +
Returns whether or not this text event is collapsible whitespace.
+
ITemplateEventExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the ITemplateEvent class.
+
ITemplateEventExtensions() - Constructor in ITemplateEventExtensions +
+
iterator(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Used to make this class iterable as an event queue.
+
ITextExtensions - Class in nz.net.ultraq.thymeleaf.layoutdialect.extensions +
Meta-programming extensions to the IText class.
+
ITextExtensions() - Constructor in ITextExtensions +
+
+ + + +

J

+
+ +
+ + + +

K

+
+ +
+ + + +

L

+
+ +
last(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Returns the last event on the model.
+
LAYOUT_TITLE_KEY - Property in TitlePatternProcessor +
+
LAYOUT_TITLE_KEY - Property in TitleProcessor +
+
LayoutDialect - Class in nz.net.ultraq.thymeleaf.layoutdialect +
A dialect for Thymeleaf that lets you build layouts and reusable templates in + order to improve code reuse.
+
LayoutDialect(nz.net.ultraq.thymeleaf.layoutdialect.decorators.SortingStrategy, boolean) - Constructor in LayoutDialect +
Constructor, configure the layout dialect.
+
+ + + +

M

+
+ +
merge(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in AttributeMerger +
Merge the attributes of the source element with those of the target + element.
+
merge(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in ElementMerger +
Replace the content of the target element, with the content of the source + element.
+
merge(org.thymeleaf.model.IModel, org.thymeleaf.model.IModel) - Method in ModelMerger +
Merge the source model into the target model.
+
merge(java.lang.String, java.lang.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.layoutdialect.models +
Create Thymeleaf 3 models using the Groovy builder syntax.
+
ModelBuilder(org.thymeleaf.model.IModelFactory, org.thymeleaf.engine.ElementDefinitions, org.thymeleaf.templatemode.TemplateMode) - Constructor in ModelBuilder +
Constructor, create a new model builder.
+
ModelMerger - Interface in nz.net.ultraq.thymeleaf.layoutdialect.models +
Merges template models by applying the source model to the target model, with + the result being implementation-dependant.
+
+ + + +

N

+
+ +
name - Property in VariableDeclaration +
+
newTitleTokens - Property in HtmlDocumentDecorator +
+
newTitleTokens - Property in HtmlHeadDecorator +
+
newTitleTokens - Property in HtmlTitleDecorator +
+
newTitleTokens - Property in TitleExtractor +
+
next() - Method in ChildModelIterator +
+
next() - Method in EventIterator +
+
nodeCompleted(java.lang.Object, java.lang.Object) - Method in ModelBuilder +
Link a parent and child node.
+
+ + + +

O

+
+ +
+ + + +

P

+
+ +
parse(java.lang.String) - Method in VariableDeclarationParser +
Parse a variable declaration string, returning as many variable declaration + objects as there are variable declarations.
+
PojoLoggerFactory - Class in nz.net.ultraq.thymeleaf.layoutdialect +
A no-Groovy wrapper around SLF4J's org.slf4j.LoggerFactory#getLogger(java.lang.Class) + method`.
+
PojoLoggerFactory() - Constructor in PojoLoggerFactory +
+
PROCESSOR_COLLECT - Property in CollectFragmentProcessor +
+
PROCESSOR_DEFINE - Property in CollectFragmentProcessor +
+
PROCESSOR_NAME - Property in DecorateProcessor +
+
PROCESSOR_NAME - Property in FragmentProcessor +
+
PROCESSOR_NAME - Property in IncludeProcessor +
+
PROCESSOR_NAME - Property in InsertProcessor +
+
PROCESSOR_NAME - Property in ReplaceProcessor +
+
PROCESSOR_NAME - Property in TitlePatternProcessor +
+
PROCESSOR_NAME - Property in TitleProcessor +
+
PROCESSOR_PRECEDENCE - Property in CollectFragmentProcessor +
+
PROCESSOR_PRECEDENCE - Property in DecorateProcessor +
+
PROCESSOR_PRECEDENCE - Property in FragmentProcessor +
+
PROCESSOR_PRECEDENCE - Property in IncludeProcessor +
+
PROCESSOR_PRECEDENCE - Property in InsertProcessor +
+
PROCESSOR_PRECEDENCE - Property in ReplaceProcessor +
+
PROCESSOR_PRECEDENCE - Property in TitlePatternProcessor +
+
PROCESSOR_PRECEDENCE - Property in TitleProcessor +
+
putAt(org.thymeleaf.context.IContext, java.lang.String, java.lang.Object) - Method in IContextExtensions +
Enables use of the context[key] = value syntax over the context + object, is a synonym for the setVariable method.
+
+ + + +

Q

+
+ +
+ + + +

R

+
+ +
removeAllModels(org.thymeleaf.model.IModel, Closure<Boolean>) - Method in IModelExtensions +
Remove a model identified by an event matched by the given closure.
+
removeChildren(org.thymeleaf.model.IModel) - Method in IModelExtensions +
If the model represents an element open to close tags, then this method + removes all of the inner events.
+
removeFirst(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Removes the first event on the model.
+
removeLast(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Removes the last event on the model.
+
removeModel(org.thymeleaf.model.IModel, int) - Method in IModelExtensions +
Removes a models-worth of events from the specified position.
+
replaceModel(org.thymeleaf.model.IModel, int, org.thymeleaf.model.IModel) - Method in IModelExtensions +
Replaces the model at the specified index with the given model.
+
ReplaceProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.includes +
Similar to Thymeleaf's th:replace, but allows the passing of entire + element fragments to the included template.
+
ReplaceProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in ReplaceProcessor +
Constructor, set this processor to work on the 'replace' attribute.
+
+ + + +

S

+
+ +
setLocalFragmentCollection(org.thymeleaf.processor.element.IElementModelStructureHandler, org.thymeleaf.context.ITemplateContext, Map<String, List<IModel>>, boolean) - Method in FragmentExtensions +
Set a fragment cache to contain any existing fragments, plus the given new + fragments, with the same scope as setting a local variable.
+
setParent(java.lang.Object, java.lang.Object) - Method in ModelBuilder +
Does nothing.
+
sizeOfModelAt(org.thymeleaf.model.IModel, int) - Method in IModelExtensions +
If an opening element exists at the given position, this method will + return the 'size' of that element (number of events from here to its + matching closing tag).
+
SortingStrategy - Interface in nz.net.ultraq.thymeleaf.layoutdialect.decorators +
Interface for controlling the sort order in which <head> elements + from one source are placed into another.
+
sortingStrategy - Property in HtmlDocumentDecorator +
+
sortingStrategy - Property in HtmlHeadDecorator +
+
+ + + +

T

+
+ +
TemplateModelFinder - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
A simple API for retrieving (immutable template) models using Thymeleaf's + template manager.
+
TemplateModelFinder() - Constructor in TemplateModelFinder +
+
TitleExtractor - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
Utility class for extracting <title> values from templates.
+
TitleExtractor() - Constructor in TitleExtractor +
+
TitlePatternProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators +
Allows for greater control of the resulting <title> element by + specifying a pattern with some special tokens.
+
TitlePatternProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in TitlePatternProcessor +
Constructor, sets this processor to work on the 'title-pattern' attribute.
+
TitleProcessor - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators +
A processor for the experimental feature of using standard Thymeleaf + expression syntax when creating the <title> element, as opposed to + the special syntax required of layout:title-pattern.
+
TitleProcessor(org.thymeleaf.templatemode.TemplateMode, java.lang.String) - Constructor in TitleProcessor +
Constructor, sets this processor to work on the 'title' attribute.
+
toString() - Method in VariableDeclaration +
Reconstructs the variable for use with th:with.
+
trim(org.thymeleaf.model.IModel) - Method in IModelExtensions +
Removes whitespace events from the head and tail of the model's + underlying event queue.
+
+ + + +

U

+
+ +
updateLocalVariables(org.thymeleaf.standard.expression.FragmentExpression, org.thymeleaf.model.IModel, org.thymeleaf.processor.element.IElementModelStructureHandler) - Method in FragmentParameterVariableUpdater +
Given a fragment expression, update the local variables of the element + being processed.
+
+ + + +

V

+
+ +
value - Property in VariableDeclaration +
+
VariableDeclaration - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
Representation of a scoped variable declaration made through th:with + attributes.
+
VariableDeclaration(org.thymeleaf.standard.expression.Assignation) - Constructor in VariableDeclaration +
Constructor, create an instance from a Thymeleaf assignation.
+
VariableDeclarationMerger - Class in nz.net.ultraq.thymeleaf.layoutdialect.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 in VariableDeclarationMerger +
+
VariableDeclarationParser - Class in nz.net.ultraq.thymeleaf.layoutdialect.models +
Parser for variable declaration strings, which are the expressions that are + found withing th:with processors.
+
VariableDeclarationParser() - Constructor in VariableDeclarationParser +
+
+ + + +

W

+
+ +
withAutoHeadMerging(boolean) - Method in LayoutDialect +
Configure this instance of the layout dialect with the given autoHeadMerging + value.
+
withExperimentalTitleTokens(boolean) - Method in LayoutDialect +
Configure this instance of the layout dialect with the given experimentalTitleTokens + value.
+
withSortingStrategy(nz.net.ultraq.thymeleaf.layoutdialect.decorators.SortingStrategy) - Method in LayoutDialect +
Configure this instance of the layout dialect with the given sortingStrategy.
+
+ + + +

X

+
+ +
XmlDocumentDecorator - Class in nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml +
A decorator made to work over an XML document.
+
XmlDocumentDecorator() - Constructor in XmlDocumentDecorator +
+
+ + + +

Y

+
+ +
+ + + +

Z

+
+ +
+ + + +

_

+
+ +
+ + +
+ + +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 + +_ + + + +
+ + + + + +
+ + + + diff --git a/groovydoc/index.html b/groovydoc/index.html new file mode 100644 index 000000000..7ed7c964f --- /dev/null +++ b/groovydoc/index.html @@ -0,0 +1,90 @@ + + + + +Index (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + + <noscript> + <div>JavaScript is disabled on your browser.</div> + </noscript> + <h2>Frame Alert</h2> + <p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + diff --git a/groovydoc/inherit.gif b/groovydoc/inherit.gif new file mode 100644 index 0000000000000000000000000000000000000000..c814867a13deb0ca7ea2156c6ca1d5a03372af7e GIT binary patch literal 57 zcmZ?wbhEHbIIT!9-C*e{wE9>Kx3D)-;0v)C; KYxQGgum%9JOA&7X literal 0 HcmV?d00001 diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/LayoutDialect.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/LayoutDialect.html new file mode 100644 index 000000000..0fd819494 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/LayoutDialect.html @@ -0,0 +1,424 @@ + + + + + + + + + + + LayoutDialect (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
+ + + + + +
+ + + + + +
+ +
Package: nz.net.ultraq.thymeleaf.layoutdialect
+ +

[Groovy] Class LayoutDialect

+
+
+
    +
        • nz.net.ultraq.thymeleaf.layoutdialect.LayoutDialect +
        +
        +
          +
        • + + + +
          + +
          class LayoutDialect
          +extends AbstractProcessorDialect
          + +

          A dialect for Thymeleaf that lets you build layouts and reusable templates in + order to improve code reuse. +

          + To configure the layout dialect, you have 2 options: +

          +

          Note that the fluent API is currently the only way to enable the experimentatlTitleTokens + setting. With the number of options growing, the constructor might be + deprecated in favour of the fluent API methods.

          Authors:
          Emanuel Rabina

          + +
        • +
        +
        + +
        + +
        + +
        +
          +
        • + + + + + + +
            +
          • + + +

            Property Detail

            + + +
              +
            • +

              static final String DIALECT_NAME

              +

              +
            • +
            + + +
              +
            • +

              static final int DIALECT_PRECEDENCE

              +

              +
            • +
            + + +
              +
            • +

              static final String DIALECT_PREFIX

              +

              +
            • +
            + +
          • +
          + + + + + + +
            +
          • + + +

            Constructor Detail

            + + +
              +
            • +

              LayoutDialect(SortingStrategy sortingStrategy, boolean autoHeadMerging)

              +

              Constructor, configure the layout dialect.

              Parameters:
              sortingStrategy
              autoHeadMerging + - Experimental option, set to false to skip the automatic merging + of an HTML <head> section.

              +
            • +
            + +
          • +
          + + + + + +
            +
          • + + +

            Method Detail

            + + +
              +
            • +

              @Override
              Set<IProcessor> getProcessors(String dialectPrefix)

              +

              Returns the layout dialect's processors.

              Parameters:
              dialectPrefix
              Returns:
              All of the processors for HTML and XML template modes.

              +
            • +
            + + +
              +
            • +

              LayoutDialect withAutoHeadMerging(boolean autoHeadMerging)

              +

              Configure this instance of the layout dialect with the given autoHeadMerging + value.

              +
            • +
            + + +
              +
            • +

              LayoutDialect withExperimentalTitleTokens(boolean experimentalTitleTokens)

              +

              Configure this instance of the layout dialect with the given experimentalTitleTokens + value.

              +
            • +
            + + +
              +
            • +

              LayoutDialect withSortingStrategy(SortingStrategy sortingStrategy)

              +

              Configure this instance of the layout dialect with the given sortingStrategy.

              +
            • +
            + +
          • +
          + +
        • +
        +
        + + + +
        + + + + + +
        + + +
        + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/PojoLoggerFactory.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/PojoLoggerFactory.html new file mode 100644 index 000000000..775de0c7d --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/PojoLoggerFactory.html @@ -0,0 +1,310 @@ + + + + + + + + + + + PojoLoggerFactory (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
        + + + + + +
        + + + + + +
        + +
        Package: nz.net.ultraq.thymeleaf.layoutdialect
        + +

        [Groovy] Class PojoLoggerFactory

        +
        +
        +
          +
          • nz.net.ultraq.thymeleaf.layoutdialect.PojoLoggerFactory +
          +
          +
            +
          • + + + +
            + +
            @CompileStatic
            +@POJO
            +class PojoLoggerFactory
            +extends Object
            + +

            A no-Groovy wrapper around SLF4J's org.slf4j.LoggerFactory#getLogger(java.lang.Class) + method`. This is to get around a bug when the bytecode generated by + `groovyc` is then run through Azul's Zulu 8 JDK. The problem seems to arise + from a static context invoking that method, so the fix is to instantiate this + class, then use its getLogger method which then calls SLF4J's + method in a non-static context 🙃 +

            + This isn't a great fix, and should be removed either if the bug in + Groovy/Azul is fixed, a better workaround is discovered, or Java 8 support is + dropped.

            Authors:
            Emanuel Rabina
            See Also:
            thymeleaf-layout-dialect/230

            + +
          • +
          +
          + +
          +
            +
          • + + + + + + + + + + + + + + + + +
              +
            • +

              Constructor Summary

              +
                + + + + + + + + + + +
                Constructors 
                Constructor and description
                + PojoLoggerFactory()
                +
              +
            • +
            + + + + + + +
          • +
          +
          + +
          +
            +
          • + + + + + + + + + + +
              +
            • + + +

              Constructor Detail

              + + +
                +
              • +

                PojoLoggerFactory()

                +

                +
              • +
              + +
            • +
            + + + + + +
              +
            • + + +

              Method Detail

              + + + + +
            • +
            + +
          • +
          +
          + + + +
          + + + + + +
          + + +
          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/DecorateProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/DecorateProcessor.html new file mode 100644 index 000000000..e8ee816f4 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/DecorateProcessor.html @@ -0,0 +1,371 @@ + + + + + + + + + + + DecorateProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
          + + + + + +
          + + + + + +
          + +
          Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators
          + +

          [Groovy] Class DecorateProcessor

          +
          +
          +
            +
                  • nz.net.ultraq.thymeleaf.layoutdialect.decorators.DecorateProcessor +
                  +
                  +
                    +
                  • + + + +
                    + +
                    class DecorateProcessor
                    +extends AbstractAttributeModelProcessor
                    + +

                    Specifies the name of the template to decorate using the current template.

                    Authors:
                    Emanuel Rabina

                    + +
                  • +
                  +
                  + +
                  + +
                  + +
                  +
                    +
                  • + + + + + + +
                      +
                    • + + +

                      Property Detail

                      + + +
                        +
                      • +

                        static final String PROCESSOR_NAME

                        +

                        +
                      • +
                      + + +
                        +
                      • +

                        static final int PROCESSOR_PRECEDENCE

                        +

                        +
                      • +
                      + +
                    • +
                    + + + + + + +
                      +
                    • + + +

                      Constructor Detail

                      + + +
                        +
                      • +

                        DecorateProcessor(TemplateMode templateMode, String dialectPrefix, SortingStrategy sortingStrategy, boolean autoHeadMerging, boolean newTitleTokens)

                        +

                        Constructor, configure this processor to work on the 'decorate' attribute + and to use the given sorting strategy.

                        +
                      • +
                      + + +
                        +
                      • +

                        protected DecorateProcessor(TemplateMode templateMode, String dialectPrefix, SortingStrategy sortingStrategy, boolean autoHeadMerging, boolean newTitleTokens, String attributeName)

                        +

                        Constructor, configurable processor name for the purposes of the + deprecated layout:decorator alias.

                        +
                      • +
                      + +
                    • +
                    + + + + + + + +
                  • +
                  +
                  + + + +
                  + + + + + +
                  + + +
                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/Decorator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/Decorator.html new file mode 100644 index 000000000..7c0bfb2e8 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/Decorator.html @@ -0,0 +1,244 @@ + + + + + + + + + + + Decorator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                  + + + + + +
                  + + + + + +
                  + +
                  Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators
                  + +

                  [Groovy] Interface Decorator

                  +
                  +
                  +
                    + +
                  +
                  +
                    +
                  • + + +
                    + +
                    interface Decorator
                    + +

                    A decorator performs decoration of a target model, using a source model for + all the decorations to apply. What exactly "decoration" means can vary per + implementation.

                    Authors:
                    Emanuel Rabina

                    + +
                  • +
                  +
                  + +
                  +
                    +
                  • + + + + + + + + + + + + + + + + + + +
                      + +
                    • +

                      Methods Summary

                      +
                        + + + + + + + + + + + + + + +
                        Methods 
                        Type ParamsReturn TypeName and description
                        abstract IModeldecorate(IModel targetModel, IModel sourceModel)
                        Decorate the target model with the contents of the source model, returning + a new model that is the result of that decoration.
                        +
                      +
                    • + +
                    + +
                  • +
                  +
                  + +
                  +
                    +
                  • + + + + + + + + + + + + + +
                      +
                    • + + +

                      Method Detail

                      + + +
                        +
                      • +

                        abstract IModel decorate(IModel targetModel, IModel sourceModel)

                        +

                        Decorate the target model with the contents of the source model, returning + a new model that is the result of that decoration.

                        Parameters:
                        targetModel - The target model to be decorated.
                        sourceModel - The source model to use for decorating.
                        Returns:
                        A new model that is the result of the decoration process.

                        +
                      • +
                      + +
                    • +
                    + +
                  • +
                  +
                  + + + +
                  + + + + + +
                  + + +
                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/SortingStrategy.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/SortingStrategy.html new file mode 100644 index 000000000..e5bf3a76f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/SortingStrategy.html @@ -0,0 +1,243 @@ + + + + + + + + + + + SortingStrategy (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                  + + + + + +
                  + + + + + +
                  + +
                  Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators
                  + +

                  [Groovy] Interface SortingStrategy

                  +
                  +
                  +
                    + +
                  +
                  +
                    +
                  • + + +
                    + +
                    interface SortingStrategy
                    + +

                    Interface for controlling the sort order in which <head> elements + from one source are placed into another.

                    Authors:
                    Emanuel Rabina

                    + +
                  • +
                  +
                  + +
                  +
                    +
                  • + + + + + + + + + + + + + + + + + + +
                      + +
                    • +

                      Methods Summary

                      +
                        + + + + + + + + + + + + + + +
                        Methods 
                        Type ParamsReturn TypeName and description
                        abstract intfindPositionForModel(IModel headModel, IModel childModel)
                        Returns the position in a <head> element model to insert a child + model.
                        +
                      +
                    • + +
                    + +
                  • +
                  +
                  + +
                  +
                    +
                  • + + + + + + + + + + + + + +
                      +
                    • + + +

                      Method Detail

                      + + +
                        +
                      • +

                        abstract int findPositionForModel(IModel headModel, IModel childModel)

                        +

                        Returns the position in a <head> element model to insert a child + model.

                        Parameters:
                        headModel - Model of a <head> element.
                        childModel - A model that can be found in a <head> element.
                        Returns:
                        Position to insert the child model into.

                        +
                      • +
                      + +
                    • +
                    + +
                  • +
                  +
                  + + + +
                  + + + + + +
                  + + +
                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitlePatternProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitlePatternProcessor.html new file mode 100644 index 000000000..571a138ff --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitlePatternProcessor.html @@ -0,0 +1,383 @@ + + + + + + + + + + + TitlePatternProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                  + + + + + +
                  + + + + + +
                  + +
                  Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators
                  + +

                  [Groovy] Class TitlePatternProcessor

                  +
                  +
                  +
                    +
                          • nz.net.ultraq.thymeleaf.layoutdialect.decorators.TitlePatternProcessor +
                          +
                          +
                            +
                          • + + + +
                            + +
                            class TitlePatternProcessor
                            +extends AbstractAttributeTagProcessor
                            + +

                            Allows for greater control of the resulting <title> element by + specifying a pattern with some special tokens. This can be used to extend + the layout's title with the content's one, instead of simply overriding + it.

                            Authors:
                            Emanuel Rabina

                            + +
                          • +
                          +
                          + +
                          + +
                          + +
                          +
                            +
                          • + + + + + + +
                              +
                            • + + +

                              Property Detail

                              + + +
                                +
                              • +

                                static final String CONTENT_TITLE_KEY

                                +

                                +
                              • +
                              + + +
                                +
                              • +

                                static final String LAYOUT_TITLE_KEY

                                +

                                +
                              • +
                              + + +
                                +
                              • +

                                static final String PROCESSOR_NAME

                                +

                                +
                              • +
                              + + +
                                +
                              • +

                                static final int PROCESSOR_PRECEDENCE

                                +

                                +
                              • +
                              + +
                            • +
                            + + + + + + +
                              +
                            • + + +

                              Constructor Detail

                              + + +
                                +
                              • +

                                TitlePatternProcessor(TemplateMode templateMode, String dialectPrefix)

                                +

                                Constructor, sets this processor to work on the 'title-pattern' attribute.

                                +
                              • +
                              + +
                            • +
                            + + + + + + + +
                          • +
                          +
                          + + + +
                          + + + + + +
                          + + +
                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitleProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitleProcessor.html new file mode 100644 index 000000000..a3c5b1c12 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/TitleProcessor.html @@ -0,0 +1,384 @@ + + + + + + + + + + + TitleProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                          + + + + + +
                          + + + + + +
                          + +
                          Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators
                          + +

                          [Groovy] Class TitleProcessor

                          +
                          +
                          +
                            +
                                  • nz.net.ultraq.thymeleaf.layoutdialect.decorators.TitleProcessor +
                                  +
                                  +
                                    +
                                  • + + + +
                                    + +
                                    class TitleProcessor
                                    +extends AbstractAttributeTagProcessor
                                    + +

                                    A processor for the experimental feature of using standard Thymeleaf + expression syntax when creating the <title> element, as opposed to + the special syntax required of layout:title-pattern.

                                    Authors:
                                    Emanuel Rabina

                                    + +
                                  • +
                                  +
                                  + +
                                  + +
                                  + +
                                  +
                                    +
                                  • + + + + + + +
                                      +
                                    • + + +

                                      Property Detail

                                      + + +
                                        +
                                      • +

                                        static final String CONTENT_TITLE_KEY

                                        +

                                        +
                                      • +
                                      + + +
                                        +
                                      • +

                                        static final String LAYOUT_TITLE_KEY

                                        +

                                        +
                                      • +
                                      + + +
                                        +
                                      • +

                                        static final String PROCESSOR_NAME

                                        +

                                        +
                                      • +
                                      + + +
                                        +
                                      • +

                                        static final int PROCESSOR_PRECEDENCE

                                        +

                                        +
                                      • +
                                      + +
                                    • +
                                    + + + + + + +
                                      +
                                    • + + +

                                      Constructor Detail

                                      + + +
                                        +
                                      • +

                                        TitleProcessor(TemplateMode templateMode, String dialectPrefix)

                                        +

                                        Constructor, sets this processor to work on the 'title' attribute.

                                        +
                                      • +
                                      + +
                                    • +
                                    + + + + + + + +
                                  • +
                                  +
                                  + + + +
                                  + + + + + +
                                  + + +
                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlBodyDecorator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlBodyDecorator.html new file mode 100644 index 000000000..e78814aad --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlBodyDecorator.html @@ -0,0 +1,346 @@ + + + + + + + + + + + HtmlBodyDecorator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                  + + + + + +
                                  + + + + + +
                                  + +
                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.html
                                  + +

                                  [Groovy] Class HtmlBodyDecorator

                                  +
                                  +
                                  +
                                    +
                                    • nz.net.ultraq.thymeleaf.layoutdialect.decorators.html.HtmlBodyDecorator +
                                    +
                                    +
                                      +
                                    • + +
                                      +
                                      All Implemented Interfaces and Traits:
                                      +
                                      Decorator
                                      +
                                      + + + +
                                      + +
                                      @TupleConstructor(defaults: false)
                                      +class HtmlBodyDecorator
                                      +extends Object
                                      +implements Decorator
                                      + +

                                      A decorator specific to processing an HTML <body> element.

                                      Authors:
                                      Emanuel Rabina

                                      + +
                                    • +
                                    +
                                    + +
                                    +
                                      +
                                    • + + + + + + + + + + +
                                        +
                                      • +

                                        Properties Summary

                                        + +
                                      • + +
                                      + + + + + + + +
                                        +
                                      • +

                                        Constructor Summary

                                        +
                                          + + + + + + + + + + +
                                          Constructors 
                                          Constructor and description
                                          + HtmlBodyDecorator()
                                          +
                                        +
                                      • +
                                      + + + + + + +
                                    • +
                                    +
                                    + +
                                    +
                                      +
                                    • + + + + + + + + + + + + + +
                                        +
                                      • + + +

                                        Constructor Detail

                                        + + +
                                          +
                                        • +

                                          HtmlBodyDecorator()

                                          +

                                          +
                                        • +
                                        + +
                                      • +
                                      + + + + + +
                                        +
                                      • + + +

                                        Method Detail

                                        + + +
                                          +
                                        • +

                                          @Override
                                          IModel decorate(IModel targetBodyModel, IModel sourceBodyModel)

                                          +

                                          Decorate the <body> part.

                                          Parameters:
                                          targetBodyModel
                                          sourceBodyModel
                                          Returns:
                                          Result of the decoration.

                                          +
                                        • +
                                        + +
                                      • +
                                      + +
                                    • +
                                    +
                                    + + + +
                                    + + + + + +
                                    + + +
                                    + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlDocumentDecorator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlDocumentDecorator.html new file mode 100644 index 000000000..8d217f6d7 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlDocumentDecorator.html @@ -0,0 +1,384 @@ + + + + + + + + + + + HtmlDocumentDecorator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                    + + + + + +
                                    + + + + + +
                                    + +
                                    Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.html
                                    + +

                                    [Groovy] Class HtmlDocumentDecorator

                                    +
                                    +
                                    +
                                      +
                                        • nz.net.ultraq.thymeleaf.layoutdialect.decorators.html.HtmlDocumentDecorator +
                                        +
                                        +
                                          +
                                        • + + + +
                                          + +
                                          class HtmlDocumentDecorator
                                          +extends XmlDocumentDecorator
                                          + +

                                          A decorator made to work over an HTML document. Decoration for a document + involves 2 sub-decorators: a special one for the <head> element, and + a standard one for the <body> element.

                                          Authors:
                                          Emanuel Rabina

                                          + +
                                        • +
                                        +
                                        + +
                                        +
                                          +
                                        • + + + + + + + + + + + + + + + + + + +
                                            +
                                          • +

                                            Constructor Summary

                                            +
                                              + + + + + + + + + + +
                                              Constructors 
                                              Constructor and description
                                              + HtmlDocumentDecorator(ITemplateContext context, SortingStrategy sortingStrategy, boolean autoHeadMerging, boolean newTitleTokens)
                                              Constructor, builds a decorator with the given configuration.
                                              +
                                            +
                                          • +
                                          + + + + +
                                            + +
                                          • +

                                            Methods Summary

                                            +
                                              + + + + + + + + + + + + + + +
                                              Methods 
                                              Type ParamsReturn TypeName and description
                                              IModeldecorate(IModel targetDocumentModel, IModel sourceDocumentModel)
                                              +
                                            +
                                          • + +
                                          • +

                                            Inherited Methods Summary

                                            + +
                                          • + +
                                          + +
                                        • +
                                        +
                                        + +
                                        +
                                          +
                                        • + + + + + + +
                                            +
                                          • + + +

                                            Property Detail

                                            + + +
                                              +
                                            • +

                                              final boolean autoHeadMerging

                                              +

                                              +
                                            • +
                                            + + +
                                              +
                                            • +

                                              final boolean newTitleTokens

                                              +

                                              +
                                            • +
                                            + + + + +
                                          • +
                                          + + + + + + +
                                            +
                                          • + + +

                                            Constructor Detail

                                            + + +
                                              +
                                            • +

                                              HtmlDocumentDecorator(ITemplateContext context, SortingStrategy sortingStrategy, boolean autoHeadMerging, boolean newTitleTokens)

                                              +

                                              Constructor, builds a decorator with the given configuration.

                                              +
                                            • +
                                            + +
                                          • +
                                          + + + + + + + +
                                        • +
                                        +
                                        + + + +
                                        + + + + + +
                                        + + +
                                        + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlHeadDecorator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlHeadDecorator.html new file mode 100644 index 000000000..b6c5e537f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlHeadDecorator.html @@ -0,0 +1,372 @@ + + + + + + + + + + + HtmlHeadDecorator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                        + + + + + +
                                        + + + + + +
                                        + +
                                        Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.html
                                        + +

                                        [Groovy] Class HtmlHeadDecorator

                                        +
                                        +
                                        +
                                          +
                                          • nz.net.ultraq.thymeleaf.layoutdialect.decorators.html.HtmlHeadDecorator +
                                          +
                                          +
                                            +
                                          • + +
                                            +
                                            All Implemented Interfaces and Traits:
                                            +
                                            Decorator
                                            +
                                            + + + +
                                            + +
                                            @TupleConstructor(defaults: false)
                                            +class HtmlHeadDecorator
                                            +extends Object
                                            +implements Decorator
                                            + +

                                            A decorator specific to processing an HTML <head> element.

                                            Authors:
                                            Emanuel Rabina

                                            + +
                                          • +
                                          +
                                          + +
                                          + +
                                          + +
                                          +
                                            +
                                          • + + + + + + +
                                              +
                                            • + + +

                                              Property Detail

                                              + + + + + +
                                                +
                                              • +

                                                final boolean newTitleTokens

                                                +

                                                +
                                              • +
                                              + + + + +
                                            • +
                                            + + + + + + +
                                              +
                                            • + + +

                                              Constructor Detail

                                              + + +
                                                +
                                              • +

                                                HtmlHeadDecorator()

                                                +

                                                +
                                              • +
                                              + +
                                            • +
                                            + + + + + + + +
                                          • +
                                          +
                                          + + + +
                                          + + + + + +
                                          + + +
                                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlTitleDecorator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlTitleDecorator.html new file mode 100644 index 000000000..0d39f3a72 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/HtmlTitleDecorator.html @@ -0,0 +1,361 @@ + + + + + + + + + + + HtmlTitleDecorator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                          + + + + + +
                                          + + + + + +
                                          + +
                                          Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.html
                                          + +

                                          [Groovy] Class HtmlTitleDecorator

                                          +
                                          +
                                          +
                                            +
                                            • nz.net.ultraq.thymeleaf.layoutdialect.decorators.html.HtmlTitleDecorator +
                                            +
                                            +
                                              +
                                            • + +
                                              +
                                              All Implemented Interfaces and Traits:
                                              +
                                              Decorator
                                              +
                                              + + + +
                                              + +
                                              @TupleConstructor(defaults: false)
                                              +class HtmlTitleDecorator
                                              +extends Object
                                              +implements Decorator
                                              + +

                                              Decorator for the <title> part of the template to handle the special + processing required for the layout:title-pattern and + layout:title processors.

                                              Authors:
                                              Emanuel Rabina

                                              + +
                                            • +
                                            +
                                            + +
                                            + +
                                            + +
                                            +
                                              +
                                            • + + + + + + +
                                                +
                                              • + + +

                                                Property Detail

                                                + + + + + +
                                                  +
                                                • +

                                                  final boolean newTitleTokens

                                                  +

                                                  +
                                                • +
                                                + +
                                              • +
                                              + + + + + + +
                                                +
                                              • + + +

                                                Constructor Detail

                                                + + +
                                                  +
                                                • +

                                                  HtmlTitleDecorator()

                                                  +

                                                  +
                                                • +
                                                + +
                                              • +
                                              + + + + + + + +
                                            • +
                                            +
                                            + + + +
                                            + + + + + +
                                            + + +
                                            + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-frame.html new file mode 100644 index 000000000..3395bf7c0 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.decorators.html + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-summary.html new file mode 100644 index 000000000..a11801df6 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/html/package-summary.html @@ -0,0 +1,170 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.decorators.html (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                            + + + + + + +
                                            + + + + + +
                                            +

                                            Package nz.net.ultraq.thymeleaf.layoutdialect.decorators.html

                                            +
                                            + + + +
                                            + + + + +
                                            +
                                              +
                                            • + + + + + + + + + + + + + + + + + + + + + + + + + +
                                              Class Summary 
                                              ClassDescription
                                              + + HtmlBodyDecorator + + A decorator specific to processing an HTML <body> element.
                                              + + HtmlDocumentDecorator + + A decorator made to work over an HTML document.
                                              + + HtmlHeadDecorator + + A decorator specific to processing an HTML <head> element.
                                              + + HtmlTitleDecorator + + Decorator for the <title> part of the template to handle the special + processing required for the layout:title-pattern and + layout:title processors.
                                              +
                                            • +
                                            +
                                            + + + + + + + +
                                            + + +
                                            + + + + + +
                                            + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-frame.html new file mode 100644 index 000000000..a925fc164 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-frame.html @@ -0,0 +1,66 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.decorators + + + + + + + + + + + + + + +
                                            +

                                            Interfaces

                                            + +
                                            + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-summary.html new file mode 100644 index 000000000..11c1567ea --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/package-summary.html @@ -0,0 +1,199 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.decorators (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                            + + + + + + +
                                            + + + + + +
                                            +

                                            Package nz.net.ultraq.thymeleaf.layoutdialect.decorators

                                            +
                                            + + + +
                                            + + +
                                            +
                                              +
                                            • + + + + + + + + + + + + + + + + + +
                                              Interface Summary 
                                              InterfaceDescription
                                              + + Decorator + + A decorator performs decoration of a target model, using a source model for + all the decorations to apply.
                                              + + SortingStrategy + + Interface for controlling the sort order in which <head> elements + from one source are placed into another.
                                              +
                                            • +
                                            +
                                            + + + + +
                                            +
                                              +
                                            • + + + + + + + + + + + + + + + + + + + + + +
                                              Class Summary 
                                              ClassDescription
                                              + + DecorateProcessor + + Specifies the name of the template to decorate using the current template.
                                              + + TitlePatternProcessor + + Allows for greater control of the resulting <title> element by + specifying a pattern with some special tokens.
                                              + + TitleProcessor + + A processor for the experimental feature of using standard Thymeleaf + expression syntax when creating the <title> element, as opposed to + the special syntax required of layout:title-pattern.
                                              +
                                            • +
                                            +
                                            + + + + + + + +
                                            + + +
                                            + + + + + +
                                            + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/AppendingStrategy.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/AppendingStrategy.html new file mode 100644 index 000000000..a85a75e5f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/AppendingStrategy.html @@ -0,0 +1,306 @@ + + + + + + + + + + + AppendingStrategy (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                            + + + + + +
                                            + + + + + +
                                            + +
                                            Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies
                                            + +

                                            [Groovy] Class AppendingStrategy

                                            +
                                            +
                                            +
                                              +
                                              • nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies.AppendingStrategy +
                                              +
                                              +
                                                +
                                              • + +
                                                +
                                                All Implemented Interfaces and Traits:
                                                +
                                                SortingStrategy
                                                +
                                                + + + +
                                                + +
                                                class AppendingStrategy
                                                +extends Object
                                                +implements SortingStrategy
                                                + +

                                                The standard <head> merging strategy, which simply appends the + content elements to the layout ones.

                                                Authors:
                                                Emanuel Rabina
                                                Since:
                                                2.4.0

                                                + +
                                              • +
                                              +
                                              + +
                                              +
                                                +
                                              • + + + + + + + + + + + + + + + + +
                                                  +
                                                • +

                                                  Constructor Summary

                                                  +
                                                    + + + + + + + + + + +
                                                    Constructors 
                                                    Constructor and description
                                                    + AppendingStrategy()
                                                    +
                                                  +
                                                • +
                                                + + + + + + +
                                              • +
                                              +
                                              + +
                                              +
                                                +
                                              • + + + + + + + + + + +
                                                  +
                                                • + + +

                                                  Constructor Detail

                                                  + + +
                                                    +
                                                  • +

                                                    AppendingStrategy()

                                                    +

                                                    +
                                                  • +
                                                  + +
                                                • +
                                                + + + + + +
                                                  +
                                                • + + +

                                                  Method Detail

                                                  + + +
                                                    +
                                                  • +

                                                    int findPositionForModel(IModel headModel, IModel childModel)

                                                    +

                                                    Returns the position at the end of the <head> section.

                                                    Parameters:
                                                    headModel
                                                    event
                                                    Returns:
                                                    The end of the head model.

                                                    +
                                                  • +
                                                  + +
                                                • +
                                                + +
                                              • +
                                              +
                                              + + + +
                                              + + + + + +
                                              + + +
                                              + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/GroupingStrategy.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/GroupingStrategy.html new file mode 100644 index 000000000..26205c186 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/GroupingStrategy.html @@ -0,0 +1,308 @@ + + + + + + + + + + + GroupingStrategy (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                              + + + + + +
                                              + + + + + +
                                              + +
                                              Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies
                                              + +

                                              [Groovy] Class GroupingStrategy

                                              +
                                              +
                                              +
                                                +
                                                • nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies.GroupingStrategy +
                                                +
                                                +
                                                  +
                                                • + +
                                                  +
                                                  All Implemented Interfaces and Traits:
                                                  +
                                                  SortingStrategy
                                                  +
                                                  + + + +
                                                  + +
                                                  class GroupingStrategy
                                                  +extends Object
                                                  +implements SortingStrategy
                                                  + +

                                                  The <head> merging strategy which groups like elements together.

                                                  Authors:
                                                  Emanuel Rabina
                                                  Since:
                                                  2.4.0

                                                  + +
                                                • +
                                                +
                                                + +
                                                +
                                                  +
                                                • + + + + + + + + + + + + + + + + +
                                                    +
                                                  • +

                                                    Constructor Summary

                                                    +
                                                      + + + + + + + + + + +
                                                      Constructors 
                                                      Constructor and description
                                                      + GroupingStrategy()
                                                      +
                                                    +
                                                  • +
                                                  + + + + + + +
                                                • +
                                                +
                                                + +
                                                +
                                                  +
                                                • + + + + + + + + + + +
                                                    +
                                                  • + + +

                                                    Constructor Detail

                                                    + + +
                                                      +
                                                    • +

                                                      GroupingStrategy()

                                                      +

                                                      +
                                                    • +
                                                    + +
                                                  • +
                                                  + + + + + +
                                                    +
                                                  • + + +

                                                    Method Detail

                                                    + + +
                                                      +
                                                    • +

                                                      int findPositionForModel(IModel headModel, IModel childModel)

                                                      +

                                                      Returns the index of the last set of elements that are of the same 'type' + as the content node. eg: groups scripts with scripts, stylesheets with + stylesheets, and so on.

                                                      Parameters:
                                                      headModel
                                                      childModel
                                                      Returns:
                                                      Position of the end of the matching element group.

                                                      +
                                                    • +
                                                    + +
                                                  • +
                                                  + +
                                                • +
                                                +
                                                + + + +
                                                + + + + + +
                                                + + +
                                                + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-frame.html new file mode 100644 index 000000000..449443ce9 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-summary.html new file mode 100644 index 000000000..34d6e9a97 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/strategies/package-summary.html @@ -0,0 +1,153 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                + + + + + + +
                                                + + + + + +
                                                +

                                                Package nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies

                                                +
                                                + + + +
                                                + + + + +
                                                +
                                                  +
                                                • + + + + + + + + + + + + + + + + + +
                                                  Class Summary 
                                                  ClassDescription
                                                  + + AppendingStrategy + + The standard <head> merging strategy, which simply appends the + content elements to the layout ones.
                                                  + + GroupingStrategy + + The <head> merging strategy which groups like elements together.
                                                  +
                                                • +
                                                +
                                                + + + + + + + +
                                                + + +
                                                + + + + + +
                                                + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/XmlDocumentDecorator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/XmlDocumentDecorator.html new file mode 100644 index 000000000..e22cf175b --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/XmlDocumentDecorator.html @@ -0,0 +1,346 @@ + + + + + + + + + + + XmlDocumentDecorator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                + + + + + +
                                                + + + + + +
                                                + +
                                                Package: nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml
                                                + +

                                                [Groovy] Class XmlDocumentDecorator

                                                +
                                                +
                                                +
                                                  +
                                                  • nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml.XmlDocumentDecorator +
                                                  +
                                                  +
                                                    +
                                                  • + +
                                                    +
                                                    All Implemented Interfaces and Traits:
                                                    +
                                                    Decorator
                                                    +
                                                    + + + +
                                                    + +
                                                    @TupleConstructor(defaults: false)
                                                    +class XmlDocumentDecorator
                                                    +extends Object
                                                    +implements Decorator
                                                    + +

                                                    A decorator made to work over an XML document.

                                                    Authors:
                                                    Emanuel Rabina

                                                    + +
                                                  • +
                                                  +
                                                  + +
                                                  +
                                                    +
                                                  • + + + + + + + + + + +
                                                      +
                                                    • +

                                                      Properties Summary

                                                      + +
                                                    • + +
                                                    + + + + + + + +
                                                      +
                                                    • +

                                                      Constructor Summary

                                                      + +
                                                    • +
                                                    + + + + + + +
                                                  • +
                                                  +
                                                  + +
                                                  +
                                                    +
                                                  • + + + + + + + + + + + + + +
                                                      +
                                                    • + + +

                                                      Constructor Detail

                                                      + + +
                                                        +
                                                      • +

                                                        XmlDocumentDecorator()

                                                        +

                                                        +
                                                      • +
                                                      + +
                                                    • +
                                                    + + + + + + + +
                                                  • +
                                                  +
                                                  + + + +
                                                  + + + + + +
                                                  + + +
                                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-frame.html new file mode 100644 index 000000000..8774e4c71 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml + + + + + + + + + + + + + + + + +
                                                  +

                                                  Classes

                                                  + +
                                                  + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-summary.html new file mode 100644 index 000000000..9ea23fa7f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/decorators/xml/package-summary.html @@ -0,0 +1,144 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                  + + + + + + +
                                                  + + + + + +
                                                  +

                                                  Package nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml

                                                  +
                                                  + + + +
                                                  + + + + +
                                                  +
                                                    +
                                                  • + + + + + + + + + + + + + +
                                                    Class Summary 
                                                    ClassDescription
                                                    + + XmlDocumentDecorator + + A decorator made to work over an XML document.
                                                    +
                                                  • +
                                                  +
                                                  + + + + + + + +
                                                  + + +
                                                  + + + + + +
                                                  + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/FragmentExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/FragmentExtensions.html new file mode 100644 index 000000000..d11f20251 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/FragmentExtensions.html @@ -0,0 +1,359 @@ + + + + + + + + + + + FragmentExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                  + + + + + +
                                                  + + + + + +
                                                  + +
                                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                  + +

                                                  [Groovy] Class FragmentExtensions

                                                  +
                                                  +
                                                  +
                                                    +
                                                    • nz.net.ultraq.thymeleaf.layoutdialect.extensions.FragmentExtensions +
                                                    +
                                                    +
                                                      +
                                                    • + + + +
                                                      + +
                                                      class FragmentExtensions
                                                      +extends Object
                                                      + +

                                                      Extensions to Thymeleaf for working with fragments.

                                                      Authors:
                                                      Emanuel Rabina

                                                      + +
                                                    • +
                                                    +
                                                    + +
                                                    + +
                                                    + +
                                                    +
                                                      +
                                                    • + + + + + + +
                                                        +
                                                      • + + +

                                                        Property Detail

                                                        + + +
                                                          +
                                                        • +

                                                          static final String FRAGMENT_COLLECTION_KEY

                                                          +

                                                          +
                                                        • +
                                                        + +
                                                      • +
                                                      + + + + + + +
                                                        +
                                                      • + + +

                                                        Constructor Detail

                                                        + + +
                                                          +
                                                        • +

                                                          FragmentExtensions()

                                                          +

                                                          +
                                                        • +
                                                        + +
                                                      • +
                                                      + + + + + +
                                                        +
                                                      • + + +

                                                        Method Detail

                                                        + + +
                                                          +
                                                        • +

                                                          static Map<String, List<IModel>> getFragmentCollection(ITemplateContext self, boolean fromDecorator)

                                                          +

                                                          Retrieves the fragment collection for the current context.

                                                          Parameters:
                                                          self
                                                          fromDecorator
                                                          Returns:
                                                          A new or existing fragment collection.

                                                          +
                                                        • +
                                                        + + +
                                                          +
                                                        • +

                                                          static void setLocalFragmentCollection(IElementModelStructureHandler self, ITemplateContext context, Map<String, List<IModel>> fragments, boolean fromDecorator)

                                                          +

                                                          Set a fragment cache to contain any existing fragments, plus the given new + fragments, with the same scope as setting a local variable.

                                                          Parameters:
                                                          self
                                                          context
                                                          fragments + - The new fragments to add to the cache.
                                                          fromDecorator + - Whether the call was from DecorateProcessor, used for determining + if a new fragment collection should be used and the order of collected + fragments.

                                                          +
                                                        • +
                                                        + +
                                                      • +
                                                      + +
                                                    • +
                                                    +
                                                    + + + +
                                                    + + + + + +
                                                    + + +
                                                    + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IAttributeExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IAttributeExtensions.html new file mode 100644 index 000000000..1aafe78e6 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IAttributeExtensions.html @@ -0,0 +1,304 @@ + + + + + + + + + + + IAttributeExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                    + + + + + +
                                                    + + + + + +
                                                    + +
                                                    Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                    + +

                                                    [Groovy] Class IAttributeExtensions

                                                    +
                                                    +
                                                    +
                                                      +
                                                      • nz.net.ultraq.thymeleaf.layoutdialect.extensions.IAttributeExtensions +
                                                      +
                                                      +
                                                        +
                                                      • + + + +
                                                        + +
                                                        class IAttributeExtensions
                                                        +extends Object
                                                        + +

                                                        Meta-programming extensions to the IAttribute class.

                                                        Authors:
                                                        Emanuel Rabina

                                                        + +
                                                      • +
                                                      +
                                                      + +
                                                      +
                                                        +
                                                      • + + + + + + + + + + + + + + + + +
                                                          +
                                                        • +

                                                          Constructor Summary

                                                          + +
                                                        • +
                                                        + + + + +
                                                          + +
                                                        • +

                                                          Methods Summary

                                                          +
                                                            + + + + + + + + + + + + + + +
                                                            Methods 
                                                            Type ParamsReturn TypeName and description
                                                            static booleanequalsName(IAttribute self, String prefix, String name)
                                                            Returns whether or not an attribute is an attribute processor of + the given name, checks both prefix:processor and + data-prefix-processor variants.
                                                            +
                                                          +
                                                        • + +
                                                        • +

                                                          Inherited Methods Summary

                                                          + +
                                                        • + +
                                                        + +
                                                      • +
                                                      +
                                                      + +
                                                      +
                                                        +
                                                      • + + + + + + + + + + +
                                                          +
                                                        • + + +

                                                          Constructor Detail

                                                          + + +
                                                            +
                                                          • +

                                                            IAttributeExtensions()

                                                            +

                                                            +
                                                          • +
                                                          + +
                                                        • +
                                                        + + + + + +
                                                          +
                                                        • + + +

                                                          Method Detail

                                                          + + +
                                                            +
                                                          • +

                                                            static boolean equalsName(IAttribute self, String prefix, String name)

                                                            +

                                                            Returns whether or not an attribute is an attribute processor of + the given name, checks both prefix:processor and + data-prefix-processor variants.

                                                            Parameters:
                                                            self
                                                            prefix
                                                            name
                                                            Returns:
                                                            true if this attribute is an attribute processor of the + matching name.

                                                            +
                                                          • +
                                                          + +
                                                        • +
                                                        + +
                                                      • +
                                                      +
                                                      + + + +
                                                      + + + + + +
                                                      + + +
                                                      + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ICloseElementTagExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ICloseElementTagExtensions.html new file mode 100644 index 000000000..52a819111 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ICloseElementTagExtensions.html @@ -0,0 +1,300 @@ + + + + + + + + + + + ICloseElementTagExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                      + + + + + +
                                                      + + + + + +
                                                      + +
                                                      Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                      + +

                                                      [Groovy] Class ICloseElementTagExtensions

                                                      +
                                                      +
                                                      +
                                                        +
                                                        • nz.net.ultraq.thymeleaf.layoutdialect.extensions.ICloseElementTagExtensions +
                                                        +
                                                        +
                                                          +
                                                        • + + + +
                                                          + +
                                                          class ICloseElementTagExtensions
                                                          +extends Object
                                                          + +

                                                          Meta-programming extensions to the ICloseElementTag class.

                                                          Authors:
                                                          Emanuel Rabina

                                                          + +
                                                        • +
                                                        +
                                                        + +
                                                        +
                                                          +
                                                        • + + + + + + + + + + + + + + + + + + + + + + + +
                                                        • +
                                                        +
                                                        + +
                                                        +
                                                          +
                                                        • + + + + + + + + + + +
                                                            +
                                                          • + + +

                                                            Constructor Detail

                                                            + + +
                                                              +
                                                            • +

                                                              ICloseElementTagExtensions()

                                                              +

                                                              +
                                                            • +
                                                            + +
                                                          • +
                                                          + + + + + +
                                                            +
                                                          • + + +

                                                            Method Detail

                                                            + + +
                                                              +
                                                            • +

                                                              @SuppressWarnings(value: EqualsOverloaded)
                                                              static boolean equals(ICloseElementTag self, Object other)

                                                              +

                                                              Compares this close tag with another.

                                                              Parameters:
                                                              self
                                                              other
                                                              Returns:
                                                              true if this tag has the same name as the other + element.

                                                              +
                                                            • +
                                                            + +
                                                          • +
                                                          + +
                                                        • +
                                                        +
                                                        + + + +
                                                        + + + + + +
                                                        + + +
                                                        + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IContextExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IContextExtensions.html new file mode 100644 index 000000000..283e439dc --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IContextExtensions.html @@ -0,0 +1,334 @@ + + + + + + + + + + + IContextExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                        + + + + + +
                                                        + + + + + +
                                                        + +
                                                        Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                        + +

                                                        [Groovy] Class IContextExtensions

                                                        +
                                                        +
                                                        +
                                                          +
                                                          • nz.net.ultraq.thymeleaf.layoutdialect.extensions.IContextExtensions +
                                                          +
                                                          +
                                                            +
                                                          • + + + +
                                                            + +
                                                            class IContextExtensions
                                                            +extends Object
                                                            + +

                                                            Meta-programming extensions to the IContext class.

                                                            Authors:
                                                            Emanuel Rabina

                                                            + +
                                                          • +
                                                          +
                                                          + +
                                                          +
                                                            +
                                                          • + + + + + + + + + + + + + + + + +
                                                              +
                                                            • +

                                                              Constructor Summary

                                                              +
                                                                + + + + + + + + + + +
                                                                Constructors 
                                                                Constructor and description
                                                                + IContextExtensions()
                                                                +
                                                              +
                                                            • +
                                                            + + + + + + +
                                                          • +
                                                          +
                                                          + +
                                                          +
                                                            +
                                                          • + + + + + + + + + + +
                                                              +
                                                            • + + +

                                                              Constructor Detail

                                                              + + +
                                                                +
                                                              • +

                                                                IContextExtensions()

                                                                +

                                                                +
                                                              • +
                                                              + +
                                                            • +
                                                            + + + + + +
                                                              +
                                                            • + + +

                                                              Method Detail

                                                              + + +
                                                                +
                                                              • +

                                                                static Object getAt(IContext self, String name)

                                                                +

                                                                Enables use of the value = context[key] syntax over the context + object, is a synonym for the getVariable method.

                                                                Parameters:
                                                                self
                                                                name - Name of the variable on the context to retrieve.
                                                                Returns:
                                                                The variable value, or null if the variable isn't + mapped to anything on the context.

                                                                +
                                                              • +
                                                              + + +
                                                                +
                                                              • +

                                                                static String getPrefixForDialect(IContext self, Class<IProcessorDialect> dialectClass)

                                                                +

                                                                Returns the configured prefix for the given dialect. If the dialect + prefix has not been configured.

                                                                Parameters:
                                                                self
                                                                dialectClass
                                                                Returns:
                                                                The configured prefix for the dialect, or null if the + dialect being queried hasn't been configured.

                                                                +
                                                              • +
                                                              + + +
                                                                +
                                                              • +

                                                                static void putAt(IContext self, String name, Object value)

                                                                +

                                                                Enables use of the context[key] = value syntax over the context + object, is a synonym for the setVariable method.

                                                                Parameters:
                                                                self
                                                                name - Name of the variable to map the value to.
                                                                value - The value to set.

                                                                +
                                                              • +
                                                              + +
                                                            • +
                                                            + +
                                                          • +
                                                          +
                                                          + + + +
                                                          + + + + + +
                                                          + + +
                                                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IModelExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IModelExtensions.html new file mode 100644 index 000000000..a631c0937 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IModelExtensions.html @@ -0,0 +1,696 @@ + + + + + + + + + + + IModelExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                          + + + + + +
                                                          + + + + + +
                                                          + +
                                                          Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                          + +

                                                          [Groovy] Class IModelExtensions

                                                          +
                                                          +
                                                          +
                                                            +
                                                            • nz.net.ultraq.thymeleaf.layoutdialect.extensions.IModelExtensions +
                                                            +
                                                            +
                                                              +
                                                            • + + + +
                                                              + +
                                                              class IModelExtensions
                                                              +extends Object
                                                              + +

                                                              Meta-programming extensions to the IModel class.

                                                              Authors:
                                                              Emanuel Rabina

                                                              + +
                                                            • +
                                                            +
                                                            + +
                                                            +
                                                              +
                                                            • + + + + + + + + + + + + + + + + +
                                                                +
                                                              • +

                                                                Constructor Summary

                                                                +
                                                                  + + + + + + + + + + +
                                                                  Constructors 
                                                                  Constructor and description
                                                                  + IModelExtensions()
                                                                  +
                                                                +
                                                              • +
                                                              + + + + +
                                                                + +
                                                              • +

                                                                Methods Summary

                                                                +
                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                  Methods 
                                                                  Type ParamsReturn TypeName and description
                                                                  static booleanasBoolean(IModel self)
                                                                  Set that a model evaluates to 'false' if it has no events.
                                                                  static Iterator<IModel>childModelIterator(IModel self)
                                                                  If this model represents an element, then this method returns an + iterator over any potential child items as models of their own.
                                                                  static voideach(IModel self, Closure closure)
                                                                  Iterate through each event in the model.
                                                                  static booleanequals(IModel self, Object other)
                                                                  Compare 2 models, returning true if all of the model's events + are equal.
                                                                  static booleaneveryWithIndex(IModel self, Closure<Boolean> closure)
                                                                  Return true only if all the events in the model return + true for the given closure.
                                                                  static ITemplateEventfind(IModel self, Closure<Boolean> closure)
                                                                  Returns the first event in the model that meets the criteria of the + given closure.
                                                                  static List<ITemplateEvent>findAll(IModel self, Closure<Boolean> closure)
                                                                  Find all events in the model that match the given closure.
                                                                  static intfindIndexOf(IModel self, Closure<Boolean> closure)
                                                                  Returns the index of the first event in the model that meets the + criteria of the given closure.
                                                                  static intfindIndexOfModel(IModel self, IModel model)
                                                                  A special variant of findIndexOf that uses models, as I seem to + be using those a lot.
                                                                  static IModelfindModel(IModel self, Closure<Boolean> closure)
                                                                  Returns the first instance of a model that meets the given closure + criteria.
                                                                  static ITemplateEventfirst(IModel self)
                                                                  Returns the first event on the model.
                                                                  static IModelgetModel(IModel self, int pos)
                                                                  Returns the model at the given index.
                                                                  static voidinsertModelWithWhitespace(IModel self, int pos, IModel model, IModelFactory modelFactory)
                                                                  Inserts a model, creating whitespace events around it so that it appears in + line with all the existing events.
                                                                  static voidinsertWithWhitespace(IModel self, int pos, ITemplateEvent event, IModelFactory modelFactory)
                                                                  Inserts an event, creating a whitespace event before it so that it + appears in line with all the existing events.
                                                                  static booleanisElement(IModel self)
                                                                  Returns whether or not this model represents a single HTML element.
                                                                  static booleanisWhitespace(IModel self)
                                                                  Returns whether or not this model represents collapsible whitespace.
                                                                  static Iterator<ITemplateEvent>iterator(IModel self)
                                                                  Used to make this class iterable as an event queue.
                                                                  static ITemplateEventlast(IModel self)
                                                                  Returns the last event on the model.
                                                                  static voidremoveAllModels(IModel self, Closure<Boolean> closure)
                                                                  Remove a model identified by an event matched by the given closure.
                                                                  static voidremoveChildren(IModel self)
                                                                  If the model represents an element open to close tags, then this method + removes all of the inner events.
                                                                  static voidremoveFirst(IModel self)
                                                                  Removes the first event on the model.
                                                                  static voidremoveLast(IModel self)
                                                                  Removes the last event on the model.
                                                                  static voidremoveModel(IModel self, int pos)
                                                                  Removes a models-worth of events from the specified position.
                                                                  static voidreplaceModel(IModel self, int pos, IModel model)
                                                                  Replaces the model at the specified index with the given model.
                                                                  static intsizeOfModelAt(IModel self, int index)
                                                                  If an opening element exists at the given position, this method will + return the 'size' of that element (number of events from here to its + matching closing tag).
                                                                  static voidtrim(IModel self)
                                                                  Removes whitespace events from the head and tail of the model's + underlying event queue.
                                                                  +
                                                                +
                                                              • + +
                                                              • +

                                                                Inherited Methods Summary

                                                                + +
                                                              • + +
                                                              + +
                                                            • +
                                                            +
                                                            + +
                                                            +
                                                              +
                                                            • + + + + + + + + + + +
                                                                +
                                                              • + + +

                                                                Constructor Detail

                                                                + + +
                                                                  +
                                                                • +

                                                                  IModelExtensions()

                                                                  +

                                                                  +
                                                                • +
                                                                + +
                                                              • +
                                                              + + + + + +
                                                                +
                                                              • + + +

                                                                Method Detail

                                                                + + +
                                                                  +
                                                                • +

                                                                  static boolean asBoolean(IModel self)

                                                                  +

                                                                  Set that a model evaluates to 'false' if it has no events.

                                                                  Parameters:
                                                                  self
                                                                  Returns:
                                                                  true if this model has events.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static Iterator<IModel> childModelIterator(IModel self)

                                                                  +

                                                                  If this model represents an element, then this method returns an + iterator over any potential child items as models of their own.

                                                                  Parameters:
                                                                  self
                                                                  modelFactory
                                                                  Returns:
                                                                  New model iterator.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void each(IModel self, @ClosureParams(value: SimpleType, options: org.thymeleaf.model.ITemplateEvent)
                                                                  Closure closure)

                                                                  +

                                                                  Iterate through each event in the model.

                                                                  Parameters:
                                                                  self
                                                                  closure

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  @SuppressWarnings(value: EqualsOverloaded)
                                                                  static boolean equals(IModel self, Object other)

                                                                  +

                                                                  Compare 2 models, returning true if all of the model's events + are equal.

                                                                  Parameters:
                                                                  self
                                                                  other
                                                                  Returns:
                                                                  true if this model is the same as the other one.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static boolean everyWithIndex(IModel self, @ClosureParams(value: SimpleType, options: [org.thymeleaf.model.ITemplateEvent, int])
                                                                  Closure<Boolean> closure)

                                                                  +

                                                                  Return true only if all the events in the model return + true for the given closure.

                                                                  Parameters:
                                                                  self
                                                                  closure
                                                                  Returns:
                                                                  true if every event satisfies the closure.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static ITemplateEvent find(IModel self, @ClosureParams(value: SimpleType, options: org.thymeleaf.model.ITemplateEvent)
                                                                  Closure<Boolean> closure)

                                                                  +

                                                                  Returns the first event in the model that meets the criteria of the + given closure.

                                                                  Parameters:
                                                                  self
                                                                  closure
                                                                  Returns:
                                                                  The first event to match the closure criteria, or null + if nothing matched.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static List<ITemplateEvent> findAll(IModel self, @ClosureParams(value: SimpleType, options: org.thymeleaf.model.ITemplateEvent)
                                                                  Closure<Boolean> closure)

                                                                  +

                                                                  Find all events in the model that match the given closure.

                                                                  Parameters:
                                                                  self
                                                                  closure
                                                                  Returns:
                                                                  A list of matched events.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static int findIndexOf(IModel self, @ClosureParams(value: SimpleType, options: org.thymeleaf.model.ITemplateEvent)
                                                                  Closure<Boolean> closure)

                                                                  +

                                                                  Returns the index of the first event in the model that meets the + criteria of the given closure.

                                                                  Parameters:
                                                                  self
                                                                  closure
                                                                  Returns:
                                                                  The index of the first event to match the closure criteria, or + -1 if nothing matched.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static int findIndexOfModel(IModel self, IModel model)

                                                                  +

                                                                  A special variant of findIndexOf that uses models, as I seem to + be using those a lot. + + This doesn't use an equality check, but an object reference check, so + if a submodel is ever located from a parent (eg: any of the find + methods, you can use this method to find the location of that submodel + within the event queue.

                                                                  Parameters:
                                                                  self
                                                                  model
                                                                  Returns:
                                                                  Index of an extracted submodel within this model.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static IModel findModel(IModel self, @ClosureParams(value: SimpleType, options: org.thymeleaf.model.ITemplateEvent)
                                                                  Closure<Boolean> closure)

                                                                  +

                                                                  Returns the first instance of a model that meets the given closure + criteria.

                                                                  Parameters:
                                                                  self
                                                                  closure
                                                                  Returns:
                                                                  A model over the event that matches the closure criteria, or + null if nothing matched.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static ITemplateEvent first(IModel self)

                                                                  +

                                                                  Returns the first event on the model.

                                                                  Parameters:
                                                                  self
                                                                  Returns:
                                                                  The model's first event.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static IModel getModel(IModel self, int pos)

                                                                  +

                                                                  Returns the model at the given index. If the event at the index is an + opening element, then the returned model will consist of that element + and all the way through to the matching closing element.

                                                                  Parameters:
                                                                  self
                                                                  pos - A valid index within the current model.
                                                                  Returns:
                                                                  Model at the given position, or `null` if the position is + outside of the event queue.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void insertModelWithWhitespace(IModel self, int pos, IModel model, IModelFactory modelFactory)

                                                                  +

                                                                  Inserts a model, creating whitespace events around it so that it appears in + line with all the existing events. +

                                                                  + This is currently only targeting uses in the layout dialect so doesn't work + very well as a general-purpose whitespace generator.

                                                                  Parameters:
                                                                  self
                                                                  pos - A valid index within the current model.
                                                                  model
                                                                  modelFactory

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void insertWithWhitespace(IModel self, int pos, ITemplateEvent event, IModelFactory modelFactory)

                                                                  +

                                                                  Inserts an event, creating a whitespace event before it so that it + appears in line with all the existing events.

                                                                  Parameters:
                                                                  self
                                                                  pos - A valid index within the current model.
                                                                  event
                                                                  modelFactory

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static boolean isElement(IModel self)

                                                                  +

                                                                  Returns whether or not this model represents a single HTML element.

                                                                  Parameters:
                                                                  self
                                                                  Returns:
                                                                  true if the first event in this model is an opening tag + and the last event is the matching closing tag.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static boolean isWhitespace(IModel self)

                                                                  +

                                                                  Returns whether or not this model represents collapsible whitespace.

                                                                  Parameters:
                                                                  self
                                                                  Returns:
                                                                  true if this is a collapsible text model.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static Iterator<ITemplateEvent> iterator(IModel self)

                                                                  +

                                                                  Used to make this class iterable as an event queue.

                                                                  Parameters:
                                                                  self
                                                                  Returns:
                                                                  A new iterator over the events of this model.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  @SuppressWarnings(value: UnnecessaryCallForLastElement)
                                                                  static ITemplateEvent last(IModel self)

                                                                  +

                                                                  Returns the last event on the model.

                                                                  Parameters:
                                                                  self
                                                                  Returns:
                                                                  The model's last event.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void removeAllModels(IModel self, @ClosureParams(value: SimpleType, options: org.thymeleaf.model.ITemplateEvent)
                                                                  Closure<Boolean> closure)

                                                                  +

                                                                  Remove a model identified by an event matched by the given closure. Note + that this closure can match any event in the model, including the top-level + model itself.

                                                                  Parameters:
                                                                  self
                                                                  closure

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void removeChildren(IModel self)

                                                                  +

                                                                  If the model represents an element open to close tags, then this method + removes all of the inner events.

                                                                  Parameters:
                                                                  self

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void removeFirst(IModel self)

                                                                  +

                                                                  Removes the first event on the model.

                                                                  Parameters:
                                                                  self

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void removeLast(IModel self)

                                                                  +

                                                                  Removes the last event on the model.

                                                                  Parameters:
                                                                  self

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void removeModel(IModel self, int pos)

                                                                  +

                                                                  Removes a models-worth of events from the specified position. What + this means is that, if the event at the position is an opening element, + then it, and everything up to and including its matching end element, + is removed.

                                                                  Parameters:
                                                                  self
                                                                  pos - A valid index within the current model.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void replaceModel(IModel self, int pos, IModel model)

                                                                  +

                                                                  Replaces the model at the specified index with the given model.

                                                                  Parameters:
                                                                  self
                                                                  pos - A valid index within the current model.
                                                                  model

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  @SuppressWarnings(value: EmptyIfStatement)
                                                                  static int sizeOfModelAt(IModel self, int index)

                                                                  +

                                                                  If an opening element exists at the given position, this method will + return the 'size' of that element (number of events from here to its + matching closing tag).

                                                                  Parameters:
                                                                  self
                                                                  model
                                                                  index
                                                                  Returns:
                                                                  Size of an element from the given position, or 1 if the event + at the position isn't an opening element.

                                                                  +
                                                                • +
                                                                + + +
                                                                  +
                                                                • +

                                                                  static void trim(IModel self)

                                                                  +

                                                                  Removes whitespace events from the head and tail of the model's + underlying event queue.

                                                                  Parameters:
                                                                  self

                                                                  +
                                                                • +
                                                                + +
                                                              • +
                                                              + +
                                                            • +
                                                            +
                                                            + + + +
                                                            + + + + + +
                                                            + + +
                                                            + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IProcessableElementTagExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IProcessableElementTagExtensions.html new file mode 100644 index 000000000..a8494783f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IProcessableElementTagExtensions.html @@ -0,0 +1,318 @@ + + + + + + + + + + + IProcessableElementTagExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                            + + + + + +
                                                            + + + + + +
                                                            + +
                                                            Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                            + +

                                                            [Groovy] Class IProcessableElementTagExtensions

                                                            +
                                                            +
                                                            +
                                                              +
                                                              • nz.net.ultraq.thymeleaf.layoutdialect.extensions.IProcessableElementTagExtensions +
                                                              +
                                                              +
                                                                +
                                                              • + + + +
                                                                + +
                                                                class IProcessableElementTagExtensions
                                                                +extends Object
                                                                + +

                                                                Meta-programming extensions to the IProcessableElementTag class.

                                                                Authors:
                                                                Emanuel Rabina

                                                                + +
                                                              • +
                                                              +
                                                              + +
                                                              + +
                                                              + +
                                                              +
                                                                +
                                                              • + + + + + + + + + + +
                                                                  +
                                                                • + + +

                                                                  Constructor Detail

                                                                  + + +
                                                                    +
                                                                  • +

                                                                    IProcessableElementTagExtensions()

                                                                    +

                                                                    +
                                                                  • +
                                                                  + +
                                                                • +
                                                                + + + + + +
                                                                  +
                                                                • + + +

                                                                  Method Detail

                                                                  + + +
                                                                    +
                                                                  • +

                                                                    @SuppressWarnings(value: EqualsOverloaded)
                                                                    static boolean equals(IProcessableElementTag self, Object other)

                                                                    +

                                                                    Compare processable elements for equality.

                                                                    Parameters:
                                                                    self
                                                                    other
                                                                    Returns:
                                                                    true if this tag has the same name and attributes as + the other element.

                                                                    +
                                                                  • +
                                                                  + + +
                                                                    +
                                                                  • +

                                                                    static boolean equalsIgnoreXmlnsAndWith(IProcessableElementTag self, IProcessableElementTag other, IContext context)

                                                                    +

                                                                    Compare elements, ignoring XML namespace declarations and Thymeleaf's + th:with processor.

                                                                    Parameters:
                                                                    self
                                                                    other
                                                                    context
                                                                    Returns:
                                                                    true if the elements share the same name and all attributes, + with exceptions for of XML namespace declarations and Thymeleaf's + th:with attribute processor.

                                                                    +
                                                                  • +
                                                                  + +
                                                                • +
                                                                + +
                                                              • +
                                                              +
                                                              + + + +
                                                              + + + + + +
                                                              + + +
                                                              + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IStandaloneElementTagExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IStandaloneElementTagExtensions.html new file mode 100644 index 000000000..c3e2ff504 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/IStandaloneElementTagExtensions.html @@ -0,0 +1,300 @@ + + + + + + + + + + + IStandaloneElementTagExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                              + + + + + +
                                                              + + + + + +
                                                              + +
                                                              Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                              + +

                                                              [Groovy] Class IStandaloneElementTagExtensions

                                                              +
                                                              +
                                                              +
                                                                +
                                                                • nz.net.ultraq.thymeleaf.layoutdialect.extensions.IStandaloneElementTagExtensions +
                                                                +
                                                                +
                                                                  +
                                                                • + + + +
                                                                  + +
                                                                  class IStandaloneElementTagExtensions
                                                                  +extends Object
                                                                  + +

                                                                  Meta-programming extensions to the IStandaloneElementTag class.

                                                                  Authors:
                                                                  Emanuel Rabina

                                                                  + +
                                                                • +
                                                                +
                                                                + +
                                                                + +
                                                                + +
                                                                +
                                                                  +
                                                                • + + + + + + + + + + +
                                                                    +
                                                                  • + + +

                                                                    Constructor Detail

                                                                    + + +
                                                                      +
                                                                    • +

                                                                      IStandaloneElementTagExtensions()

                                                                      +

                                                                      +
                                                                    • +
                                                                    + +
                                                                  • +
                                                                  + + + + + +
                                                                    +
                                                                  • + + +

                                                                    Method Detail

                                                                    + + +
                                                                      +
                                                                    • +

                                                                      @SuppressWarnings(value: EqualsOverloaded)
                                                                      static boolean equals(IStandaloneElementTag self, Object other)

                                                                      +

                                                                      Compares this standalone tag with another.

                                                                      Parameters:
                                                                      self
                                                                      other
                                                                      Returns:
                                                                      true if this tag has the same name and attributes as + the other element.

                                                                      +
                                                                    • +
                                                                    + +
                                                                  • +
                                                                  + +
                                                                • +
                                                                +
                                                                + + + +
                                                                + + + + + +
                                                                + + +
                                                                + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITemplateEventExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITemplateEventExtensions.html new file mode 100644 index 000000000..22c987ec4 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITemplateEventExtensions.html @@ -0,0 +1,333 @@ + + + + + + + + + + + ITemplateEventExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                + + + + + +
                                                                + + + + + +
                                                                + +
                                                                Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                                + +

                                                                [Groovy] Class ITemplateEventExtensions

                                                                +
                                                                +
                                                                +
                                                                  +
                                                                  • nz.net.ultraq.thymeleaf.layoutdialect.extensions.ITemplateEventExtensions +
                                                                  +
                                                                  +
                                                                    +
                                                                  • + + + +
                                                                    + +
                                                                    class ITemplateEventExtensions
                                                                    +extends Object
                                                                    + +

                                                                    Meta-programming extensions to the ITemplateEvent class.

                                                                    Authors:
                                                                    Emanuel Rabina

                                                                    + +
                                                                  • +
                                                                  +
                                                                  + +
                                                                  + +
                                                                  + +
                                                                  +
                                                                    +
                                                                  • + + + + + + + + + + +
                                                                      +
                                                                    • + + +

                                                                      Constructor Detail

                                                                      + + +
                                                                        +
                                                                      • +

                                                                        ITemplateEventExtensions()

                                                                        +

                                                                        +
                                                                      • +
                                                                      + +
                                                                    • +
                                                                    + + + + + +
                                                                      +
                                                                    • + + +

                                                                      Method Detail

                                                                      + + +
                                                                        +
                                                                      • +

                                                                        static boolean isClosingElementOf(ITemplateEvent self, String tagName)

                                                                        +

                                                                        Returns whether or not this event represents a closing element of the + given name.

                                                                        Parameters:
                                                                        self
                                                                        tagName
                                                                        Returns:
                                                                        true if this event is a closing tag and has the given + tag name.

                                                                        +
                                                                      • +
                                                                      + + +
                                                                        +
                                                                      • +

                                                                        static boolean isOpeningElementOf(ITemplateEvent self, String tagName)

                                                                        +

                                                                        Returns whether or not this event represents an opening element of the + given name.

                                                                        Parameters:
                                                                        self
                                                                        tagName
                                                                        Returns:
                                                                        true if this event is an opening tag and has the given + tag name.

                                                                        +
                                                                      • +
                                                                      + + +
                                                                        +
                                                                      • +

                                                                        static boolean isWhitespace(ITemplateEvent self)

                                                                        +

                                                                        Returns whether or not this event represents collapsible whitespace.

                                                                        Parameters:
                                                                        self
                                                                        Returns:
                                                                        true if this is a collapsible text node.

                                                                        +
                                                                      • +
                                                                      + +
                                                                    • +
                                                                    + +
                                                                  • +
                                                                  +
                                                                  + + + +
                                                                  + + + + + +
                                                                  + + +
                                                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITextExtensions.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITextExtensions.html new file mode 100644 index 000000000..6c01e7652 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/ITextExtensions.html @@ -0,0 +1,313 @@ + + + + + + + + + + + ITextExtensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                  + + + + + +
                                                                  + + + + + +
                                                                  + +
                                                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.extensions
                                                                  + +

                                                                  [Groovy] Class ITextExtensions

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                    • nz.net.ultraq.thymeleaf.layoutdialect.extensions.ITextExtensions +
                                                                    +
                                                                    +
                                                                      +
                                                                    • + + + +
                                                                      + +
                                                                      class ITextExtensions
                                                                      +extends Object
                                                                      + +

                                                                      Meta-programming extensions to the IText class.

                                                                      Authors:
                                                                      Emanuel Rabina

                                                                      + +
                                                                    • +
                                                                    +
                                                                    + +
                                                                    +
                                                                      +
                                                                    • + + + + + + + + + + + + + + + + +
                                                                        +
                                                                      • +

                                                                        Constructor Summary

                                                                        +
                                                                          + + + + + + + + + + +
                                                                          Constructors 
                                                                          Constructor and description
                                                                          + ITextExtensions()
                                                                          +
                                                                        +
                                                                      • +
                                                                      + + + + +
                                                                        + +
                                                                      • +

                                                                        Methods Summary

                                                                        +
                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                          Methods 
                                                                          Type ParamsReturn TypeName and description
                                                                          static booleanequals(IText self, Object other)
                                                                          Compares this text with another.
                                                                          static booleanisWhitespace(IText self)
                                                                          Returns whether or not this text event is collapsible whitespace.
                                                                          +
                                                                        +
                                                                      • + +
                                                                      • +

                                                                        Inherited Methods Summary

                                                                        + +
                                                                      • + +
                                                                      + +
                                                                    • +
                                                                    +
                                                                    + +
                                                                    +
                                                                      +
                                                                    • + + + + + + + + + + +
                                                                        +
                                                                      • + + +

                                                                        Constructor Detail

                                                                        + + +
                                                                          +
                                                                        • +

                                                                          ITextExtensions()

                                                                          +

                                                                          +
                                                                        • +
                                                                        + +
                                                                      • +
                                                                      + + + + + +
                                                                        +
                                                                      • + + +

                                                                        Method Detail

                                                                        + + +
                                                                          +
                                                                        • +

                                                                          @SuppressWarnings(value: EqualsOverloaded)
                                                                          static boolean equals(IText self, Object other)

                                                                          +

                                                                          Compares this text with another.

                                                                          Parameters:
                                                                          self
                                                                          other
                                                                          Returns:
                                                                          true if the text content matches.

                                                                          +
                                                                        • +
                                                                        + + +
                                                                          +
                                                                        • +

                                                                          static boolean isWhitespace(IText self)

                                                                          +

                                                                          Returns whether or not this text event is collapsible whitespace.

                                                                          Parameters:
                                                                          self
                                                                          Returns:
                                                                          true if, when trimmed, the text content is empty.

                                                                          +
                                                                        • +
                                                                        + +
                                                                      • +
                                                                      + +
                                                                    • +
                                                                    +
                                                                    + + + +
                                                                    + + + + + +
                                                                    + + +
                                                                    + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-frame.html new file mode 100644 index 000000000..a09f88aba --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.extensions + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-summary.html new file mode 100644 index 000000000..7e10a9db4 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/extensions/package-summary.html @@ -0,0 +1,208 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.extensions (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                                    + + + + + + +
                                                                    + + + + + +
                                                                    +

                                                                    Package nz.net.ultraq.thymeleaf.layoutdialect.extensions

                                                                    +
                                                                    + + + +
                                                                    + + + + +
                                                                    + +
                                                                    + + + + + + + +
                                                                    + + +
                                                                    + + + + + +
                                                                    + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/CollectFragmentProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/CollectFragmentProcessor.html new file mode 100644 index 000000000..1cec71fb4 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/CollectFragmentProcessor.html @@ -0,0 +1,369 @@ + + + + + + + + + + + CollectFragmentProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                    + + + + + +
                                                                    + + + + + +
                                                                    + +
                                                                    Package: nz.net.ultraq.thymeleaf.layoutdialect.fragments
                                                                    + +

                                                                    [Groovy] Class CollectFragmentProcessor

                                                                    +
                                                                    +
                                                                    +
                                                                      +
                                                                            • nz.net.ultraq.thymeleaf.layoutdialect.fragments.CollectFragmentProcessor +
                                                                            +
                                                                            +
                                                                              +
                                                                            • + + + +
                                                                              + +
                                                                              @Deprecated
                                                                              +class CollectFragmentProcessor
                                                                              +extends AbstractAttributeTagProcessor
                                                                              + +

                                                                              Processor produced from FragmentProcessor in order to separate include and + define logic to avoid ambiguity.

                                                                              authors:
                                                                              Emanuel Rabina, George Vinokhodov

                                                                              + +
                                                                            • +
                                                                            +
                                                                            + +
                                                                            + +
                                                                            + +
                                                                            +
                                                                              +
                                                                            • + + + + + + +
                                                                                +
                                                                              • + + +

                                                                                Property Detail

                                                                                + + +
                                                                                  +
                                                                                • +

                                                                                  static final String PROCESSOR_COLLECT

                                                                                  +

                                                                                  +
                                                                                • +
                                                                                + + +
                                                                                  +
                                                                                • +

                                                                                  static final String PROCESSOR_DEFINE

                                                                                  +

                                                                                  +
                                                                                • +
                                                                                + + +
                                                                                  +
                                                                                • +

                                                                                  static final int PROCESSOR_PRECEDENCE

                                                                                  +

                                                                                  +
                                                                                • +
                                                                                + +
                                                                              • +
                                                                              + + + + + + +
                                                                                +
                                                                              • + + +

                                                                                Constructor Detail

                                                                                + + +
                                                                                  +
                                                                                • +

                                                                                  CollectFragmentProcessor(TemplateMode templateMode, String dialectPrefix)

                                                                                  +

                                                                                  Constructor, sets this processor to work on the 'collect' attribute.

                                                                                  Parameters:
                                                                                  templateMode
                                                                                  dialectPrefix

                                                                                  +
                                                                                • +
                                                                                + +
                                                                              • +
                                                                              + + + + + + + +
                                                                            • +
                                                                            +
                                                                            + + + +
                                                                            + + + + + +
                                                                            + + +
                                                                            + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentFinder.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentFinder.html new file mode 100644 index 000000000..f658bd447 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentFinder.html @@ -0,0 +1,345 @@ + + + + + + + + + + + FragmentFinder (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                            + + + + + +
                                                                            + + + + + +
                                                                            + +
                                                                            Package: nz.net.ultraq.thymeleaf.layoutdialect.fragments
                                                                            + +

                                                                            [Groovy] Class FragmentFinder

                                                                            +
                                                                            +
                                                                            +
                                                                              +
                                                                              • nz.net.ultraq.thymeleaf.layoutdialect.fragments.FragmentFinder +
                                                                              +
                                                                              +
                                                                                +
                                                                              • + + + +
                                                                                + +
                                                                                @TupleConstructor(defaults: false)
                                                                                +class FragmentFinder
                                                                                +extends Object
                                                                                + +

                                                                                Searches for and returns layout dialect fragments within a given + scope/element.

                                                                                Authors:
                                                                                Emanuel Rabina

                                                                                + +
                                                                              • +
                                                                              +
                                                                              + +
                                                                              +
                                                                                +
                                                                              • + + + + + + + + + + +
                                                                                  +
                                                                                • +

                                                                                  Properties Summary

                                                                                  + +
                                                                                • + +
                                                                                + + + + + + + +
                                                                                  +
                                                                                • +

                                                                                  Constructor Summary

                                                                                  +
                                                                                    + + + + + + + + + + +
                                                                                    Constructors 
                                                                                    Constructor and description
                                                                                    + FragmentFinder()
                                                                                    +
                                                                                  +
                                                                                • +
                                                                                + + + + +
                                                                                  + +
                                                                                • +

                                                                                  Methods Summary

                                                                                  +
                                                                                    + + + + + + + + + + + + + + +
                                                                                    Methods 
                                                                                    Type ParamsReturn TypeName and description
                                                                                    Map<String, List<IModel>>findFragments(IModel model)
                                                                                    Find and return models for layout dialect fragments within the scope of the + given model, without delving into layout:insert or + layout:replace elements, mapped by the name of each fragment.
                                                                                    +
                                                                                  +
                                                                                • + +
                                                                                • +

                                                                                  Inherited Methods Summary

                                                                                  + +
                                                                                • + +
                                                                                + +
                                                                              • +
                                                                              +
                                                                              + +
                                                                              +
                                                                                +
                                                                              • + + + + + + +
                                                                                  +
                                                                                • + + +

                                                                                  Property Detail

                                                                                  + + +
                                                                                    +
                                                                                  • +

                                                                                    final String dialectPrefix

                                                                                    +

                                                                                    +
                                                                                  • +
                                                                                  + +
                                                                                • +
                                                                                + + + + + + +
                                                                                  +
                                                                                • + + +

                                                                                  Constructor Detail

                                                                                  + + +
                                                                                    +
                                                                                  • +

                                                                                    FragmentFinder()

                                                                                    +

                                                                                    +
                                                                                  • +
                                                                                  + +
                                                                                • +
                                                                                + + + + + +
                                                                                  +
                                                                                • + + +

                                                                                  Method Detail

                                                                                  + + +
                                                                                    +
                                                                                  • +

                                                                                    Map<String, List<IModel>> findFragments(IModel model)

                                                                                    +

                                                                                    Find and return models for layout dialect fragments within the scope of the + given model, without delving into layout:insert or + layout:replace elements, mapped by the name of each fragment.

                                                                                    Parameters:
                                                                                    model - Model whose events are to be searched.
                                                                                    Returns:
                                                                                    Map of fragment names and their elements.

                                                                                    +
                                                                                  • +
                                                                                  + +
                                                                                • +
                                                                                + +
                                                                              • +
                                                                              +
                                                                              + + + +
                                                                              + + + + + +
                                                                              + + +
                                                                              + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterNamesExtractor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterNamesExtractor.html new file mode 100644 index 000000000..c1b235e36 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterNamesExtractor.html @@ -0,0 +1,300 @@ + + + + + + + + + + + FragmentParameterNamesExtractor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                              + + + + + +
                                                                              + + + + + +
                                                                              + +
                                                                              Package: nz.net.ultraq.thymeleaf.layoutdialect.fragments
                                                                              + +

                                                                              [Groovy] Class FragmentParameterNamesExtractor

                                                                              +
                                                                              +
                                                                              +
                                                                                +
                                                                                • nz.net.ultraq.thymeleaf.layoutdialect.fragments.FragmentParameterNamesExtractor +
                                                                                +
                                                                                +
                                                                                  +
                                                                                • + + + +
                                                                                  + +
                                                                                  class FragmentParameterNamesExtractor
                                                                                  +extends Object
                                                                                  + +

                                                                                  Extracts just the parameter names from a fragment definition. Used for when + unnamed fragment parameters need to be mapped to their respective names.

                                                                                  Authors:
                                                                                  Emanuel Rabina

                                                                                  + +
                                                                                • +
                                                                                +
                                                                                + +
                                                                                +
                                                                                  +
                                                                                • + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                • +
                                                                                +
                                                                                + +
                                                                                +
                                                                                  +
                                                                                • + + + + + + + + + + +
                                                                                    +
                                                                                  • + + +

                                                                                    Constructor Detail

                                                                                    + + +
                                                                                      +
                                                                                    • +

                                                                                      FragmentParameterNamesExtractor()

                                                                                      +

                                                                                      +
                                                                                    • +
                                                                                    + +
                                                                                  • +
                                                                                  + + + + + +
                                                                                    +
                                                                                  • + + +

                                                                                    Method Detail

                                                                                    + + +
                                                                                      +
                                                                                    • +

                                                                                      List<String> extract(String fragmentDefinition)

                                                                                      +

                                                                                      Returns a list of parameter names for the given fragment definition.

                                                                                      Parameters:
                                                                                      fragmentDefinition
                                                                                      Returns:
                                                                                      A list of the named parameters, in the order they are defined.

                                                                                      +
                                                                                    • +
                                                                                    + +
                                                                                  • +
                                                                                  + +
                                                                                • +
                                                                                +
                                                                                + + + +
                                                                                + + + + + +
                                                                                + + +
                                                                                + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterVariableUpdater.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterVariableUpdater.html new file mode 100644 index 000000000..ce6ec3970 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentParameterVariableUpdater.html @@ -0,0 +1,356 @@ + + + + + + + + + + + FragmentParameterVariableUpdater (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                + + + + + +
                                                                                + + + + + +
                                                                                + +
                                                                                Package: nz.net.ultraq.thymeleaf.layoutdialect.fragments
                                                                                + +

                                                                                [Groovy] Class FragmentParameterVariableUpdater

                                                                                +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  • nz.net.ultraq.thymeleaf.layoutdialect.fragments.FragmentParameterVariableUpdater +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                  • + + + +
                                                                                    + +
                                                                                    @TupleConstructor(defaults: false)
                                                                                    +class FragmentParameterVariableUpdater
                                                                                    +extends Object
                                                                                    + +

                                                                                    Updates the variables at a given element/fragment scope to include those in + a fragment expression.

                                                                                    Authors:
                                                                                    Emanuel Rabina

                                                                                    + +
                                                                                  • +
                                                                                  +
                                                                                  + +
                                                                                  + +
                                                                                  + +
                                                                                  +
                                                                                    +
                                                                                  • + + + + + + + + + + + + + +
                                                                                      +
                                                                                    • + + +

                                                                                      Constructor Detail

                                                                                      + + +
                                                                                        +
                                                                                      • +

                                                                                        FragmentParameterVariableUpdater()

                                                                                        +

                                                                                        +
                                                                                      • +
                                                                                      + +
                                                                                    • +
                                                                                    + + + + + +
                                                                                      +
                                                                                    • + + +

                                                                                      Method Detail

                                                                                      + + +
                                                                                        +
                                                                                      • +

                                                                                        void updateLocalVariables(FragmentExpression fragmentExpression, IModel fragment, IElementModelStructureHandler structureHandler)

                                                                                        +

                                                                                        Given a fragment expression, update the local variables of the element + being processed.

                                                                                        Parameters:
                                                                                        fragmentExpression
                                                                                        fragment
                                                                                        structureHandler

                                                                                        +
                                                                                      • +
                                                                                      + +
                                                                                    • +
                                                                                    + +
                                                                                  • +
                                                                                  +
                                                                                  + + + +
                                                                                  + + + + + +
                                                                                  + + +
                                                                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentProcessor.html new file mode 100644 index 000000000..e23c52662 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/FragmentProcessor.html @@ -0,0 +1,353 @@ + + + + + + + + + + + FragmentProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                  + + + + + +
                                                                                  + + + + + +
                                                                                  + +
                                                                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.fragments
                                                                                  + +

                                                                                  [Groovy] Class FragmentProcessor

                                                                                  +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                          • nz.net.ultraq.thymeleaf.layoutdialect.fragments.FragmentProcessor +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                          • + + + +
                                                                                            + +
                                                                                            class FragmentProcessor
                                                                                            +extends AbstractAttributeTagProcessor
                                                                                            + +

                                                                                            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.

                                                                                            Authors:
                                                                                            Emanuel Rabina

                                                                                            + +
                                                                                          • +
                                                                                          +
                                                                                          + +
                                                                                          + +
                                                                                          + +
                                                                                          +
                                                                                            +
                                                                                          • + + + + + + +
                                                                                              +
                                                                                            • + + +

                                                                                              Property Detail

                                                                                              + + +
                                                                                                +
                                                                                              • +

                                                                                                static final String PROCESSOR_NAME

                                                                                                +

                                                                                                +
                                                                                              • +
                                                                                              + + +
                                                                                                +
                                                                                              • +

                                                                                                static final int PROCESSOR_PRECEDENCE

                                                                                                +

                                                                                                +
                                                                                              • +
                                                                                              + +
                                                                                            • +
                                                                                            + + + + + + +
                                                                                              +
                                                                                            • + + +

                                                                                              Constructor Detail

                                                                                              + + +
                                                                                                +
                                                                                              • +

                                                                                                FragmentProcessor(TemplateMode templateMode, String dialectPrefix)

                                                                                                +

                                                                                                Constructor, sets this processor to work on the 'fragment' attribute.

                                                                                                Parameters:
                                                                                                templateMode
                                                                                                dialectPrefix

                                                                                                +
                                                                                              • +
                                                                                              + +
                                                                                            • +
                                                                                            + + + + + + + +
                                                                                          • +
                                                                                          +
                                                                                          + + + +
                                                                                          + + + + + +
                                                                                          + + +
                                                                                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-frame.html new file mode 100644 index 000000000..303ecc427 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.fragments + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-summary.html new file mode 100644 index 000000000..768f62517 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/fragments/package-summary.html @@ -0,0 +1,180 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.fragments (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                                                          + + + + + + +
                                                                                          + + + + + +
                                                                                          +

                                                                                          Package nz.net.ultraq.thymeleaf.layoutdialect.fragments

                                                                                          +
                                                                                          + + + +
                                                                                          + + + + +
                                                                                          +
                                                                                            +
                                                                                          • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                            Class Summary 
                                                                                            ClassDescription
                                                                                            + + CollectFragmentProcessor + + Processor produced from FragmentProcessor in order to separate include and + define logic to avoid ambiguity.
                                                                                            + + FragmentFinder + + Searches for and returns layout dialect fragments within a given + scope/element.
                                                                                            + + FragmentParameterNamesExtractor + + Extracts just the parameter names from a fragment definition.
                                                                                            + + FragmentParameterVariableUpdater + + Updates the variables at a given element/fragment scope to include those in + a fragment expression.
                                                                                            + + FragmentProcessor + + 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.
                                                                                            +
                                                                                          • +
                                                                                          +
                                                                                          + + + + + + + +
                                                                                          + + +
                                                                                          + + + + + +
                                                                                          + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/IncludeProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/IncludeProcessor.html new file mode 100644 index 000000000..860d7ef2c --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/IncludeProcessor.html @@ -0,0 +1,356 @@ + + + + + + + + + + + IncludeProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                          + + + + + +
                                                                                          + + + + + +
                                                                                          + +
                                                                                          Package: nz.net.ultraq.thymeleaf.layoutdialect.includes
                                                                                          + +

                                                                                          [Groovy] Class IncludeProcessor

                                                                                          +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                                  • nz.net.ultraq.thymeleaf.layoutdialect.includes.IncludeProcessor +
                                                                                                  +
                                                                                                  +
                                                                                                    +
                                                                                                  • + + + +
                                                                                                    + +
                                                                                                    @Deprecated
                                                                                                    +class IncludeProcessor
                                                                                                    +extends AbstractAttributeModelProcessor
                                                                                                    + +

                                                                                                    Similar to Thymeleaf's th:include, but allows the passing of entire + element fragments to the included template. Useful if you have some HTML + that you want to reuse, but whose contents are too complex to determine or + construct with context variables alone.

                                                                                                    deprecated:
                                                                                                    Use InsertProcessor (layout:insert) instead.
                                                                                                    Authors:
                                                                                                    Emanuel Rabina

                                                                                                    + +
                                                                                                  • +
                                                                                                  +
                                                                                                  + +
                                                                                                  + +
                                                                                                  + +
                                                                                                  +
                                                                                                    +
                                                                                                  • + + + + + + +
                                                                                                      +
                                                                                                    • + + +

                                                                                                      Property Detail

                                                                                                      + + +
                                                                                                        +
                                                                                                      • +

                                                                                                        static final String PROCESSOR_NAME

                                                                                                        +

                                                                                                        +
                                                                                                      • +
                                                                                                      + + +
                                                                                                        +
                                                                                                      • +

                                                                                                        static final int PROCESSOR_PRECEDENCE

                                                                                                        +

                                                                                                        +
                                                                                                      • +
                                                                                                      + +
                                                                                                    • +
                                                                                                    + + + + + + +
                                                                                                      +
                                                                                                    • + + +

                                                                                                      Constructor Detail

                                                                                                      + + +
                                                                                                        +
                                                                                                      • +

                                                                                                        IncludeProcessor(TemplateMode templateMode, String dialectPrefix)

                                                                                                        +

                                                                                                        Constructor, sets this processor to work on the 'include' attribute.

                                                                                                        Parameters:
                                                                                                        templateMode
                                                                                                        dialectPrefix

                                                                                                        +
                                                                                                      • +
                                                                                                      + +
                                                                                                    • +
                                                                                                    + + + + + + + +
                                                                                                  • +
                                                                                                  +
                                                                                                  + + + +
                                                                                                  + + + + + +
                                                                                                  + + +
                                                                                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/InsertProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/InsertProcessor.html new file mode 100644 index 000000000..662b08307 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/InsertProcessor.html @@ -0,0 +1,355 @@ + + + + + + + + + + + InsertProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                  + + + + + +
                                                                                                  + + + + + +
                                                                                                  + +
                                                                                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.includes
                                                                                                  + +

                                                                                                  [Groovy] Class InsertProcessor

                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                    +
                                                                                                          • nz.net.ultraq.thymeleaf.layoutdialect.includes.InsertProcessor +
                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                          • + + + +
                                                                                                            + +
                                                                                                            class InsertProcessor
                                                                                                            +extends AbstractAttributeModelProcessor
                                                                                                            + +

                                                                                                            Similar to Thymeleaf's th:insert, but allows the passing of entire + element fragments to the included template. Useful if you have some HTML + that you want to reuse, but whose contents are too complex to determine or + construct with context variables alone.

                                                                                                            Authors:
                                                                                                            Emanuel Rabina

                                                                                                            + +
                                                                                                          • +
                                                                                                          +
                                                                                                          + +
                                                                                                          + +
                                                                                                          + +
                                                                                                          +
                                                                                                            +
                                                                                                          • + + + + + + +
                                                                                                              +
                                                                                                            • + + +

                                                                                                              Property Detail

                                                                                                              + + +
                                                                                                                +
                                                                                                              • +

                                                                                                                static final String PROCESSOR_NAME

                                                                                                                +

                                                                                                                +
                                                                                                              • +
                                                                                                              + + +
                                                                                                                +
                                                                                                              • +

                                                                                                                static final int PROCESSOR_PRECEDENCE

                                                                                                                +

                                                                                                                +
                                                                                                              • +
                                                                                                              + +
                                                                                                            • +
                                                                                                            + + + + + + +
                                                                                                              +
                                                                                                            • + + +

                                                                                                              Constructor Detail

                                                                                                              + + +
                                                                                                                +
                                                                                                              • +

                                                                                                                InsertProcessor(TemplateMode templateMode, String dialectPrefix)

                                                                                                                +

                                                                                                                Constructor, sets this processor to work on the 'insert' attribute.

                                                                                                                Parameters:
                                                                                                                templateMode
                                                                                                                dialectPrefix

                                                                                                                +
                                                                                                              • +
                                                                                                              + +
                                                                                                            • +
                                                                                                            + + + + + + + +
                                                                                                          • +
                                                                                                          +
                                                                                                          + + + +
                                                                                                          + + + + + +
                                                                                                          + + +
                                                                                                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/ReplaceProcessor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/ReplaceProcessor.html new file mode 100644 index 000000000..910f043d6 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/ReplaceProcessor.html @@ -0,0 +1,355 @@ + + + + + + + + + + + ReplaceProcessor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                          + + + + + +
                                                                                                          + + + + + +
                                                                                                          + +
                                                                                                          Package: nz.net.ultraq.thymeleaf.layoutdialect.includes
                                                                                                          + +

                                                                                                          [Groovy] Class ReplaceProcessor

                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                                  • nz.net.ultraq.thymeleaf.layoutdialect.includes.ReplaceProcessor +
                                                                                                                  +
                                                                                                                  +
                                                                                                                    +
                                                                                                                  • + + + +
                                                                                                                    + +
                                                                                                                    class ReplaceProcessor
                                                                                                                    +extends AbstractAttributeModelProcessor
                                                                                                                    + +

                                                                                                                    Similar to Thymeleaf's th:replace, but allows the passing of entire + element fragments to the included template. Useful if you have some HTML + that you want to reuse, but whose contents are too complex to determine or + construct with context variables alone.

                                                                                                                    Authors:
                                                                                                                    Emanuel Rabina

                                                                                                                    + +
                                                                                                                  • +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  + +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                    +
                                                                                                                  • + + + + + + +
                                                                                                                      +
                                                                                                                    • + + +

                                                                                                                      Property Detail

                                                                                                                      + + +
                                                                                                                        +
                                                                                                                      • +

                                                                                                                        static final String PROCESSOR_NAME

                                                                                                                        +

                                                                                                                        +
                                                                                                                      • +
                                                                                                                      + + +
                                                                                                                        +
                                                                                                                      • +

                                                                                                                        static final int PROCESSOR_PRECEDENCE

                                                                                                                        +

                                                                                                                        +
                                                                                                                      • +
                                                                                                                      + +
                                                                                                                    • +
                                                                                                                    + + + + + + +
                                                                                                                      +
                                                                                                                    • + + +

                                                                                                                      Constructor Detail

                                                                                                                      + + +
                                                                                                                        +
                                                                                                                      • +

                                                                                                                        ReplaceProcessor(TemplateMode templateMode, String dialectPrefix)

                                                                                                                        +

                                                                                                                        Constructor, set this processor to work on the 'replace' attribute.

                                                                                                                        Parameters:
                                                                                                                        templateMode
                                                                                                                        dialectPrefix

                                                                                                                        +
                                                                                                                      • +
                                                                                                                      + +
                                                                                                                    • +
                                                                                                                    + + + + + + + +
                                                                                                                  • +
                                                                                                                  +
                                                                                                                  + + + +
                                                                                                                  + + + + + +
                                                                                                                  + + +
                                                                                                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-frame.html new file mode 100644 index 000000000..05b7173c2 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.includes + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-summary.html new file mode 100644 index 000000000..7695de4fa --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/includes/package-summary.html @@ -0,0 +1,163 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.includes (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                                                                                  + + + + + + +
                                                                                                                  + + + + + +
                                                                                                                  +

                                                                                                                  Package nz.net.ultraq.thymeleaf.layoutdialect.includes

                                                                                                                  +
                                                                                                                  + + + +
                                                                                                                  + + + + +
                                                                                                                  +
                                                                                                                    +
                                                                                                                  • + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                    Class Summary 
                                                                                                                    ClassDescription
                                                                                                                    + + IncludeProcessor + + Similar to Thymeleaf's th:include, but allows the passing of entire + element fragments to the included template.
                                                                                                                    + + InsertProcessor + + Similar to Thymeleaf's th:insert, but allows the passing of entire + element fragments to the included template.
                                                                                                                    + + ReplaceProcessor + + Similar to Thymeleaf's th:replace, but allows the passing of entire + element fragments to the included template.
                                                                                                                    +
                                                                                                                  • +
                                                                                                                  +
                                                                                                                  + + + + + + + +
                                                                                                                  + + +
                                                                                                                  + + + + + +
                                                                                                                  + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/AttributeMerger.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/AttributeMerger.html new file mode 100644 index 000000000..ef2cac400 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/AttributeMerger.html @@ -0,0 +1,351 @@ + + + + + + + + + + + AttributeMerger (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                  + + + + + +
                                                                                                                  + + + + + +
                                                                                                                  + +
                                                                                                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                  + +

                                                                                                                  [Groovy] Class AttributeMerger

                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                    +
                                                                                                                    • nz.net.ultraq.thymeleaf.layoutdialect.models.AttributeMerger +
                                                                                                                    +
                                                                                                                    +
                                                                                                                      +
                                                                                                                    • + +
                                                                                                                      +
                                                                                                                      All Implemented Interfaces and Traits:
                                                                                                                      +
                                                                                                                      ModelMerger
                                                                                                                      +
                                                                                                                      + + + +
                                                                                                                      + +
                                                                                                                      @TupleConstructor(defaults: false)
                                                                                                                      +class AttributeMerger
                                                                                                                      +extends Object
                                                                                                                      +implements ModelMerger
                                                                                                                      + +

                                                                                                                      Merges attributes from one element into another.

                                                                                                                      Authors:
                                                                                                                      Emanuel Rabina

                                                                                                                      + +
                                                                                                                    • +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                      +
                                                                                                                    • + + + + + + + + + + +
                                                                                                                        +
                                                                                                                      • +

                                                                                                                        Properties Summary

                                                                                                                        + +
                                                                                                                      • + +
                                                                                                                      + + + + + + + +
                                                                                                                        +
                                                                                                                      • +

                                                                                                                        Constructor Summary

                                                                                                                        +
                                                                                                                          + + + + + + + + + + +
                                                                                                                          Constructors 
                                                                                                                          Constructor and description
                                                                                                                          + AttributeMerger()
                                                                                                                          +
                                                                                                                        +
                                                                                                                      • +
                                                                                                                      + + + + +
                                                                                                                        + +
                                                                                                                      • +

                                                                                                                        Methods Summary

                                                                                                                        +
                                                                                                                          + + + + + + + + + + + + + + +
                                                                                                                          Methods 
                                                                                                                          Type ParamsReturn TypeName and description
                                                                                                                          IModelmerge(IModel targetModel, IModel sourceModel)
                                                                                                                          Merge the attributes of the source element with those of the target + element.
                                                                                                                          +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                      • +

                                                                                                                        Inherited Methods Summary

                                                                                                                        + +
                                                                                                                      • + +
                                                                                                                      + +
                                                                                                                    • +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                      +
                                                                                                                    • + + + + + + + + + + + + + +
                                                                                                                        +
                                                                                                                      • + + +

                                                                                                                        Constructor Detail

                                                                                                                        + + +
                                                                                                                          +
                                                                                                                        • +

                                                                                                                          AttributeMerger()

                                                                                                                          +

                                                                                                                          +
                                                                                                                        • +
                                                                                                                        + +
                                                                                                                      • +
                                                                                                                      + + + + + +
                                                                                                                        +
                                                                                                                      • + + +

                                                                                                                        Method Detail

                                                                                                                        + + +
                                                                                                                          +
                                                                                                                        • +

                                                                                                                          @Override
                                                                                                                          IModel merge(IModel targetModel, IModel sourceModel)

                                                                                                                          +

                                                                                                                          Merge the attributes of the source element with those of the target + element. This is basically a copy of all attributes in the source model + with those in the target model, overwriting any attributes that have the + same name, except for the case of th:with where variable + declarations are preserved, only overwriting same-named declarations.

                                                                                                                          Parameters:
                                                                                                                          sourceModel
                                                                                                                          targetModel
                                                                                                                          Returns:
                                                                                                                          New element with the merged attributes.

                                                                                                                          +
                                                                                                                        • +
                                                                                                                        + +
                                                                                                                      • +
                                                                                                                      + +
                                                                                                                    • +
                                                                                                                    +
                                                                                                                    + + + +
                                                                                                                    + + + + + +
                                                                                                                    + + +
                                                                                                                    + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ChildModelIterator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ChildModelIterator.html new file mode 100644 index 000000000..1dc88a5d1 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ChildModelIterator.html @@ -0,0 +1,320 @@ + + + + + + + + + + + ChildModelIterator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                    + + + + + +
                                                                                                                    + + + + + +
                                                                                                                    + +
                                                                                                                    Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                    + +

                                                                                                                    [Groovy] Class ChildModelIterator

                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                      +
                                                                                                                      • nz.net.ultraq.thymeleaf.layoutdialect.models.ChildModelIterator +
                                                                                                                      +
                                                                                                                      +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +
                                                                                                                        All Implemented Interfaces and Traits:
                                                                                                                        +
                                                                                                                        Iterator<IModel>
                                                                                                                        +
                                                                                                                        + + + +
                                                                                                                        + +
                                                                                                                        class ChildModelIterator
                                                                                                                        +extends Object
                                                                                                                        +implements Iterator<IModel>
                                                                                                                        + +

                                                                                                                        An iterator that works with a model's immediate children, returning each one + as a model of its own.

                                                                                                                        Authors:
                                                                                                                        Emanuel Rabina

                                                                                                                        + +
                                                                                                                      • +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                        +
                                                                                                                      • + + + + + + + + + + + + + + + + +
                                                                                                                          +
                                                                                                                        • +

                                                                                                                          Constructor Summary

                                                                                                                          + +
                                                                                                                        • +
                                                                                                                        + + + + + + +
                                                                                                                      • +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                        +
                                                                                                                      • + + + + + + + + + + +
                                                                                                                          +
                                                                                                                        • + + +

                                                                                                                          Constructor Detail

                                                                                                                          + + +
                                                                                                                            +
                                                                                                                          • +

                                                                                                                            ChildModelIterator(IModel parent)

                                                                                                                            +

                                                                                                                            +
                                                                                                                          • +
                                                                                                                          + +
                                                                                                                        • +
                                                                                                                        + + + + + + + +
                                                                                                                      • +
                                                                                                                      +
                                                                                                                      + + + +
                                                                                                                      + + + + + +
                                                                                                                      + + +
                                                                                                                      + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ElementMerger.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ElementMerger.html new file mode 100644 index 000000000..dac0b0f6f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ElementMerger.html @@ -0,0 +1,348 @@ + + + + + + + + + + + ElementMerger (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                      + + + + + +
                                                                                                                      + + + + + +
                                                                                                                      + +
                                                                                                                      Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                      + +

                                                                                                                      [Groovy] Class ElementMerger

                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                        +
                                                                                                                        • nz.net.ultraq.thymeleaf.layoutdialect.models.ElementMerger +
                                                                                                                        +
                                                                                                                        +
                                                                                                                          +
                                                                                                                        • + +
                                                                                                                          +
                                                                                                                          All Implemented Interfaces and Traits:
                                                                                                                          +
                                                                                                                          ModelMerger
                                                                                                                          +
                                                                                                                          + + + +
                                                                                                                          + +
                                                                                                                          @TupleConstructor(defaults: false)
                                                                                                                          +class ElementMerger
                                                                                                                          +extends Object
                                                                                                                          +implements ModelMerger
                                                                                                                          + +

                                                                                                                          Merges an element and all its children into an existing element.

                                                                                                                          Authors:
                                                                                                                          Emanuel Rabina

                                                                                                                          + +
                                                                                                                        • +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                          +
                                                                                                                        • + + + + + + + + + + +
                                                                                                                            +
                                                                                                                          • +

                                                                                                                            Properties Summary

                                                                                                                            + +
                                                                                                                          • + +
                                                                                                                          + + + + + + + +
                                                                                                                            +
                                                                                                                          • +

                                                                                                                            Constructor Summary

                                                                                                                            +
                                                                                                                              + + + + + + + + + + +
                                                                                                                              Constructors 
                                                                                                                              Constructor and description
                                                                                                                              + ElementMerger()
                                                                                                                              +
                                                                                                                            +
                                                                                                                          • +
                                                                                                                          + + + + +
                                                                                                                            + +
                                                                                                                          • +

                                                                                                                            Methods Summary

                                                                                                                            +
                                                                                                                              + + + + + + + + + + + + + + +
                                                                                                                              Methods 
                                                                                                                              Type ParamsReturn TypeName and description
                                                                                                                              IModelmerge(IModel targetModel, IModel sourceModel)
                                                                                                                              Replace the content of the target element, with the content of the source + element.
                                                                                                                              +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                          • +

                                                                                                                            Inherited Methods Summary

                                                                                                                            + +
                                                                                                                          • + +
                                                                                                                          + +
                                                                                                                        • +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                          +
                                                                                                                        • + + + + + + + + + + + + + +
                                                                                                                            +
                                                                                                                          • + + +

                                                                                                                            Constructor Detail

                                                                                                                            + + +
                                                                                                                              +
                                                                                                                            • +

                                                                                                                              ElementMerger()

                                                                                                                              +

                                                                                                                              +
                                                                                                                            • +
                                                                                                                            + +
                                                                                                                          • +
                                                                                                                          + + + + + +
                                                                                                                            +
                                                                                                                          • + + +

                                                                                                                            Method Detail

                                                                                                                            + + +
                                                                                                                              +
                                                                                                                            • +

                                                                                                                              @Override
                                                                                                                              IModel merge(IModel targetModel, IModel sourceModel)

                                                                                                                              +

                                                                                                                              Replace the content of the target element, with the content of the source + element.

                                                                                                                              Parameters:
                                                                                                                              targetModel
                                                                                                                              sourceModel
                                                                                                                              Returns:
                                                                                                                              Model that is the result of the merge.

                                                                                                                              +
                                                                                                                            • +
                                                                                                                            + +
                                                                                                                          • +
                                                                                                                          + +
                                                                                                                        • +
                                                                                                                        +
                                                                                                                        + + + +
                                                                                                                        + + + + + +
                                                                                                                        + + +
                                                                                                                        + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/EventIterator.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/EventIterator.html new file mode 100644 index 000000000..c6a297ca9 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/EventIterator.html @@ -0,0 +1,319 @@ + + + + + + + + + + + EventIterator (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                        + + + + + +
                                                                                                                        + + + + + +
                                                                                                                        + +
                                                                                                                        Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                        + +

                                                                                                                        [Groovy] Class EventIterator

                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                          +
                                                                                                                          • nz.net.ultraq.thymeleaf.layoutdialect.models.EventIterator +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                            +
                                                                                                                          • + + + + + + + + + + + + + + + + +
                                                                                                                              +
                                                                                                                            • +

                                                                                                                              Constructor Summary

                                                                                                                              +
                                                                                                                                + + + + + + + + + + +
                                                                                                                                Constructors 
                                                                                                                                Constructor and description
                                                                                                                                + EventIterator(IModel model)
                                                                                                                                +
                                                                                                                              +
                                                                                                                            • +
                                                                                                                            + + + + + + +
                                                                                                                          • +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                            +
                                                                                                                          • + + + + + + + + + + +
                                                                                                                              +
                                                                                                                            • + + +

                                                                                                                              Constructor Detail

                                                                                                                              + + +
                                                                                                                                +
                                                                                                                              • +

                                                                                                                                EventIterator(IModel model)

                                                                                                                                +

                                                                                                                                +
                                                                                                                              • +
                                                                                                                              + +
                                                                                                                            • +
                                                                                                                            + + + + + + + +
                                                                                                                          • +
                                                                                                                          +
                                                                                                                          + + + +
                                                                                                                          + + + + + +
                                                                                                                          + + +
                                                                                                                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelBuilder.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelBuilder.html new file mode 100644 index 000000000..b79c3194c --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelBuilder.html @@ -0,0 +1,418 @@ + + + + + + + + + + + ModelBuilder (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                          + + + + + +
                                                                                                                          + + + + + +
                                                                                                                          + +
                                                                                                                          Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                          + +

                                                                                                                          [Groovy] Class ModelBuilder

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                            +
                                                                                                                                • nz.net.ultraq.thymeleaf.layoutdialect.models.ModelBuilder +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • + + + +
                                                                                                                                  + +
                                                                                                                                  class ModelBuilder
                                                                                                                                  +extends BuilderSupport
                                                                                                                                  + +

                                                                                                                                  Create Thymeleaf 3 models using the Groovy builder syntax.

                                                                                                                                  Authors:
                                                                                                                                  Emanuel Rabina

                                                                                                                                  + +
                                                                                                                                • +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                + +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • + + + + + + + + + + +
                                                                                                                                    +
                                                                                                                                  • + + +

                                                                                                                                    Constructor Detail

                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      ModelBuilder(ITemplateContext context)

                                                                                                                                      +

                                                                                                                                      Constructor, create a new model builder.

                                                                                                                                      Parameters:
                                                                                                                                      context

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + + + +
                                                                                                                                  • +
                                                                                                                                  + + + + + +
                                                                                                                                    +
                                                                                                                                  • + + +

                                                                                                                                    Method Detail

                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      void add(IModel model)

                                                                                                                                      +

                                                                                                                                      Appends an existing model to the model being built.

                                                                                                                                      Parameters:
                                                                                                                                      model

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      IModel build(Closure<IModel> definition)

                                                                                                                                      +

                                                                                                                                      Captures the top `build` call so that it doesn't end up as a node in the + final model.

                                                                                                                                      Parameters:
                                                                                                                                      definition
                                                                                                                                      Returns:
                                                                                                                                      The model built using the closure definition.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      @Override
                                                                                                                                      protected Object createNode(Object name)

                                                                                                                                      +

                                                                                                                                      Create a model for the given element.

                                                                                                                                      Parameters:
                                                                                                                                      name - Element name.
                                                                                                                                      Returns:
                                                                                                                                      New model representing an element with the given name.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      @Override
                                                                                                                                      protected Object createNode(Object name, Object value)

                                                                                                                                      +

                                                                                                                                      Create a model for the given element and inner text content.

                                                                                                                                      Parameters:
                                                                                                                                      name - Element name.
                                                                                                                                      value - Text content.
                                                                                                                                      Returns:
                                                                                                                                      New model representing an element with the given name and content.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      @Override
                                                                                                                                      protected Object createNode(Object name, Map attributes)

                                                                                                                                      +

                                                                                                                                      Create a model for the given element and attributes.

                                                                                                                                      Parameters:
                                                                                                                                      name - Element name.
                                                                                                                                      attributes - Element attributes.
                                                                                                                                      Returns:
                                                                                                                                      New model representing an element with the given name and + attributes.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      @Override
                                                                                                                                      @SuppressWarnings(value: AssignmentToStaticFieldFromInstanceMethod)
                                                                                                                                      protected IModel createNode(Object name, Map attributes, Object value)

                                                                                                                                      +

                                                                                                                                      Create a model for the given element, attributes, and inner text content.

                                                                                                                                      Parameters:
                                                                                                                                      name - Element name.
                                                                                                                                      attributes - Element attributes.
                                                                                                                                      value - Text content.
                                                                                                                                      Returns:
                                                                                                                                      New model representing an element with the given name, attributes, + and content.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      @Override
                                                                                                                                      protected void nodeCompleted(Object parent, Object child)

                                                                                                                                      +

                                                                                                                                      Link a parent and child node. A child node is appended to a parent by + being the last sub-model before the parent close tag.

                                                                                                                                      Parameters:
                                                                                                                                      parent
                                                                                                                                      child

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      @Override
                                                                                                                                      protected void setParent(Object parent, Object child)

                                                                                                                                      +

                                                                                                                                      Does nothing. Because models only copy events when added to one another, + we can't just add child events at this point - we need to wait until that + child has had it's children added, and so on. So the parent/child link is + made in the ModelBuilder.nodeCompleted method instead.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + +
                                                                                                                                  • +
                                                                                                                                  + +
                                                                                                                                • +
                                                                                                                                +
                                                                                                                                + + + +
                                                                                                                                + + + + + +
                                                                                                                                + + +
                                                                                                                                + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelMerger.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelMerger.html new file mode 100644 index 000000000..772f0703d --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/ModelMerger.html @@ -0,0 +1,241 @@ + + + + + + + + + + + ModelMerger (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                                + + + + + +
                                                                                                                                + + + + + +
                                                                                                                                + +
                                                                                                                                Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                                + +

                                                                                                                                [Groovy] Interface ModelMerger

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                  + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • + + +
                                                                                                                                  + +
                                                                                                                                  interface ModelMerger
                                                                                                                                  + +

                                                                                                                                  Merges template models by applying the source model to the target model, with + the result being implementation-dependant.

                                                                                                                                  Authors:
                                                                                                                                  Emanuel Rabina

                                                                                                                                  + +
                                                                                                                                • +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • + + + + + + + + + + + + + + + + + + +
                                                                                                                                    + +
                                                                                                                                  • +

                                                                                                                                    Methods Summary

                                                                                                                                    +
                                                                                                                                      + + + + + + + + + + + + + + +
                                                                                                                                      Methods 
                                                                                                                                      Type ParamsReturn TypeName and description
                                                                                                                                      abstract IModelmerge(IModel targetModel, IModel sourceModel)
                                                                                                                                      Merge the source model into the target model.
                                                                                                                                      +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                  + +
                                                                                                                                • +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • + + + + + + + + + + + + + +
                                                                                                                                    +
                                                                                                                                  • + + +

                                                                                                                                    Method Detail

                                                                                                                                    + + +
                                                                                                                                      +
                                                                                                                                    • +

                                                                                                                                      abstract IModel merge(IModel targetModel, IModel sourceModel)

                                                                                                                                      +

                                                                                                                                      Merge the source model into the target model.

                                                                                                                                      Parameters:
                                                                                                                                      targetModel
                                                                                                                                      sourceModel
                                                                                                                                      Returns:
                                                                                                                                      The result of the merge.

                                                                                                                                      +
                                                                                                                                    • +
                                                                                                                                    + +
                                                                                                                                  • +
                                                                                                                                  + +
                                                                                                                                • +
                                                                                                                                +
                                                                                                                                + + + +
                                                                                                                                + + + + + +
                                                                                                                                + + +
                                                                                                                                + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TemplateModelFinder.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TemplateModelFinder.html new file mode 100644 index 000000000..71d014baa --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TemplateModelFinder.html @@ -0,0 +1,383 @@ + + + + + + + + + + + TemplateModelFinder (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                                + + + + + +
                                                                                                                                + + + + + +
                                                                                                                                + +
                                                                                                                                Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                                + +

                                                                                                                                [Groovy] Class TemplateModelFinder

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                  • nz.net.ultraq.thymeleaf.layoutdialect.models.TemplateModelFinder +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                    +
                                                                                                                                  • + + + +
                                                                                                                                    + +
                                                                                                                                    @TupleConstructor(defaults: false)
                                                                                                                                    +class TemplateModelFinder
                                                                                                                                    +extends Object
                                                                                                                                    + +

                                                                                                                                    A simple API for retrieving (immutable template) models using Thymeleaf's + template manager.

                                                                                                                                    Authors:
                                                                                                                                    Emanuel Rabina

                                                                                                                                    + +
                                                                                                                                  • +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  + +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                    +
                                                                                                                                  • + + + + + + + + + + + + + +
                                                                                                                                      +
                                                                                                                                    • + + +

                                                                                                                                      Constructor Detail

                                                                                                                                      + + +
                                                                                                                                        +
                                                                                                                                      • +

                                                                                                                                        TemplateModelFinder()

                                                                                                                                        +

                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                      + +
                                                                                                                                    • +
                                                                                                                                    + + + + + +
                                                                                                                                      +
                                                                                                                                    • + + +

                                                                                                                                      Method Detail

                                                                                                                                      + + +
                                                                                                                                        +
                                                                                                                                      • +

                                                                                                                                        TemplateModel findFragment(FragmentExpression fragmentExpression)

                                                                                                                                        +

                                                                                                                                        Return the model specified by the given fragment expression.

                                                                                                                                        Parameters:
                                                                                                                                        fragmentExpression
                                                                                                                                        Returns:
                                                                                                                                        Fragment matching the fragment specification.

                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                      + + +
                                                                                                                                        +
                                                                                                                                      • +

                                                                                                                                        @SuppressWarnings(value: UnnecessaryGString)
                                                                                                                                        TemplateModel findFragment(String templateName, String fragmentName, String dialectPrefix)

                                                                                                                                        +

                                                                                                                                        Return the model specified by the template and fragment name parameters.

                                                                                                                                        Parameters:
                                                                                                                                        templateName
                                                                                                                                        fragmentName
                                                                                                                                        dialectPrefix
                                                                                                                                        Returns:
                                                                                                                                        Fragment matching the fragment specification.

                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                      + + +
                                                                                                                                        +
                                                                                                                                      • +

                                                                                                                                        TemplateModel findTemplate(FragmentExpression fragmentExpression)

                                                                                                                                        +

                                                                                                                                        Return a model for the template specified by the given fragment expression.

                                                                                                                                        Parameters:
                                                                                                                                        fragmentExpression
                                                                                                                                        Returns:
                                                                                                                                        Template model matching the fragment specification.

                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                      + + +
                                                                                                                                        +
                                                                                                                                      • +

                                                                                                                                        TemplateModel findTemplate(String templateName)

                                                                                                                                        +

                                                                                                                                        Return a model for the template specified by the given template name.

                                                                                                                                        Parameters:
                                                                                                                                        templateName
                                                                                                                                        Returns:
                                                                                                                                        Template model matching the fragment specification.

                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                      + +
                                                                                                                                    • +
                                                                                                                                    + +
                                                                                                                                  • +
                                                                                                                                  +
                                                                                                                                  + + + +
                                                                                                                                  + + + + + +
                                                                                                                                  + + +
                                                                                                                                  + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TitleExtractor.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TitleExtractor.html new file mode 100644 index 000000000..6939b2496 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/TitleExtractor.html @@ -0,0 +1,356 @@ + + + + + + + + + + + TitleExtractor (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                                  + + + + + +
                                                                                                                                  + + + + + +
                                                                                                                                  + +
                                                                                                                                  Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                                  + +

                                                                                                                                  [Groovy] Class TitleExtractor

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                    +
                                                                                                                                    • nz.net.ultraq.thymeleaf.layoutdialect.models.TitleExtractor +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • + + + +
                                                                                                                                      + +
                                                                                                                                      @TupleConstructor
                                                                                                                                      +class TitleExtractor
                                                                                                                                      +extends Object
                                                                                                                                      + +

                                                                                                                                      Utility class for extracting <title> values from templates.

                                                                                                                                      Authors:
                                                                                                                                      Emanuel Rabina

                                                                                                                                      + +
                                                                                                                                    • +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • + + + + + + + + + + + + + + + + + + +
                                                                                                                                        +
                                                                                                                                      • +

                                                                                                                                        Constructor Summary

                                                                                                                                        +
                                                                                                                                          + + + + + + + + + + +
                                                                                                                                          Constructors 
                                                                                                                                          Constructor and description
                                                                                                                                          + TitleExtractor()
                                                                                                                                          +
                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                      + + + + +
                                                                                                                                        + +
                                                                                                                                      • +

                                                                                                                                        Methods Summary

                                                                                                                                        +
                                                                                                                                          + + + + + + + + + + + + + + +
                                                                                                                                          Methods 
                                                                                                                                          Type ParamsReturn TypeName and description
                                                                                                                                          voidextract(IModel template, String contextKey)
                                                                                                                                          Locate and extract title data from the given template model, saving it to + the template context as the given context key.
                                                                                                                                          +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                      • +

                                                                                                                                        Inherited Methods Summary

                                                                                                                                        + +
                                                                                                                                      • + +
                                                                                                                                      + +
                                                                                                                                    • +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • + + + + + + +
                                                                                                                                        +
                                                                                                                                      • + + +

                                                                                                                                        Property Detail

                                                                                                                                        + + + + + +
                                                                                                                                          +
                                                                                                                                        • +

                                                                                                                                          final boolean newTitleTokens

                                                                                                                                          +

                                                                                                                                          +
                                                                                                                                        • +
                                                                                                                                        + +
                                                                                                                                      • +
                                                                                                                                      + + + + + + +
                                                                                                                                        +
                                                                                                                                      • + + +

                                                                                                                                        Constructor Detail

                                                                                                                                        + + +
                                                                                                                                          +
                                                                                                                                        • +

                                                                                                                                          TitleExtractor()

                                                                                                                                          +

                                                                                                                                          +
                                                                                                                                        • +
                                                                                                                                        + +
                                                                                                                                      • +
                                                                                                                                      + + + + + +
                                                                                                                                        +
                                                                                                                                      • + + +

                                                                                                                                        Method Detail

                                                                                                                                        + + +
                                                                                                                                          +
                                                                                                                                        • +

                                                                                                                                          void extract(IModel template, String contextKey)

                                                                                                                                          +

                                                                                                                                          Locate and extract title data from the given template model, saving it to + the template context as the given context key. This is so that it can be + accessed from within the context level using that key.

                                                                                                                                          Parameters:
                                                                                                                                          template
                                                                                                                                          contextKey

                                                                                                                                          +
                                                                                                                                        • +
                                                                                                                                        + +
                                                                                                                                      • +
                                                                                                                                      + +
                                                                                                                                    • +
                                                                                                                                    +
                                                                                                                                    + + + +
                                                                                                                                    + + + + + +
                                                                                                                                    + + +
                                                                                                                                    + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclaration.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclaration.html new file mode 100644 index 000000000..84be59745 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclaration.html @@ -0,0 +1,355 @@ + + + + + + + + + + + VariableDeclaration (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                                    + + + + + +
                                                                                                                                    + + + + + +
                                                                                                                                    + +
                                                                                                                                    Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                                    + +

                                                                                                                                    [Groovy] Class VariableDeclaration

                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                      • nz.net.ultraq.thymeleaf.layoutdialect.models.VariableDeclaration +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                      • + + + +
                                                                                                                                        + +
                                                                                                                                        class VariableDeclaration
                                                                                                                                        +extends Object
                                                                                                                                        + +

                                                                                                                                        Representation of a scoped variable declaration made through th:with + attributes. This is really a wrapper around Thymeleaf's Assignation + class, but simplified to just the left and right hand components in string + form.

                                                                                                                                        Authors:
                                                                                                                                        Emanuel Rabina

                                                                                                                                        + +
                                                                                                                                      • +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                      • + + + + + + + + + + +
                                                                                                                                          +
                                                                                                                                        • +

                                                                                                                                          Properties Summary

                                                                                                                                          + +
                                                                                                                                        • + +
                                                                                                                                        + + + + + + + +
                                                                                                                                          +
                                                                                                                                        • +

                                                                                                                                          Constructor Summary

                                                                                                                                          +
                                                                                                                                            + + + + + + + + + + +
                                                                                                                                            Constructors 
                                                                                                                                            Constructor and description
                                                                                                                                            + VariableDeclaration(Assignation assignation)
                                                                                                                                            Constructor, create an instance from a Thymeleaf assignation.
                                                                                                                                            +
                                                                                                                                          +
                                                                                                                                        • +
                                                                                                                                        + + + + + + +
                                                                                                                                      • +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                      • + + + + + + +
                                                                                                                                          +
                                                                                                                                        • + + +

                                                                                                                                          Property Detail

                                                                                                                                          + + +
                                                                                                                                            +
                                                                                                                                          • +

                                                                                                                                            final String name

                                                                                                                                            +

                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          + + +
                                                                                                                                            +
                                                                                                                                          • +

                                                                                                                                            final String value

                                                                                                                                            +

                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          + +
                                                                                                                                        • +
                                                                                                                                        + + + + + + +
                                                                                                                                          +
                                                                                                                                        • + + +

                                                                                                                                          Constructor Detail

                                                                                                                                          + + +
                                                                                                                                            +
                                                                                                                                          • +

                                                                                                                                            VariableDeclaration(Assignation assignation)

                                                                                                                                            +

                                                                                                                                            Constructor, create an instance from a Thymeleaf assignation.

                                                                                                                                            Parameters:
                                                                                                                                            assignation

                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          + +
                                                                                                                                        • +
                                                                                                                                        + + + + + +
                                                                                                                                          +
                                                                                                                                        • + + +

                                                                                                                                          Method Detail

                                                                                                                                          + + +
                                                                                                                                            +
                                                                                                                                          • +

                                                                                                                                            @Override
                                                                                                                                            String toString()

                                                                                                                                            +

                                                                                                                                            Reconstructs the variable for use with th:with.

                                                                                                                                            Returns:
                                                                                                                                            name=value

                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          + +
                                                                                                                                        • +
                                                                                                                                        + +
                                                                                                                                      • +
                                                                                                                                      +
                                                                                                                                      + + + +
                                                                                                                                      + + + + + +
                                                                                                                                      + + +
                                                                                                                                      + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationMerger.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationMerger.html new file mode 100644 index 000000000..0b2d12e0f --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationMerger.html @@ -0,0 +1,344 @@ + + + + + + + + + + + VariableDeclarationMerger (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                                      + + + + + +
                                                                                                                                      + + + + + +
                                                                                                                                      + +
                                                                                                                                      Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                                      + +

                                                                                                                                      [Groovy] Class VariableDeclarationMerger

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                        • nz.net.ultraq.thymeleaf.layoutdialect.models.VariableDeclarationMerger +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                        • + + + +
                                                                                                                                          + +
                                                                                                                                          @TupleConstructor(defaults: false)
                                                                                                                                          +class VariableDeclarationMerger
                                                                                                                                          +extends Object
                                                                                                                                          + +

                                                                                                                                          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.

                                                                                                                                          Authors:
                                                                                                                                          Emanuel Rabina

                                                                                                                                          + +
                                                                                                                                        • +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                        • + + + + + + + + + + + + + + + + + + +
                                                                                                                                            +
                                                                                                                                          • +

                                                                                                                                            Constructor Summary

                                                                                                                                            + +
                                                                                                                                          • +
                                                                                                                                          + + + + +
                                                                                                                                            + +
                                                                                                                                          • +

                                                                                                                                            Methods Summary

                                                                                                                                            +
                                                                                                                                              + + + + + + + + + + + + + + +
                                                                                                                                              Methods 
                                                                                                                                              Type ParamsReturn TypeName and description
                                                                                                                                              Stringmerge(String target, String source)
                                                                                                                                              Merge th:with attributes so that names from the source value + overwrite the same names in the target value.
                                                                                                                                              +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                          • +

                                                                                                                                            Inherited Methods Summary

                                                                                                                                            + +
                                                                                                                                          • + +
                                                                                                                                          + +
                                                                                                                                        • +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                        • + + + + + + + + + + + + + +
                                                                                                                                            +
                                                                                                                                          • + + +

                                                                                                                                            Constructor Detail

                                                                                                                                            + + +
                                                                                                                                              +
                                                                                                                                            • +

                                                                                                                                              VariableDeclarationMerger()

                                                                                                                                              +

                                                                                                                                              +
                                                                                                                                            • +
                                                                                                                                            + +
                                                                                                                                          • +
                                                                                                                                          + + + + + +
                                                                                                                                            +
                                                                                                                                          • + + +

                                                                                                                                            Method Detail

                                                                                                                                            + + +
                                                                                                                                              +
                                                                                                                                            • +

                                                                                                                                              String merge(String target, String source)

                                                                                                                                              +

                                                                                                                                              Merge th:with attributes so that names from the source value + overwrite the same names in the target value.

                                                                                                                                              +
                                                                                                                                            • +
                                                                                                                                            + +
                                                                                                                                          • +
                                                                                                                                          + +
                                                                                                                                        • +
                                                                                                                                        +
                                                                                                                                        + + + +
                                                                                                                                        + + + + + +
                                                                                                                                        + + +
                                                                                                                                        + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationParser.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationParser.html new file mode 100644 index 000000000..bdc03a90d --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/VariableDeclarationParser.html @@ -0,0 +1,345 @@ + + + + + + + + + + + VariableDeclarationParser (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + +
                                                                                                                                        + + + + + +
                                                                                                                                        + + + + + +
                                                                                                                                        + +
                                                                                                                                        Package: nz.net.ultraq.thymeleaf.layoutdialect.models
                                                                                                                                        + +

                                                                                                                                        [Groovy] Class VariableDeclarationParser

                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                          • nz.net.ultraq.thymeleaf.layoutdialect.models.VariableDeclarationParser +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • + + + +
                                                                                                                                            + +
                                                                                                                                            @TupleConstructor(defaults: false)
                                                                                                                                            +class VariableDeclarationParser
                                                                                                                                            +extends Object
                                                                                                                                            + +

                                                                                                                                            Parser for variable declaration strings, which are the expressions that are + found withing th:with processors. This is really a wrapper around + Thymeleaf's AssignationUtils class, which is a crazy house of code + that splits the expression string into the parts needed by this dialect.

                                                                                                                                            Authors:
                                                                                                                                            Emanuel Rabina

                                                                                                                                            + +
                                                                                                                                          • +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • + + + + + + + + + + + + + + + + + + +
                                                                                                                                              +
                                                                                                                                            • +

                                                                                                                                              Constructor Summary

                                                                                                                                              + +
                                                                                                                                            • +
                                                                                                                                            + + + + +
                                                                                                                                              + +
                                                                                                                                            • +

                                                                                                                                              Methods Summary

                                                                                                                                              +
                                                                                                                                                + + + + + + + + + + + + + + +
                                                                                                                                                Methods 
                                                                                                                                                Type ParamsReturn TypeName and description
                                                                                                                                                List<VariableDeclaration>parse(String declarationString)
                                                                                                                                                Parse a variable declaration string, returning as many variable declaration + objects as there are variable declarations.
                                                                                                                                                +
                                                                                                                                              +
                                                                                                                                            • + +
                                                                                                                                            • +

                                                                                                                                              Inherited Methods Summary

                                                                                                                                              + +
                                                                                                                                            • + +
                                                                                                                                            + +
                                                                                                                                          • +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • + + + + + + + + + + + + + +
                                                                                                                                              +
                                                                                                                                            • + + +

                                                                                                                                              Constructor Detail

                                                                                                                                              + + +
                                                                                                                                                +
                                                                                                                                              • +

                                                                                                                                                VariableDeclarationParser()

                                                                                                                                                +

                                                                                                                                                +
                                                                                                                                              • +
                                                                                                                                              + +
                                                                                                                                            • +
                                                                                                                                            + + + + + +
                                                                                                                                              +
                                                                                                                                            • + + +

                                                                                                                                              Method Detail

                                                                                                                                              + + +
                                                                                                                                                +
                                                                                                                                              • +

                                                                                                                                                List<VariableDeclaration> parse(String declarationString)

                                                                                                                                                +

                                                                                                                                                Parse a variable declaration string, returning as many variable declaration + objects as there are variable declarations.

                                                                                                                                                Parameters:
                                                                                                                                                declarationString
                                                                                                                                                Returns:
                                                                                                                                                List of variable declaration objects.

                                                                                                                                                +
                                                                                                                                              • +
                                                                                                                                              + +
                                                                                                                                            • +
                                                                                                                                            + +
                                                                                                                                          • +
                                                                                                                                          +
                                                                                                                                          + + + +
                                                                                                                                          + + + + + +
                                                                                                                                          + + +
                                                                                                                                          + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-frame.html new file mode 100644 index 000000000..08ac5e7d2 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-frame.html @@ -0,0 +1,66 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect.models + + + + + + + + + + + + + + +
                                                                                                                                          +

                                                                                                                                          Interfaces

                                                                                                                                          + +
                                                                                                                                          + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-summary.html new file mode 100644 index 000000000..e2a8f6c68 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/models/package-summary.html @@ -0,0 +1,249 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect.models (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                                                                                                          + + + + + + +
                                                                                                                                          + + + + + +
                                                                                                                                          +

                                                                                                                                          Package nz.net.ultraq.thymeleaf.layoutdialect.models

                                                                                                                                          +
                                                                                                                                          + + + +
                                                                                                                                          + + +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • + + + + + + + + + + + + + +
                                                                                                                                            Interface Summary 
                                                                                                                                            InterfaceDescription
                                                                                                                                            + + ModelMerger + + Merges template models by applying the source model to the target model, with + the result being implementation-dependant.
                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          +
                                                                                                                                          + + + + +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                            Class Summary 
                                                                                                                                            ClassDescription
                                                                                                                                            + + AttributeMerger + + Merges attributes from one element into another.
                                                                                                                                            + + ChildModelIterator + + An iterator that works with a model's immediate children, returning each one + as a model of its own.
                                                                                                                                            + + ElementMerger + + Merges an element and all its children into an existing element.
                                                                                                                                            + + EventIterator + + An iterator that treats a model as a queue of events.
                                                                                                                                            + + ModelBuilder + + Create Thymeleaf 3 models using the Groovy builder syntax.
                                                                                                                                            + + TemplateModelFinder + + A simple API for retrieving (immutable template) models using Thymeleaf's + template manager.
                                                                                                                                            + + TitleExtractor + + Utility class for extracting <title> values from templates.
                                                                                                                                            + + VariableDeclaration + + Representation of a scoped variable declaration made through th:with + attributes.
                                                                                                                                            + + VariableDeclarationMerger + + 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.
                                                                                                                                            + + VariableDeclarationParser + + Parser for variable declaration strings, which are the expressions that are + found withing th:with processors.
                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          +
                                                                                                                                          + + + + + + + +
                                                                                                                                          + + +
                                                                                                                                          + + + + + +
                                                                                                                                          + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-frame.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-frame.html new file mode 100644 index 000000000..a674f8ced --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-frame.html @@ -0,0 +1,58 @@ + + + + + nz.net.ultraq.thymeleaf.layoutdialect + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-summary.html b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-summary.html new file mode 100644 index 000000000..c638000d1 --- /dev/null +++ b/groovydoc/nz/net/ultraq/thymeleaf/layoutdialect/package-summary.html @@ -0,0 +1,154 @@ + + + + + +nz.net.ultraq.thymeleaf.layoutdialect (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + +
                                                                                                                                          + + + + + + +
                                                                                                                                          + + + + + +
                                                                                                                                          +

                                                                                                                                          Package nz.net.ultraq.thymeleaf.layoutdialect

                                                                                                                                          +
                                                                                                                                          + + + +
                                                                                                                                          + + + + +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • + + + + + + + + + + + + + + + + + +
                                                                                                                                            Class Summary 
                                                                                                                                            ClassDescription
                                                                                                                                            + + LayoutDialect + + A dialect for Thymeleaf that lets you build layouts and reusable templates in + order to improve code reuse.
                                                                                                                                            + + PojoLoggerFactory + + A no-Groovy wrapper around SLF4J's org.slf4j.LoggerFactory#getLogger(java.lang.Class) + method`.
                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                          +
                                                                                                                                          + + + + + + + +
                                                                                                                                          + + +
                                                                                                                                          + + + + + +
                                                                                                                                          + + + + + diff --git a/groovydoc/overview-frame.html b/groovydoc/overview-frame.html new file mode 100644 index 000000000..7e17791e1 --- /dev/null +++ b/groovydoc/overview-frame.html @@ -0,0 +1,69 @@ + + + + +Overview (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + + + diff --git a/groovydoc/overview-summary.html b/groovydoc/overview-summary.html new file mode 100644 index 000000000..a041c0e81 --- /dev/null +++ b/groovydoc/overview-summary.html @@ -0,0 +1,178 @@ + + + + + +Overview (thymeleaf-layout-dialect 3.4.0 API) + + + + + + + + + + + +
                                                                                                                                          + + + + + +
                                                                                                                                          + + +
                                                                                                                                          +

                                                                                                                                          thymeleaf-layout-dialect 3.4.0 API

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          + + + + + diff --git a/groovydoc/package-list b/groovydoc/package-list new file mode 100644 index 000000000..cd02c4615 --- /dev/null +++ b/groovydoc/package-list @@ -0,0 +1,9 @@ +nz.net.ultraq.thymeleaf.layoutdialect +nz.net.ultraq.thymeleaf.layoutdialect.decorators +nz.net.ultraq.thymeleaf.layoutdialect.decorators.html +nz.net.ultraq.thymeleaf.layoutdialect.decorators.strategies +nz.net.ultraq.thymeleaf.layoutdialect.decorators.xml +nz.net.ultraq.thymeleaf.layoutdialect.extensions +nz.net.ultraq.thymeleaf.layoutdialect.fragments +nz.net.ultraq.thymeleaf.layoutdialect.includes +nz.net.ultraq.thymeleaf.layoutdialect.models diff --git a/groovydoc/stylesheet.css b/groovydoc/stylesheet.css new file mode 100644 index 000000000..06eb31a18 --- /dev/null +++ b/groovydoc/stylesheet.css @@ -0,0 +1,2306 @@ +@charset "UTF-8"; + +/*! normalize.css v2.1.0 | MIT License | git.io/normalize */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { + display: block +} + +audio, canvas, video { + display: inline-block +} + +audio:not([controls]) { + display: none; + height: 0 +} + +[hidden] { + display: none +} + +html { + font-family: sans-serif; + -webkit-text-size-adjust: 100%; + -ms-text-size-adjust: 100% +} + +body { + margin: 0 +} + +a:focus { + outline: thin dotted +} + +a:active, a:hover { + outline: 0 +} + +h1 { + font-size: 2em; + margin: .67em 0 +} + +abbr[title] { + border-bottom: 1px dotted +} + +b, strong { + font-weight: bold +} + +dfn { + font-style: italic +} + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0 +} + +mark { + background: #ff0; + color: #000 +} + +code, kbd, pre, samp { + font-family: monospace, serif; + font-size: 1em +} + +pre { + white-space: pre-wrap +} + +q { + quotes: "C" "D" "8" "9" +} + +small { + font-size: 80% +} + +sub, sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline +} + +sup { + top: -0.5em +} + +sub { + bottom: -0.25em +} + +img { + border: 0 +} + +svg:not(:root) { + overflow: hidden +} + +figure { + margin: 0 +} + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: .35em .625em .75em +} + +legend { + border: 0; + padding: 0 +} + +button, input, select, textarea { + font-family: inherit; + font-size: 100%; + margin: 0 +} + +button, input { + line-height: normal +} + +button, select { + text-transform: none +} + +button, html input[type="button"], input[type="reset"], input[type="submit"] { + -webkit-appearance: button; + cursor: pointer +} + +button[disabled], html input[disabled] { + cursor: default +} + +input[type="checkbox"], input[type="radio"] { + box-sizing: border-box; + padding: 0 +} + +input[type="search"] { + -webkit-appearance: textfield; + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; + box-sizing: content-box +} + +input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none +} + +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0 +} + +textarea { + overflow: auto; + vertical-align: top +} + +table { + border-collapse: collapse; + border-spacing: 0 +} + +@-ms-viewport { + width: device-width +} + +@media screen and (max-width: 400px) { + @-ms-viewport { + width: 320px + } +} + +.hidden { + display: none !important; + visibility: hidden !important +} + +.visible-xs { + display: none !important +} + +tr.visible-xs { + display: none !important +} + +th.visible-xs, td.visible-xs { + display: none !important +} + +@media (max-width: 767px) { + .visible-xs { + display: block !important + } + + tr.visible-xs { + display: table-row !important + } + + th.visible-xs, td.visible-xs { + display: table-cell !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-xs.visible-sm { + display: block !important + } + + tr.visible-xs.visible-sm { + display: table-row !important + } + + th.visible-xs.visible-sm, td.visible-xs.visible-sm { + display: table-cell !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-xs.visible-md { + display: block !important + } + + tr.visible-xs.visible-md { + display: table-row !important + } + + th.visible-xs.visible-md, td.visible-xs.visible-md { + display: table-cell !important + } +} + +@media (min-width: 1200px) { + .visible-xs.visible-lg { + display: block !important + } + + tr.visible-xs.visible-lg { + display: table-row !important + } + + th.visible-xs.visible-lg, td.visible-xs.visible-lg { + display: table-cell !important + } +} + +.visible-sm { + display: none !important +} + +tr.visible-sm { + display: none !important +} + +th.visible-sm, td.visible-sm { + display: none !important +} + +@media (max-width: 767px) { + .visible-sm.visible-xs { + display: block !important + } + + tr.visible-sm.visible-xs { + display: table-row !important + } + + th.visible-sm.visible-xs, td.visible-sm.visible-xs { + display: table-cell !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-sm { + display: block !important + } + + tr.visible-sm { + display: table-row !important + } + + th.visible-sm, td.visible-sm { + display: table-cell !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-sm.visible-md { + display: block !important + } + + tr.visible-sm.visible-md { + display: table-row !important + } + + th.visible-sm.visible-md, td.visible-sm.visible-md { + display: table-cell !important + } +} + +@media (min-width: 1200px) { + .visible-sm.visible-lg { + display: block !important + } + + tr.visible-sm.visible-lg { + display: table-row !important + } + + th.visible-sm.visible-lg, td.visible-sm.visible-lg { + display: table-cell !important + } +} + +.visible-md { + display: none !important +} + +tr.visible-md { + display: none !important +} + +th.visible-md, td.visible-md { + display: none !important +} + +@media (max-width: 767px) { + .visible-md.visible-xs { + display: block !important + } + + tr.visible-md.visible-xs { + display: table-row !important + } + + th.visible-md.visible-xs, td.visible-md.visible-xs { + display: table-cell !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-md.visible-sm { + display: block !important + } + + tr.visible-md.visible-sm { + display: table-row !important + } + + th.visible-md.visible-sm, td.visible-md.visible-sm { + display: table-cell !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-md { + display: block !important + } + + tr.visible-md { + display: table-row !important + } + + th.visible-md, td.visible-md { + display: table-cell !important + } +} + +@media (min-width: 1200px) { + .visible-md.visible-lg { + display: block !important + } + + tr.visible-md.visible-lg { + display: table-row !important + } + + th.visible-md.visible-lg, td.visible-md.visible-lg { + display: table-cell !important + } +} + +.visible-lg { + display: none !important +} + +tr.visible-lg { + display: none !important +} + +th.visible-lg, td.visible-lg { + display: none !important +} + +@media (max-width: 767px) { + .visible-lg.visible-xs { + display: block !important + } + + tr.visible-lg.visible-xs { + display: table-row !important + } + + th.visible-lg.visible-xs, td.visible-lg.visible-xs { + display: table-cell !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .visible-lg.visible-sm { + display: block !important + } + + tr.visible-lg.visible-sm { + display: table-row !important + } + + th.visible-lg.visible-sm, td.visible-lg.visible-sm { + display: table-cell !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .visible-lg.visible-md { + display: block !important + } + + tr.visible-lg.visible-md { + display: table-row !important + } + + th.visible-lg.visible-md, td.visible-lg.visible-md { + display: table-cell !important + } +} + +@media (min-width: 1200px) { + .visible-lg { + display: block !important + } + + tr.visible-lg { + display: table-row !important + } + + th.visible-lg, td.visible-lg { + display: table-cell !important + } +} + +.hidden-xs { + display: block !important +} + +tr.hidden-xs { + display: table-row !important +} + +th.hidden-xs, td.hidden-xs { + display: table-cell !important +} + +@media (max-width: 767px) { + .hidden-xs { + display: none !important + } + + tr.hidden-xs { + display: none !important + } + + th.hidden-xs, td.hidden-xs { + display: none !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-xs.hidden-sm { + display: none !important + } + + tr.hidden-xs.hidden-sm { + display: none !important + } + + th.hidden-xs.hidden-sm, td.hidden-xs.hidden-sm { + display: none !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-xs.hidden-md { + display: none !important + } + + tr.hidden-xs.hidden-md { + display: none !important + } + + th.hidden-xs.hidden-md, td.hidden-xs.hidden-md { + display: none !important + } +} + +@media (min-width: 1200px) { + .hidden-xs.hidden-lg { + display: none !important + } + + tr.hidden-xs.hidden-lg { + display: none !important + } + + th.hidden-xs.hidden-lg, td.hidden-xs.hidden-lg { + display: none !important + } +} + +.hidden-sm { + display: block !important +} + +tr.hidden-sm { + display: table-row !important +} + +th.hidden-sm, td.hidden-sm { + display: table-cell !important +} + +@media (max-width: 767px) { + .hidden-sm.hidden-xs { + display: none !important + } + + tr.hidden-sm.hidden-xs { + display: none !important + } + + th.hidden-sm.hidden-xs, td.hidden-sm.hidden-xs { + display: none !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-sm { + display: none !important + } + + tr.hidden-sm { + display: none !important + } + + th.hidden-sm, td.hidden-sm { + display: none !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-sm.hidden-md { + display: none !important + } + + tr.hidden-sm.hidden-md { + display: none !important + } + + th.hidden-sm.hidden-md, td.hidden-sm.hidden-md { + display: none !important + } +} + +@media (min-width: 1200px) { + .hidden-sm.hidden-lg { + display: none !important + } + + tr.hidden-sm.hidden-lg { + display: none !important + } + + th.hidden-sm.hidden-lg, td.hidden-sm.hidden-lg { + display: none !important + } +} + +.hidden-md { + display: block !important +} + +tr.hidden-md { + display: table-row !important +} + +th.hidden-md, td.hidden-md { + display: table-cell !important +} + +@media (max-width: 767px) { + .hidden-md.hidden-xs { + display: none !important + } + + tr.hidden-md.hidden-xs { + display: none !important + } + + th.hidden-md.hidden-xs, td.hidden-md.hidden-xs { + display: none !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-md.hidden-sm { + display: none !important + } + + tr.hidden-md.hidden-sm { + display: none !important + } + + th.hidden-md.hidden-sm, td.hidden-md.hidden-sm { + display: none !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-md { + display: none !important + } + + tr.hidden-md { + display: none !important + } + + th.hidden-md, td.hidden-md { + display: none !important + } +} + +@media (min-width: 1200px) { + .hidden-md.hidden-lg { + display: none !important + } + + tr.hidden-md.hidden-lg { + display: none !important + } + + th.hidden-md.hidden-lg, td.hidden-md.hidden-lg { + display: none !important + } +} + +.hidden-lg { + display: block !important +} + +tr.hidden-lg { + display: table-row !important +} + +th.hidden-lg, td.hidden-lg { + display: table-cell !important +} + +@media (max-width: 767px) { + .hidden-lg.hidden-xs { + display: none !important + } + + tr.hidden-lg.hidden-xs { + display: none !important + } + + th.hidden-lg.hidden-xs, td.hidden-lg.hidden-xs { + display: none !important + } +} + +@media (min-width: 768px) and (max-width: 991px) { + .hidden-lg.hidden-sm { + display: none !important + } + + tr.hidden-lg.hidden-sm { + display: none !important + } + + th.hidden-lg.hidden-sm, td.hidden-lg.hidden-sm { + display: none !important + } +} + +@media (min-width: 992px) and (max-width: 1199px) { + .hidden-lg.hidden-md { + display: none !important + } + + tr.hidden-lg.hidden-md { + display: none !important + } + + th.hidden-lg.hidden-md, td.hidden-lg.hidden-md { + display: none !important + } +} + +@media (min-width: 1200px) { + .hidden-lg { + display: none !important + } + + tr.hidden-lg { + display: none !important + } + + th.hidden-lg, td.hidden-lg { + display: none !important + } +} + +.visible-print { + display: none !important +} + +tr.visible-print { + display: none !important +} + +th.visible-print, td.visible-print { + display: none !important +} + +@media print { + .visible-print { + display: block !important + } + + tr.visible-print { + display: table-row !important + } + + th.visible-print, td.visible-print { + display: table-cell !important + } + + .hidden-print { + display: none !important + } + + tr.hidden-print { + display: none !important + } + + th.hidden-print, td.hidden-print { + display: none !important + } +} + +.container { + margin-right: auto; + margin-left: auto; + padding-left: 15px; + padding-right: 15px +} + +.container:before, .container:after { + content: " "; + display: table +} + +.container:after { + clear: both +} + +.row-fluid { + margin-left: -15px; + margin-right: -15px +} + +.row-fluid:before, .row-fluid:after { + content: " "; + display: table +} + +.row-fluid:after { + clear: both +} + +.col-xs-1, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9, .col-xs-10, .col-xs-11, .col-xs-12, .col-sm-1, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9, .col-sm-10, .col-sm-11, .col-sm-12, .col-md-1, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9, .col-md-10, .col-md-11, .col-md-12, .col-lg-1, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9, .col-lg-10, .col-lg-11, .col-lg-12 { + position: relative; + min-height: 1px; + padding-left: 15px; + padding-right: 15px +} + +.col-xs-1, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9, .col-xs-10, .col-xs-11 { + float: left +} + +.col-xs-1 { + width: 8.333333333333332% +} + +.col-xs-2 { + width: 16.666666666666664% +} + +.col-xs-3 { + width: 25% +} + +.col-xs-4 { + width: 33.33333333333333% +} + +.col-xs-5 { + width: 41.66666666666667% +} + +.col-xs-6 { + width: 50% +} + +.col-xs-7 { + width: 58.333333333333336% +} + +.col-xs-8 { + width: 66.66666666666666% +} + +.col-xs-9 { + width: 75% +} + +.col-xs-10 { + width: 83.33333333333334% +} + +.col-xs-11 { + width: 91.66666666666666% +} + +.col-xs-12 { + width: 100% +} + +@media (min-width: 768px) { + .container { + max-width: 750px + } + + .col-sm-1, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9, .col-sm-10, .col-sm-11 { + float: left + } + + .col-sm-1 { + width: 8.333333333333332% + } + + .col-sm-2 { + width: 16.666666666666664% + } + + .col-sm-3 { + width: 25% + } + + .col-sm-4 { + width: 33.33333333333333% + } + + .col-sm-5 { + width: 41.66666666666667% + } + + .col-sm-6 { + width: 50% + } + + .col-sm-7 { + width: 58.333333333333336% + } + + .col-sm-8 { + width: 66.66666666666666% + } + + .col-sm-9 { + width: 75% + } + + .col-sm-10 { + width: 83.33333333333334% + } + + .col-sm-11 { + width: 91.66666666666666% + } + + .col-sm-12 { + width: 100% + } + + .col-sm-push-1 { + left: 8.333333333333332% + } + + .col-sm-push-2 { + left: 16.666666666666664% + } + + .col-sm-push-3 { + left: 25% + } + + .col-sm-push-4 { + left: 33.33333333333333% + } + + .col-sm-push-5 { + left: 41.66666666666667% + } + + .col-sm-push-6 { + left: 50% + } + + .col-sm-push-7 { + left: 58.333333333333336% + } + + .col-sm-push-8 { + left: 66.66666666666666% + } + + .col-sm-push-9 { + left: 75% + } + + .col-sm-push-10 { + left: 83.33333333333334% + } + + .col-sm-push-11 { + left: 91.66666666666666% + } + + .col-sm-pull-1 { + right: 8.333333333333332% + } + + .col-sm-pull-2 { + right: 16.666666666666664% + } + + .col-sm-pull-3 { + right: 25% + } + + .col-sm-pull-4 { + right: 33.33333333333333% + } + + .col-sm-pull-5 { + right: 41.66666666666667% + } + + .col-sm-pull-6 { + right: 50% + } + + .col-sm-pull-7 { + right: 58.333333333333336% + } + + .col-sm-pull-8 { + right: 66.66666666666666% + } + + .col-sm-pull-9 { + right: 75% + } + + .col-sm-pull-10 { + right: 83.33333333333334% + } + + .col-sm-pull-11 { + right: 91.66666666666666% + } + + .col-sm-offset-1 { + margin-left: 8.333333333333332% + } + + .col-sm-offset-2 { + margin-left: 16.666666666666664% + } + + .col-sm-offset-3 { + margin-left: 25% + } + + .col-sm-offset-4 { + margin-left: 33.33333333333333% + } + + .col-sm-offset-5 { + margin-left: 41.66666666666667% + } + + .col-sm-offset-6 { + margin-left: 50% + } + + .col-sm-offset-7 { + margin-left: 58.333333333333336% + } + + .col-sm-offset-8 { + margin-left: 66.66666666666666% + } + + .col-sm-offset-9 { + margin-left: 75% + } + + .col-sm-offset-10 { + margin-left: 83.33333333333334% + } + + .col-sm-offset-11 { + margin-left: 91.66666666666666% + } +} + +@media (min-width: 992px) { + .container { + max-width: 970px + } + + .col-md-1, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9, .col-md-10, .col-md-11 { + float: left + } + + .col-md-1 { + width: 8.333333333333332% + } + + .col-md-2 { + width: 16.666666666666664% + } + + .col-md-3 { + width: 25% + } + + .col-md-4 { + width: 33.33333333333333% + } + + .col-md-5 { + width: 41.66666666666667% + } + + .col-md-6 { + width: 50% + } + + .col-md-7 { + width: 58.333333333333336% + } + + .col-md-8 { + width: 66.66666666666666% + } + + .col-md-9 { + width: 75% + } + + .col-md-10 { + width: 83.33333333333334% + } + + .col-md-11 { + width: 91.66666666666666% + } + + .col-md-12 { + width: 100% + } + + .col-md-push-0 { + left: auto + } + + .col-md-push-1 { + left: 8.333333333333332% + } + + .col-md-push-2 { + left: 16.666666666666664% + } + + .col-md-push-3 { + left: 25% + } + + .col-md-push-4 { + left: 33.33333333333333% + } + + .col-md-push-5 { + left: 41.66666666666667% + } + + .col-md-push-6 { + left: 50% + } + + .col-md-push-7 { + left: 58.333333333333336% + } + + .col-md-push-8 { + left: 66.66666666666666% + } + + .col-md-push-9 { + left: 75% + } + + .col-md-push-10 { + left: 83.33333333333334% + } + + .col-md-push-11 { + left: 91.66666666666666% + } + + .col-md-pull-0 { + right: auto + } + + .col-md-pull-1 { + right: 8.333333333333332% + } + + .col-md-pull-2 { + right: 16.666666666666664% + } + + .col-md-pull-3 { + right: 25% + } + + .col-md-pull-4 { + right: 33.33333333333333% + } + + .col-md-pull-5 { + right: 41.66666666666667% + } + + .col-md-pull-6 { + right: 50% + } + + .col-md-pull-7 { + right: 58.333333333333336% + } + + .col-md-pull-8 { + right: 66.66666666666666% + } + + .col-md-pull-9 { + right: 75% + } + + .col-md-pull-10 { + right: 83.33333333333334% + } + + .col-md-pull-11 { + right: 91.66666666666666% + } + + .col-md-offset-0 { + margin-left: 0 + } + + .col-md-offset-1 { + margin-left: 8.333333333333332% + } + + .col-md-offset-2 { + margin-left: 16.666666666666664% + } + + .col-md-offset-3 { + margin-left: 25% + } + + .col-md-offset-4 { + margin-left: 33.33333333333333% + } + + .col-md-offset-5 { + margin-left: 41.66666666666667% + } + + .col-md-offset-6 { + margin-left: 50% + } + + .col-md-offset-7 { + margin-left: 58.333333333333336% + } + + .col-md-offset-8 { + margin-left: 66.66666666666666% + } + + .col-md-offset-9 { + margin-left: 75% + } + + .col-md-offset-10 { + margin-left: 83.33333333333334% + } + + .col-md-offset-11 { + margin-left: 91.66666666666666% + } +} + +@media (min-width: 1200px) { + .container { + max-width: 1170px + } + + .col-lg-1, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9, .col-lg-10, .col-lg-11 { + float: left + } + + .col-lg-1 { + width: 8.333333333333332% + } + + .col-lg-2 { + width: 16.666666666666664% + } + + .col-lg-3 { + width: 25% + } + + .col-lg-4 { + width: 33.33333333333333% + } + + .col-lg-5 { + width: 41.66666666666667% + } + + .col-lg-6 { + width: 50% + } + + .col-lg-7 { + width: 58.333333333333336% + } + + .col-lg-8 { + width: 66.66666666666666% + } + + .col-lg-9 { + width: 75% + } + + .col-lg-10 { + width: 83.33333333333334% + } + + .col-lg-11 { + width: 91.66666666666666% + } + + .col-lg-12 { + width: 100% + } + + .col-lg-push-0 { + left: auto + } + + .col-lg-push-1 { + left: 8.333333333333332% + } + + .col-lg-push-2 { + left: 16.666666666666664% + } + + .col-lg-push-3 { + left: 25% + } + + .col-lg-push-4 { + left: 33.33333333333333% + } + + .col-lg-push-5 { + left: 41.66666666666667% + } + + .col-lg-push-6 { + left: 50% + } + + .col-lg-push-7 { + left: 58.333333333333336% + } + + .col-lg-push-8 { + left: 66.66666666666666% + } + + .col-lg-push-9 { + left: 75% + } + + .col-lg-push-10 { + left: 83.33333333333334% + } + + .col-lg-push-11 { + left: 91.66666666666666% + } + + .col-lg-pull-0 { + right: auto + } + + .col-lg-pull-1 { + right: 8.333333333333332% + } + + .col-lg-pull-2 { + right: 16.666666666666664% + } + + .col-lg-pull-3 { + right: 25% + } + + .col-lg-pull-4 { + right: 33.33333333333333% + } + + .col-lg-pull-5 { + right: 41.66666666666667% + } + + .col-lg-pull-6 { + right: 50% + } + + .col-lg-pull-7 { + right: 58.333333333333336% + } + + .col-lg-pull-8 { + right: 66.66666666666666% + } + + .col-lg-pull-9 { + right: 75% + } + + .col-lg-pull-10 { + right: 83.33333333333334% + } + + .col-lg-pull-11 { + right: 91.66666666666666% + } + + .col-lg-offset-0 { + margin-left: 0 + } + + .col-lg-offset-1 { + margin-left: 8.333333333333332% + } + + .col-lg-offset-2 { + margin-left: 16.666666666666664% + } + + .col-lg-offset-3 { + margin-left: 25% + } + + .col-lg-offset-4 { + margin-left: 33.33333333333333% + } + + .col-lg-offset-5 { + margin-left: 41.66666666666667% + } + + .col-lg-offset-6 { + margin-left: 50% + } + + .col-lg-offset-7 { + margin-left: 58.333333333333336% + } + + .col-lg-offset-8 { + margin-left: 66.66666666666666% + } + + .col-lg-offset-9 { + margin-left: 75% + } + + .col-lg-offset-10 { + margin-left: 83.33333333333334% + } + + .col-lg-offset-11 { + margin-left: 91.66666666666666% + } +} + +.btn { + display: inline-block; + padding: 6px 12px; + margin-bottom: 0; + font-size: 14px; + font-weight: normal; + line-height: 1.428571429; + text-align: center; + vertical-align: middle; + cursor: pointer; + border: 1px solid transparent; + border-radius: 0; + white-space: nowrap; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + -o-user-select: none; + user-select: none +} + +.btn:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px +} + +.btn:hover, .btn:focus { + color: #333; + text-decoration: none +} + +.btn:active, .btn.active { + outline: 0; + background-image: none +} + +.btn.disabled, .btn[disabled], fieldset[disabled] .btn { + cursor: not-allowed; + pointer-events: none; + opacity: .65; + filter: alpha(opacity=65); + -webkit-box-shadow: none; + box-shadow: none +} + +.btn-default { + color: #333; + background-color: #fff; + border-color: #ccc +} + +.btn-default:hover, .btn-default:focus, .btn-default:active, .btn-default.active, .open .dropdown-toggle.btn-default { + color: #333; + background-color: #ebebeb; + border-color: #adadad +} + +.btn-default:active, .btn-default.active, .open .dropdown-toggle.btn-default { + background-image: none +} + +.btn-default.disabled, .btn-default[disabled], fieldset[disabled] .btn-default, .btn-default.disabled:hover, .btn-default[disabled]:hover, fieldset[disabled] .btn-default:hover, .btn-default.disabled:focus, .btn-default[disabled]:focus, fieldset[disabled] .btn-default:focus, .btn-default.disabled:active, .btn-default[disabled]:active, fieldset[disabled] .btn-default:active, .btn-default.disabled.active, .btn-default[disabled].active, fieldset[disabled] .btn-default.active { + background-color: #fff; + border-color: #ccc +} + +.btn-primary { + color: #fff; + background-color: #428bca; + border-color: #357ebd +} + +.btn-primary:hover, .btn-primary:focus, .btn-primary:active, .btn-primary.active, .open .dropdown-toggle.btn-primary { + color: #fff; + background-color: #3276b1; + border-color: #285e8e +} + +.btn-primary:active, .btn-primary.active, .open .dropdown-toggle.btn-primary { + background-image: none +} + +.btn-primary.disabled, .btn-primary[disabled], fieldset[disabled] .btn-primary, .btn-primary.disabled:hover, .btn-primary[disabled]:hover, fieldset[disabled] .btn-primary:hover, .btn-primary.disabled:focus, .btn-primary[disabled]:focus, fieldset[disabled] .btn-primary:focus, .btn-primary.disabled:active, .btn-primary[disabled]:active, fieldset[disabled] .btn-primary:active, .btn-primary.disabled.active, .btn-primary[disabled].active, fieldset[disabled] .btn-primary.active { + background-color: #428bca; + border-color: #357ebd +} + +.btn-warning { + color: #fff; + background-color: #f0ad4e; + border-color: #eea236 +} + +.btn-warning:hover, .btn-warning:focus, .btn-warning:active, .btn-warning.active, .open .dropdown-toggle.btn-warning { + color: #fff; + background-color: #ed9c28; + border-color: #d58512 +} + +.btn-warning:active, .btn-warning.active, .open .dropdown-toggle.btn-warning { + background-image: none +} + +.btn-warning.disabled, .btn-warning[disabled], fieldset[disabled] .btn-warning, .btn-warning.disabled:hover, .btn-warning[disabled]:hover, fieldset[disabled] .btn-warning:hover, .btn-warning.disabled:focus, .btn-warning[disabled]:focus, fieldset[disabled] .btn-warning:focus, .btn-warning.disabled:active, .btn-warning[disabled]:active, fieldset[disabled] .btn-warning:active, .btn-warning.disabled.active, .btn-warning[disabled].active, fieldset[disabled] .btn-warning.active { + background-color: #f0ad4e; + border-color: #eea236 +} + +.btn-danger { + color: #fff; + background-color: #d9534f; + border-color: #d43f3a +} + +.btn-danger:hover, .btn-danger:focus, .btn-danger:active, .btn-danger.active, .open .dropdown-toggle.btn-danger { + color: #fff; + background-color: #d2322d; + border-color: #ac2925 +} + +.btn-danger:active, .btn-danger.active, .open .dropdown-toggle.btn-danger { + background-image: none +} + +.btn-danger.disabled, .btn-danger[disabled], fieldset[disabled] .btn-danger, .btn-danger.disabled:hover, .btn-danger[disabled]:hover, fieldset[disabled] .btn-danger:hover, .btn-danger.disabled:focus, .btn-danger[disabled]:focus, fieldset[disabled] .btn-danger:focus, .btn-danger.disabled:active, .btn-danger[disabled]:active, fieldset[disabled] .btn-danger:active, .btn-danger.disabled.active, .btn-danger[disabled].active, fieldset[disabled] .btn-danger.active { + background-color: #d9534f; + border-color: #d43f3a +} + +.btn-success { + color: #fff; + background-color: #5cb85c; + border-color: #4cae4c +} + +.btn-success:hover, .btn-success:focus, .btn-success:active, .btn-success.active, .open .dropdown-toggle.btn-success { + color: #fff; + background-color: #47a447; + border-color: #398439 +} + +.btn-success:active, .btn-success.active, .open .dropdown-toggle.btn-success { + background-image: none +} + +.btn-success.disabled, .btn-success[disabled], fieldset[disabled] .btn-success, .btn-success.disabled:hover, .btn-success[disabled]:hover, fieldset[disabled] .btn-success:hover, .btn-success.disabled:focus, .btn-success[disabled]:focus, fieldset[disabled] .btn-success:focus, .btn-success.disabled:active, .btn-success[disabled]:active, fieldset[disabled] .btn-success:active, .btn-success.disabled.active, .btn-success[disabled].active, fieldset[disabled] .btn-success.active { + background-color: #5cb85c; + border-color: #4cae4c +} + +.btn-info { + color: #fff; + background-color: #5bc0de; + border-color: #46b8da +} + +.btn-info:hover, .btn-info:focus, .btn-info:active, .btn-info.active, .open .dropdown-toggle.btn-info { + color: #fff; + background-color: #39b3d7; + border-color: #269abc +} + +.btn-info:active, .btn-info.active, .open .dropdown-toggle.btn-info { + background-image: none +} + +.btn-info.disabled, .btn-info[disabled], fieldset[disabled] .btn-info, .btn-info.disabled:hover, .btn-info[disabled]:hover, fieldset[disabled] .btn-info:hover, .btn-info.disabled:focus, .btn-info[disabled]:focus, fieldset[disabled] .btn-info:focus, .btn-info.disabled:active, .btn-info[disabled]:active, fieldset[disabled] .btn-info:active, .btn-info.disabled.active, .btn-info[disabled].active, fieldset[disabled] .btn-info.active { + background-color: #5bc0de; + border-color: #46b8da +} + +.btn-link { + color: #428bca; + font-weight: normal; + cursor: pointer; + border-radius: 0 +} + +.btn-link, .btn-link:active, .btn-link[disabled], fieldset[disabled] .btn-link { + background-color: transparent; + -webkit-box-shadow: none; + box-shadow: none +} + +.btn-link, .btn-link:hover, .btn-link:focus, .btn-link:active { + border-color: transparent +} + +.btn-link:hover, .btn-link:focus { + color: #2a6496; + text-decoration: underline; + background-color: transparent +} + +.btn-link[disabled]:hover, fieldset[disabled] .btn-link:hover, .btn-link[disabled]:focus, fieldset[disabled] .btn-link:focus { + color: #999; + text-decoration: none +} + +.btn-lg { + padding: 10px 16px; + font-size: 18px; + line-height: 1.33; + border-radius: 6px +} + +.btn-sm, .btn-xs { + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px +} + +.btn-xs { + padding: 1px 5px +} + +.btn-block { + display: block; + width: 100%; + padding-left: 0; + padding-right: 0 +} + +.btn-block + .btn-block { + margin-top: 5px +} + +input[type="submit"].btn-block, input[type="reset"].btn-block, input[type="button"].btn-block { + width: 100% +} + +.btn-default .caret { + border-top-color: #333 +} + +.btn-primary .caret, .btn-success .caret, .btn-warning .caret, .btn-danger .caret, .btn-info .caret { + border-top-color: #fff +} + +.dropup .btn-default .caret { + border-bottom-color: #333 +} + +.dropup .btn-primary .caret, .dropup .btn-success .caret, .dropup .btn-warning .caret, .dropup .btn-danger .caret, .dropup .btn-info .caret { + border-bottom-color: #fff +} + +.btn-group, .btn-group-vertical { + position: relative; + display: inline-block; + vertical-align: middle +} + +.btn-group > .btn, .btn-group-vertical > .btn { + position: relative; + float: left +} + +.btn-group > .btn:hover, .btn-group-vertical > .btn:hover, .btn-group > .btn:focus, .btn-group-vertical > .btn:focus, .btn-group > .btn:active, .btn-group-vertical > .btn:active, .btn-group > .btn.active, .btn-group-vertical > .btn.active { + z-index: 2 +} + +.btn-group > .btn:focus, .btn-group-vertical > .btn:focus { + outline: 0 +} + +.btn-group .btn + .btn, .btn-group .btn + .btn-group, .btn-group .btn-group + .btn, .btn-group .btn-group + .btn-group { + margin-left: -1px +} + +.btn-toolbar:before, .btn-toolbar:after { + content: " "; + display: table +} + +.btn-toolbar:after { + clear: both +} + +.btn-toolbar .btn-group { + float: left +} + +.btn-toolbar > .btn + .btn, .btn-toolbar > .btn-group + .btn, .btn-toolbar > .btn + .btn-group, .btn-toolbar > .btn-group + .btn-group { + margin-left: 5px +} + +.btn-group > .btn:not(:first-child):not(:last-child):not(.dropdown-toggle) { + border-radius: 0 +} + +.btn-group > .btn:first-child { + margin-left: 0 +} + +.btn-group > .btn:first-child:not(:last-child):not(.dropdown-toggle) { + border-bottom-right-radius: 0; + border-top-right-radius: 0 +} + +.btn-group > .btn:last-child:not(:first-child), .btn-group > .dropdown-toggle:not(:first-child) { + border-bottom-left-radius: 0; + border-top-left-radius: 0 +} + +.btn-group > .btn-group { + float: left +} + +.btn-group > .btn-group:not(:first-child):not(:last-child) > .btn { + border-radius: 0 +} + +.btn-group > .btn-group:first-child > .btn:last-child, .btn-group > .btn-group:first-child > .dropdown-toggle { + border-bottom-right-radius: 0; + border-top-right-radius: 0 +} + +.btn-group > .btn-group:last-child > .btn:first-child { + border-bottom-left-radius: 0; + border-top-left-radius: 0 +} + +.btn-group .dropdown-toggle:active, .btn-group.open .dropdown-toggle { + outline: 0 +} + +.btn-group-xs > .btn { + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px; + padding: 1px 5px +} + +.btn-group-sm > .btn { + padding: 5px 10px; + font-size: 12px; + line-height: 1.5; + border-radius: 3px +} + +.btn-group-lg > .btn { + padding: 10px 16px; + font-size: 18px; + line-height: 1.33; + border-radius: 6px +} + +.btn-group > .btn + .dropdown-toggle { + padding-left: 8px; + padding-right: 8px +} + +.btn-group > .btn-lg + .dropdown-toggle { + padding-left: 12px; + padding-right: 12px +} + +.btn-group.open .dropdown-toggle { + background: #f2f2f2 +} + +.btn .caret { + margin-left: 0 +} + +.btn-lg .caret { + border-width: 5px 5px 0; + border-bottom-width: 0 +} + +.dropup .btn-lg .caret { + border-width: 0 5px 5px +} + +.btn-group-vertical > .btn, .btn-group-vertical > .btn-group { + display: block; + float: none; + width: 100%; + max-width: 100% +} + +.btn-group-vertical > .btn-group:before, .btn-group-vertical > .btn-group:after { + content: " "; + display: table +} + +.btn-group-vertical > .btn-group:after { + clear: both +} + +.btn-group-vertical > .btn-group > .btn { + float: none +} + +.btn-group-vertical > .btn + .btn, .btn-group-vertical > .btn + .btn-group, .btn-group-vertical > .btn-group + .btn, .btn-group-vertical > .btn-group + .btn-group { + margin-top: -1px; + margin-left: 0 +} + +.btn-group-vertical > .btn:not(:first-child):not(:last-child) { + border-radius: 0 +} + +.btn-group-vertical > .btn:first-child:not(:last-child) { + border-top-right-radius: 0; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0 +} + +.btn-group-vertical > .btn:last-child:not(:first-child) { + border-bottom-left-radius: 0; + border-top-right-radius: 0; + border-top-left-radius: 0 +} + +.btn-group-vertical > .btn-group:not(:first-child):not(:last-child) > .btn { + border-radius: 0 +} + +.btn-group-vertical > .btn-group:first-child > .btn:last-child, .btn-group-vertical > .btn-group:first-child > .dropdown-toggle { + border-bottom-right-radius: 0; + border-bottom-left-radius: 0 +} + +.btn-group-vertical > .btn-group:last-child > .btn:first-child { + border-top-right-radius: 0; + border-top-left-radius: 0 +} + +.btn-group-justified { + display: table; + width: 100%; + table-layout: fixed; + border-collapse: separate +} + +.btn-group-justified .btn { + float: none; + display: table-cell; + width: 1% +} + +[data-toggle="buttons"] > .btn > input[type="radio"], [data-toggle="buttons"] > .btn > input[type="checkbox"] { + display: none +} + +.caret { + display: inline-block; + width: 0; + height: 0; + margin-left: 2px; + vertical-align: middle; + border-top: 4px solid #000; + border-right: 4px solid transparent; + border-left: 4px solid transparent; + border-bottom: 0 dotted; + content: "" +} + +.dropdown { + position: relative +} + +.dropdown-toggle:focus { + outline: 0 +} + +.dropdown-menu { + position: absolute; + top: 100%; + left: 0; + z-index: 1000; + display: none; + float: left; + min-width: 160px; + padding: 5px 0; + margin: 2px 0 0; + list-style: none; + font-size: 14px; + background-color: #fff; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.15); + border-radius: 0; + background-clip: padding-box +} + +.dropdown-menu.pull-right { + right: 0; + left: auto +} + +.dropdown-menu .divider { + height: 1px; + margin: 9px 0; + overflow: hidden; + background-color: #e5e5e5 +} + +.dropdown-menu > li > a { + font-size: 14px; + text-decoration: none; + display: block; + padding: 5px 20px; + clear: both; + font-weight: normal; + line-height: 1.428571429; + color: #333; + white-space: nowrap +} + +.dropdown-menu > li > a:hover, .dropdown-menu > li > a:focus { + text-decoration: none; + color: #fff; + background-color: #428bca +} + +.dropdown-menu > .active > a, .dropdown-menu > .active > a:hover, .dropdown-menu > .active > a:focus { + color: #fff; + text-decoration: none; + outline: 0; + background-color: #428bca +} + +.dropdown-menu > .disabled > a, .dropdown-menu > .disabled > a:hover, .dropdown-menu > .disabled > a:focus { + color: #999 +} + +.dropdown-menu > .disabled > a:hover, .dropdown-menu > .disabled > a:focus { + text-decoration: none; + background-color: transparent; + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); + cursor: not-allowed +} + +.open > .dropdown-menu { + display: block +} + +.open > a { + outline: 0 +} + +.dropdown-header { + display: block; + padding: 3px 20px; + font-size: 12px; + line-height: 1.428571429; + color: #999 +} + +.dropdown-backdrop { + position: fixed; + left: 0; + right: 0; + bottom: 0; + top: 0; + z-index: 990 +} + +.pull-right > .dropdown-menu { + right: 0; + left: auto +} + +.dropup .caret, .navbar-fixed-bottom .dropdown .caret { + border-top: 0 dotted; + border-bottom: 4px solid #000; + content: "" +} + +.dropup .dropdown-menu, .navbar-fixed-bottom .dropdown .dropdown-menu { + top: auto; + bottom: 100%; + margin-bottom: 1px +} + +@media (min-width: 768px) { + .navbar-right .dropdown-menu { + right: 0; + left: auto + } +} + +body, html { + font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; + margin: 0; + background: #ededed; + color: #343437; + line-height: 2em; + font-weight: 300; + font-size: .95em +} + +h1 { + font-size: 2.5em; + margin: .8em 0 +} + +body.center { + padding: 0 30px; + background: #FFF; + font-size: 1em +} + +ul li { + list-style-type: disc +} + +a { + color: #4290ad; + text-decoration: none; + font-weight: normal +} + +a:hover { + text-decoration: underline +} + +h1, h2, h3 { + font-weight: 300; + line-height: 1.2em +} + +.topNav, .bottomNav { + background: #f2f2f2; + margin: 0 -30px; + margin-bottom: 20px +} + +.topNav:before, .bottomNav:before, .topNav:after, .bottomNav:after { + content: " "; + display: table +} + +.topNav:after, .bottomNav:after { + clear: both +} + +.topNav ul.navList, .bottomNav ul.navList { + padding: 10px 20px; + margin: 0; + list-style-type: none +} + +.topNav ul.navList li, .bottomNav ul.navList li { + display: inline; + padding: 0 10px +} + +.topNav ul.navList li.navBarCell1Rev, .bottomNav ul.navList li.navBarCell1Rev { + font-weight: bold +} + +.bottomNav { + margin-top: 30px; + margin-bottom: 0 +} + +.aboutLanguage { + color: #BBB; + background: white; + text-align: center; + padding: 20px 0 +} + +.subNav { + padding-bottom: 10px; + margin-bottom: 10px; + border-bottom: 1px solid #EEE +} + +.subNav:before, .subNav:after { + content: " "; + display: table +} + +.subNav:after { + clear: both +} + +.subNav div:before, .subNav div:after { + content: " "; + display: table +} + +.subNav div:after { + clear: both +} + +.subNav ul.navList, .subNav ul { + font-size: .9em; + margin: 0; + padding: 00; + float: left; + list-style-type: none +} + +.subNav ul.navList li, .subNav ul li { + padding: 0 5px; + display: inline +} + +table.overviewSummary, .contentContainer ul li table { + width: 100%; + margin: 20px 0 +} + +table.overviewSummary caption, .contentContainer ul li table caption { + text-align: left; + font-weight: 100; + font-size: 1em; + float: left; + padding: 0 10px; + margin-top: 10px; + background: #db4800; + color: white +} + +table.overviewSummary tr th, .contentContainer ul li table tr th { + padding: 10px; + font-weight: bold; + font-size: 1em; + text-align: left +} + +table.overviewSummary tr td, .contentContainer ul li table tr td { + vertical-align: top; + font-size: .9em; + padding: 5px 10px; + border-top: 1px solid #EEE +} + +table.overviewSummary tbody > tr:nth-child(odd) > td, .contentContainer ul li table tbody > tr:nth-child(odd) > td { + background-color: #f9f9f9 +} + +body.left { + padding-top: 10px +} + +body.left h1, body.left h2 { + display: inline; + text-align: left; + font-weight: 100; + font-size: 1em; + margin: 0 10px; + padding: 3px 10px; + margin-top: 10px; + background: #db4800; + color: white; + line-height: 40px +} + +body.left .indexHeader { + margin: 0; + padding: 0 15px; + font-size: .9em +} + +body.left ul { + list-style-type: none; + margin: 0; + padding: 0 +} + +body.left ul li { + margin: 0; + padding: 0 +} + +body.left ul li a { + display: block; + padding: 0 15px; + text-decoration: none +} + +body.left ul li a:hover { + text-decoration: underline +} + +.contentContainer .header ul, .contentContainer ul.blockList { + padding: 0 +} + +.contentContainer .header ul > li, .contentContainer ul.blockList > li { + list-style-type: none +} + +.contentContainer ul.inheritance { + margin-left: 0; + padding-left: 0 +} + +.contentContainer ul.inheritance li { + list-style-type: none +} + +.contentContainer ul.inheritance ul.inheritance { + padding-left: 20px +} + +.contentContainer hr { + border: 0 none; + border-top: 1px solid #EEE; + margin-top: 30px; + margin-botom: 0 +} + +ul.blockList ul.blockList, ul.blockList ul.blockListLast { + border: 1px solid #EEE; + margin: 20px 0; + padding: 0 20px +} + +ul.blockList ul.blockList h4, ul.blockList ul.blockListLast h4, ul.blockList ul.blockList h3, ul.blockList ul.blockListLast h3 { + font-size: 1em; + font-weight: bold; + line-height: 2em; + text-indent: 10px; + border-bottom: 1px solid #EEE; + margin: 0 -20px; + padding: 5px 0; + background: #f2f2f2 +} + +ul.blockList ul.blockList li, ul.blockList ul.blockListLast li { + list-style-type: none +} + +ul.horizontal { + list-style-type: none; + padding: 0; + margin: 0; + font-size: .9em +} + +ul.horizontal li { + display: inline +} + +span.strong { + font-weight: bold +} + +a span.strong { + font-weight: normal +} \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 000000000..9ea843ba5 --- /dev/null +++ b/index.md @@ -0,0 +1,105 @@ +--- +layout: default +title: Home +nav_order: 1 +--- + +Thymeleaf Layout Dialect +======================== +{: .no_toc } + +A dialect for Thymeleaf that lets you build layouts and reusable templates in +order to improve code reuse. +{: .fs-6 .fw-300 } + + +On this page +------------ +{: .no_toc .text-delta } + +1. TOC +{:toc} + + +What does it do? +---------------- + +The Thymeleaf Layout Dialect adds the ability to decorate templates - +automatically for the `` section of an HTML template, and explicitly +through extension points that developers can add to their templates. This all +adds up to create layouts that can be extended in a manner similar to classical +inheritence. + +For example, given a common `layout.html` file, set some shared static assets in +the `` and define extension points in the body with the `layout:fragment` +processor: + +```html + + + + Layout page + + + +
                                                                                                                                          +

                                                                                                                                          My website

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Page content goes here

                                                                                                                                          +
                                                                                                                                          + + +``` + +Create a content template that will define its own title, static resources, and +replacements for those extension points. Link the page to the layout by using +the `layout:decorate` processor at the root element of the page which will +instruct Thymeleaf to decorate the layout with this template: + +```html + + + + Content page + + + +
                                                                                                                                          +

                                                                                                                                          This is a paragraph from the content page

                                                                                                                                          +
                                                                                                                                          + + +``` + +When Thymeleaf processes your content template, the resulting HTML will be: + +```html + + + + Content page + + + + +
                                                                                                                                          +

                                                                                                                                          My website

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          This is a paragraph from the content page

                                                                                                                                          +
                                                                                                                                          + + +``` + + +Learn more +---------- + +Check out the [getting started]({{ site.baseurl }}{% link getting-started.md %}) +guide to learn how to add the layout dialect to your Thymeleaf project, or the +[processors]({{ site.baseurl}}{% link processors/index.md %}) pages for in-depth +examples of each of the layout dialect features and how they can help you build +your templates. diff --git a/migrating-to-2.0.md b/migrating-to-2.0.md new file mode 100644 index 000000000..19b84ddfa --- /dev/null +++ b/migrating-to-2.0.md @@ -0,0 +1,76 @@ +--- +layout: default +title: Migrating to 2.0 +nav_order: 5 +redirect_from: + - /MigrationGuide.html +--- + +Migrating to 2.0 +================ +{: .no_toc } + +The biggest change between 1.x and 2.x of the layout dialect is that 2.x is a +rewrite of the layout dialect to support Thymeleaf 3. Thymeleaf 3 is largely +backwards compatible with Thymeleaf 2 templates, and so the layout dialect has +gone out of its way to be backwards compatible too. + +As such, everything in this guide is *completely optional*. However, if you +want to future-proof your code and keep your logs clean of deprecation warnings, +then follow the steps in this guide. + + +On this page +------------ +{: .no_toc .text-delta } + +1. TOC +{:toc} + + +`decorator` processor renamed to `decorate` +------------------------------------------- + +[thymeleaf-layout-dialect/issues/95](https://github.com/ultraq/thymeleaf-layout-dialect/issues/95) + +While the layout dialect does perform decoration as per the [decorator pattern](https://en.wikipedia.org/wiki/Decorator_pattern), +throughout 1.x it incorrectly identified the layout/parent template as the +decorator, when instead, according to the design pattern, the extension (content +template in this case) is the decorator. + +This change is simply a rename of the `layout:decorator` processor to `layout:decorate` +so that the template being specified is the one being decorated, not the +decorator, plus an overhaul of the documentation to fix this inconsistency. + + +`$DECORATOR_TITLE` renamed to `$LAYOUT_TITLE` +--------------------------------------------- + +A consequence of the above is that the special tokens in the `title-pattern` +processor were also incorrectly named, and so a new token has been introduced to +fix this. + + +Deprecated `include`, introduced `insert` +----------------------------------------- + +[thymeleaf-layout-dialect/issues/107](https://github.com/ultraq/thymeleaf-layout-dialect/issues/107) + +Thymeleaf 3 deprecated the `th:include` processor and introduced the `th:insert` +processor as its replacement. Because the layout dialect patterned the naming +of its template inclusion processors after Thymeleaf, it did the same - +deprecating `layout:include` and introducing `layout:insert`. + + +Thymeleaf 3 fragment processors +------------------------------- + +[thymeleaf/issues/451](https://github.com/thymeleaf/thymeleaf/issues/451) + +In 1.x of the layout dialect, it used the same template/fragment specifiers as +Thymeleaf 2, which was basically string paths with a special `::` separator. In +Thymeleaf 3, these specifiers have been formalized into "fragment expressions", +and have a new syntax which surrounds the old one with `~{...}`. + +The layout dialect now favours the use of these fragment expressions for all +processors that pick a template or fragment. diff --git a/migrating-to-3.0.md b/migrating-to-3.0.md new file mode 100644 index 000000000..8afe74709 --- /dev/null +++ b/migrating-to-3.0.md @@ -0,0 +1,95 @@ +--- +layout: default +title: Migrating to 3.0 +nav_order: 6 +--- + +Migrating to 3.0 +================ +{: .no_toc } + +Version 3.0 of the layout dialect is largely an upgrade to use Groovy 3.0 which +removes the 'reflective access warning' in Java (which is set to become an error +in Java 17) and the deletion of code that has been deprecated in version 2.x. +It's also a step towards becoming a full Java module, applying an automatic +module name and doing some reorganizing of packages in the interim. + +All the changes are listed below to help you make an assessment of what an +upgrade would entail. + + +On this page +------------ +{: .no_toc .text-delta } + +1. TOC +{:toc} + + +Deprecated `decorator` processor has been deleted +------------------------------------------------- + +This was deprecated back in 2.0 ([thymeleaf-layout-dialect/issues/95](https://github.com/ultraq/thymeleaf-layout-dialect/issues/95)) +in favour of `decorate` as the naming was misleading, and has now been deleted. + + +Deprecated `$DECORATOR_TITLE` constant has been deleted +------------------------------------------------------- + +Similar to the change above, another poorly-named constant that was deprecated +is now deleted. + + +`` merging strategies now respect the `` position by default +------------------------------------------------------------------------- + +The default behaviour of the layout dialect has historically been to place the +`<title>` element at the beginning of the `<head>` element during the decoration +process; an arbitrary design decision which made development of this library +easier. However, this runs against the expectations of developers who wished to +control the order of elements, most notably the practice of putting +`<meta charset...>` as the first element in the `<head>`. + +In 2.4.0, new `<head>` merging strategies were introduced ([thymeleaf-layout-dialect/issues/177](https://github.com/ultraq/thymeleaf-layout-dialect/issues/177), +`AppendingRespectLayoutTitleStrategy` and `GroupingRespectLayoutTitleStrategy`) +to keep `<title>`s wherever they exist within the target/layout template being +decorated, and then work on everything else as normal. + +These strategies have been renamed to replace the old strategies (`AppendingRespectLayoutTitleStrategy +-> AppendingStrategy` and `GroupingRespectLayoutTitleStrategy -> GroupingStrategy`) +and the old strategies have been removed. + + +Deprecated `layout:collect` with no replacement +----------------------------------------------- + +This was a feature added in 2.3.0 ([#166](https://github.com/ultraq/thymeleaf-layout-dialect/pull/166)). +However, it has complicated the maintenance of the layout dialect, and, after +some time with it, feels like a very special purpose tool that this library +doesn't need to cover. As such, I am deprecating this feature. + + +Automatic module name and package restructure +--------------------------------------------- + +As part of the work to convert the layout dialect into a full Java module ([#171](https://github.com/ultraq/thymeleaf-layout-dialect/issues/171)), +I've taken the steps of setting an `Automatic-Module-Name` in the manifest file, +and reorganizing packages to meet the standards set out by Java modules. + +This module now has the name of `nz.net.ultraq.thymeleaf.layoutdialect`, and the +base package (previously `nz.net.ultraq.thymeleaf`) has been changed to match. + +As a consequence of this move, if you're using Spring Boot versions older than +2.6.0 to automatically configure the layout dialect, you will now need to +configure it yourself. To do that, add the following to any of your Spring Boot +configuration classes: + +```java +@Bean +public LayoutDialect layoutDialect() { + return new LayoutDialect(); +} +``` + +Spring Boot 2.6.0 includes support for Thymeleaf Layout Dialect 3, and so this +extra configuration is not necessary from that version on. diff --git a/processors/decorate.md b/processors/decorate.md new file mode 100644 index 000000000..8cf3daee9 --- /dev/null +++ b/processors/decorate.md @@ -0,0 +1,393 @@ +--- +layout: default +title: decorate +parent: Processors +nav_order: 1 +redirect_from: + - /Configuration.html +--- + +decorate +======== +{: .no_toc } + + - XML attribute: `layout:decorate` + - Data attribute: `data-layout-decorate` + +Used in your content templates and declared in the root tag (usually `<html>`), +this processor takes a [fragment expression](https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#fragments) +that specifies the layout template to decorate with the content template. + +```html +<html layout:decorate="~{layout}>" +``` + + +On this page +------------ +{: .no_toc .text-delta } + +1. TOC +{:toc} + + +Example +------- + +Create a template that will contain a layout that will be shared across pages. +Often this will be a template that contains a page header, navigation, a footer, +and a spot where your page-specific content will go. + +```html +layout.html + +<!DOCTYPE html> +<html xmlns:layout="http://www.ultraq.net.nz/thymeleaf/layout"> +<head> + <title>Layout page + + + +
                                                                                                                                          +

                                                                                                                                          My website

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Page content goes here

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          My footer

                                                                                                                                          +

                                                                                                                                          Custom footer here

                                                                                                                                          +
                                                                                                                                          + + +``` + +Notice how the `layout:fragment` attribute was applied to the `
                                                                                                                                          ` and +`

                                                                                                                                          ` element in the footer. These are the points in the layout that are +candidates for replacement by matching fragments in your content templates. + +Now, create some content templates. + +```html +content1.html + + + + + Content page 1 + + + +

                                                                                                                                          +

                                                                                                                                          This is a paragraph from content page 1

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          This is some footer content from content page 1

                                                                                                                                          +
                                                                                                                                          + + +``` + +The `layout:decorate` in the `` tag says which layout template to decorate +using this content template. The content template defines its own title and +script, as well as both the `content` and `custom-footer` fragments. The `custom-footer` +fragment is within a `