com.googlecode.wicketelements.library.behavior.AttributeModifierFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket-elements-library Show documentation
A class library which makes using Wicket easier.
The newest version!
/*
 *  Copyright 2011 Yannick LOTH.
 * 
 *  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.
 *  under the License.
 */
package com.googlecode.wicketelements.library.behavior;

import org.apache.wicket.AttributeModifier;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;

import static com.googlecode.jbp.common.requirements.Reqs.PARAM_REQ;

/**
 * Factory to create an attribute modifier for various attributes.
 * 
 * @author Yannick LOTH
 */
public final class AttributeModifierFactory {

	private static final String CLASS_ATTRIBUTE = "class";
	private static final String ALT_ATTRIBUTE = "alt";
	private static final String SRC_ATTRIBUTE = "src";
	private static final String TITLE_ATTRIBUTE = "title";

	/**
	 * Instantiates a new attribute modifier for the attribute alt.
	 * 
	 * @param altText
	 *            The name of the alt text to add to the tag. Must
	 *            not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeAppenderForAlt(
			final String altText) {
		PARAM_REQ.String.requireNotBlank(altText,
				"The alt attribute parameter must not be null.");
		return new AttributeModifier(ALT_ATTRIBUTE, new Model(
				altText));
	}

	/**
	 * Instantiates a new attribute modifier for the attribute alt.
	 * 
	 * @param altTextModel
	 *            The model with the name of the alt text to add to
	 *            the tag. Must not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeAppenderForAlt(
			final IModel altTextModel) {
		PARAM_REQ.Object.requireNotNull(altTextModel,
				"The alt attribute model parameter must not be null.");
		return new AttributeModifier(ALT_ATTRIBUTE, altTextModel);
	}

	/**
	 * Instantiates a new attribute modifier for the attribute src.
	 * 
	 * @param srcText
	 *            The name of the src text to add to the tag. Must
	 *            not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeAppenderForSrc(
			final String srcText) {
		PARAM_REQ.String.requireNotBlank(srcText,
				"The src attribute parameter must not be null.");
		return new AttributeModifier(SRC_ATTRIBUTE, new Model(
				srcText));
	}

	/**
	 * Instantiates a new attribute modifier for the attribute src.
	 * 
	 * @param srcTextModel
	 *            The model with the name of the src text to add to
	 *            the tag. Must not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeAppenderForSrc(
			final IModel srcTextModel) {
		PARAM_REQ.Object.requireNotNull(srcTextModel,
				"The src attribute model parameter must not be null.");
		return new AttributeModifier(SRC_ATTRIBUTE, srcTextModel);
	}

	/**
	 * Instantiates a new attribute modifier for the attribute
	 * title.
	 * 
	 * @param titleText
	 *            The name of the title text to add to the tag.
	 *            Must not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeAppenderForTitle(
			final String titleText) {
		PARAM_REQ.String.requireNotBlank(titleText,
				"The title attribute parameter must not be null.");
		return new AttributeModifier(TITLE_ATTRIBUTE, new Model(
				titleText));
	}

	/**
	 * Instantiates a new attribute modifier for the attribute
	 * title.
	 * 
	 * @param titleTextModel
	 *            The model with the name of the title text to add
	 *            to the tag. Must not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeAppenderForTitle(
			final IModel titleTextModel) {
		PARAM_REQ.Object.requireNotNull(titleTextModel,
				"The title attribute model parameter must not be null.");
		return new AttributeModifier(TITLE_ATTRIBUTE, titleTextModel);
	}

	/**
	 * Instanciates a new attribute modifier for the attribute
	 * class.
	 * 
	 * @param cssClassNameParam
	 *            The name of the CSS class to add to the tag. Must not be
	 *            blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeModifierForClass(
			final String cssClassNameParam) {
		PARAM_REQ.String.requireNotBlank(cssClassNameParam,
				"The CSS class parameter must not be null.");
		return new AttributeModifier(CLASS_ATTRIBUTE, new Model(
				cssClassNameParam.trim()));
	}

	/**
	 * Instantiates a new attribute modifier for the attribute
	 * class.
	 * 
	 * @param cssClassModel
	 *            The model with the name of the CSS class to add to the tag.
	 *            Must not be blank.
	 * @return The new attribute modifier.
	 */
	public static AttributeModifier newAttributeModifierForClass(
			final IModel cssClassModel) {
		PARAM_REQ.Object.requireNotNull(cssClassModel,
				"The class attribute model parameter must not be null.");
		return new AttributeModifier(CLASS_ATTRIBUTE, cssClassModel);
	}

	private AttributeModifierFactory() {
	}
}