/*
    * Copyright 2004 Jeff Johnston
    *
    * 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.extremecomponents.table.view;
  
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.extremecomponents.table.bean.Export;
  import org.extremecomponents.table.bean.Form;
  import org.extremecomponents.table.bean.Table;
  import org.extremecomponents.table.bean.TableSection;
  import org.extremecomponents.table.model.ExportHandler;
  import org.extremecomponents.table.model.FilterHandler;
  import org.extremecomponents.table.model.ParameterRegistry;
  import org.extremecomponents.table.model.TableModel;
  import org.extremecomponents.table.model.TableModelUtils;
  import org.extremecomponents.table.model.ViewHandler;
  import org.extremecomponents.util.HtmlBuilder;
  
  
  /***
   * The default implementation of the table. The notion
   * is that you can easily plug in different parts of the view as
   * needed or desired.
   *
   * @author Jeff Johnston
   */
  public class HtmlView implements View
  {
  	private static Log logger = LogFactory.getLog(HtmlView.class);
  	public final static String PAGINATION_EXPORT_REGION = "paginationExportRegion";
  	public final static String PAGINATION = "pagination";
  	public final static String PAGINATION_TITLE = "paginationTitle";
  	public final static String PAGINATION_HEADER = "paginationHeader";
  	public final static String EXPORT_TOOLBAR = "exportToolBar";
  	public final static String FORM_BUTTONS = "formButtons";
  	public final static String FILTER = "filter";
  	public final static String TABLE_TITLE = "tableTitle";
  	private HtmlBuilder html = new HtmlBuilder();
  
  	public void beforeBody(TableModel model)
  	{
  		paginationExport(model);
  		tableStart(model);
  		header(model);
  		filter(model);
  		formStart(model);
  	}
  
  	public void body(TableModel model, String value, boolean startRow, boolean endRow)
  	{
  		if (startRow)
  		{
  			html.tr(1).close();
  		}
  
  		html.append(value);
  
  		if (endRow)
  		{
  			html.trEnd(1);
  		}
  	}
  
  	public Object afterBody(TableModel model)
  	{
  		tableEnd(model);
  
  		return html.toString();
  	}
  
  	/***
  	 * The pagination and export will display together.
  	 */
  	public void paginationExport(TableModel model)
  	{
  		html.table(0).styleClass(PAGINATION_EXPORT_REGION).width(model.getTable().getWidth()).close();
  		html.tr(1).close();
  		html.td(2).close();
  
  		pagination(model);
  
  		html.tdEnd();
 
 		html.td(2).align("right").valign("bottom").style("padding-right:15px").close();
 
 		export(model);
 
 		html.tdEnd();
 		html.trEnd(1);
 		html.tableEnd(0);
 	}
 
 	/***
 	 * The pagination that will hover over the table.
 	 */
 	public void pagination(TableModel model)
 	{
 		if (!model.getTable().doPagination())
 		{
 			return;
 		}
 
 		List pagination = model.getPageHandler().getPagination(model);
 
 		html.table(2).border("0").cellPadding("0").cellSpacing("0").styleClass(PAGINATION).close();
 
 		//the title
 		Table table = model.getTable();
 
 		if (StringUtils.isNotEmpty(table.getTitle()))
 		{
 			html.tr(3).close();
 			html.th(4).styleClass(PAGINATION_TITLE).colSpan("" + pagination.size()).close();
 			html.append(table.getTitle());
 			html.thEnd().trEnd(3);
 		}
 
 		//the information
 		html.tr(3).close();
 		html.td(4);
 
 		if (pagination.size() > 0)
 		{
 			html.styleClass(PAGINATION_HEADER);
 		}
 
 		html.colSpan("" + pagination.size()).close();
 
 		TableSection section = model.getTableSection();
 
 		if (section.getTotalRows() == 0)
 		{
 			html.append("There were no results found.");
 		}
 		else
 		{
 			html.append(section.getTotalRows() + " results found, displaying " + (section.getRowStart() + 1) + " to " + section.getRowEnd());
 		}
 
 		html.tdEnd();
 		html.trEnd(3);
 
 		//the pagination
 		html.tr(3);
 		html.close();
 
 		if (pagination.size() > 0)
 		{
 			for (Iterator iter = pagination.iterator(); iter.hasNext();)
 			{
 				html.append((String) iter.next());
 			}
 		}
 
 		html.trEnd(3);
 		html.tableEnd(2);
 		html.newline();
 		html.tabs(2);
 	}
 
 	public void export(TableModel model)
 	{
 		if (!model.getExportHandler().hasExports())
 		{
 			return;
 		}
 
 		html.table(2).styleClass(EXPORT_TOOLBAR).close();
 		html.tr(3).close();
 
 		for (Iterator iter = model.getExportHandler().getExports().iterator(); iter.hasNext();)
 		{
 			html.td(4).close();
 
 			Export export = (Export) iter.next();
 			exportHtml(model, export);
 			html.tdEnd();
 		}
 
 		html.trEnd(3);
 		html.tableEnd(2);
 	}
 
 	private void exportHtml(TableModel model, Export export)
 	{
 		html.a();
 		html.quote();
 
 		String action = model.getTable().getAction();
 
 		if (StringUtils.isNotEmpty(action))
 		{
 			html.append(action);
 		}
 
 		html.question().append(Table.EXTREME_TABLE).equals().append(model.getTableKey()).ampersand().append(model.getTableKey() + ParameterRegistry.EXPORT).equals().append(export.getView()).ampersand().append(model.getTableKey() + ExportHandler.EXPORT_NAME).equals().append(export.getName());
 		html.append(model.getRegistry().getURLParameterString(true, true, true));
 		html.quote();
 		html.close();
 
 		if (StringUtils.isNotEmpty(export.getImage()))
 		{
 			String title = (export.getTitle() == null) ? "Export" : export.getTitle();
 			html.img(export.getImage(), title);
 		}
 		else
 		{
 			html.append(" " + export.getView() + " ");
 		}
 
 		html.aEnd();
 	}
 
 	/***
 	 * The opening table tag along with all the attributes of the table.
 	 */
 	public void tableStart(TableModel model)
 	{
 		Table table = model.getTable();
 
 		html.table(0);
 		html.id(table.getId());
 		html.border(table.getBorder());
 		html.cellSpacing(table.getCellspacing());
 		html.cellPadding(table.getCellpadding());
 		html.width(table.getWidth());
 
 		String styleClass = table.getStyleClass();
 
 		if (StringUtils.isNotBlank(styleClass))
 		{
 			html.styleClass(styleClass);
 		}
 
 		String style = table.getStyle();
 
 		if (StringUtils.isNotBlank(style))
 		{
 			html.style(style);
 		}
 
 		html.close();
 
 		if (!model.getTable().doPagination() && StringUtils.isNotBlank(table.getTitle())) //not doing pagination and have a title
 		{
 			html.tr(1).close();
 			html.th(2).styleClass(TABLE_TITLE).colSpan("" + model.getColumnMetaData().columnCount()).close();
 			html.append(table.getTitle());
 			html.thEnd();
 			html.trEnd(1);
 		}
 	}
 
 	/***
 	 * Closes the table.
 	 */
 	public void tableEnd(TableModel model)
 	{
 		html.tableEnd(0);
 		formButtons(model);
 	}
 
 	/***
 	 * The header row of the table. This is typically the first row of the table.
 	 */
 	public void header(TableModel model)
 	{
 		html.tr(1).close();
 
 		for (Iterator iter = TableModelUtils.getHeader(model, ViewHandler.HTML).iterator();
 				iter.hasNext();)
 		{
 			html.append((String) iter.next());
 		}
 
 		html.trEnd(1);
 	}
 
 	/***
 	 * The filter row of the table. Typically sits below the header (if enabled).
 	 * Will contain input or select type fields to allow the user to filter the result set.
 	 */
 	public void filter(TableModel model)
 	{
 		List filter = model.getFilterHandler().getFilter(model);
 
 		if (!model.getTable().doFilter())
 		{
 			return;
 		}
 
 		filterFormStart(model);
 
 		html.tr(1).styleClass(FILTER).close();
 
 		for (Iterator iter = filter.iterator(); iter.hasNext();)
 		{
 			String value = (String) iter.next();
 
 			html.td(2).close();
 
 			if (iter.hasNext())
 			{
 				html.append(value);
 			}
 			else
 			{
 				html.table(2).cellPadding("0").cellSpacing("0").border("0").width("100%").close();
 
 				html.tr(3).close();
 
 				html.td(4).width("100%").close();
 				html.append(value);
 				html.tdEnd();
 
 				html.td(4).align("right").close();
 				filterFomButtons(model);
 				html.tdEnd();
 
 				html.trEnd(3);
 				html.tableEnd(2);
 			}
 
 			html.tdEnd();
 		}
 
 		html.trEnd(1);
 		filterFormEnd();
 	}
 
 	/***
 	 * Get the HTML for the start of the form <form> tag. The filter will need to be
 	 * wrapped in a form tag so that it can be submitted.
 	 */
 	private void filterFormStart(TableModel model)
 	{
 		html.form();
 		html.name(model.getTableKey() + "filter");
 
 		String action = model.getTable().getAction();
 
 		if (StringUtils.isNotEmpty(action))
 		{
 			html.action(action);
 		}
 
 		html.close();
 
 		String hiddenFields = model.getRegistry().getFormHiddenFields(false, true, false);
 
 		if (StringUtils.isNotEmpty(hiddenFields))
 		{
 			html.append(hiddenFields);
 		}
 	}
 
 	/***
 	 * The HTML for the filter search and clear buttons.
 	 */
 	private void filterFomButtons(TableModel model)
 	{
 		html.table(4).cellPadding("0").cellSpacing("0").border("0").close();
 		html.tr(5).close();
 
 		html.input("hidden").name(model.getTableKey() + "filter_button").close();
 
 		html.td(6).valign("center").close();
 
 		html.a().quote().append("javascript:document." + model.getTableKey() + "filter." + model.getTableKey() + "filter_button.value='" + FilterHandler.DO_SEARCH + "';document." + model.getTableKey() + "filter.submit()").quote().close();
 
 		String imageSearch = model.getTable().getImage(FilterHandler.SEARCH_IMAGE);
 
 		if (StringUtils.isNotEmpty(imageSearch))
 		{
 			html.img(imageSearch, "Search");
 		}
 		else
 		{
 			html.append("&nbsp;Filter&nbsp;");
 		}
 
 		html.aEnd();
 
 		html.tdEnd();
 		html.td(6).valign("center").close();
 
 		html.a().quote().append("javascript:document." + model.getTableKey() + "filter." + model.getTableKey() + "filter_button.value='" + FilterHandler.DO_CLEAR + "';document." + model.getTableKey() + "filter.submit()").quote().close();
 
 		String imageClear = model.getTable().getImage(FilterHandler.CLEAR_IMAGE);
 
 		if (StringUtils.isNotEmpty(imageClear))
 		{
 			html.img(imageClear, "Clear");
 		}
 		else
 		{
 			html.append("&nbsp;Clear&nbsp;");
 		}
 
 		html.aEnd();
 
 		html.tdEnd();
 		html.trEnd(5);
 		html.tableEnd(4);
 		html.format(4, 1);
 		html.newline();
 	}
 
 	/***
 	 * Get the HTML for the end of the form <form> tag.
 	 */
 	private void filterFormEnd()
 	{
 		html.formEnd();
 	}
 
 	/***
 	 * The form will come right before the body section.
 	 */
 	private void formStart(TableModel model)
 	{
 		Form form = model.getFormHandler().getForm();
 
 		if (form != null)
 		{
 			String name = form.getName();
 			String action = form.getAction();
 			String method = form.getMethod();
 
 			html.form().name(name).action(action).method(method);
 
 			String onsubmit = form.getOnsubmit();
 
 			if (StringUtils.isNotEmpty(onsubmit))
 			{
 				html.onsubmit(onsubmit);
 			}
 
 			html.close();
 
 			//make up the hiddens
 			html.append(model.getRegistry().getFormHiddenFields(true, true, true));
 			html.append(model.getFormHandler().getHiddenFields());
 		}
 	}
 
 	public void formButtons(TableModel model)
 	{
 		String formButtons = model.getFormHandler().getFormButtons();
 
 		if (StringUtils.isNotEmpty(formButtons))
 		{
 			html.newline();
 			html.span().styleClass(FORM_BUTTONS).close();
 			html.append(formButtons);
 			html.spanEnd();
 			html.formEnd();
 		}
 	}
 }