/*
 * HtmlInfoBuilder.java
 * Copyright 2007 (C) Koen Van Daele
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Created on 4-feb-07
 *
 * $Id: HtmlInfoBuilder.java 14600 2011-02-24 23:41:00Z jdempsey $
 */
package pcgen.gui2.util;

import pcgen.system.LanguageBundle;

/**
 * {@code HtmlInfoBuilder} is a helper class for the various
 * setInfoLabelText methods in the gui tabs.
 *
 *
 * @author Koen Van Daele <vandaelek@users.sourceforge.net>
 */
public class HtmlInfoBuilder 
{
	/** Constant for 3 spaces in HTML */
	public static final String THREE_SPACES = "   "; //$NON-NLS-1$

	private final StringBuilder buffer = new StringBuilder(300);
	private final boolean fullDocument;  
	
	public HtmlInfoBuilder()
	{
		this(null, true);
	}
	
	/**
	 * @param title Element that will be added as the start of the string and emphasized.
	 */
	public HtmlInfoBuilder(String title)
	{
		this(title, true);
	}
	
	/**
	 * @param title Element that will be added as the start of the string and emphasized.
	 * @param fullDocument Should html tags be added to make this a full html document
	 */
	public HtmlInfoBuilder(String title, boolean fullDocument)
	{
		this.fullDocument = fullDocument;
		if (fullDocument)
		{
			buffer.append("<html>");
		}
		if (title != null)
		{
			appendTitleElement(title);
		}
	}
	
	/**
	 * Adds a string to the LabelText.
	 * @param string String to add
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder append(final String string)
	{
		buffer.append(string);
		return this;
	}
	
	/**
	 * Adds a localised string to the LabelText.
	 * @param key Key to the localised string to add
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder appendIl8n(final String key)
	{
		buffer.append(LanguageBundle.getString(key));
		return this;
	}
	
	/**
	 * Adds a character to the LabelText.
	 * @param ch Char to add
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder append(final char ch)
	{
		buffer.append(ch);
		return this;
	}
	
	/**
	 * Adds a line break to the LabelText.
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder appendLineBreak()
	{
		buffer.append("<br>");
		return this;
	}
	
	/**
	 * Adds a spacer to the LabelText.
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder appendSpacer()
	{
		buffer.append(THREE_SPACES);
		return this;
	}
	
	/**
	 * Append a title element with a regular sized font.
	 * 
	 * @param title the title
	 */
	public void appendSmallTitleElement(final String title)
	{
		buffer.append("<b>").append(title).append("</b>");
	}
	
	/**
	 * Append a title element with a larger sized font.
	 * 
	 * @param title the title
	 */
	public void appendTitleElement(final String title)
	{
		buffer.append("<b><font size=+1>").append(title).append("</font></b>");
	}
	
	/**
	 * Adds an element to the labelText. The key will be put in bold-face.
	 * @param key The string that will be used as the key in the LabelText, e.g. SOURCE. 
	 * @param value The value that belongs to the key.
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder appendElement(final String key, final String value)
	{
		buffer.append("<b>").append(key).append(":</b> ").append(value);
		return this;
	}
	
	/**
	 * Used for internationalisation. Looks up the property through the 
	 * {@code ProperyFactory} and uses that as the key.
	 * @param propertyKey The name of a property in the LanguageProperties file.
	 * @param value The value that belongs to the key.
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder appendI18nElement(final String propertyKey, final String value)
	{
		return appendElement(LanguageBundle.getString(propertyKey), value);
	}
	
	/**
	 * Used for internationalisation. Looks up the property through the 
	 * {@code ProperyFactory} and uses that as the key.
	 * @param propertyKey The name of a property in the LanguageProperties file.
	 * @param value The values that should be added as parameters to the property.
	 * @return HtmlInfoBuilder
	 */
	public HtmlInfoBuilder appendI18nFormattedElement(final String propertyKey, final String... value)
	{
		buffer.append(LanguageBundle.getFormattedString(propertyKey, (Object[]) value));
		return this;
	}
	
	/**
	 * Append an image to the label text.
	 * 
	 * @param iconPath the URL of the icon
	 */
	public void appendIconElement(final String iconPath)
	{
		buffer.append("<img src=\"").append(iconPath).append("\" > ");
	}
	
	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString()
	{
		if (fullDocument)
		{
			buffer.append("</html>");
		}
		return buffer.toString();
	}
}