com.github.heneke.thymeleaf.togglz.processor.FeatureActiveAttrProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-extras-togglz Show documentation

Thymeleaf dialect integrating Togglz feature toggles.

The newest version!

/*
 * =============================================================================
 *
 *   Copyright (c) 2014, Hendrik Heneke
 *
 *   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 com.github.heneke.thymeleaf.togglz.processor;

import org.thymeleaf.context.ITemplateContext;
import org.thymeleaf.engine.AttributeName;
import org.thymeleaf.model.IProcessableElementTag;

import com.github.heneke.thymeleaf.togglz.TogglzDialect;
import org.thymeleaf.standard.processor.StandardIfTagProcessor;
import org.thymeleaf.templatemode.TemplateMode;

/**
 * Processor for the active attribute in {@link TogglzDialect}. It shows or hides the given DOM container
 * based on feature state: 

 * 

 * 
 *  * <span togglz:active="FEATURE">
 *    Only visible when FEATURE is active.
 * </span>
 * 
 * 
 * Features may also be specified dynamically by using expressions:

 * 

 * 
 *  * <span togglz:active="${feature}">
 *    Only visible when feature resolved by evaluating ${feature} is active.
 * </span>
 * 
 * 
 * When using Thymeleaf 2.0.x, literal feature names have to be quoted with single quotes. Thymeleaf from 2.1 onward
 * supports unquoted string literals.
 * 
 * @author Hendrik Heneke
 * @since 1.0.0
 */
public class FeatureActiveAttrProcessor extends AbstractFeatureAttrProcessor {

	public static final String ATTR_NAME = "active";
	public static final int ATTR_PRECEDENCE = StandardIfTagProcessor.PRECEDENCE;

	public FeatureActiveAttrProcessor(final TemplateMode templateMode, final String dialectPrefix) {
		super(templateMode, dialectPrefix, ATTR_NAME, ATTR_PRECEDENCE);
	}

	@Override
	protected boolean isVisible(final ITemplateContext context, final IProcessableElementTag tag, final AttributeName attributeName, final String attributeValue) {
		return determineFeatureState(context, tag, attributeName, attributeValue, false);
	}

}