|
RichFaces UI Components UI 4.3.3.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.UIDataAdaptor
org.richfaces.component.UISequence
org.richfaces.component.UIDataTableBase
org.richfaces.component.AbstractExtendedDataTable
org.richfaces.component.UIExtendedDataTable
@Generated(value={"RichFaces CDK","4.3.1.Final"}) public class UIExtendedDataTable
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.
Nested Class Summary | |
---|---|
protected static class |
UIExtendedDataTable.Properties
|
Nested classes/interfaces inherited from class org.richfaces.component.AbstractExtendedDataTable |
---|
AbstractExtendedDataTable.PropertyKeys |
Nested classes/interfaces inherited from class org.richfaces.component.UIDataAdaptor |
---|
UIDataAdaptor.ComponentVisitor |
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
Fields inherited from class org.richfaces.component.AbstractExtendedDataTable |
---|
OLD_CLIENT_FIRST, SCROLL, SUBMITTED_CLIENT_FIRST |
Fields inherited from class org.richfaces.component.UIDataTableBase |
---|
BODY, FOOTER, FOOTER_FACET_NAME, HEADER, HEADER_FACET_NAME, NODATA_FACET_NAME |
Fields inherited from class org.richfaces.component.UIDataAdaptor |
---|
decodeVisitor, updateVisitor, validateVisitor |
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 org.richfaces.component.MetaComponentResolver |
---|
META_COMPONENT_SEPARATOR_CHAR |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UIExtendedDataTable()
|
Method Summary | |
---|---|
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. |
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()
Assigns one or more space-separated CSS class names to the table footer |
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()
Assigns one or more space-separated CSS class names to the table header |
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 |
getOnbeforeselectionchange()
The client-side script method to be called before the selection is changed. |
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()
|
String |
getOnrowdblclick()
|
String |
getOnrowkeydown()
|
String |
getOnrowkeypress()
|
String |
getOnrowkeyup()
|
String |
getOnrowmousedown()
|
String |
getOnrowmousemove()
|
String |
getOnrowmouseout()
|
String |
getOnrowmouseover()
|
String |
getOnrowmouseup()
|
String |
getOnselectionchange()
The client-side script method to be called after the selection is changed. |
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). |
org.richfaces.model.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) |
org.richfaces.model.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()
|
String |
getStyleClass()
|
String |
getTableState()
ValueBinding pointing at a property of a String to hold table state |
void |
setColumnClasses(String columnClasses)
|
void |
setColumnsOrder(String[] columnsOrder)
|
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 |
setNoData(javax.faces.component.UIComponent facet)
|
void |
setNoDataLabel(String noDataLabel)
|
void |
setOnbeforeselectionchange(String onbeforeselectionchange)
|
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 |
setRowClass(String rowClass)
|
void |
setRowClasses(String rowClasses)
|
void |
setSelection(Collection<Object> selection)
|
void |
setSelectionMode(org.richfaces.model.SelectionMode selectionMode)
|
void |
setSortMode(org.richfaces.model.SortMode sortMode)
|
void |
setSortPriority(Collection<Object> sortPriority)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setTableState(String tableState)
|
Methods inherited from class org.richfaces.component.AbstractExtendedDataTable |
---|
encodeMetaComponent, getActualFirst, getActualRows, getClientFirst, getClientRows, resolveClientId, setClientFirst, setClientRows, setFirst, setValueBinding, setValueExpression, visitDataChildren |
Methods inherited from class org.richfaces.component.UIDataTableBase |
---|
addFilteringListener, addSortingListener, columns, createExtendedDataModel, dataChildren, fixedChildren, getFilteringListeners, getRendersChildren, getSortingListeners, getSupportedMetaComponents, hasRowChildren, isColumnFacetPresent, queueEvent, removeFilteringListener, removeSortingListener, restoreChildState, substituteUnresolvedClientId, visitFixedChildren, walk |
Methods inherited from class org.richfaces.component.UISequence |
---|
captureOrigValue, createComponentState, createFacesModel, getFirst, getIterationStatusVar, getRelativeClientId, getRelativeRowIndex, getRowIndex, getRowKeyConverter, getRows, getValue, preEncodeBegin, restoreOrigValue, setIterationStatusVar, setRows, setupVariable, setValue, updateState, updateState |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, 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 |
Methods inherited from interface org.richfaces.component.MetaComponentEncoder |
---|
encodeMetaComponent |
Methods inherited from interface org.richfaces.component.MetaComponentResolver |
---|
resolveClientId, substituteUnresolvedClientId |
Methods inherited from interface org.richfaces.component.Row |
---|
setRowKey, walk |
Field Detail |
---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
Constructor Detail |
---|
public UIExtendedDataTable()
Method Detail |
---|
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()
UIDataTableBase
getColumnClasses
in class UIDataTableBase
public void setColumnClasses(String columnClasses)
public String[] getColumnsOrder()
AbstractExtendedDataTable
getColumnsOrder
in class AbstractExtendedDataTable
public void setColumnsOrder(String[] columnsOrder)
public String getFilterVar()
UIDataTableBase
getFilterVar
in class UIDataTableBase
public void setFilterVar(String filterVar)
public String getFooterClass()
UIDataTableBase
getFooterClass
in class UIDataTableBase
public void setFooterClass(String footerClass)
public int getFrozenColumns()
AbstractExtendedDataTable
getFrozenColumns
in class AbstractExtendedDataTable
public void setFrozenColumns(int frozenColumns)
public String getHeaderClass()
UIDataTableBase
getHeaderClass
in class UIDataTableBase
public void setHeaderClass(String headerClass)
public String getNoDataLabel()
UIDataTableBase
getNoDataLabel
in class UIDataTableBase
public void setNoDataLabel(String noDataLabel)
public String getOnbeforeselectionchange()
AbstractExtendedDataTable
getOnbeforeselectionchange
in class AbstractExtendedDataTable
public void setOnbeforeselectionchange(String onbeforeselectionchange)
public String getOnready()
AbstractExtendedDataTable
getOnready
in class AbstractExtendedDataTable
public void setOnready(String onready)
public String getOnrowclick()
getOnrowclick
in class UIDataTableBase
public void setOnrowclick(String onrowclick)
public String getOnrowdblclick()
getOnrowdblclick
in class UIDataTableBase
public void setOnrowdblclick(String onrowdblclick)
public String getOnrowkeydown()
getOnrowkeydown
in class UIDataTableBase
public void setOnrowkeydown(String onrowkeydown)
public String getOnrowkeypress()
getOnrowkeypress
in class UIDataTableBase
public void setOnrowkeypress(String onrowkeypress)
public String getOnrowkeyup()
getOnrowkeyup
in class UIDataTableBase
public void setOnrowkeyup(String onrowkeyup)
public String getOnrowmousedown()
getOnrowmousedown
in class UIDataTableBase
public void setOnrowmousedown(String onrowmousedown)
public String getOnrowmousemove()
getOnrowmousemove
in class UIDataTableBase
public void setOnrowmousemove(String onrowmousemove)
public String getOnrowmouseout()
getOnrowmouseout
in class UIDataTableBase
public void setOnrowmouseout(String onrowmouseout)
public String getOnrowmouseover()
getOnrowmouseover
in class UIDataTableBase
public void setOnrowmouseover(String onrowmouseover)
public String getOnrowmouseup()
getOnrowmouseup
in class UIDataTableBase
public void setOnrowmouseup(String onrowmouseup)
public String getOnselectionchange()
AbstractExtendedDataTable
getOnselectionchange
in class AbstractExtendedDataTable
public void setOnselectionchange(String onselectionchange)
public String getRowClass()
UIDataTableBase
getRowClass
in class UIDataTableBase
public void setRowClass(String rowClass)
public String getRowClasses()
UIDataTableBase
getRowClasses
in class UIDataTableBase
public void setRowClasses(String rowClasses)
public Collection<Object> getSelection()
AbstractExtendedDataTable
getSelection
in class AbstractExtendedDataTable
public void setSelection(Collection<Object> selection)
public org.richfaces.model.SelectionMode getSelectionMode()
AbstractExtendedDataTable
getSelectionMode
in class AbstractExtendedDataTable
public void setSelectionMode(org.richfaces.model.SelectionMode selectionMode)
public org.richfaces.model.SortMode getSortMode()
UIDataTableBase
getSortMode
in class UIDataTableBase
public void setSortMode(org.richfaces.model.SortMode sortMode)
public Collection<Object> getSortPriority()
UIDataTableBase
getSortPriority
in class UIDataTableBase
public void setSortPriority(Collection<Object> sortPriority)
public String getStyle()
getStyle
in class UIDataTableBase
public void setStyle(String style)
public String getStyleClass()
getStyleClass
in class AbstractExtendedDataTable
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)
|
RichFaces UI Components UI 4.3.3.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |