org.wicketstuff.datatable_autocomplete.model.MarkupIDInStringModel Maven / Gradle / Ivy

Go to download
/*
 * 
 * ==============================================================================
 * 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 org.wicketstuff.datatable_autocomplete.model;

import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Map;

import org.apache.wicket.Component;
import org.apache.wicket.model.IModel;


/**
 * @author mocleiri
 * 
 *         Used for situations like rendering javascript method calls where we need the markupid for
 *         the component.
 * 
 *         The markupid is not available until the component is on a page so we need the model to
 *         defer the question until rendering time which by definition the context will exist.
 * 
 */
public class MarkupIDInStringModel implements IModel
{

	/**
	 * 
	 */
	private static final long serialVersionUID = 548831417478329002L;

	/**
	 * Used by child classes to define the markupid placeholder in their attached template
	 */
	public static final String MARKUP_ID_TAG = ":markupID:";

	private final String template;
	private final Component target;
	private final Map> templateArgMap;


	/**
	 * 
	 */
	public MarkupIDInStringModel(String template, Component target,
		Map> templateArgMap)
	{
		super();
		this.template = template;
		this.target = target;
		this.templateArgMap = templateArgMap;

		target.setOutputMarkupId(true);

	}

	public MarkupIDInStringModel(String template, Component target)
	{
		this(template, target, new LinkedHashMap>());

	}

	protected void storeTemplateArgument(String alias, IModel valueModel)
	{
		templateArgMap.put(alias, valueModel);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.apache.wicket.model.IModel#getObject()
	 */
	public final String getObject()
	{

		/*
		 * Render the string using the template and replacing the content as dictated by the
		 * parameters.
		 */

		String renderedMarkupIDString = template;

		if (target != null)
			renderedMarkupIDString = renderedMarkupIDString.replaceAll(MARKUP_ID_TAG,
				target.getMarkupId());

		for (String id : templateArgMap.keySet())
		{

			IModel replacement = templateArgMap.get(id);

			String replacementValue = null;

			if (replacement == null || replacement.getObject() == null)
				replacementValue = "";
			else
				replacementValue = replacement.getObject().toString();

			renderedMarkupIDString = renderedMarkupIDString.replaceAll(id, replacementValue);
		}

		return renderedMarkupIDString;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.apache.wicket.model.IModel#setObject(java.lang.Object)
	 */
	public void setObject(String object)
	{

		// does nothing

	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.apache.wicket.model.IDetachable#detach()
	 */
	public void detach()
	{

		// does nothing

	}


}