teamdev.jsf.component.datatable
Class DataTable

java.lang.Object
  UIData
      teamdev.jsf.component.datatable.QUIData
          teamdev.jsf.component.datatable.AbstractTable
              teamdev.jsf.component.datatable.DataTable

All Implemented Interfaces:

TableStyles

public class DataTable
extends AbstractTable

Field Summary

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

Constructor Summary

DataTable()

Method Summary

void	encodeBegin(FacesContext facesContext) Perform necessary actions when rendering of this component starts, before delegating to the inherited implementation which calls the associated renderer's encodeBegin method.
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
boolean	getCustomDataProviding()
java.lang.String	getFamily()
int	getPageCount()
int	getPageIndex()
int	getPageSize()
java.lang.String	getRowIndexVar()
java.util.List	getRowListForFiltering(teamdev.jsf.component.datatable.DataTableFilter filter)
ValueBinding	getValueBinding()
boolean	isDataSourceEmpty()
boolean	isPaginationKeyboardSupport()
void	restoreState(FacesContext facesContext, java.lang.Object object)
java.lang.Object	saveState(FacesContext facesContext)
void	setCustomDataProviding(boolean customDataProviding)
void	setPageIndex(int pageIndex)
void	setPageSize(int pageSize)
void	setPaginationKeyboardSupport(boolean paginationKeyboardSupport)
void	setRowIndex(int rowIndex) Set the current row index that methods like getRowData use.
void	setRowIndexVar(java.lang.String rowIndexVar)
void	setValueBinding(java.lang.String name, ValueBinding binding)
void	setValueBinding(ValueBinding value)

Methods inherited from class teamdev.jsf.component.datatable.AbstractTable

getAlign, getAllColumns, getAllRecordsFilterName, getApplyDefaultStyle, getBgcolor, getBodyOddRowClass, getBodyOddRowStyle, getBodyRowClass, getBodyRowStyle, getBodySectionClass, getBodySectionStyle, getBorder, getCellpadding, getCellspacing, getClientId, getColumnIdVar, getColumnIndexVar, getColumnResizing, getColumnsForRendering, getColumnsOrder, getCommonFooterRowClass, getCommonFooterRowStyle, getCommonFooterSeparator, getCommonHeaderRowClass, getCommonHeaderRowStyle, getCommonHeaderSeparator, getDir, getEmptyRecordsFilterName, getFilteredValueByData, getFilterRowClass, getFilterRowSeparator, getFilterRowStyle, getFocusedClass, getFocusedStyle, getFooterHorizSeparator, getFooterRowClass, getFooterRowStyle, getFooterSectionClass, getFooterSectionStyle, getFooterVertSeparator, getHeaderHorizSeparator, getHeaderRowClass, getHeaderRowStyle, getHeaderSectionClass, getHeaderSectionStyle, getHeaderVertSeparator, getHorizontalGridLines, getMultiFooterSeparator, getMultiHeaderSeparator, getNoDataMessage, getNoDataMessageAllowed, getNoDataRowClass, getNoDataRowStyle, getNoFilterDataMessage, getNonEmptyRecordsFilterName, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRolloverClass, getRolloverRowClass, getRolloverRowStyle, getRolloverStyle, getRowOnclick, getRowOndblclick, getRowOnmousedown, getRowOnmousemove, getRowOnmouseout, getRowOnmouseover, getRowOnmouseup, getRules, getSelection, getSortableHeaderClass, getSortableHeaderRolloverClass, getSortableHeaderRolloverStyle, getSortableHeaderStyle, getSortColumnId, getSortColumnIndex, getSortedAscendingImageUrl, getSortedColumnBodyClass, getSortedColumnBodyStyle, getSortedColumnClass, getSortedColumnFooterClass, getSortedColumnFooterStyle, getSortedColumnHeaderClass, getSortedColumnHeaderStyle, getSortedColumnStyle, getSortedDescendingImageUrl, getStyle, getStyleClass, getTotalRowCount, getUseAjax, getValue, getVerticalGridLines, getWidth, invokeBeforeProcessDecodes, invokeBeforeRenderResponse, isSortAscending, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, setAlign, setAllRecordsFilterName, setApplyDefaultStyle, setBgcolor, setBodyOddRowClass, setBodyOddRowStyle, setBodyRowClass, setBodyRowStyle, setBodySectionClass, setBodySectionStyle, setBorder, setCellpadding, setCellspacing, setColumnIdVar, setColumnIndexVar, setColumnsOrder, setCommonFooterRowClass, setCommonFooterRowStyle, setCommonFooterSeparator, setCommonHeaderRowClass, setCommonHeaderRowStyle, setCommonHeaderSeparator, setDir, setEmptyRecordsFilterName, setFilterRowClass, setFilterRowSeparator, setFilterRowStyle, setFocusedClass, setFocusedStyle, setFooterHorizSeparator, setFooterRowClass, setFooterRowStyle, setFooterSectionClass, setFooterSectionStyle, setFooterVertSeparator, setHeaderHorizSeparator, setHeaderRowClass, setHeaderRowStyle, setHeaderSectionClass, setHeaderSectionStyle, setHeaderVertSeparator, setHorizontalGridLines, setId, setMultiFooterSeparator, setMultiHeaderSeparator, setNoDataMessageAllowed, setNoDataRowClass, setNoDataRowStyle, setNonEmptyRecordsFilterName, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRolloverClass, setRolloverRowClass, setRolloverRowStyle, setRolloverStyle, setRowOnclick, setRowOndblclick, setRowOnmousedown, setRowOnmousemove, setRowOnmouseout, setRowOnmouseover, setRowOnmouseup, setRules, setSelection, setSortableHeaderClass, setSortableHeaderRolloverClass, setSortableHeaderRolloverStyle, setSortableHeaderStyle, setSortAscending, setSortColumnId, setSortColumnIndex, setSortedAscendingImageUrl, setSortedColumnBodyClass, setSortedColumnBodyStyle, setSortedColumnClass, setSortedColumnFooterClass, setSortedColumnFooterStyle, setSortedColumnHeaderClass, setSortedColumnHeaderStyle, setSortedColumnStyle, setSortedDescendingImageUrl, setStyle, setStyleClass, setUseAjax, setValue, setVerticalGridLines, setWidth, toggleSorting

Methods inherited from class teamdev.jsf.component.datatable.QUIData

broadcast, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getUiDataValue, getVar, isRowAvailable, isRowAvailableAfterRestoring, queueEvent, restoreDescendantComponentStates, saveDescendantComponentStates, setFirst, setFooter, setHeader, setRows, setUiDataValue, setVar

Methods inherited from class java.lang.Object

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

Methods inherited from interface teamdev.jsf.component.util.TableStyles

getFooter, getHeader

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

DataTable

public DataTable()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class QUIData

setValueBinding

public void setValueBinding(java.lang.String name,
                            ValueBinding binding)

Overrides:

setValueBinding in class QUIData

saveState

public java.lang.Object saveState(FacesContext facesContext)

Overrides:

saveState in class AbstractTable

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object object)

Overrides:

restoreState in class AbstractTable

getPageSize

public int getPageSize()

Returns:

Returns the size of a page if the table is being paged and zero if the table is not being paged.

setPageSize

public void setPageSize(int pageSize)

getPageIndex

public int getPageIndex()

setPageIndex

public void setPageIndex(int pageIndex)

getRowIndexVar

public java.lang.String getRowIndexVar()

setRowIndexVar

public void setRowIndexVar(java.lang.String rowIndexVar)

isPaginationKeyboardSupport

public boolean isPaginationKeyboardSupport()

setPaginationKeyboardSupport

public void setPaginationKeyboardSupport(boolean paginationKeyboardSupport)

getPageCount

public int getPageCount()

Returns:

the number of pages if paging is currently enabled. If paging is disabled (by setting pageSize to 0) or if the total number of rows is unknown then -1 is returned. Note the that if paging is enabled then there will always be at least one page even if there are no rows to show.

getValueBinding

public ValueBinding getValueBinding()

setValueBinding

public void setValueBinding(ValueBinding value)

encodeBegin

public void encodeBegin(FacesContext facesContext)
                 throws java.io.IOException

Description copied from class: QUIData

Perform necessary actions when rendering of this component starts, before delegating to the inherited implementation which calls the associated renderer's encodeBegin method.

Overrides:

encodeBegin in class AbstractTable

Throws:

java.io.IOException

encodeChildren

public void encodeChildren(FacesContext context)
                    throws java.io.IOException

Throws:

java.io.IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws java.io.IOException

Overrides:

encodeEnd in class QUIData

Throws:

java.io.IOException

See Also:

javax.faces.component.UIComponentBase#encodeEnd(javax.faces.context.FacesContext)

getRowListForFiltering

public java.util.List getRowListForFiltering(teamdev.jsf.component.datatable.DataTableFilter filter)

Specified by:

getRowListForFiltering in class AbstractTable

isDataSourceEmpty

public boolean isDataSourceEmpty()

Specified by:

isDataSourceEmpty in class AbstractTable

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from class: QUIData

Set the current row index that methods like getRowData use.

Param rowIndex can be -1, meaning "no row".

Overrides:

setRowIndex in class QUIData

getCustomDataProviding

public boolean getCustomDataProviding()

setCustomDataProviding

public void setCustomDataProviding(boolean customDataProviding)