nz.net.ultraq.thymeleaf.LayoutDialect Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-layout-dialect Show documentation
Thymeleaf Layout Dialect rewritten in java.
There is a newer version: 3.2.0
Show newest version
/*
 * Copyright 2012, Emanuel Rabina (http://www.ultraq.net.nz/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nz.net.ultraq.thymeleaf;

import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Set;
import nz.net.ultraq.thymeleaf.decorators.DecorateProcessor;
import nz.net.ultraq.thymeleaf.decorators.SortingStrategy;
import nz.net.ultraq.thymeleaf.decorators.TitlePatternProcessor;
import nz.net.ultraq.thymeleaf.fragments.CollectFragmentProcessor;
import nz.net.ultraq.thymeleaf.fragments.FragmentProcessor;
import nz.net.ultraq.thymeleaf.includes.InsertProcessor;
import nz.net.ultraq.thymeleaf.includes.ReplaceProcessor;
import org.thymeleaf.dialect.AbstractProcessorDialect;
import org.thymeleaf.processor.IProcessor;
import org.thymeleaf.standard.processor.StandardXmlNsTagProcessor;
import org.thymeleaf.templatemode.TemplateMode;

/**
 * A dialect for Thymeleaf that lets you build layouts and reusable templates in
 * order to improve code reuse
 *
 * @author zhanhb
 * @author Emanuel Rabina
 */
public class LayoutDialect extends AbstractProcessorDialect {

    public static final String DIALECT_NAME = "Layout";
    public static final String DIALECT_PREFIX = "layout";
    public static final int DIALECT_PRECEDENCE = 10;

    private final boolean autoHeadMerging;
    private final SortingStrategy sortingStrategy;

    /**
     * Constructor, configure the layout dialect.
     *
     * @param sortingStrategy
     * @param autoHeadMerging Experimental option, set to {@code false} to skip
     * the automatic merging of an HTML {@code } section.
     */
    public LayoutDialect(SortingStrategy sortingStrategy, boolean autoHeadMerging) {
        super(DIALECT_NAME, DIALECT_PREFIX, DIALECT_PRECEDENCE);
        this.sortingStrategy = sortingStrategy;
        this.autoHeadMerging = autoHeadMerging;
    }

    /**
     * Constructor, configure the layout dialect.
     *
     * @param sortingStrategy
     */
    public LayoutDialect(SortingStrategy sortingStrategy) {
        this(sortingStrategy, true);
    }

    /**
     * Constructor, configure the layout dialect.
     */
    @SuppressWarnings("deprecation")
    public LayoutDialect() {
        this(new nz.net.ultraq.thymeleaf.decorators.strategies.AppendingStrategy());
    }

    /**
     * Returns the layout dialect's processors.
     *
     * @param dialectPrefix
     * @return All of the processors for HTML and XML template modes.
     */
    @Override
    @SuppressWarnings("deprecation")
    public Set getProcessors(String dialectPrefix) {
        return new LinkedHashSet<>(Arrays.asList(
                // Processors available in the HTML template mode
                new StandardXmlNsTagProcessor(TemplateMode.HTML, dialectPrefix),
                new DecorateProcessor(TemplateMode.HTML, dialectPrefix, sortingStrategy, autoHeadMerging),
                new nz.net.ultraq.thymeleaf.decorators.DecoratorProcessor(TemplateMode.HTML, dialectPrefix, sortingStrategy, autoHeadMerging),
                new nz.net.ultraq.thymeleaf.includes.IncludeProcessor(TemplateMode.HTML, dialectPrefix),
                new InsertProcessor(TemplateMode.HTML, dialectPrefix),
                new ReplaceProcessor(TemplateMode.HTML, dialectPrefix),
                new FragmentProcessor(TemplateMode.HTML, dialectPrefix),
                new CollectFragmentProcessor(TemplateMode.HTML, dialectPrefix),
                new TitlePatternProcessor(TemplateMode.HTML, dialectPrefix),
                // Processors available in the XML template mode
                new StandardXmlNsTagProcessor(TemplateMode.XML, dialectPrefix),
                new DecorateProcessor(TemplateMode.XML, dialectPrefix, sortingStrategy, autoHeadMerging),
                new nz.net.ultraq.thymeleaf.decorators.DecoratorProcessor(TemplateMode.XML, dialectPrefix, sortingStrategy, autoHeadMerging),
                new nz.net.ultraq.thymeleaf.includes.IncludeProcessor(TemplateMode.XML, dialectPrefix),
                new InsertProcessor(TemplateMode.XML, dialectPrefix),
                new ReplaceProcessor(TemplateMode.XML, dialectPrefix),
                new FragmentProcessor(TemplateMode.XML, dialectPrefix),
                new CollectFragmentProcessor(TemplateMode.XML, dialectPrefix)
        ));
    }

}