Package com.webmethods.caf.faces.component.table.html

Class AsyncTable

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

javax.faces.component.html.HtmlDataTable

com.webmethods.caf.faces.component.table.html.DataTable

com.webmethods.caf.faces.component.table.html.AsyncTable

All Implemented Interfaces:

IDynamicComponent, IExtendedTable, ITableRowStateHolder, Serializable, EventListener, ClientBehaviorHolder, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

Direct Known Subclasses:

AsyncCategorizedTable, AsyncSearchResultTable, CalendarTable, Newsfeed.NewsfeedTable

public class AsyncTable
extends DataTable

Table that pages through data via asynchronous requests.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.component.table.html.DataTable

DataTable.ExportActionEvent, DataTable.ExportActionListener

Nested classes/interfaces inherited from interface com.webmethods.caf.faces.component.table.IExtendedTable

IExtendedTable.RowMovement

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<UIComponent,Boolean>	m_savedSuppressed
protected Boolean	m_savedVisible
static final String	TYPE

Fields inherited from class com.webmethods.caf.faces.component.table.html.DataTable

content, lazyRowIndex, NO_LAZY_INDEX, rowsToCreate, rowsToDelete, rowsToMove, rowsToUpdate, saved, skipRowIndexLookup, sortIds, sortKeys, templateRowId

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

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIData

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
AsyncTable()

Method Summary

Modifier and Type	Method	Description
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)	In addition to the default behavior, ensure that any saved per-row state for our child input components is discarded unless it is needed to rerender the current page with errors.
Collection<UIComponent>	findSuppressed()	Collection of UIComponent suppressed inputs.
int	getBufferChunk()
int	getBufferMax()
int	getBufferMin()
int	getProgressDelay()
String	getProgressMsg()
Collection<String>	getSuppressInputs()
boolean	isAncestorOrSelf(UIComponent c)	True if component is ancestor or self, false otherwise.
boolean	isAsync()
boolean	isClientSideCache()
boolean	isFlashOnChange()
void	setBufferChunk(int bufferChunk)
void	setBufferMax(int bufferMax)
void	setBufferMin(int bufferMin)
void	setClientSideCache(boolean clientSideCache)
void	setFlashOnChange(boolean flashOnChange)
void	setProgressDelay(int progressDelay)
void	setProgressMsg(String progressMsg)
void	setSuppressInputs(Collection<String> suppressInputs)

Methods inherited from class com.webmethods.caf.faces.component.table.html.DataTable

broadcast, clearContent, clearDescendantState, convertCreatedToOriginalRowIds, convertOriginalToCreatedRowIds, filter, fromClientRowId, getCanTemplateRow, getClientId, getContentProvider, getContentProvider, getExportSettings, getFilter, getFirst, getRowCount, getRowData, getRowId, getRowIndex, getRows, getRowsToCreate, getRowsToDelete, getRowsToMove, getRowsToUpdate, getSortInfo, getTableRowState, isNestedWithinUIData, isRowAvailable, isTemplateRow, iterate, keepSaved, populateInitialComponents, prepareForEncode, processColumnChild, processDecodes, processUpdates, processValidators, queueEvent, resetContent, resetRowCaches, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, setFilter, setFirst, setLazyRowIndex, setRowById, setRowIndex, setRows, setRowsToCreate, setRowsToDelete, setRowsToMove, setRowsToUpdate, setTableRowState, setTemplateRow, setTemplateRowId, setValue, setValueBinding, setValueExpression, sort, toClientRowId, updateRowsToCreate

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

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

Methods inherited from class javax.faces.component.UIData

createUniqueId, getDataModel, getFamily, getFooter, getHeader, getValue, getVar, invokeOnComponent, isRowStatePreserved, markInitialState, saveState, setDataModel, setFooter, setHeader, setRowStatePreserved, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

m_savedSuppressed

protected transient Map<UIComponent,Boolean> m_savedSuppressed

m_savedVisible

protected transient Boolean m_savedVisible

Constructor Details

AsyncTable

public AsyncTable()

Method Details

decode

public void decode(FacesContext context)

Overrides:

decode in class UIComponentBase

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Description copied from class: DataTable

In addition to the default behavior, ensure that any saved per-row state for our child input components is discarded unless it is needed to rerender the current page with errors.

Overrides:

encodeBegin in class DataTable

Parameters:

context - FacesContext for the current request

Throws:

IOException - if an input/output error occurs while rendering

findSuppressed

public Collection<UIComponent> findSuppressed()

Collection of UIComponent suppressed inputs. Never null.

isAncestorOrSelf

public boolean isAncestorOrSelf(UIComponent c)

True if component is ancestor or self, false otherwise. Null allowed.

isAsync

public boolean isAsync()

isClientSideCache

public boolean isClientSideCache()

setClientSideCache

public void setClientSideCache(boolean clientSideCache)

getBufferMin

public int getBufferMin()

setBufferMin

public void setBufferMin(int bufferMin)

getBufferMax

public int getBufferMax()

setBufferMax

public void setBufferMax(int bufferMax)

getBufferChunk

public int getBufferChunk()

setBufferChunk

public void setBufferChunk(int bufferChunk)

isFlashOnChange

public boolean isFlashOnChange()

setFlashOnChange

public void setFlashOnChange(boolean flashOnChange)

getProgressDelay

public int getProgressDelay()

setProgressDelay

public void setProgressDelay(int progressDelay)

getProgressMsg

public String getProgressMsg()

setProgressMsg

public void setProgressMsg(String progressMsg)

getSuppressInputs

public Collection<String> getSuppressInputs()

setSuppressInputs

public void setSuppressInputs(Collection<String> suppressInputs)