DisclaimerPanel.java

/**
 * Copyright (C) 2010 Asterios Raptis
 *
 * 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 de.alpharogroup.wicket.components.termofuse.disclaimer;

import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.model.IModel;

import de.alpharogroup.resourcebundle.locale.ResourceBundleKey;
import de.alpharogroup.wicket.base.util.resource.ResourceModelFactory;
import de.alpharogroup.wicket.components.factory.ComponentFactory;
import de.alpharogroup.wicket.components.i18n.list.HeaderContentListModelBean;

/**
 * The Class {@link DisclaimerPanel}.
 */
public class DisclaimerPanel extends Panel
{

	/**
	 * The serialVersionUID.
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * Instantiates a new {@link DisclaimerPanel}.
	 *
	 * @param id
	 *            the id
	 */
	public DisclaimerPanel(final String id)
	{
		this(id, null);
	}

	/**
	 * Instantiates a new {@link DisclaimerPanel}.
	 *
	 * @param id
	 *            the id
	 * @param model
	 *            the model
	 */
	public DisclaimerPanel(final String id, final IModel<HeaderContentListModelBean> model)
	{
		super(id, model);

		add(newDisclaimerLabel("disclaimerLbl", newDisclaimerModel()))
			.add(newDisclaimerContentLabel("disclaimerContentLbl", newDisclaimerContentModel()))
			.add(newDisclaimerLinkLabel("disclaimerLinkLabel", newDisclaimerLinkLabelModel()));
	}


	/**
	 * Factory method for creating the new {@link Label}. This method is invoked in the constructor
	 * from the derived classes and can be overridden so users can provide their own version of a
	 * new {@link Label}.
	 *
	 * @param id
	 *            the id
	 * @param model
	 *            the model
	 * @return the new {@link Label}
	 */
	protected Label newDisclaimerContentLabel(final String id, final IModel<String> model)
	{
		return ComponentFactory.newLabel(id, model);
	}

	/**
	 * Factory method to create a new {@link IModel} for the disclaimer content. This method is
	 * invoked in the constructor from this class and can be overridden so users can provide their
	 * own version of a disclaimer content.
	 *
	 * @return the new {@link IModel}
	 */
	protected IModel<String> newDisclaimerContentModel()
	{
		return newIModel("imprint.disclaimer.content");
	}

	/**
	 * Factory method for creating the new {@link Label}. This method is invoked in the constructor
	 * from the derived classes and can be overridden so users can provide their own version of a
	 * new {@link Label}.
	 *
	 * @param id
	 *            the id
	 * @param model
	 *            the model
	 * @return the new {@link Label}
	 */
	protected Label newDisclaimerLabel(final String id, final IModel<String> model)
	{
		return ComponentFactory.newLabel(id, model);
	}

	/**
	 * Factory method for creating the new {@link Label}. This method is invoked in the constructor
	 * from the derived classes and can be overridden so users can provide their own version of a
	 * new {@link Label}.
	 *
	 * @param id
	 *            the id
	 * @param model
	 *            the model
	 * @return the new {@link Label}
	 */
	protected Label newDisclaimerLinkLabel(final String id, final IModel<String> model)
	{
		return ComponentFactory.newLabel(id, model);
	}

	/**
	 * Factory method to create a new {@link IModel} for the disclaimer content. This method is
	 * invoked in the constructor from this class and can be overridden so users can provide their
	 * own version of a disclaimer content.
	 *
	 * @return the new {@link IModel}
	 */
	protected IModel<String> newDisclaimerLinkLabelModel()
	{
		return newIModel("imprint.disclaimer.link.label");
	}

	/**
	 * Factory method to create a new {@link IModel} for the disclaimer header. This method is
	 * invoked in the constructor from this class and can be overridden so users can provide their
	 * own version of a disclaimer header.
	 *
	 * @return the new {@link IModel}
	 */
	protected IModel<String> newDisclaimerModel()
	{
		return newIModel("imprint.disclaimer.label");
	}

	/**
	 * Factory method to create a new StringResourceModel from the given key.
	 *
	 * @param key
	 *            the key
	 * @return the new {@link IModel}
	 */
	protected IModel<String> newIModel(final String key)
	{
		return ResourceModelFactory
			.newResourceModel(ResourceBundleKey.builder().key(key).defaultValue("").build(), this);
	}

}