org.apache.myfaces.custom.crosstable
Class HtmlColumns

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
                      org.apache.myfaces.custom.crosstable.HtmlColumns

All Implemented Interfaces:

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

public class HtmlColumns
extends AbstractHtmlColumns
implements HtmlColumn

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

HtmlColumns()

Method Summary

java.lang.String	getDir() HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
java.lang.String	getFamily()
java.lang.String	getFooterdir()
java.lang.String	getFooterlang()
java.lang.String	getFooteronclick()
java.lang.String	getFooterondblclick()
java.lang.String	getFooteronkeydown()
java.lang.String	getFooteronkeypress()
java.lang.String	getFooteronkeyup()
java.lang.String	getFooteronmousedown()
java.lang.String	getFooteronmousemove()
java.lang.String	getFooteronmouseout()
java.lang.String	getFooteronmouseover()
java.lang.String	getFooteronmouseup()
java.lang.String	getFooterstyle()
java.lang.String	getFooterstyleClass() Corresponds to the HTML class attribute.
java.lang.String	getFootertitle()
java.lang.Object	getGroupByValue() Optional - Allows you configure where to get the value to check for the group change condition.
java.lang.String	getHeaderdir()
java.lang.String	getHeaderlang()
java.lang.String	getHeaderonclick()
java.lang.String	getHeaderondblclick()
java.lang.String	getHeaderonkeydown()
java.lang.String	getHeaderonkeypress()
java.lang.String	getHeaderonkeyup()
java.lang.String	getHeaderonmousedown()
java.lang.String	getHeaderonmousemove()
java.lang.String	getHeaderonmouseout()
java.lang.String	getHeaderonmouseover()
java.lang.String	getHeaderonmouseup()
java.lang.String	getHeaderstyle()
java.lang.String	getHeaderstyleClass() Corresponds to the HTML class attribute.
java.lang.String	getHeadertitle()
java.lang.String	getLang() HTML: The base language of this document.
java.lang.String	getOnclick() HTML: Script to be invoked when the element is clicked.
java.lang.String	getOndblclick() HTML: Script to be invoked when the element is double-clicked.
java.lang.String	getOnkeydown() HTML: Script to be invoked when a key is pressed down over this element.
java.lang.String	getOnkeypress() HTML: Script to be invoked when a key is pressed over this element.
java.lang.String	getOnkeyup() HTML: Script to be invoked when a key is released over this element.
java.lang.String	getOnmousedown() HTML: Script to be invoked when the pointing device is pressed over this element.
java.lang.String	getOnmousemove() HTML: Script to be invoked when the pointing device is moved while it is in this element.
java.lang.String	getOnmouseout() HTML: Script to be invoked when the pointing device is moves out of this element.
java.lang.String	getOnmouseover() HTML: Script to be invoked when the pointing device is moved into this element.
java.lang.String	getOnmouseup() HTML: Script to be invoked when the pointing device is released over this element.
java.lang.String	getSortPropertyName() This attribute tells row object's property by which sorting will be performed on this column
java.lang.String	getStyle() HTML: CSS styling instructions.
java.lang.String	getStyleClass() The CSS class for this element.
java.lang.String	getTitle() HTML: An advisory title for this element.
java.lang.String	getWidth() This attribute can be used to set the width of the elements.
boolean	isDefaultSorted() This attribute tells the datatable to make this column the default sorted, when sortable=true
boolean	isGroupBy() This attribute tells the datatable to group by data in this column
boolean	isSortable() This attribute makes this column automaticaly sortable by a row object's property
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setDefaultSorted(boolean defaultSorted)
void	setDir(java.lang.String dir)
void	setFooterdir(java.lang.String footerdir)
void	setFooterlang(java.lang.String footerlang)
void	setFooteronclick(java.lang.String footeronclick)
void	setFooterondblclick(java.lang.String footerondblclick)
void	setFooteronkeydown(java.lang.String footeronkeydown)
void	setFooteronkeypress(java.lang.String footeronkeypress)
void	setFooteronkeyup(java.lang.String footeronkeyup)
void	setFooteronmousedown(java.lang.String footeronmousedown)
void	setFooteronmousemove(java.lang.String footeronmousemove)
void	setFooteronmouseout(java.lang.String footeronmouseout)
void	setFooteronmouseover(java.lang.String footeronmouseover)
void	setFooteronmouseup(java.lang.String footeronmouseup)
void	setFooterstyle(java.lang.String footerstyle)
void	setFooterstyleClass(java.lang.String footerstyleClass)
void	setFootertitle(java.lang.String footertitle)
void	setGroupBy(boolean groupBy)
void	setGroupByValue(java.lang.Object groupByValue)
void	setHeaderdir(java.lang.String headerdir)
void	setHeaderlang(java.lang.String headerlang)
void	setHeaderonclick(java.lang.String headeronclick)
void	setHeaderondblclick(java.lang.String headerondblclick)
void	setHeaderonkeydown(java.lang.String headeronkeydown)
void	setHeaderonkeypress(java.lang.String headeronkeypress)
void	setHeaderonkeyup(java.lang.String headeronkeyup)
void	setHeaderonmousedown(java.lang.String headeronmousedown)
void	setHeaderonmousemove(java.lang.String headeronmousemove)
void	setHeaderonmouseout(java.lang.String headeronmouseout)
void	setHeaderonmouseover(java.lang.String headeronmouseover)
void	setHeaderonmouseup(java.lang.String headeronmouseup)
void	setHeaderstyle(java.lang.String headerstyle)
void	setHeaderstyleClass(java.lang.String headerstyleClass)
void	setHeadertitle(java.lang.String headertitle)
void	setLang(java.lang.String lang)
void	setOnclick(java.lang.String onclick)
void	setOndblclick(java.lang.String ondblclick)
void	setOnkeydown(java.lang.String onkeydown)
void	setOnkeypress(java.lang.String onkeypress)
void	setOnkeyup(java.lang.String onkeyup)
void	setOnmousedown(java.lang.String onmousedown)
void	setOnmousemove(java.lang.String onmousemove)
void	setOnmouseout(java.lang.String onmouseout)
void	setOnmouseover(java.lang.String onmouseover)
void	setOnmouseup(java.lang.String onmouseup)
void	setSortable(boolean sortable)
void	setSortPropertyName(java.lang.String sortPropertyName)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTitle(java.lang.String title)
void	setWidth(java.lang.String width)

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

getColspan, getColumnId, getFootercolspan, getHeadercolspan, setColspan, setColumnId, setFootercolspan, setHeadercolspan

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, getFirst, getFooter, getHeader, getRows, getValue, getVar, queueEvent, 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

getColspan, getColumnId, getFootercolspan, getHeadercolspan, setColspan, setColumnId, setFootercolspan, setHeadercolspan

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlColumns

public HtmlColumns()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

isGroupBy

public boolean isGroupBy()

Description copied from class: AbstractHtmlColumns

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

Specified by:

isGroupBy in class AbstractHtmlColumns

setGroupBy

public void setGroupBy(boolean groupBy)

getGroupByValue

public java.lang.Object getGroupByValue()

Description copied from class: AbstractHtmlColumns

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

Specified by:

getGroupByValue in class AbstractHtmlColumns

setGroupByValue

public void setGroupByValue(java.lang.Object groupByValue)

isDefaultSorted

public boolean isDefaultSorted()

Description copied from class: AbstractHtmlColumns

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

Specified by:

isDefaultSorted in class AbstractHtmlColumns

setDefaultSorted

public void setDefaultSorted(boolean defaultSorted)

isSortable

public boolean isSortable()

Description copied from class: AbstractHtmlColumns

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

Specified by:

isSortable in class AbstractHtmlColumns

setSortable

public void setSortable(boolean sortable)

getSortPropertyName

public java.lang.String getSortPropertyName()

Description copied from class: AbstractHtmlColumns

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

Specified by:

getSortPropertyName in class AbstractHtmlColumns

setSortPropertyName

public void setSortPropertyName(java.lang.String sortPropertyName)

getFooterdir

public java.lang.String getFooterdir()

Specified by:

getFooterdir in interface HtmlColumn

setFooterdir

public void setFooterdir(java.lang.String footerdir)

Specified by:

setFooterdir in interface HtmlColumn

getFooterlang

public java.lang.String getFooterlang()

Specified by:

getFooterlang in interface HtmlColumn

setFooterlang

public void setFooterlang(java.lang.String footerlang)

Specified by:

setFooterlang in interface HtmlColumn

getFooteronclick

public java.lang.String getFooteronclick()

Specified by:

getFooteronclick in interface HtmlColumn

setFooteronclick

public void setFooteronclick(java.lang.String footeronclick)

Specified by:

setFooteronclick in interface HtmlColumn

getFooterondblclick

public java.lang.String getFooterondblclick()

Specified by:

getFooterondblclick in interface HtmlColumn

setFooterondblclick

public void setFooterondblclick(java.lang.String footerondblclick)

Specified by:

setFooterondblclick in interface HtmlColumn

getFooteronkeydown

public java.lang.String getFooteronkeydown()

Specified by:

getFooteronkeydown in interface HtmlColumn

setFooteronkeydown

public void setFooteronkeydown(java.lang.String footeronkeydown)

Specified by:

setFooteronkeydown in interface HtmlColumn

getFooteronkeypress

public java.lang.String getFooteronkeypress()

Specified by:

getFooteronkeypress in interface HtmlColumn

setFooteronkeypress

public void setFooteronkeypress(java.lang.String footeronkeypress)

Specified by:

setFooteronkeypress in interface HtmlColumn

getFooteronkeyup

public java.lang.String getFooteronkeyup()

Specified by:

getFooteronkeyup in interface HtmlColumn

setFooteronkeyup

public void setFooteronkeyup(java.lang.String footeronkeyup)

Specified by:

setFooteronkeyup in interface HtmlColumn

getFooteronmousedown

public java.lang.String getFooteronmousedown()

Specified by:

getFooteronmousedown in interface HtmlColumn

setFooteronmousedown

public void setFooteronmousedown(java.lang.String footeronmousedown)

Specified by:

setFooteronmousedown in interface HtmlColumn

getFooteronmousemove

public java.lang.String getFooteronmousemove()

Specified by:

getFooteronmousemove in interface HtmlColumn

setFooteronmousemove

public void setFooteronmousemove(java.lang.String footeronmousemove)

Specified by:

setFooteronmousemove in interface HtmlColumn

getFooteronmouseout

public java.lang.String getFooteronmouseout()

Specified by:

getFooteronmouseout in interface HtmlColumn

setFooteronmouseout

public void setFooteronmouseout(java.lang.String footeronmouseout)

Specified by:

setFooteronmouseout in interface HtmlColumn

getFooteronmouseover

public java.lang.String getFooteronmouseover()

Specified by:

getFooteronmouseover in interface HtmlColumn

setFooteronmouseover

public void setFooteronmouseover(java.lang.String footeronmouseover)

Specified by:

setFooteronmouseover in interface HtmlColumn

getFooteronmouseup

public java.lang.String getFooteronmouseup()

Specified by:

getFooteronmouseup in interface HtmlColumn

setFooteronmouseup

public void setFooteronmouseup(java.lang.String footeronmouseup)

Specified by:

setFooteronmouseup in interface HtmlColumn

getFooterstyle

public java.lang.String getFooterstyle()

Specified by:

getFooterstyle in interface HtmlColumn

setFooterstyle

public void setFooterstyle(java.lang.String footerstyle)

Specified by:

setFooterstyle in interface HtmlColumn

getFooterstyleClass

public java.lang.String getFooterstyleClass()

Description copied from interface: HtmlColumn

Corresponds to the HTML class attribute.

Specified by:

getFooterstyleClass in interface HtmlColumn

setFooterstyleClass

public void setFooterstyleClass(java.lang.String footerstyleClass)

Specified by:

setFooterstyleClass in interface HtmlColumn

getFootertitle

public java.lang.String getFootertitle()

Specified by:

getFootertitle in interface HtmlColumn

setFootertitle

public void setFootertitle(java.lang.String footertitle)

Specified by:

setFootertitle in interface HtmlColumn

getHeaderdir

public java.lang.String getHeaderdir()

Specified by:

getHeaderdir in interface HtmlColumn

setHeaderdir

public void setHeaderdir(java.lang.String headerdir)

Specified by:

setHeaderdir in interface HtmlColumn

getHeaderlang

public java.lang.String getHeaderlang()

Specified by:

getHeaderlang in interface HtmlColumn

setHeaderlang

public void setHeaderlang(java.lang.String headerlang)

Specified by:

setHeaderlang in interface HtmlColumn

getHeaderonclick

public java.lang.String getHeaderonclick()

Specified by:

getHeaderonclick in interface HtmlColumn

setHeaderonclick

public void setHeaderonclick(java.lang.String headeronclick)

Specified by:

setHeaderonclick in interface HtmlColumn

getHeaderondblclick

public java.lang.String getHeaderondblclick()

Specified by:

getHeaderondblclick in interface HtmlColumn

setHeaderondblclick

public void setHeaderondblclick(java.lang.String headerondblclick)

Specified by:

setHeaderondblclick in interface HtmlColumn

getHeaderonkeydown

public java.lang.String getHeaderonkeydown()

Specified by:

getHeaderonkeydown in interface HtmlColumn

setHeaderonkeydown

public void setHeaderonkeydown(java.lang.String headeronkeydown)

Specified by:

setHeaderonkeydown in interface HtmlColumn

getHeaderonkeypress

public java.lang.String getHeaderonkeypress()

Specified by:

getHeaderonkeypress in interface HtmlColumn

setHeaderonkeypress

public void setHeaderonkeypress(java.lang.String headeronkeypress)

Specified by:

setHeaderonkeypress in interface HtmlColumn

getHeaderonkeyup

public java.lang.String getHeaderonkeyup()

Specified by:

getHeaderonkeyup in interface HtmlColumn

setHeaderonkeyup

public void setHeaderonkeyup(java.lang.String headeronkeyup)

Specified by:

setHeaderonkeyup in interface HtmlColumn

getHeaderonmousedown

public java.lang.String getHeaderonmousedown()

Specified by:

getHeaderonmousedown in interface HtmlColumn

setHeaderonmousedown

public void setHeaderonmousedown(java.lang.String headeronmousedown)

Specified by:

setHeaderonmousedown in interface HtmlColumn

getHeaderonmousemove

public java.lang.String getHeaderonmousemove()

Specified by:

getHeaderonmousemove in interface HtmlColumn

setHeaderonmousemove

public void setHeaderonmousemove(java.lang.String headeronmousemove)

Specified by:

setHeaderonmousemove in interface HtmlColumn

getHeaderonmouseout

public java.lang.String getHeaderonmouseout()

Specified by:

getHeaderonmouseout in interface HtmlColumn

setHeaderonmouseout

public void setHeaderonmouseout(java.lang.String headeronmouseout)

Specified by:

setHeaderonmouseout in interface HtmlColumn

getHeaderonmouseover

public java.lang.String getHeaderonmouseover()

Specified by:

getHeaderonmouseover in interface HtmlColumn

setHeaderonmouseover

public void setHeaderonmouseover(java.lang.String headeronmouseover)

Specified by:

setHeaderonmouseover in interface HtmlColumn

getHeaderonmouseup

public java.lang.String getHeaderonmouseup()

Specified by:

getHeaderonmouseup in interface HtmlColumn

setHeaderonmouseup

public void setHeaderonmouseup(java.lang.String headeronmouseup)

Specified by:

setHeaderonmouseup in interface HtmlColumn

getHeaderstyle

public java.lang.String getHeaderstyle()

Specified by:

getHeaderstyle in interface HtmlColumn

setHeaderstyle

public void setHeaderstyle(java.lang.String headerstyle)

Specified by:

setHeaderstyle in interface HtmlColumn

getHeaderstyleClass

public java.lang.String getHeaderstyleClass()

Description copied from interface: HtmlColumn

Corresponds to the HTML class attribute.

Specified by:

getHeaderstyleClass in interface HtmlColumn

setHeaderstyleClass

public void setHeaderstyleClass(java.lang.String headerstyleClass)

Specified by:

setHeaderstyleClass in interface HtmlColumn

getHeadertitle

public java.lang.String getHeadertitle()

Specified by:

getHeadertitle in interface HtmlColumn

setHeadertitle

public void setHeadertitle(java.lang.String headertitle)

Specified by:

setHeadertitle in interface HtmlColumn

getDir

public java.lang.String getDir()

Description copied from interface: HtmlColumn

HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Specified by:

getDir in interface HtmlColumn

setDir

public void setDir(java.lang.String dir)

Specified by:

setDir in interface HtmlColumn

getLang

public java.lang.String getLang()

Description copied from interface: HtmlColumn

HTML: The base language of this document.

Specified by:

getLang in interface HtmlColumn

setLang

public void setLang(java.lang.String lang)

Specified by:

setLang in interface HtmlColumn

getOnclick

public java.lang.String getOnclick()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the element is clicked.

Specified by:

getOnclick in interface HtmlColumn

setOnclick

public void setOnclick(java.lang.String onclick)

Specified by:

setOnclick in interface HtmlColumn

getOndblclick

public java.lang.String getOndblclick()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the element is double-clicked.

Specified by:

getOndblclick in interface HtmlColumn

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Specified by:

setOndblclick in interface HtmlColumn

getOnkeydown

public java.lang.String getOnkeydown()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when a key is pressed down over this element.

Specified by:

getOnkeydown in interface HtmlColumn

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Specified by:

setOnkeydown in interface HtmlColumn

getOnkeypress

public java.lang.String getOnkeypress()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when a key is pressed over this element.

Specified by:

getOnkeypress in interface HtmlColumn

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Specified by:

setOnkeypress in interface HtmlColumn

getOnkeyup

public java.lang.String getOnkeyup()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when a key is released over this element.

Specified by:

getOnkeyup in interface HtmlColumn

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Specified by:

setOnkeyup in interface HtmlColumn

getOnmousedown

public java.lang.String getOnmousedown()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the pointing device is pressed over this element.

Specified by:

getOnmousedown in interface HtmlColumn

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Specified by:

setOnmousedown in interface HtmlColumn

getOnmousemove

public java.lang.String getOnmousemove()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the pointing device is moved while it is in this element.

Specified by:

getOnmousemove in interface HtmlColumn

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Specified by:

setOnmousemove in interface HtmlColumn

getOnmouseout

public java.lang.String getOnmouseout()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the pointing device is moves out of this element.

Specified by:

getOnmouseout in interface HtmlColumn

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Specified by:

setOnmouseout in interface HtmlColumn

getOnmouseover

public java.lang.String getOnmouseover()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the pointing device is moved into this element.

Specified by:

getOnmouseover in interface HtmlColumn

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Specified by:

setOnmouseover in interface HtmlColumn

getOnmouseup

public java.lang.String getOnmouseup()

Description copied from interface: HtmlColumn

HTML: Script to be invoked when the pointing device is released over this element.

Specified by:

getOnmouseup in interface HtmlColumn

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Specified by:

setOnmouseup in interface HtmlColumn

getStyle

public java.lang.String getStyle()

Description copied from interface: HtmlColumn

HTML: CSS styling instructions.

Specified by:

getStyle in interface HtmlColumn

setStyle

public void setStyle(java.lang.String style)

Specified by:

setStyle in interface HtmlColumn

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: HtmlColumn

The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:

getStyleClass in interface HtmlColumn

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Specified by:

setStyleClass in interface HtmlColumn

getTitle

public java.lang.String getTitle()

Description copied from interface: HtmlColumn

HTML: An advisory title for this element. Often used by the user agent as a tooltip.

Specified by:

getTitle in interface HtmlColumn

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface HtmlColumn

getWidth

public java.lang.String getWidth()

Description copied from interface: HtmlColumn

This attribute can be used to set the width of the elements.

Specified by:

getWidth in interface HtmlColumn

setWidth

public void setWidth(java.lang.String width)

Specified by:

setWidth in interface HtmlColumn

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIData

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIData