org.apache.myfaces.custom.column
Class HtmlSimpleColumn

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIColumn
              org.apache.myfaces.custom.column.AbstractHtmlSimpleColumn
                  org.apache.myfaces.custom.column.HtmlSimpleColumn

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, HtmlColumn

public class HtmlSimpleColumn
extends AbstractHtmlSimpleColumn

Nested Class Summary

protected static class

HtmlSimpleColumn.PropertyKeys

Field Summary

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

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

HtmlSimpleColumn()

Method Summary

java.lang.String	getColspan() This attribute specifies the colspan attribute for the cell
java.lang.String	getColumnId() The columnId which will be used as id for the column header.
java.lang.String	getDir() HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getFootercolspan()
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	getHeadercolspan()
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	setColspan(java.lang.String colspan)
void	setColumnId(java.lang.String columnId)
void	setDefaultSorted(boolean defaultSorted)
void	setDir(java.lang.String dir)
void	setFootercolspan(java.lang.String footercolspan)
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	setHeadercolspan(java.lang.String headercolspan)
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.column.AbstractHtmlSimpleColumn

isGroupByValueSet

Methods inherited from class javax.faces.component.UIColumn

getFooter, getHeader, getId, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

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

HtmlSimpleColumn

public HtmlSimpleColumn()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIColumn

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

isGroupBy

public boolean isGroupBy()

Description copied from class: AbstractHtmlSimpleColumn

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

Specified by:

isGroupBy in class AbstractHtmlSimpleColumn

setGroupBy

public void setGroupBy(boolean groupBy)

getGroupByValue

public java.lang.Object getGroupByValue()

Description copied from class: AbstractHtmlSimpleColumn

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 AbstractHtmlSimpleColumn

setGroupByValue

public void setGroupByValue(java.lang.Object groupByValue)

isDefaultSorted

public boolean isDefaultSorted()

Description copied from class: AbstractHtmlSimpleColumn

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

Specified by:

isDefaultSorted in class AbstractHtmlSimpleColumn

setDefaultSorted

public void setDefaultSorted(boolean defaultSorted)

isSortable

public boolean isSortable()

Description copied from class: AbstractHtmlSimpleColumn

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

Specified by:

isSortable in class AbstractHtmlSimpleColumn

setSortable

public void setSortable(boolean sortable)

getSortPropertyName

public java.lang.String getSortPropertyName()

Description copied from class: AbstractHtmlSimpleColumn

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

Specified by:

getSortPropertyName in class AbstractHtmlSimpleColumn

setSortPropertyName

public void setSortPropertyName(java.lang.String sortPropertyName)

getFooterdir

public java.lang.String getFooterdir()

setFooterdir

public void setFooterdir(java.lang.String footerdir)

getFooterlang

public java.lang.String getFooterlang()

setFooterlang

public void setFooterlang(java.lang.String footerlang)

getFooteronclick

public java.lang.String getFooteronclick()

setFooteronclick

public void setFooteronclick(java.lang.String footeronclick)

getFooterondblclick

public java.lang.String getFooterondblclick()

setFooterondblclick

public void setFooterondblclick(java.lang.String footerondblclick)

getFooteronkeydown

public java.lang.String getFooteronkeydown()

setFooteronkeydown

public void setFooteronkeydown(java.lang.String footeronkeydown)

getFooteronkeypress

public java.lang.String getFooteronkeypress()

setFooteronkeypress

public void setFooteronkeypress(java.lang.String footeronkeypress)

getFooteronkeyup

public java.lang.String getFooteronkeyup()

setFooteronkeyup

public void setFooteronkeyup(java.lang.String footeronkeyup)

getFooteronmousedown

public java.lang.String getFooteronmousedown()

setFooteronmousedown

public void setFooteronmousedown(java.lang.String footeronmousedown)

getFooteronmousemove

public java.lang.String getFooteronmousemove()

setFooteronmousemove

public void setFooteronmousemove(java.lang.String footeronmousemove)

getFooteronmouseout

public java.lang.String getFooteronmouseout()

setFooteronmouseout

public void setFooteronmouseout(java.lang.String footeronmouseout)

getFooteronmouseover

public java.lang.String getFooteronmouseover()

setFooteronmouseover

public void setFooteronmouseover(java.lang.String footeronmouseover)

getFooteronmouseup

public java.lang.String getFooteronmouseup()

setFooteronmouseup

public void setFooteronmouseup(java.lang.String footeronmouseup)

getFooterstyle

public java.lang.String getFooterstyle()

setFooterstyle

public void setFooterstyle(java.lang.String footerstyle)

getFooterstyleClass

public java.lang.String getFooterstyleClass()

Description copied from interface: HtmlColumn

Corresponds to the HTML class attribute.

setFooterstyleClass

public void setFooterstyleClass(java.lang.String footerstyleClass)

getFootertitle

public java.lang.String getFootertitle()

setFootertitle

public void setFootertitle(java.lang.String footertitle)

getHeaderdir

public java.lang.String getHeaderdir()

setHeaderdir

public void setHeaderdir(java.lang.String headerdir)

getHeaderlang

public java.lang.String getHeaderlang()

setHeaderlang

public void setHeaderlang(java.lang.String headerlang)

getHeaderonclick

public java.lang.String getHeaderonclick()

setHeaderonclick

public void setHeaderonclick(java.lang.String headeronclick)

getHeaderondblclick

public java.lang.String getHeaderondblclick()

setHeaderondblclick

public void setHeaderondblclick(java.lang.String headerondblclick)

getHeaderonkeydown

public java.lang.String getHeaderonkeydown()

setHeaderonkeydown

public void setHeaderonkeydown(java.lang.String headeronkeydown)

getHeaderonkeypress

public java.lang.String getHeaderonkeypress()

setHeaderonkeypress

public void setHeaderonkeypress(java.lang.String headeronkeypress)

getHeaderonkeyup

public java.lang.String getHeaderonkeyup()

setHeaderonkeyup

public void setHeaderonkeyup(java.lang.String headeronkeyup)

getHeaderonmousedown

public java.lang.String getHeaderonmousedown()

setHeaderonmousedown

public void setHeaderonmousedown(java.lang.String headeronmousedown)

getHeaderonmousemove

public java.lang.String getHeaderonmousemove()

setHeaderonmousemove

public void setHeaderonmousemove(java.lang.String headeronmousemove)

getHeaderonmouseout

public java.lang.String getHeaderonmouseout()

setHeaderonmouseout

public void setHeaderonmouseout(java.lang.String headeronmouseout)

getHeaderonmouseover

public java.lang.String getHeaderonmouseover()

setHeaderonmouseover

public void setHeaderonmouseover(java.lang.String headeronmouseover)

getHeaderonmouseup

public java.lang.String getHeaderonmouseup()

setHeaderonmouseup

public void setHeaderonmouseup(java.lang.String headeronmouseup)

getHeaderstyle

public java.lang.String getHeaderstyle()

setHeaderstyle

public void setHeaderstyle(java.lang.String headerstyle)

getHeaderstyleClass

public java.lang.String getHeaderstyleClass()

Description copied from interface: HtmlColumn

Corresponds to the HTML class attribute.

setHeaderstyleClass

public void setHeaderstyleClass(java.lang.String headerstyleClass)

getHeadertitle

public java.lang.String getHeadertitle()

setHeadertitle

public void setHeadertitle(java.lang.String headertitle)

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).

setDir

public void setDir(java.lang.String dir)

getLang

public java.lang.String getLang()

Description copied from interface: HtmlColumn

HTML: The base language of this document.

setLang

public void setLang(java.lang.String lang)

getOnclick

public java.lang.String getOnclick()

Description copied from interface: HtmlColumn

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

setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()

Description copied from interface: HtmlColumn

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

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

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.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()

Description copied from interface: HtmlColumn

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

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()

Description copied from interface: HtmlColumn

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

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

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.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

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.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

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.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

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.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

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.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

getStyle

public java.lang.String getStyle()

Description copied from interface: HtmlColumn

HTML: CSS styling instructions.

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: HtmlColumn

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

setStyleClass

public void setStyleClass(java.lang.String styleClass)

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.

setTitle

public void setTitle(java.lang.String title)

getWidth

public java.lang.String getWidth()

Description copied from interface: HtmlColumn

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

setWidth

public void setWidth(java.lang.String width)

getColspan

public java.lang.String getColspan()

Description copied from interface: HtmlColumn

This attribute specifies the colspan attribute for the cell

setColspan

public void setColspan(java.lang.String colspan)

getHeadercolspan

public java.lang.String getHeadercolspan()

setHeadercolspan

public void setHeadercolspan(java.lang.String headercolspan)

getFootercolspan

public java.lang.String getFootercolspan()

setFootercolspan

public void setFootercolspan(java.lang.String footercolspan)

getColumnId

public java.lang.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.

setColumnId

public void setColumnId(java.lang.String columnId)