public abstract class AbstractExtendedDataTable extends UIDataTableBase implements MetaComponentResolver, MetaComponentEncoder, EventsRowProps, RowsProps, StyleProps, StyleClassProps, SequenceProps, IterationProps
The <r:extendedDataTable> component builds on the functionality of the <r:dataTable> component, adding features such as scrolling for the table body (both horizontal and vertical), Ajax loading for vertical scrolling, frozen columns, row selection, and rearranging of columns. It also supports all the basic table features such as sorting, filtering, and paging using the <r:dataScroller> component.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
AbstractExtendedDataTable.PropertyKeys |
UIDataAdaptor.ComponentVisitor| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
OLD_CLIENT_FIRST |
static String |
SCROLL |
static String |
SUBMITTED_CLIENT_FIRST |
BODY, FOOTER, FOOTER_FACET_NAME, HEADER, HEADER_FACET_NAME, NODATA_FACET_NAMEdecodeVisitor, updateVisitor, validateVisitorATTRS_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_KEYMETA_COMPONENT_SEPARATOR_CHAR| Constructor and Description |
|---|
AbstractExtendedDataTable() |
| Modifier and Type | Method and Description |
|---|---|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId) |
protected int |
getActualFirst() |
protected int |
getActualRows() |
int |
getClientFirst() |
int |
getClientRows()
Use to switch Extended Data Table to AJAX lazy-loading mode.
|
abstract String[] |
getColumnsOrder()
Determines the order in which the columns should be rendered, left to right.
|
abstract int |
getFrozenColumns()
Determines how many columns should not be vertically scrollable (should be "frozen").
|
abstract String |
getOnbeforeselectionchange()
The client-side script method to be called before the selection is changed.
|
abstract String |
getOnready()
The client-side script method to be called after the EDT has been initialized, either after a page load, and an ajax update.
|
abstract String |
getOnselectionchange()
The client-side script method to be called after the selection is changed.
|
abstract Collection<Object> |
getSelection()
The collection of keys for currently selected table rows (generated from data model by rowKeyConverter).
|
abstract SelectionMode |
getSelectionMode()
Defines selection mode for the table: none, single (only one row can be selected), multiple (Ctrl/Shift keys are used for
multi-selection), multipleKeyboardFree (clicks are used for multi-selection)
|
abstract String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
abstract String |
getTableState()
ValueBinding pointing at a property of a String to hold table state
|
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Resolves and returns string identifying supported meta-component or
null if provided meta-component name is
not a supported one. |
void |
setClientFirst(int clientFirst) |
void |
setClientRows(int clientRows) |
void |
setFirst(int first) |
void |
setValueBinding(String name,
javax.faces.el.ValueBinding binding) |
void |
setValueExpression(String name,
javax.el.ValueExpression binding) |
protected boolean |
visitDataChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback,
boolean visitRows) |
addFilteringListener, addSortingListener, columns, createExtendedDataModel, dataChildren, fixedChildren, getColumnClasses, getFilteringListeners, getFilterVar, getFooter, getFooterClass, getHeader, getHeaderClass, getNoData, getNoDataLabel, getOnrowclick, getOnrowdblclick, getOnrowkeydown, getOnrowkeypress, getOnrowkeyup, getOnrowmousedown, getOnrowmousemove, getOnrowmouseout, getOnrowmouseover, getOnrowmouseup, getRendersChildren, getRowClass, getRowClasses, getSortingListeners, getSortMode, getSortPriority, getStyle, getSupportedMetaComponents, hasRowChildren, isColumnFacetPresent, queueEvent, removeFilteringListener, removeSortingListener, restoreChildState, substituteUnresolvedClientId, visitFixedChildren, walkcaptureOrigValue, createComponentState, createFacesModel, getFirst, getIterationStatusVar, getRelativeClientId, getRelativeRowIndex, getRowIndex, getRowKeyConverter, getRows, getValue, preEncodeBegin, restoreOrigValue, setIterationStatusVar, setRows, setupVariable, setValue, updateState, updateStateallFixedChildren, broadcast, clearExtendedDataModel, clearInitialState, createUniqueId, doUpdate, extractKeySegment, getComponentState, getContainerClientId, getContainerClientId, getExtendedDataModel, getFamily, getIterationState, getLocalComponentState, getRowCount, getRowData, getRowKey, getRowKeyVar, getStateVar, getVar, getVariablesMap, invokeOnComponent, invokeOnRow, isKeepSaved, isListenerForSource, isRowAvailable, iterate, keepSaved, markInitialState, preDecode, preUpdate, preValidate, processDecodes, processDecodesChildren, processEvent, processEvent, processUpdates, processUpdatesChildren, processValidatesChildren, processValidators, resetChildState, resetDataModel, restoreChildState, restoreState, saveChildState, saveChildState, saveState, setExtendedDataModel, setId, setIterationState, setKeepSaved, setRowKey, setRowKey, setRowKeyConverter, setRowKeyVar, setStateVar, setVar, visitDataChildrenMetaComponents, visitTree, walk, wrapEventaddClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInViewclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsubstituteUnresolvedClientIdgetOnrowclick, getOnrowdblclick, getOnrowkeydown, getOnrowkeypress, getOnrowkeyup, getOnrowmousedown, getOnrowmousemove, getOnrowmouseout, getOnrowmouseover, getOnrowmouseupgetStylegetRowKeyConvertergetFirst, getIterationStatusVar, getRowKeyVar, getStateVar, getValue, getVar, isKeepSavedpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String SCROLL
public static final String SUBMITTED_CLIENT_FIRST
public static final String OLD_CLIENT_FIRST
public abstract int getFrozenColumns()
public abstract String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic abstract SelectionMode getSelectionMode()
public abstract String getOnready()
public abstract String getOnselectionchange()
public abstract String[] getColumnsOrder()
public abstract String getTableState()
public abstract String getOnbeforeselectionchange()
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolvernull if provided meta-component name is
not a supported one.resolveClientId in interface MetaComponentResolverresolveClientId in class UIDataTableBasefacesContext - - current instance of FacesContextcontextComponent - - instance of UIComponent that requested resolution of meta-componentmetaComponentId - - name of meta-component (without leading '@' sign)nullpublic void encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
throws IOException
encodeMetaComponent in interface MetaComponentEncoderencodeMetaComponent in class UIDataTableBaseIOExceptionprotected boolean visitDataChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback,
boolean visitRows)
visitDataChildren in class UIDataTableBaseprotected int getActualFirst()
getActualFirst in class UISequenceprotected int getActualRows()
getActualRows in class UISequencepublic int getClientFirst()
public void setClientFirst(int clientFirst)
public void setFirst(int first)
setFirst in class UISequencepublic int getClientRows()
public void setClientRows(int clientRows)
public void setValueBinding(String name, javax.faces.el.ValueBinding binding)
setValueBinding in class UISequencepublic void setValueExpression(String name, javax.el.ValueExpression binding)
setValueExpression in class UISequencepublic abstract Collection<Object> getSelection()
Copyright © 2014 JBoss by Red Hat. All rights reserved.