@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.PropertyKeys
UIDataAdaptor.ComponentVisitor
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
OLD_CLIENT_FIRST, SCROLL, SUBMITTED_CLIENT_FIRST
BODY, FOOTER, FOOTER_FACET_NAME, HEADER, HEADER_FACET_NAME, NODATA_FACET_NAME
decodeVisitor, updateVisitor, validateVisitor
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
META_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, visitDataChildren
addFilteringListener, addSortingListener, columns, createExtendedDataModel, dataChildren, fixedChildren, getFilteringListeners, getRendersChildren, getSortingAndFilteringRenderTargetId, getSortingListeners, getSupportedMetaComponents, hasRowChildren, isColumnFacetPresent, queueEvent, removeFilteringListener, removeSortingListener, restoreChildState, substituteUnresolvedClientId, visitFixedChildren, walk
captureOrigValue, createComponentState, createFacesModel, getFirst, getIterationStatusVar, getRelativeClientId, getRowIndex, getRowKeyConverter, getRows, getValue, invokeOnRow, preEncodeBegin, restoreOrigValue, setIterationStatusVar, setRows, setupVariable, setValue, updateState, updateState
allFixedChildren, 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, wrapEvent
addClientBehavior, 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, setTransient
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClientBehavior, getClientBehaviors
encodeMetaComponent
resolveClientId, substituteUnresolvedClientId
getFirst, getIterationStatusVar, getRowKeyVar, getStateVar, getValue, getVar, isKeepSaved
getRowKeyConverter
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class UIDataAdaptor
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public String getColumnClasses()
RowColumnStyleProps
getColumnClasses
in interface RowColumnStyleProps
public void setColumnClasses(String columnClasses)
public String[] getColumnsOrder()
AbstractExtendedDataTable
getColumnsOrder
in class AbstractExtendedDataTable
public void setColumnsOrder(String[] columnsOrder)
public Object getData()
AjaxActivatorProps
getData
in interface AjaxActivatorProps
public void setData(Object data)
public String getFilterVar()
UIDataTableBase
getFilterVar
in class UIDataTableBase
public void setFilterVar(String filterVar)
public String getFooterClass()
ColumnProps
getFooterClass
in interface ColumnProps
public void setFooterClass(String footerClass)
public int getFrozenColumns()
AbstractExtendedDataTable
getFrozenColumns
in class AbstractExtendedDataTable
public void setFrozenColumns(int frozenColumns)
public String getHeaderClass()
ColumnProps
getHeaderClass
in interface ColumnProps
public void setHeaderClass(String headerClass)
public boolean isLimitRender()
AjaxActivatorProps
isLimitRender
in interface AjaxActivatorProps
public void setLimitRender(boolean limitRender)
public String getNoDataLabel()
UIDataTableBase
getNoDataLabel
in class UIDataTableBase
public void setNoDataLabel(String noDataLabel)
public String getOnbeforedomupdate()
AjaxActivatorProps
getOnbeforedomupdate
in interface AjaxActivatorProps
public void setOnbeforedomupdate(String onbeforedomupdate)
public String getOnbeforeselectionchange()
AbstractExtendedDataTable
getOnbeforeselectionchange
in class AbstractExtendedDataTable
public void setOnbeforeselectionchange(String onbeforeselectionchange)
public String getOncomplete()
AjaxActivatorProps
getOncomplete
in interface AjaxActivatorProps
public void setOncomplete(String oncomplete)
public String getOnready()
AbstractExtendedDataTable
getOnready
in class AbstractExtendedDataTable
public void setOnready(String onready)
public String getOnrowclick()
EventsRowProps
getOnrowclick
in interface EventsRowProps
public void setOnrowclick(String onrowclick)
public String getOnrowdblclick()
EventsRowProps
getOnrowdblclick
in interface EventsRowProps
public void setOnrowdblclick(String onrowdblclick)
public String getOnrowkeydown()
EventsRowProps
getOnrowkeydown
in interface EventsRowProps
public void setOnrowkeydown(String onrowkeydown)
public String getOnrowkeypress()
EventsRowProps
getOnrowkeypress
in interface EventsRowProps
public void setOnrowkeypress(String onrowkeypress)
public String getOnrowkeyup()
EventsRowProps
getOnrowkeyup
in interface EventsRowProps
public void setOnrowkeyup(String onrowkeyup)
public String getOnrowmousedown()
EventsRowProps
getOnrowmousedown
in interface EventsRowProps
public void setOnrowmousedown(String onrowmousedown)
public String getOnrowmousemove()
EventsRowProps
getOnrowmousemove
in interface EventsRowProps
public void setOnrowmousemove(String onrowmousemove)
public String getOnrowmouseout()
EventsRowProps
getOnrowmouseout
in interface EventsRowProps
public void setOnrowmouseout(String onrowmouseout)
public String getOnrowmouseover()
EventsRowProps
getOnrowmouseover
in interface EventsRowProps
public void setOnrowmouseover(String onrowmouseover)
public String getOnrowmouseup()
EventsRowProps
getOnrowmouseup
in interface EventsRowProps
public void setOnrowmouseup(String onrowmouseup)
public String getOnselectionchange()
AbstractExtendedDataTable
getOnselectionchange
in class AbstractExtendedDataTable
public void setOnselectionchange(String onselectionchange)
public Object getRender()
AjaxActivatorProps
getRender
in interface AjaxActivatorProps
public void setRender(Object render)
public String getRowClass()
UIDataTableBase
getRowClass
in class UIDataTableBase
public void setRowClass(String rowClass)
public String getRowClasses()
RowColumnStyleProps
getRowClasses
in interface RowColumnStyleProps
public void setRowClasses(String rowClasses)
public Collection<Object> getSelection()
AbstractExtendedDataTable
getSelection
in class AbstractExtendedDataTable
public void setSelection(Collection<Object> selection)
public SelectionMode getSelectionMode()
AbstractExtendedDataTable
getSelectionMode
in class AbstractExtendedDataTable
public void setSelectionMode(SelectionMode selectionMode)
public boolean isShowColumnControl()
AbstractExtendedDataTable
isShowColumnControl
in class AbstractExtendedDataTable
public void setShowColumnControl(boolean showColumnControl)
public SortMode getSortMode()
UIDataTableBase
getSortMode
in class UIDataTableBase
public void setSortMode(SortMode sortMode)
public Collection<Object> getSortPriority()
UIDataTableBase
getSortPriority
in class UIDataTableBase
public void setSortPriority(Collection<Object> sortPriority)
public String getStyle()
StyleProps
getStyle
in interface StyleProps
public void setStyle(String style)
public String getStyleClass()
StyleClassProps
getStyleClass
in interface StyleClassProps
public void setStyleClass(String styleClass)
public String getTableState()
AbstractExtendedDataTable
getTableState
in class AbstractExtendedDataTable
public void setTableState(String tableState)
public javax.faces.component.UIComponent getFooter()
UIDataTableBase
getFooter
in class UIDataTableBase
public void setFooter(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getNoData()
UIDataTableBase
getNoData
in class UIDataTableBase
public void setNoData(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getHeader()
UIDataTableBase
getHeader
in class UIDataTableBase
public void setHeader(javax.faces.component.UIComponent facet)
Copyright © 2016 JBoss by Red Hat. All Rights Reserved.