org.apache.myfaces.custom.crosstable
Class AbstractHtmlColumns

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIData
              org.apache.myfaces.custom.crosstable.UIColumns
                  org.apache.myfaces.custom.crosstable.AbstractHtmlColumns

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, HtmlColumn

public abstract class AbstractHtmlColumns
extends UIColumns
implements HtmlColumn

The tag allows dynamic columns in a datatable. The UIColumns component is used below a t:datatable to create a dynamic count of columns. It is used like a UIData component which iterates through a datamodel to create the columns. Unless otherwise specified, all attributes accept static values or EL expressions.

Since:

1.1.7

Version:

$Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $

Author:

Mathias Broekelmann (latest modification by $Author: lu4242 $)

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIData

COMPONENT_FAMILY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

AbstractHtmlColumns()

Method Summary

String	getColspan() This attribute specifies the colspan attribute for the cell
String	getColumnId() The columnId which will be used as id for the column header.
String	getFootercolspan()
abstract Object	getGroupByValue() Optional - Allows you configure where to get the value to check for the group change condition.
String	getHeadercolspan()
abstract String	getSortPropertyName() This attribute tells row object's property by which sorting will be performed on this column
abstract boolean	isDefaultSorted() This attribute tells the datatable to make this column the default sorted, when sortable=true
abstract boolean	isGroupBy() This attribute tells the datatable to group by data in this column
abstract boolean	isSortable() This attribute makes this column automaticaly sortable by a row object's property
void	setColspan(String colspan)
void	setColumnId(String columnId)
void	setFootercolspan(String footercolspan)
void	setHeadercolspan(String headercolspan)

Methods inherited from class org.apache.myfaces.custom.crosstable.UIColumns

createDataModel, encodeTableBegin, encodeTableEnd, getClientId, getDataModel, getRowCount, getRowData, getRowIndex, hasErrorMessages, isRowAvailable, processDecodes, processUpdates, processValidators, restoreDescendantComponentStates, saveDescendantComponentStates, setDataModel, setRowIndex, setValue, setValueBinding

Methods inherited from class javax.faces.component.UIData

broadcast, encodeBegin, encodeEnd, getFamily, getFirst, getFooter, getHeader, getRows, getValue, getVar, queueEvent, restoreState, saveState, setFirst, setFooter, setHeader, setRows, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.myfaces.custom.column.HtmlColumn

getDir, getFooterdir, getFooterlang, getFooteronclick, getFooterondblclick, getFooteronkeydown, getFooteronkeypress, getFooteronkeyup, getFooteronmousedown, getFooteronmousemove, getFooteronmouseout, getFooteronmouseover, getFooteronmouseup, getFooterstyle, getFooterstyleClass, getFootertitle, getHeaderdir, getHeaderlang, getHeaderonclick, getHeaderondblclick, getHeaderonkeydown, getHeaderonkeypress, getHeaderonkeyup, getHeaderonmousedown, getHeaderonmousemove, getHeaderonmouseout, getHeaderonmouseover, getHeaderonmouseup, getHeaderstyle, getHeaderstyleClass, getHeadertitle, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getStyle, getStyleClass, getTitle, getWidth, setDir, setFooterdir, setFooterlang, setFooteronclick, setFooterondblclick, setFooteronkeydown, setFooteronkeypress, setFooteronkeyup, setFooteronmousedown, setFooteronmousemove, setFooteronmouseout, setFooteronmouseover, setFooteronmouseup, setFooterstyle, setFooterstyleClass, setFootertitle, setHeaderdir, setHeaderlang, setHeaderonclick, setHeaderondblclick, setHeaderonkeydown, setHeaderonkeypress, setHeaderonkeyup, setHeaderonmousedown, setHeaderonmousemove, setHeaderonmouseout, setHeaderonmouseover, setHeaderonmouseup, setHeaderstyle, setHeaderstyleClass, setHeadertitle, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setStyleClass, setTitle, setWidth

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlColumns

public AbstractHtmlColumns()

Method Detail

isGroupBy

public abstract boolean isGroupBy()

This attribute tells the datatable to group by data in this column

getGroupByValue

public abstract Object getGroupByValue()

Optional - Allows you configure where to get the value to check for the group change condition. Default: all children of the column cell will be checked

isDefaultSorted

public abstract boolean isDefaultSorted()

This attribute tells the datatable to make this column the default sorted, when sortable=true

isSortable

public abstract boolean isSortable()

This attribute makes this column automaticaly sortable by a row object's property

getSortPropertyName

public abstract String getSortPropertyName()

This attribute tells row object's property by which sorting will be performed on this column

getColspan

public String getColspan()

Description copied from interface: HtmlColumn

This attribute specifies the colspan attribute for the cell

Specified by:

getColspan in interface HtmlColumn

setColspan

public void setColspan(String colspan)

Specified by:

setColspan in interface HtmlColumn

getHeadercolspan

public String getHeadercolspan()

Specified by:

getHeadercolspan in interface HtmlColumn

setHeadercolspan

public void setHeadercolspan(String headercolspan)

Specified by:

setHeadercolspan in interface HtmlColumn

getFootercolspan

public String getFootercolspan()

Specified by:

getFootercolspan in interface HtmlColumn

setFootercolspan

public void setFootercolspan(String footercolspan)

Specified by:

setFootercolspan in interface HtmlColumn

getColumnId

public String getColumnId()

Description copied from interface: HtmlColumn

The columnId which will be used as id for the column header. Notice: As the rowId on t:datatable this will not add any namespace to the id. The id will be rendered exactly as you provide it.

Specified by:

getColumnId in interface HtmlColumn

setColumnId

public void setColumnId(String columnId)

Specified by:

setColumnId in interface HtmlColumn