/**
* Licensed under the Artistic License; you may not use this file
* except in compliance with the License.
* You may obtain a copy of the License at
*
* http://displaytag.sourceforge.net/license.html
*
* THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
* WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*/
package org.displaytag.model;
import java.util.Comparator;
import org.apache.commons.beanutils.Converter;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.displaytag.decorator.DisplaytagColumnDecorator;
import org.displaytag.exception.DecoratorException;
import org.displaytag.exception.ObjectLookupException;
import org.displaytag.properties.SortOrderEnum;
import org.displaytag.util.Href;
import org.displaytag.util.HtmlAttributeMap;
import org.displaytag.util.HtmlTagUtil;
import org.displaytag.util.MultipleHtmlAttribute;
import org.displaytag.util.TagConstants;
/**
* DataObject representing the column header. The header cell contains all the properties common to cells in the same
* column.
* @author Fabrizio Giustina
* @version $Revision: 987 $ ($Author: fgiust $)
*/
public class HeaderCell
{
/**
* Map containing the html tag attributes for cells (td).
*/
private HtmlAttributeMap htmlAttributes;
/**
* Map containing the html tag attributes for header cells (td).
*/
private HtmlAttributeMap headerAttributes;
/**
* base href for creating dinamic links.
*/
private Href href;
/**
* param name used in adding a link.
*/
private String paramName;
/**
* property of the object where to get the param value from.
*/
private String paramProperty;
/**
* column title.
*/
private String title;
/**
* is the column sortable?
*/
private boolean sortable;
/**
* Name given to the server when sorting this column
*/
private String sortName;
/**
* ColumnDecorators.
*/
private DisplaytagColumnDecorator[] columnDecorators;
/**
* column number.
*/
private int columnNumber;
/**
* is the column sorted?
*/
private boolean alreadySorted;
/**
* property name to look up in the bean.
*/
private String beanPropertyName;
/**
* show null values?
*/
private boolean showNulls;
/**
* max length of cell content.
*/
private int maxLength;
/**
* max number of words for cell content.
*/
private int maxWords;
/**
* group the column?
*/
private int group;
/**
* Name of the non-decorated property used during sorting.
*/
private String sortPropertyName;
/**
* Should we be attempting to tabulate the totals?
*/
private boolean totaled;
/**
* Defalt sort order for this column.
*/
private SortOrderEnum defaultSortOrder;
/**
* The running total for the column.
*/
private double total;
/**
* Use this comparator for sorting.
*/
private Comparator comparator;
/**
* getter for the grouping index.
* @return 0 if the column is not grouped or the grouping order
*/
public int getGroup()
{
return this.group;
}
/**
* setter for the grouping index.
* @param groupingOrder int grouping order (>0)
*/
public void setGroup(int groupingOrder)
{
this.group = groupingOrder;
}
/**
* getter for the max number of characters to display in the column.
* @return int number of characters to display in the column
*/
public int getMaxLength()
{
return this.maxLength;
}
/**
* setter for the max number of characters to display in the column.
* @param numOfChars number of characters to display in the column
*/
public void setMaxLength(int numOfChars)
{
this.maxLength = numOfChars;
}
/**
* getter for the max number of words to display in the column.
* @return int number of words to display in the column
*/
public int getMaxWords()
{
return this.maxWords;
}
/**
* setter for the max number of words to display in the column.
* @param numOfWords number of words to display in the column
*/
public void setMaxWords(int numOfWords)
{
this.maxWords = numOfWords;
}
/**
* Should null be displayed?
* @return true null will be displayed in cell content
*/
public boolean getShowNulls()
{
return this.showNulls;
}
/**
* Enable or disable displaying of null values.
* @param outputNulls boolean true if null should be displayed
*/
public void setShowNulls(boolean outputNulls)
{
this.showNulls = outputNulls;
}
/**
* Getter for the name of the property to look up in the bean.
* @return String name of the property to look up in the bean
*/
public String getBeanPropertyName()
{
return this.beanPropertyName;
}
/**
* Setter for the name of the property to look up in the bean.
* @param propertyName - name of the property to look up in the bean
*/
public void setBeanPropertyName(String propertyName)
{
this.beanPropertyName = propertyName;
}
/**
* Is the column already sorted?
* @return true if the column already sorted
*/
public boolean isAlreadySorted()
{
return this.alreadySorted;
}
/**
* Setter for the sorted property (the column is actually sorted).
*/
public void setAlreadySorted()
{
this.alreadySorted = true;
}
/**
* Getter for the column number.
* @return int column number
*/
public int getColumnNumber()
{
return this.columnNumber;
}
/**
* Setter for the column number.
* @param number - int column number
*/
public void setColumnNumber(int number)
{
this.columnNumber = number;
}
/**
* Returns the columnDecorator object for this column.
* @return DisplaytagColumnDecorator
*/
public DisplaytagColumnDecorator[] getColumnDecorators()
{
return this.columnDecorators != null ? this.columnDecorators : new DisplaytagColumnDecorator[0];
}
/**
* Sets the columnDecorator object for this column.
* @param decorator - the DisplaytagColumnDecorator
*/
public void setColumnDecorators(DisplaytagColumnDecorator[] decorator)
{
this.columnDecorators = decorator;
}
/**
* Is the column sortable?
* @return true if the column is sortable
*/
public boolean getSortable()
{
return this.sortable;
}
/**
* is the column sortable?
* @param isSortable - true if the column can be sorted
*/
public void setSortable(boolean isSortable)
{
this.sortable = isSortable;
}
/**
* Get name given to server for sorting this column
* @return name given to server for sorting this column
*/
public String getSortName()
{
return sortName;
}
/**
* Set name given to server for sorting this column
* @param sortName name given to server for sorting this column
*/
public void setSortName(String sortName)
{
this.sortName = sortName;
}
/**
* Gets the column title.
* @return the column title. If no title is specified the capitalized bean property name is returned
*/
public String getTitle()
{
if (this.title != null)
{
return this.title;
}
else if (this.beanPropertyName != null)
{
return StringUtils.capitalize(this.beanPropertyName);
}
return TagConstants.EMPTY_STRING;
}
/**
* Setter for the column title.
* @param value - the column title
*/
public void setTitle(String value)
{
this.title = value;
}
/**
* Returns the HtmlAttributeMap containg all the html attributes for the <strong>td </strong> tags.
* @return HtmlAttributeMap with td attributes
*/
public HtmlAttributeMap getHtmlAttributes()
{
return this.htmlAttributes;
}
/**
* Sets the HtmlAttributeMap containg all the html attributes for the <strong>td </strong> tags.
* @param attributes HtmlAttributeMap
*/
public void setHtmlAttributes(HtmlAttributeMap attributes)
{
this.htmlAttributes = attributes;
}
/**
* returns the HtmlAttributeMap containg all the html attributes for the <strong>th </strong> tag.
* @return HtmlAttributeMap with th attributes
*/
public HtmlAttributeMap getHeaderAttributes()
{
return this.headerAttributes;
}
/**
* Sets the HtmlAttributeMap containg all the html attributes for the <strong>th </strong> tag.
* @param attributes HtmlAttributeMap
*/
public void setHeaderAttributes(HtmlAttributeMap attributes)
{
this.headerAttributes = attributes;
}
/**
* Adds a css class to the html "class" attribute.
* @param cssClass String
*/
public void addHeaderClass(String cssClass)
{
// null safe
if (StringUtils.isBlank(cssClass))
{
return;
}
// if headerAttributes has not been set, instantiates a new map
if (headerAttributes == null)
{
headerAttributes = new HtmlAttributeMap();
}
Object classAttributes = this.headerAttributes.get(TagConstants.ATTRIBUTE_CLASS);
// handle multiple values
if (classAttributes == null)
{
this.headerAttributes.put(TagConstants.ATTRIBUTE_CLASS, new MultipleHtmlAttribute(cssClass));
}
else
{
((MultipleHtmlAttribute) classAttributes).addAttributeValue(cssClass);
}
}
/**
* return the open tag for a column header (th).
* @return String <th> tag with attributes
*/
public String getHeaderOpenTag()
{
return HtmlTagUtil.createOpenTagString(TagConstants.TAGNAME_COLUMN_HEADER, this.headerAttributes);
}
/**
* return the closing tag for a cell (td).
* @return String </td>
*/
public String getCloseTag()
{
return TagConstants.TAG_OPENCLOSING + TagConstants.TAGNAME_COLUMN + TagConstants.TAG_CLOSE;
}
/**
* return the closing tag for a column header (th).
* @return String </th>
*/
public String getHeaderCloseTag()
{
return TagConstants.TAG_OPENCLOSING + TagConstants.TAGNAME_COLUMN_HEADER + TagConstants.TAG_CLOSE;
}
/**
* Setter for the href to be used for dinamic links in cells.
* @param baseHref base href for links
*/
public void setHref(Href baseHref)
{
this.href = baseHref;
}
/**
* Getter for the href to be used for dinamic links in cells.
* @return Href base href for links
*/
public Href getHref()
{
return this.href;
}
/**
* Setter for the name of the param to add to links.
* @param name name of the param
*/
public void setParamName(String name)
{
this.paramName = name;
}
/**
* Getter for the name of the param to add to links.
* @return String name of the param
*/
public String getParamName()
{
return this.paramName;
}
/**
* Setter for the name of the property to look up in bean to get the param value for links.
* @param property name of the property to look up in bean to get the param value for links
*/
public void setParamProperty(String property)
{
this.paramProperty = property;
}
/**
* Getter for the name of the property to look up in bean to get the param value for links.
* @return String name of the property to look up in bean to get the param value for links
*/
public String getParamProperty()
{
return this.paramProperty;
}
/**
* Getter for the name of the property in the bean which will be used for sorting.
* @return String name of the property in the bean which will be used for sorting
*/
public String getSortProperty()
{
return this.sortPropertyName;
}
/**
* Setter for the name of the property in the bean which will be used for sorting.
* @param propertyName - name of the property in the bean which will be used for sorting
*/
public void setSortProperty(String propertyName)
{
this.sortPropertyName = propertyName;
}
/**
* Sets the default sort order for this column
* @return default order
*/
public SortOrderEnum getDefaultSortOrder()
{
return this.defaultSortOrder;
}
/**
* Gets the default sort order for this column
* @param order default order
*/
public void setDefaultSortOrder(SortOrderEnum order)
{
this.defaultSortOrder = order;
}
/**
* @see java.lang.Object#toString()
*/
public String toString()
{
return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE) //
.append("columnNumber", this.columnNumber) //$NON-NLS-1$
.append("title", this.title) //$NON-NLS-1$
.append("beanPropertyName", this.beanPropertyName) //$NON-NLS-1$
.toString();
}
/**
* Set the column comparator.
* @param columnComparator the value
*/
public void setComparator(Comparator columnComparator)
{
this.comparator = columnComparator;
}
/**
* Get the comparator for sorting this column.
* @return the comparator
*/
public Comparator getComparator()
{
return this.comparator;
}
/**
* Will we be keeping a total for this column?
* @return true if we are totaling
*/
public boolean isTotaled()
{
return totaled;
}
/**
* Setter for totaled.
* @param isTotaled the value
*/
public void setTotaled(boolean isTotaled)
{
this.totaled = isTotaled;
}
/**
* Add the value of this parameter to the column total. The param will be converted to a number via a property
* Converter.
* @param value the value
* @see Converter#convert(Class, Object)
*/
private void addToTotal(Object value)
{
if (value != null)
{
this.total = this.total + ((Number) value).doubleValue();
}
}
/**
* Get the current total.
* @return the current total.
*/
public double getTotal()
{
return this.total;
}
/**
* Add a new cell to this column.
* @param column the value
*/
public void addCell(Column column)
{
// Not actually going to hold a reference to the added cell - we just need access for the totals
if (this.totaled)
{
try
{
Object val = column.getValue(false);
addToTotal(val);
}
catch (ObjectLookupException e)
{
throw new RuntimeException(e);
}
catch (DecoratorException e)
{
throw new RuntimeException(e);
}
}
}
}