org.apache.myfaces.component.html.ext
Class HtmlDataTable

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIData
              javax.faces.component.html.HtmlDataTable
                  org.apache.myfaces.component.html.ext.HtmlDataTableHack
                      org.apache.myfaces.component.html.ext.AbstractHtmlDataTable
                          org.apache.myfaces.component.html.ext.HtmlDataTable

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, NewspaperTable, UserRoleAware, ExtendedComponentBase

public class HtmlDataTable
extends AbstractHtmlDataTable

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlDataTable

DETAIL_STAMP_FACET_NAME, NEWSPAPER_COLUMNS_PROPERTY, NEWSPAPER_ORIENTATION_PROPERTY, SPACER_FACET_NAME

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Fields inherited from interface org.apache.myfaces.component.NewspaperTable

NEWSPAPER_HORIZONTAL_ORIENTATION

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

HtmlDataTable()

Method Summary

String	getAlign() HTML: Specifies the horizontal alignment of this element.
String	getBodyStyle() Corresponds to the HTML style attribute for the table body tag
String	getBodyStyleClass() Corresponds to the HTML class attribute for the table body tag.
String	getDatafld() Reserved for future use.
String	getDataformatas() Reserved for future use.
String	getDatasrc() Reserved for future use.
String	getDetailStampLocation() before|after - where to render the detailStamp, before the actual row or after it.
String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
String	getFamily()
int	getNewspaperColumns() The number of columns to wrap the table over.
String	getNewspaperOrientation() The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical".
String	getPreviousRowDataVar() A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters.
String	getRowCountVar() A parameter name, under which the rowCount is set in request scope similar to the var parameter.
String	getRowGroupStyle() Corresponds to the HTML style attribute for grouped rows.
String	getRowGroupStyleClass() StyleClass for grouped rows.
String	getRowId() The id to use for
String	getRowIndexVar() A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.
String	getRowOnClick() Defines a JavaScript onclick event handler for each table row
String	getRowOnDblClick() Defines a JavaScript ondblclick event handler for each table row
String	getRowOnKeyDown() Defines a JavaScript onkeydown event handler for each table row
String	getRowOnKeyPress() Defines a JavaScript onkeypress event handler for each table row
String	getRowOnKeyUp() Defines a JavaScript onkeyup event handler for each table row
String	getRowOnMouseDown() Defines a JavaScript onmpusedown event handler for each table row
String	getRowOnMouseMove() Defines a JavaScript onmousemove event handler for each table row
String	getRowOnMouseOut() Defines a JavaScript onmouseout event handler for each table row
String	getRowOnMouseOver() Defines a JavaScript onmouseover event handler for each table row
String	getRowOnMouseUp() Defines a JavaScript onmouseup event handler for each table row
String	getSortedColumnVar() A parameter name, under which the a boolean is set in request scope similar to the var parameter.
String	getValueType() Indicate the expected type of the EL expression pointed by value property.
String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
boolean	isDetailStampExpandedDefault() true|false - true if the detailStamp should be expanded by default.
boolean	isEmbedded() Avoids rendering the html table tags, thus, giving you a table rendering just rows.
boolean	isRenderedIfEmpty() Indicates whether this table should be rendered if the underlying DataModel is empty.
boolean	isSortable() Define if the table is sortable or not
void	restoreState(javax.faces.context.FacesContext facesContext, Object state)
Object	saveState(javax.faces.context.FacesContext facesContext)
void	setAlign(String align)
void	setBodyStyle(String bodyStyle)
void	setBodyStyleClass(String bodyStyleClass)
void	setDatafld(String datafld)
void	setDataformatas(String dataformatas)
void	setDatasrc(String datasrc)
void	setDetailStampExpandedDefault(boolean detailStampExpandedDefault)
void	setDetailStampLocation(String detailStampLocation)
void	setEmbedded(boolean embedded)
void	setEnabledOnUserRole(String enabledOnUserRole)
void	setNewspaperColumns(int newspaperColumns)
void	setNewspaperOrientation(String newspaperOrientation)
void	setPreviousRowDataVar(String previousRowDataVar)
void	setRenderedIfEmpty(boolean renderedIfEmpty)
void	setRowCountVar(String rowCountVar)
void	setRowGroupStyle(String rowGroupStyle)
void	setRowGroupStyleClass(String rowGroupStyleClass)
void	setRowId(String rowId)
void	setRowIndexVar(String rowIndexVar)
void	setRowOnClick(String rowOnClick)
void	setRowOnDblClick(String rowOnDblClick)
void	setRowOnKeyDown(String rowOnKeyDown)
void	setRowOnKeyPress(String rowOnKeyPress)
void	setRowOnKeyUp(String rowOnKeyUp)
void	setRowOnMouseDown(String rowOnMouseDown)
void	setRowOnMouseMove(String rowOnMouseMove)
void	setRowOnMouseOut(String rowOnMouseOut)
void	setRowOnMouseOver(String rowOnMouseOver)
void	setRowOnMouseUp(String rowOnMouseUp)
void	setSortable(boolean sortable)
void	setSortedColumnVar(String sortedColumnVar)
void	setValueType(String valueType)
void	setVisibleOnUserRole(String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlDataTable

collapseAllDetails, columnNameToIndex, createDataModel, createSortHeaderComponent, encodeBegin, encodeEnd, expandAllDetails, findComponent, getClientId, getDataModel, getDetailStamp, getFirst, getForceIdIndexFormula, getPreservedDataModel, getRows, getRowStyle, getRowStyleClass, getSerializableDataModel, getSortColumn, getSortColumnIndex, getSortProperty, getSortPropertyFromEL, getSpacer, getTableContext, getVarDetailToggler, isCurrentDetailExpanded, isDetailExpanded, isExpandedEmpty, isPreserveDataModel, isPreserveSort, isRendered, isSortAscending, isSortHeaderNeeded, isValidChildren, processDecodes, processUpdates, processValidators, restoreDescendantComponentStates, saveDescendantComponentStates, setDetailStamp, setExpandedEmpty, setFirst, setForceIdIndexFormula, setIsValidChildren, setPreserveDataModel, setPreservedDataModel, setPreserveSort, setRowIndex, setRows, setRowStyle, setRowStyleClass, setSortAscending, setSortColumn, setSortColumnIndex, setSortProperty, setSpacer, setVarDetailToggler, toggleDetail

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlDataTableHack

checkUpdateModelError, clearRowStates, deleteRowStateForRow, getDerivedRowKeyPrefix, getDerivedSubClientId, getRowCount, getRowData, getRowIndex, getRowKey, hasErrorMessages, isForceId, isForceIdIndex, isPreserveRowStates, isRowAvailable, restoreDescendantComponentStates, saveDescendantComponentStates, setDataModel, setDerivedRowKeyPrefix, setForceId, setForceIdIndex, setPreserveRowStates, setRowKey, setValue, setValueBinding

Methods inherited from class javax.faces.component.html.HtmlDataTable

getBgcolor, getBorder, getCellpadding, getCellspacing, getColumnClasses, getDir, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBorder, setCellpadding, setCellspacing, setColumnClasses, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth

Methods inherited from class javax.faces.component.UIData

broadcast, getFooter, getHeader, getValue, getVar, queueEvent, setFooter, setHeader, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeChildren, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlDataTable

public HtmlDataTable()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

isSortable

public boolean isSortable()

Description copied from class: AbstractHtmlDataTable

Define if the table is sortable or not

Specified by:

isSortable in class AbstractHtmlDataTable

setSortable

public void setSortable(boolean sortable)

isEmbedded

public boolean isEmbedded()

Description copied from class: AbstractHtmlDataTable

Avoids rendering the html table tags, thus, giving you a table rendering just rows. You can use this together with the detailStamp faces of the parent datatable to render child-tables using the same layout as the parent. Notice: You have to ensure both tables do have the same number of columns. Using the colspan attribute of the column tag might help alot.

Specified by:

isEmbedded in class AbstractHtmlDataTable

setEmbedded

public void setEmbedded(boolean embedded)

isDetailStampExpandedDefault

public boolean isDetailStampExpandedDefault()

Description copied from class: AbstractHtmlDataTable

true|false - true if the detailStamp should be expanded by default. default: false

Specified by:

isDetailStampExpandedDefault in class AbstractHtmlDataTable

setDetailStampExpandedDefault

public void setDetailStampExpandedDefault(boolean detailStampExpandedDefault)

getDetailStampLocation

public String getDetailStampLocation()

Description copied from class: AbstractHtmlDataTable

before|after - where to render the detailStamp, before the actual row or after it. default: after

Specified by:

getDetailStampLocation in class AbstractHtmlDataTable

setDetailStampLocation

public void setDetailStampLocation(String detailStampLocation)

getRowOnMouseOver

public String getRowOnMouseOver()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onmouseover event handler for each table row

Specified by:

getRowOnMouseOver in class AbstractHtmlDataTable

setRowOnMouseOver

public void setRowOnMouseOver(String rowOnMouseOver)

getRowOnMouseOut

public String getRowOnMouseOut()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onmouseout event handler for each table row

Specified by:

getRowOnMouseOut in class AbstractHtmlDataTable

setRowOnMouseOut

public void setRowOnMouseOut(String rowOnMouseOut)

getRowOnClick

public String getRowOnClick()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onclick event handler for each table row

Specified by:

getRowOnClick in class AbstractHtmlDataTable

setRowOnClick

public void setRowOnClick(String rowOnClick)

getRowOnDblClick

public String getRowOnDblClick()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript ondblclick event handler for each table row

Specified by:

getRowOnDblClick in class AbstractHtmlDataTable

setRowOnDblClick

public void setRowOnDblClick(String rowOnDblClick)

getRowOnKeyDown

public String getRowOnKeyDown()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onkeydown event handler for each table row

Specified by:

getRowOnKeyDown in class AbstractHtmlDataTable

setRowOnKeyDown

public void setRowOnKeyDown(String rowOnKeyDown)

getRowOnKeyPress

public String getRowOnKeyPress()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onkeypress event handler for each table row

Specified by:

getRowOnKeyPress in class AbstractHtmlDataTable

setRowOnKeyPress

public void setRowOnKeyPress(String rowOnKeyPress)

getRowOnKeyUp

public String getRowOnKeyUp()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onkeyup event handler for each table row

Specified by:

getRowOnKeyUp in class AbstractHtmlDataTable

setRowOnKeyUp

public void setRowOnKeyUp(String rowOnKeyUp)

getRowOnMouseDown

public String getRowOnMouseDown()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onmpusedown event handler for each table row

Specified by:

getRowOnMouseDown in class AbstractHtmlDataTable

setRowOnMouseDown

public void setRowOnMouseDown(String rowOnMouseDown)

getRowOnMouseMove

public String getRowOnMouseMove()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onmousemove event handler for each table row

Specified by:

getRowOnMouseMove in class AbstractHtmlDataTable

setRowOnMouseMove

public void setRowOnMouseMove(String rowOnMouseMove)

getRowOnMouseUp

public String getRowOnMouseUp()

Description copied from class: AbstractHtmlDataTable

Defines a JavaScript onmouseup event handler for each table row

Specified by:

getRowOnMouseUp in class AbstractHtmlDataTable

setRowOnMouseUp

public void setRowOnMouseUp(String rowOnMouseUp)

getRowGroupStyle

public String getRowGroupStyle()

Description copied from class: AbstractHtmlDataTable

Corresponds to the HTML style attribute for grouped rows.

Specified by:

getRowGroupStyle in class AbstractHtmlDataTable

setRowGroupStyle

public void setRowGroupStyle(String rowGroupStyle)

getRowGroupStyleClass

public String getRowGroupStyleClass()

Description copied from class: AbstractHtmlDataTable

StyleClass for grouped rows.

Specified by:

getRowGroupStyleClass in class AbstractHtmlDataTable

setRowGroupStyleClass

public void setRowGroupStyleClass(String rowGroupStyleClass)

getBodyStyle

public String getBodyStyle()

Description copied from class: AbstractHtmlDataTable

Corresponds to the HTML style attribute for the table body tag

Specified by:

getBodyStyle in class AbstractHtmlDataTable

setBodyStyle

public void setBodyStyle(String bodyStyle)

getBodyStyleClass

public String getBodyStyleClass()

Description copied from class: AbstractHtmlDataTable

Corresponds to the HTML class attribute for the table body tag.

Specified by:

getBodyStyleClass in class AbstractHtmlDataTable

setBodyStyleClass

public void setBodyStyleClass(String bodyStyleClass)

getNewspaperColumns

public int getNewspaperColumns()

Description copied from class: AbstractHtmlDataTable

The number of columns to wrap the table over. Default: 1 Set the number of columns the table will be divided over.

Specified by:

getNewspaperColumns in interface NewspaperTable

Specified by:

getNewspaperColumns in class AbstractHtmlDataTable

setNewspaperColumns

public void setNewspaperColumns(int newspaperColumns)

getNewspaperOrientation

public String getNewspaperOrientation()

Description copied from class: AbstractHtmlDataTable

The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". Default: vertical

Specified by:

getNewspaperOrientation in interface NewspaperTable

Specified by:

getNewspaperOrientation in class AbstractHtmlDataTable

setNewspaperOrientation

public void setNewspaperOrientation(String newspaperOrientation)

isRenderedIfEmpty

public boolean isRenderedIfEmpty()

Description copied from class: AbstractHtmlDataTable

Indicates whether this table should be rendered if the underlying DataModel is empty. You could as well use rendered="#{not empty bean.list}", but this one causes the getList method of your model bean beeing called up to five times per request, which is not optimal when the list is backed by a DB table. Using renderedIfEmpty="false" solves this problem, because the MyFaces extended HtmlDataTable automatically caches the DataModel and calles the model getter only once per request. Default: true

Specified by:

isRenderedIfEmpty in class AbstractHtmlDataTable

setRenderedIfEmpty

public void setRenderedIfEmpty(boolean renderedIfEmpty)

getRowIndexVar

public String getRowIndexVar()

Description copied from class: AbstractHtmlDataTable

A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.

Specified by:

getRowIndexVar in class AbstractHtmlDataTable

setRowIndexVar

public void setRowIndexVar(String rowIndexVar)

getRowCountVar

public String getRowCountVar()

Description copied from class: AbstractHtmlDataTable

A parameter name, under which the rowCount is set in request scope similar to the var parameter.

Specified by:

getRowCountVar in class AbstractHtmlDataTable

setRowCountVar

public void setRowCountVar(String rowCountVar)

getPreviousRowDataVar

public String getPreviousRowDataVar()

Description copied from class: AbstractHtmlDataTable

A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters. Mind that the value of this request scope attribute is null in the first row or when isRowAvailable returns false for the previous row.

Specified by:

getPreviousRowDataVar in class AbstractHtmlDataTable

setPreviousRowDataVar

public void setPreviousRowDataVar(String previousRowDataVar)

getSortedColumnVar

public String getSortedColumnVar()

Description copied from class: AbstractHtmlDataTable

A parameter name, under which the a boolean is set in request scope similar to the var parameter. TRUE for the column that is currently sorted, FALSE otherwise.

Specified by:

getSortedColumnVar in class AbstractHtmlDataTable

setSortedColumnVar

public void setSortedColumnVar(String sortedColumnVar)

getAlign

public String getAlign()

Description copied from class: AbstractHtmlDataTable

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

Specified by:

getAlign in class AbstractHtmlDataTable

setAlign

public void setAlign(String align)

getRowId

public String getRowId()

Description copied from class: AbstractHtmlDataTable

The id to use for

Specified by:

getRowId in class AbstractHtmlDataTable

setRowId

public void setRowId(String rowId)

getDatafld

public String getDatafld()

Description copied from class: AbstractHtmlDataTable

Reserved for future use.

Specified by:

getDatafld in class AbstractHtmlDataTable

setDatafld

public void setDatafld(String datafld)

getDatasrc

public String getDatasrc()

Description copied from class: AbstractHtmlDataTable

Reserved for future use.

Specified by:

getDatasrc in class AbstractHtmlDataTable

setDatasrc

public void setDatasrc(String datasrc)

getDataformatas

public String getDataformatas()

Description copied from class: AbstractHtmlDataTable

Reserved for future use.

Specified by:

getDataformatas in class AbstractHtmlDataTable

setDataformatas

public void setDataformatas(String dataformatas)

getValueType

public String getValueType()

Description copied from class: AbstractHtmlDataTable

Indicate the expected type of the EL expression pointed by value property. It is useful when vb.getType() cannot found the type, like when a map value is resolved on the expression.

Specified by:

getValueType in class AbstractHtmlDataTable

setValueType

public void setValueType(String valueType)

getEnabledOnUserRole

public String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractHtmlDataTable

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class AbstractHtmlDataTable