org.apache.myfaces.custom.autoupdatedatatable
Class AutoUpdateDataTable

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

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 class AutoUpdateDataTable
extends AbstractAutoUpdateDataTable

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.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

AutoUpdateDataTable()

Method Summary

java.lang.String	getFamily()
java.lang.String	getFrequency() Defines in seconds the interval of reloads.
java.lang.String	getOnSuccess() Define javascript function to call after successful refresh.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setFrequency(java.lang.String frequency)
void	setOnSuccess(java.lang.String onSuccess)

Methods inherited from class org.apache.myfaces.custom.autoupdatedatatable.AbstractAutoUpdateDataTable

decodeAjax, encodeAjax, processRestoreState, processSaveState

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

getAlign, getBodyStyle, getBodyStyleClass, getDatafld, getDataformatas, getDatasrc, getDetailStampLocation, getEnabledOnUserRole, 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, 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, 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, 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, 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 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

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

AutoUpdateDataTable

public AutoUpdateDataTable()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.component.html.ext.HtmlDataTable

getFrequency

public java.lang.String getFrequency()

Description copied from class: AbstractAutoUpdateDataTable

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

Specified by:

getFrequency in class AbstractAutoUpdateDataTable

Returns:

the frequency String

setFrequency

public void setFrequency(java.lang.String frequency)

getOnSuccess

public java.lang.String getOnSuccess()

Description copied from class: AbstractAutoUpdateDataTable

Define javascript function to call after successful refresh.

Specified by:

getOnSuccess in class AbstractAutoUpdateDataTable

Returns:

setOnSuccess

public void setOnSuccess(java.lang.String onSuccess)

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class org.apache.myfaces.component.html.ext.HtmlDataTable

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 org.apache.myfaces.component.html.ext.HtmlDataTable