org.apache.myfaces.custom.autoupdatedatatable
Class AbstractAutoUpdateDataTable

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
                              org.apache.myfaces.custom.autoupdatedatatable.AbstractAutoUpdateDataTable

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, org.apache.myfaces.component.NewspaperTable, org.apache.myfaces.component.UserRoleAware, AjaxComponent, org.apache.myfaces.custom.ExtendedComponentBase

public abstract class AbstractAutoUpdateDataTable
extends org.apache.myfaces.component.html.ext.HtmlDataTable
implements AjaxComponent

Extended data_table that adds some additional features to the standard data_table action: see attribute descriptions for preserveDataModel, sortColumn, sortAscending and preserveSort. NOTE: This component is deprecated. Use periodicalUpdate mechanism of partial page rendering instead

Version:

$Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (Thu, 03 Jul 2008) $

$Log: $

Author:

Jörg Artaker, Thomas Huber

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

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

COMPONENT_FAMILY

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 class javax.faces.component.UIComponent

bindings

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

AbstractAutoUpdateDataTable()

Method Summary

void	decodeAjax(javax.faces.context.FacesContext context)
void	encodeAjax(javax.faces.context.FacesContext context)
abstract java.lang.String	getFrequency() Defines in seconds the interval of reloads.
abstract java.lang.String	getOnSuccess() Define javascript function to call after successful refresh.
void	processRestoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	processSaveState(javax.faces.context.FacesContext context)

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

getAlign, getBodyStyle, getBodyStyleClass, getDatafld, getDataformatas, getDatasrc, getDetailStampLocation, getEnabledOnUserRole, getFamily, getNewspaperColumns, getNewspaperOrientation, getPreviousRowDataVar, getRowCountVar, getRowGroupStyle, getRowGroupStyleClass, getRowId, getRowIndexVar, getRowOnClick, getRowOnDblClick, getRowOnKeyDown, getRowOnKeyPress, getRowOnKeyUp, getRowOnMouseDown, getRowOnMouseMove, getRowOnMouseOut, getRowOnMouseOver, getRowOnMouseUp, getSortedColumnVar, getValueType, getVisibleOnUserRole, isDetailStampExpandedDefault, isEmbedded, isRenderedIfEmpty, isSortable, restoreState, saveState, setAlign, setBodyStyle, setBodyStyleClass, setDatafld, setDataformatas, setDatasrc, setDetailStampExpandedDefault, setDetailStampLocation, setEmbedded, setEnabledOnUserRole, setNewspaperColumns, setNewspaperOrientation, setPreviousRowDataVar, setRenderedIfEmpty, setRowCountVar, setRowGroupStyle, setRowGroupStyleClass, setRowId, setRowIndexVar, setRowOnClick, setRowOnDblClick, setRowOnKeyDown, setRowOnKeyPress, setRowOnKeyUp, setRowOnMouseDown, setRowOnMouseMove, setRowOnMouseOut, setRowOnMouseOver, setRowOnMouseUp, setSortable, setSortedColumnVar, setValueType, setVisibleOnUserRole

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

collapseAllDetails, columnNameToIndex, createDataModel, createSortHeaderComponent, encodeBegin, encodeEnd, expandAllDetails, findComponent, getClientId, getDataModel, getFirst, getForceIdIndexFormula, getPreservedDataModel, getRows, getRowStyle, getRowStyleClass, getSerializableDataModel, getSortColumn, getSortColumnIndex, getSortProperty, getSortPropertyFromEL, getSpacer, getTableContext, getVarDetailToggler, invokeOnComponent, isCurrentDetailExpanded, isDetailExpanded, isExpandedEmpty, isPreserveDataModel, isPreserveSort, isRendered, isSortAscending, isSortHeaderNeeded, isValidChildren, processDecodes, processUpdates, processValidators, restoreDescendantComponentStates, saveDescendantComponentStates, 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, getCaptionClass, getCaptionStyle, 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, setCaptionClass, setCaptionStyle, 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, setValueExpression, setVar

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractAutoUpdateDataTable

public AbstractAutoUpdateDataTable()

Method Detail

processRestoreState

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

Overrides:

processRestoreState in class javax.faces.component.UIComponentBase

Parameters:

context - FacesContext

state - Object

processSaveState

public java.lang.Object processSaveState(javax.faces.context.FacesContext context)

Overrides:

processSaveState in class javax.faces.component.UIComponentBase

Parameters:

context - FacesContext

Returns:

Object

getFrequency

public abstract java.lang.String getFrequency()

Defines in seconds the interval of reloads. if no value is specified 2 seconds will be default.

Returns:

the frequency String

getOnSuccess

public abstract java.lang.String getOnSuccess()

Define javascript function to call after successful refresh.

Returns:

encodeAjax

public void encodeAjax(javax.faces.context.FacesContext context)
                throws java.io.IOException

Specified by:

encodeAjax in interface AjaxComponent

Parameters:

context - FacesContext

Throws:

java.io.IOException

decodeAjax

public void decodeAjax(javax.faces.context.FacesContext context)

Specified by:

decodeAjax in interface AjaxComponent