@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIExtendedDataTable extends AbstractExtendedDataTable implements javax.faces.component.behavior.ClientBehaviorHolder, MetaComponentEncoder, MetaComponentResolver, AjaxActivatorProps, EventsRowProps, IterationProps, RowsProps, SequenceProps, StyleClassProps, StyleProps
The <rich:extendedDataTable> component builds on the functionality of the <rich: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 <rich:dataScroller> component.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UIExtendedDataTable.Properties |
AbstractExtendedDataTable.PropertyKeysUIDataAdaptor.ComponentVisitor| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
OLD_CLIENT_FIRST, SCROLL, SUBMITTED_CLIENT_FIRSTBODY, 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 |
|---|
UIExtendedDataTable() |
| Modifier and Type | Method and Description |
|---|---|
String |
getColumnClasses()
Assigns one or more space-separated CSS class names to the columns of the table.
|
String[] |
getColumnsOrder()
Determines the order in which the columns should be rendered, left to right.
|
Object |
getData()
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getFilterVar()
Name of the variable used in EL expression provided in filterExpression in order to decide about displaying particular
row.
|
javax.faces.component.UIComponent |
getFooter()
The footer of the table
|
String |
getFooterClass()
Space-separated list of CSS style class(es) that will be applied to any footer generated for this column.
|
int |
getFrozenColumns()
Determines how many columns should not be vertically scrollable (should be "frozen").
|
javax.faces.component.UIComponent |
getHeader()
The header of the table
|
String |
getHeaderClass()
Space-separated list of CSS style class(es) that will be applied to any header generated for this column.
|
javax.faces.component.UIComponent |
getNoData()
The content to be displayed when table contains no rows (no data provided).
|
String |
getNoDataLabel()
The label to be displayed when table contains no rows (no data provided).
|
String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
|
String |
getOnbeforeselectionchange()
The client-side script method to be called before the selection is changed.
|
String |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
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.
|
String |
getOnrowclick()
Javascript code executed when a pointer button is clicked over table row.
|
String |
getOnrowdblclick()
Javascript code executed when a pointer button is double clicked over table row.
|
String |
getOnrowkeydown()
Javascript code executed when a key is pressed down over table row.
|
String |
getOnrowkeypress()
Javascript code executed when a key is pressed and released over table row.
|
String |
getOnrowkeyup()
Javascript code executed when a key is released over table row.
|
String |
getOnrowmousedown()
Javascript code executed when a pointer button is pressed down over table row.
|
String |
getOnrowmousemove()
Javascript code executed when a pointer button is moved within table row.
|
String |
getOnrowmouseout()
Javascript code executed when a pointer button is moved away from table row.
|
String |
getOnrowmouseover()
Javascript code executed when a pointer button is moved onto table row.
|
String |
getOnrowmouseup()
Javascript code executed when a pointer button is released over table row.
|
String |
getOnselectionchange()
The client-side script method to be called after the selection is changed.
|
Object |
getRender()
IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
|
String |
getRowClass()
Assigns one or more space-separated CSS class names to the table cells
|
String |
getRowClasses()
Assigns one or more space-separated CSS class names to the rows of the table.
|
Collection<Object> |
getSelection()
The collection of keys for currently selected table rows (generated from data model by rowKeyConverter).
|
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).
|
SortMode |
getSortMode()
Specifies when table will be sorted according to one column (single) or multiple columns (multi).
|
Collection<Object> |
getSortPriority()
Comma-separated list of column names determining priority of row sorting.
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTableState()
ValueBinding pointing at a property of a String to hold table state
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
boolean |
isShowColumnControl()
If "true" a menu for controlling column visibility will be added to the table.
|
void |
setColumnClasses(String columnClasses) |
void |
setColumnsOrder(String[] columnsOrder) |
void |
setData(Object data) |
void |
setFilterVar(String filterVar) |
void |
setFooter(javax.faces.component.UIComponent facet) |
void |
setFooterClass(String footerClass) |
void |
setFrozenColumns(int frozenColumns) |
void |
setHeader(javax.faces.component.UIComponent facet) |
void |
setHeaderClass(String headerClass) |
void |
setLimitRender(boolean limitRender) |
void |
setNoData(javax.faces.component.UIComponent facet) |
void |
setNoDataLabel(String noDataLabel) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOnbeforeselectionchange(String onbeforeselectionchange) |
void |
setOncomplete(String oncomplete) |
void |
setOnready(String onready) |
void |
setOnrowclick(String onrowclick) |
void |
setOnrowdblclick(String onrowdblclick) |
void |
setOnrowkeydown(String onrowkeydown) |
void |
setOnrowkeypress(String onrowkeypress) |
void |
setOnrowkeyup(String onrowkeyup) |
void |
setOnrowmousedown(String onrowmousedown) |
void |
setOnrowmousemove(String onrowmousemove) |
void |
setOnrowmouseout(String onrowmouseout) |
void |
setOnrowmouseover(String onrowmouseover) |
void |
setOnrowmouseup(String onrowmouseup) |
void |
setOnselectionchange(String onselectionchange) |
void |
setRender(Object render) |
void |
setRowClass(String rowClass) |
void |
setRowClasses(String rowClasses) |
void |
setSelection(Collection<Object> selection) |
void |
setSelectionMode(SelectionMode selectionMode) |
void |
setShowColumnControl(boolean showColumnControl) |
void |
setSortMode(SortMode sortMode) |
void |
setSortPriority(Collection<Object> sortPriority) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTableState(String tableState) |
encodeMetaComponent, getActualFirst, getActualRows, getClientFirst, getClientRows, resolveClientId, setClientFirst, setClientRows, setFirst, setValueBinding, setValueExpression, visitDataChildrenaddFilteringListener, addSortingListener, columns, createExtendedDataModel, dataChildren, fixedChildren, getFilteringListeners, getRendersChildren, getSortingAndFilteringRenderTargetId, getSortingListeners, getSupportedMetaComponents, hasRowChildren, isColumnFacetPresent, queueEvent, removeFilteringListener, removeSortingListener, restoreChildState, substituteUnresolvedClientId, visitFixedChildren, walkcaptureOrigValue, createComponentState, createFacesModel, getFirst, getIterationStatusVar, getRelativeClientId, getRowIndex, getRowKeyConverter, getRows, getValue, invokeOnRow, preEncodeBegin, restoreOrigValue, setIterationStatusVar, setRows, setupVariable, setValue, updateState, updateStateallFixedChildren, broadcast, clearExtendedDataModel, clearInitialState, createUniqueId, doUpdate, extractKeySegment, getComponentState, getContainerClientId, getContainerClientId, getExtendedDataModel, getIterationState, getLocalComponentState, getRowCount, getRowData, getRowKey, getRowKeyVar, getStateVar, getVar, getVariablesMap, invokeOnComponent, isKeepSaved, isListenerForSource, isRowAvailable, iterate, keepSaved, markInitialState, matchesBaseId, 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, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransientgetClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviorsencodeMetaComponentresolveClientId, substituteUnresolvedClientIdgetFirst, getIterationStatusVar, getRowKeyVar, getStateVar, getValue, getVar, isKeepSavedgetRowKeyConverterpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class UIDataAdaptorpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getColumnClasses()
RowColumnStylePropsgetColumnClasses in interface RowColumnStylePropspublic void setColumnClasses(String columnClasses)
public String[] getColumnsOrder()
AbstractExtendedDataTablegetColumnsOrder in class AbstractExtendedDataTablepublic void setColumnsOrder(String[] columnsOrder)
public Object getData()
AjaxActivatorPropsgetData in interface AjaxActivatorPropspublic void setData(Object data)
public String getFilterVar()
UIDataTableBasegetFilterVar in class UIDataTableBasepublic void setFilterVar(String filterVar)
public String getFooterClass()
ColumnPropsgetFooterClass in interface ColumnPropspublic void setFooterClass(String footerClass)
public int getFrozenColumns()
AbstractExtendedDataTablegetFrozenColumns in class AbstractExtendedDataTablepublic void setFrozenColumns(int frozenColumns)
public String getHeaderClass()
ColumnPropsgetHeaderClass in interface ColumnPropspublic void setHeaderClass(String headerClass)
public boolean isLimitRender()
AjaxActivatorPropsisLimitRender in interface AjaxActivatorPropspublic void setLimitRender(boolean limitRender)
public String getNoDataLabel()
UIDataTableBasegetNoDataLabel in class UIDataTableBasepublic void setNoDataLabel(String noDataLabel)
public String getOnbeforedomupdate()
AjaxActivatorPropsgetOnbeforedomupdate in interface AjaxActivatorPropspublic void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbeforeselectionchange()
AbstractExtendedDataTablegetOnbeforeselectionchange in class AbstractExtendedDataTablepublic void setOnbeforeselectionchange(String onbeforeselectionchange)
public String getOncomplete()
AjaxActivatorPropsgetOncomplete in interface AjaxActivatorPropspublic void setOncomplete(String oncomplete)
public String getOnready()
AbstractExtendedDataTablegetOnready in class AbstractExtendedDataTablepublic void setOnready(String onready)
public String getOnrowclick()
EventsRowPropsgetOnrowclick in interface EventsRowPropspublic void setOnrowclick(String onrowclick)
public String getOnrowdblclick()
EventsRowPropsgetOnrowdblclick in interface EventsRowPropspublic void setOnrowdblclick(String onrowdblclick)
public String getOnrowkeydown()
EventsRowPropsgetOnrowkeydown in interface EventsRowPropspublic void setOnrowkeydown(String onrowkeydown)
public String getOnrowkeypress()
EventsRowPropsgetOnrowkeypress in interface EventsRowPropspublic void setOnrowkeypress(String onrowkeypress)
public String getOnrowkeyup()
EventsRowPropsgetOnrowkeyup in interface EventsRowPropspublic void setOnrowkeyup(String onrowkeyup)
public String getOnrowmousedown()
EventsRowPropsgetOnrowmousedown in interface EventsRowPropspublic void setOnrowmousedown(String onrowmousedown)
public String getOnrowmousemove()
EventsRowPropsgetOnrowmousemove in interface EventsRowPropspublic void setOnrowmousemove(String onrowmousemove)
public String getOnrowmouseout()
EventsRowPropsgetOnrowmouseout in interface EventsRowPropspublic void setOnrowmouseout(String onrowmouseout)
public String getOnrowmouseover()
EventsRowPropsgetOnrowmouseover in interface EventsRowPropspublic void setOnrowmouseover(String onrowmouseover)
public String getOnrowmouseup()
EventsRowPropsgetOnrowmouseup in interface EventsRowPropspublic void setOnrowmouseup(String onrowmouseup)
public String getOnselectionchange()
AbstractExtendedDataTablegetOnselectionchange in class AbstractExtendedDataTablepublic void setOnselectionchange(String onselectionchange)
public Object getRender()
AjaxActivatorPropsgetRender in interface AjaxActivatorPropspublic void setRender(Object render)
public String getRowClass()
UIDataTableBasegetRowClass in class UIDataTableBasepublic void setRowClass(String rowClass)
public String getRowClasses()
RowColumnStylePropsgetRowClasses in interface RowColumnStylePropspublic void setRowClasses(String rowClasses)
public Collection<Object> getSelection()
AbstractExtendedDataTablegetSelection in class AbstractExtendedDataTablepublic void setSelection(Collection<Object> selection)
public SelectionMode getSelectionMode()
AbstractExtendedDataTablegetSelectionMode in class AbstractExtendedDataTablepublic void setSelectionMode(SelectionMode selectionMode)
public boolean isShowColumnControl()
AbstractExtendedDataTableisShowColumnControl in class AbstractExtendedDataTablepublic void setShowColumnControl(boolean showColumnControl)
public SortMode getSortMode()
UIDataTableBasegetSortMode in class UIDataTableBasepublic void setSortMode(SortMode sortMode)
public Collection<Object> getSortPriority()
UIDataTableBasegetSortPriority in class UIDataTableBasepublic void setSortPriority(Collection<Object> sortPriority)
public String getStyle()
StylePropsgetStyle in interface StylePropspublic void setStyle(String style)
public String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic void setStyleClass(String styleClass)
public String getTableState()
AbstractExtendedDataTablegetTableState in class AbstractExtendedDataTablepublic void setTableState(String tableState)
public javax.faces.component.UIComponent getFooter()
UIDataTableBasegetFooter in class UIDataTableBasepublic void setFooter(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getNoData()
UIDataTableBasegetNoData in class UIDataTableBasepublic void setNoData(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getHeader()
UIDataTableBasegetHeader in class UIDataTableBasepublic void setHeader(javax.faces.component.UIComponent facet)
Copyright © 2016 JBoss by Red Hat. All Rights Reserved.