@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIDataTable extends AbstractDataTable implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxActivatorProps, EventsRowProps, IterationProps, RowsProps, SequenceProps, StyleClassProps, StyleProps, TableStyleProps
The <rich:dataTable> component is used to render a table, including the table's caption. It works in conjunction with the <rich:column> and <rich:columnGroup> components to list the contents of a data model.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UIDataTable.Properties |
UIDataTableBase.PropertyKeysUIDataAdaptor.ComponentVisitor| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
CAPTION_FACET_NAMEBODY, 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 |
|---|
UIDataTable() |
| Modifier and Type | Method and Description |
|---|---|
javax.faces.component.UIComponent |
getCaption() |
String |
getCaptionClass()
Assigns one or more space-separated CSS class names to the component caption
|
String |
getCellClass() |
String |
getColumnClasses()
Assigns one or more space-separated CSS class names to the columns of the table.
|
String |
getColumnFooterCellClass() |
String |
getColumnFooterClass() |
String |
getColumnHeaderCellClass() |
String |
getColumnHeaderClass() |
String |
getColumnHeaderFirstClass() |
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.
|
String |
getFirstColumnFooterClass() |
String |
getFirstRowClass() |
javax.faces.component.UIComponent |
getFooter()
The footer of the table
|
String |
getFooterCellClass() |
String |
getFooterClass()
Space-separated list of CSS style class(es) that will be applied to any footer generated for this column.
|
String |
getFooterFirstClass() |
javax.faces.component.UIComponent |
getHeader()
The header of the table
|
String |
getHeaderCellClass() |
String |
getHeaderClass()
Space-separated list of CSS style class(es) that will be applied to any header generated for this column.
|
String |
getHeaderFirstClass() |
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 |
getOncomplete()
The client-side script method to be called after the DOM is updated
|
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.
|
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.
|
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.
|
boolean |
isLimitRender()
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
|
void |
setCaption(javax.faces.component.UIComponent facet) |
void |
setCaptionClass(String captionClass) |
void |
setCellClass(String cellClass) |
void |
setColumnClasses(String columnClasses) |
void |
setColumnFooterCellClass(String columnFooterCellClass) |
void |
setColumnFooterClass(String columnFooterClass) |
void |
setColumnHeaderCellClass(String columnHeaderCellClass) |
void |
setColumnHeaderClass(String columnHeaderClass) |
void |
setColumnHeaderFirstClass(String columnHeaderFirstClass) |
void |
setData(Object data) |
void |
setFilterVar(String filterVar) |
void |
setFirstColumnFooterClass(String firstColumnFooterClass) |
void |
setFirstRowClass(String firstRowClass) |
void |
setFooter(javax.faces.component.UIComponent facet) |
void |
setFooterCellClass(String footerCellClass) |
void |
setFooterClass(String footerClass) |
void |
setFooterFirstClass(String footerFirstClass) |
void |
setHeader(javax.faces.component.UIComponent facet) |
void |
setHeaderCellClass(String headerCellClass) |
void |
setHeaderClass(String headerClass) |
void |
setHeaderFirstClass(String headerFirstClass) |
void |
setLimitRender(boolean limitRender) |
void |
setNoData(javax.faces.component.UIComponent facet) |
void |
setNoDataLabel(String noDataLabel) |
void |
setOnbeforedomupdate(String onbeforedomupdate) |
void |
setOncomplete(String oncomplete) |
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 |
setRender(Object render) |
void |
setRowClass(String rowClass) |
void |
setRowClasses(String rowClasses) |
void |
setSortMode(SortMode sortMode) |
void |
setSortPriority(Collection<Object> sortPriority) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
addFilteringListener, addSortingListener, columns, createExtendedDataModel, dataChildren, encodeMetaComponent, fixedChildren, getFilteringListeners, getRendersChildren, getSortingAndFilteringRenderTargetId, getSortingListeners, getSupportedMetaComponents, hasRowChildren, isColumnFacetPresent, queueEvent, removeFilteringListener, removeSortingListener, resolveClientId, restoreChildState, substituteUnresolvedClientId, visitDataChildren, visitFixedChildren, walkcaptureOrigValue, createComponentState, createFacesModel, getActualFirst, getActualRows, getFirst, getIterationStatusVar, getRelativeClientId, getRelativeRowIndex, getRowIndex, getRowKeyConverter, getRows, getValue, preEncodeBegin, restoreOrigValue, setFirst, setIterationStatusVar, setRows, setupVariable, setValue, setValueBinding, setValueExpression, updateState, updateStateallFixedChildren, broadcast, clearExtendedDataModel, clearInitialState, createUniqueId, doUpdate, extractKeySegment, getComponentState, getContainerClientId, getContainerClientId, getExtendedDataModel, 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, 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, waitaddClientBehavior, getClientBehaviorsgetFirst, 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 getCaptionClass()
AbstractDataTablegetCaptionClass in class AbstractDataTablepublic void setCaptionClass(String captionClass)
public String getCellClass()
getCellClass in interface TableStylePropspublic void setCellClass(String cellClass)
public String getColumnClasses()
UIDataTableBasegetColumnClasses in class UIDataTableBasepublic void setColumnClasses(String columnClasses)
public String getColumnFooterCellClass()
getColumnFooterCellClass in interface TableStylePropspublic void setColumnFooterCellClass(String columnFooterCellClass)
public String getColumnFooterClass()
getColumnFooterClass in interface TableStylePropspublic void setColumnFooterClass(String columnFooterClass)
public String getColumnHeaderCellClass()
getColumnHeaderCellClass in interface TableStylePropspublic void setColumnHeaderCellClass(String columnHeaderCellClass)
public String getColumnHeaderClass()
getColumnHeaderClass in interface TableStylePropspublic void setColumnHeaderClass(String columnHeaderClass)
public String getColumnHeaderFirstClass()
getColumnHeaderFirstClass in interface TableStylePropspublic void setColumnHeaderFirstClass(String columnHeaderFirstClass)
public Object getData()
AjaxActivatorPropsgetData in interface AjaxActivatorPropspublic void setData(Object data)
public String getFilterVar()
UIDataTableBasegetFilterVar in class UIDataTableBasepublic void setFilterVar(String filterVar)
public String getFirstColumnFooterClass()
getFirstColumnFooterClass in interface TableStylePropspublic void setFirstColumnFooterClass(String firstColumnFooterClass)
public String getFirstRowClass()
getFirstRowClass in interface TableStylePropspublic void setFirstRowClass(String firstRowClass)
public String getFooterCellClass()
getFooterCellClass in interface TableStylePropspublic void setFooterCellClass(String footerCellClass)
public String getFooterClass()
ColumnPropsgetFooterClass in interface ColumnPropspublic void setFooterClass(String footerClass)
public String getFooterFirstClass()
getFooterFirstClass in interface TableStylePropspublic void setFooterFirstClass(String footerFirstClass)
public String getHeaderCellClass()
getHeaderCellClass in interface TableStylePropspublic void setHeaderCellClass(String headerCellClass)
public String getHeaderClass()
ColumnPropsgetHeaderClass in interface ColumnPropspublic void setHeaderClass(String headerClass)
public String getHeaderFirstClass()
getHeaderFirstClass in interface TableStylePropspublic void setHeaderFirstClass(String headerFirstClass)
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 getOncomplete()
AjaxActivatorPropsgetOncomplete in interface AjaxActivatorPropspublic void setOncomplete(String oncomplete)
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 Object getRender()
AjaxActivatorPropsgetRender in interface AjaxActivatorPropspublic void setRender(Object render)
public String getRowClass()
UIDataTableBasegetRowClass in class UIDataTableBasepublic void setRowClass(String rowClass)
public String getRowClasses()
UIDataTableBasegetRowClasses in class UIDataTableBasepublic void setRowClasses(String rowClasses)
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 javax.faces.component.UIComponent getCaption()
getCaption in class AbstractDataTablepublic void setCaption(javax.faces.component.UIComponent facet)
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 © 2014 JBoss by Red Hat. All Rights Reserved.