public abstract class DataTableBase extends javax.faces.component.UIData implements IDataTable, IceClientBehaviorHolder
For more information, see the DataTable Wiki Documentation.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
DataTableBase.PropertyKeys |
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_TYPE |
static java.lang.String |
RENDERER_TYPE |
| Constructor and Description |
|---|
DataTableBase() |
| Modifier and Type | Method and Description |
|---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior) |
java.lang.String |
getAccesskey()
Return the value of the
accesskey property. |
java.lang.Object |
getCachedGlobalFilter()
Return the value of the
cachedGlobalFilter property. |
java.lang.String |
getCaption()
Return the value of the
caption property. |
java.util.List |
getColumnOrdering()
Return the value of the
columnOrdering property. |
java.lang.String |
getCurrentPageReportTemplate()
Return the value of the
currentPageReportTemplate property. |
java.lang.String |
getDefaultEventName() |
java.lang.String |
getDefaultExecute(java.lang.String event) |
java.lang.String |
getDefaultRender(java.lang.String event) |
java.lang.String |
getEmptyMessage()
Return the value of the
emptyMessage property. |
java.util.Collection<java.lang.String> |
getEventNames() |
java.lang.String |
getFamily() |
java.util.List |
getFilteredData()
Return the value of the
filteredData property. |
java.lang.String |
getFilterEvent()
Return the value of the
filterEvent property. |
javax.el.MethodExpression |
getFilterListener()
Return the value of the
filterListener property. |
java.lang.String |
getFilterValue()
Return the value of the
filterValue property. |
java.lang.Integer |
getForcedUpdateCounter()
Return the value of the
forcedUpdateCounter property. |
java.util.List |
getHeaderColumnOrdering()
Return the value of the
headerColumnOrdering property. |
java.lang.Long |
getLastReordering()
Return the value of the
lastReordering property. |
java.lang.String |
getListenerArgument(java.lang.String event) |
java.lang.Integer |
getLiveScrollBufferPages()
Return the value of the
liveScrollBufferPages property. |
int |
getPage()
Return the value of the
page property. |
java.lang.Integer |
getPageCount()
Return the value of the
pageCount property. |
int |
getPagesToSkip()
Return the value of the
pagesToSkip property. |
java.lang.String |
getPaginatorAccesskey()
Return the value of the
paginatorAccesskey property. |
java.lang.String |
getPaginatorPosition()
Return the value of the
paginatorPosition property. |
java.lang.String |
getPaginatorTemplate()
Return the value of the
paginatorTemplate property. |
java.lang.String |
getRowIndexVar()
Return the value of the
rowIndexVar property. |
int |
getRows()
Return the value of the
rows property. |
javax.el.MethodExpression |
getRowSelectListener()
Return the value of the
rowSelectListener property. |
java.lang.String |
getRowsPerPageTemplate()
Return the value of the
rowsPerPageTemplate property. |
java.lang.String |
getRowStateVar()
Return the value of the
rowStateVar property. |
java.lang.String |
getRowStyleClass()
Return the value of the
rowStyleClass property. |
javax.el.MethodExpression |
getRowUnselectListener()
Return the value of the
rowUnselectListener property. |
java.lang.Integer |
getScrollHeight()
Return the value of the
scrollHeight property. |
java.lang.String |
getScrollWidthIE7()
Return the value of the
scrollWidthIE7 property. |
java.lang.String |
getSelectionMode()
Return the value of the
selectionMode property. |
RowStateMap |
getStateMap()
Return the value of the
stateMap property. |
java.lang.String |
getStyle()
Return the value of the
style property. |
java.lang.String |
getStyleClass()
Return the value of the
styleClass property. |
java.lang.Integer |
getTabIndex()
Return the value of the
tabIndex property. |
java.lang.String |
getTableConfigPanel()
Return the value of the
tableConfigPanel property. |
java.lang.Integer |
getValueHashCode()
Return the value of the
valueHashCode property. |
boolean |
isAllColumnClicks()
Return the value of the
allColumnClicks property. |
java.lang.Boolean |
isAlwaysExecuteContents()
Return the value of the
alwaysExecuteContents property. |
java.lang.Boolean |
isApplyingFilters()
Return the value of the
applyingFilters property. |
java.lang.Boolean |
isApplyingSorts()
Return the value of the
applyingSorts property. |
boolean |
isClickableHeaderSorting()
Return the value of the
clickableHeaderSorting property. |
boolean |
isColumnPinning()
Return the value of the
columnPinning property. |
boolean |
isColumnPinningControlsInHeader()
Return the value of the
columnPinningControlsInHeader property. |
boolean |
isColumnsInheritProperties()
Return the value of the
columnsInheritProperties property. |
boolean |
isConstantRefilter()
Return the value of the
constantRefilter property. |
boolean |
isDisabled()
Return the value of the
disabled property. |
boolean |
isDoubleClickSelect()
Return the value of the
doubleClickSelect property. |
boolean |
isGroupedFilterResults()
Return the value of the
groupedFilterResults property. |
java.lang.Boolean |
isHiddenScrollableSizing()
Return the value of the
hiddenScrollableSizing property. |
boolean |
isLazy()
Return the value of the
lazy property. |
boolean |
isLiveScroll()
Return the value of the
liveScroll property. |
boolean |
isPaginator()
Return the value of the
paginator property. |
boolean |
isPaginatorAlwaysVisible()
Return the value of the
paginatorAlwaysVisible property. |
protected boolean |
isPropertySet(java.lang.String finder) |
boolean |
isRenderRowTabindex()
Return the value of the
renderRowTabindex property. |
boolean |
isReorderableColumns()
Return the value of the
reorderableColumns property. |
boolean |
isResizableColumns()
Return the value of the
resizableColumns property. |
boolean |
isScrollable()
Return the value of the
scrollable property. |
boolean |
isSingleSort()
Return the value of the
singleSort property. |
java.lang.Boolean |
isStaticHeaders()
Return the value of the
staticHeaders property. |
java.lang.Boolean |
isToggleOnInvalidEdit()
Return the value of the
toggleOnInvalidEdit property. |
void |
setAccesskey(java.lang.String accesskey)
Set the value of the
accesskey property. |
void |
setAllColumnClicks(boolean allColumnClicks)
Set the value of the
allColumnClicks property. |
void |
setAlwaysExecuteContents(java.lang.Boolean alwaysExecuteContents)
Set the value of the
alwaysExecuteContents property. |
void |
setApplyingFilters(java.lang.Boolean applyingFilters)
Set the value of the
applyingFilters property. |
void |
setApplyingSorts(java.lang.Boolean applyingSorts)
Set the value of the
applyingSorts property. |
void |
setCachedGlobalFilter(java.lang.Object cachedGlobalFilter)
Set the value of the
cachedGlobalFilter property. |
void |
setCaption(java.lang.String caption)
Set the value of the
caption property. |
void |
setClickableHeaderSorting(boolean clickableHeaderSorting)
Set the value of the
clickableHeaderSorting property. |
void |
setColumnOrdering(java.util.List columnOrdering)
Set the value of the
columnOrdering property. |
void |
setColumnPinning(boolean columnPinning)
Set the value of the
columnPinning property. |
void |
setColumnPinningControlsInHeader(boolean columnPinningControlsInHeader)
Set the value of the
columnPinningControlsInHeader property. |
void |
setColumnsInheritProperties(boolean columnsInheritProperties)
Set the value of the
columnsInheritProperties property. |
void |
setConstantRefilter(boolean constantRefilter)
Set the value of the
constantRefilter property. |
void |
setCurrentPageReportTemplate(java.lang.String currentPageReportTemplate)
Set the value of the
currentPageReportTemplate property. |
void |
setDisabled(boolean disabled)
Set the value of the
disabled property. |
void |
setDoubleClickSelect(boolean doubleClickSelect)
Set the value of the
doubleClickSelect property. |
void |
setEmptyMessage(java.lang.String emptyMessage)
Set the value of the
emptyMessage property. |
void |
setFilteredData(java.util.List filteredData)
Set the value of the
filteredData property. |
void |
setFilterEvent(java.lang.String filterEvent)
Set the value of the
filterEvent property. |
void |
setFilterListener(javax.el.MethodExpression filterListener)
Set the value of the
filterListener property. |
void |
setFilterValue(java.lang.String filterValue)
Set the value of the
filterValue property. |
void |
setForcedUpdateCounter(java.lang.Integer forcedUpdateCounter)
Set the value of the
forcedUpdateCounter property. |
void |
setGroupedFilterResults(boolean groupedFilterResults)
Set the value of the
groupedFilterResults property. |
void |
setHeaderColumnOrdering(java.util.List headerColumnOrdering)
Set the value of the
headerColumnOrdering property. |
void |
setHiddenScrollableSizing(java.lang.Boolean hiddenScrollableSizing)
Set the value of the
hiddenScrollableSizing property. |
void |
setLastReordering(java.lang.Long lastReordering)
Set the value of the
lastReordering property. |
void |
setLazy(boolean lazy)
Set the value of the
lazy property. |
void |
setLiveScroll(boolean liveScroll)
Set the value of the
liveScroll property. |
void |
setLiveScrollBufferPages(java.lang.Integer liveScrollBufferPages)
Set the value of the
liveScrollBufferPages property. |
void |
setPage(int page)
Set the value of the
page property. |
void |
setPageCount(java.lang.Integer pageCount)
Set the value of the
pageCount property. |
void |
setPagesToSkip(int pagesToSkip)
Set the value of the
pagesToSkip property. |
void |
setPaginator(boolean paginator)
Set the value of the
paginator property. |
void |
setPaginatorAccesskey(java.lang.String paginatorAccesskey)
Set the value of the
paginatorAccesskey property. |
void |
setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)
Set the value of the
paginatorAlwaysVisible property. |
void |
setPaginatorPosition(java.lang.String paginatorPosition)
Set the value of the
paginatorPosition property. |
void |
setPaginatorTemplate(java.lang.String paginatorTemplate)
Set the value of the
paginatorTemplate property. |
void |
setRenderRowTabindex(boolean renderRowTabindex)
Set the value of the
renderRowTabindex property. |
void |
setReorderableColumns(boolean reorderableColumns)
Set the value of the
reorderableColumns property. |
void |
setResizableColumns(boolean resizableColumns)
Set the value of the
resizableColumns property. |
void |
setRowIndexVar(java.lang.String rowIndexVar)
Set the value of the
rowIndexVar property. |
void |
setRows(int rows)
Set the value of the
rows property. |
void |
setRowSelectListener(javax.el.MethodExpression rowSelectListener)
Set the value of the
rowSelectListener property. |
void |
setRowsPerPageTemplate(java.lang.String rowsPerPageTemplate)
Set the value of the
rowsPerPageTemplate property. |
void |
setRowStateVar(java.lang.String rowStateVar)
Set the value of the
rowStateVar property. |
void |
setRowStyleClass(java.lang.String rowStyleClass)
Set the value of the
rowStyleClass property. |
void |
setRowUnselectListener(javax.el.MethodExpression rowUnselectListener)
Set the value of the
rowUnselectListener property. |
void |
setScrollable(boolean scrollable)
Set the value of the
scrollable property. |
void |
setScrollHeight(java.lang.Integer scrollHeight)
Set the value of the
scrollHeight property. |
void |
setScrollWidthIE7(java.lang.String scrollWidthIE7)
Set the value of the
scrollWidthIE7 property. |
void |
setSelectionMode(java.lang.String selectionMode)
Set the value of the
selectionMode property. |
void |
setSingleSort(boolean singleSort)
Set the value of the
singleSort property. |
void |
setStateMap(RowStateMap stateMap)
Set the value of the
stateMap property. |
void |
setStaticHeaders(java.lang.Boolean staticHeaders)
Set the value of the
staticHeaders property. |
void |
setStyle(java.lang.String style)
Set the value of the
style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the
styleClass property. |
void |
setTabIndex(java.lang.Integer tabIndex)
Set the value of the
tabIndex property. |
void |
setTableConfigPanel(java.lang.String tableConfigPanel)
Set the value of the
tableConfigPanel property. |
void |
setToggleOnInvalidEdit(java.lang.Boolean toggleOnInvalidEdit)
Set the value of the
toggleOnInvalidEdit property. |
void |
setValueExpression(java.lang.String name,
javax.el.ValueExpression binding) |
void |
setValueHashCode(java.lang.Integer valueHashCode)
Set the value of the
valueHashCode property. |
broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRowStatePreserved, setValue, setValueBinding, setVar, visitTreeaddFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInViewpublic static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIDatapublic void setAccesskey(java.lang.String accesskey)
Set the value of the accesskey property.
Contents: Access key that, when pressed, transfers focus to this component.
setAccesskey in interface IDataTablepublic java.lang.String getAccesskey()
Return the value of the accesskey property.
Contents: Access key that, when pressed, transfers focus to this component.
getAccesskey in interface IDataTablepublic void setAllColumnClicks(boolean allColumnClicks)
Set the value of the allColumnClicks property.
Contents: Enable to have all column clicks accepted as selection and/or ajax click events. Typically only click eventsthat occur on a child div, span, or the td element itself are captured for processing.
setAllColumnClicks in interface IDataTablepublic boolean isAllColumnClicks()
Return the value of the allColumnClicks property.
Contents: Enable to have all column clicks accepted as selection and/or ajax click events. Typically only click eventsthat occur on a child div, span, or the td element itself are captured for processing.
isAllColumnClicks in interface IDataTablepublic void setAlwaysExecuteContents(java.lang.Boolean alwaysExecuteContents)
Set the value of the alwaysExecuteContents property.
Contents: Enable the decoding of child components during table feature requests. The table attempts to decode children whenever it is executed, meaning whenever a parent region is submitted, or the table submits itself to paginate, make a selection, reorder columns, or any other feature. Decoding children during feature requests can result in unwanted input submission (during pagination for example), so by default this component suppresses child decoding whenever submitting itself. To cause decoding in the children of the table, use the row editing feature for row-scoped input decoding, ajax submit the form (or other table parent) for broad decodingor enable this option to submit during all table operations.
setAlwaysExecuteContents in interface IDataTablepublic java.lang.Boolean isAlwaysExecuteContents()
Return the value of the alwaysExecuteContents property.
Contents: Enable the decoding of child components during table feature requests. The table attempts to decode children whenever it is executed, meaning whenever a parent region is submitted, or the table submits itself to paginate, make a selection, reorder columns, or any other feature. Decoding children during feature requests can result in unwanted input submission (during pagination for example), so by default this component suppresses child decoding whenever submitting itself. To cause decoding in the children of the table, use the row editing feature for row-scoped input decoding, ajax submit the form (or other table parent) for broad decodingor enable this option to submit during all table operations. Default = 'false'.
isAlwaysExecuteContents in interface IDataTablepublic void setCaption(java.lang.String caption)
Set the value of the caption property.
Contents: Causes a caption element to be rendered with the specified text, in order to facilitate better screen reader support and accessibility for this table.
setCaption in interface IDataTablepublic java.lang.String getCaption()
Return the value of the caption property.
Contents: Causes a caption element to be rendered with the specified text, in order to facilitate better screen reader support and accessibility for this table.
getCaption in interface IDataTablepublic void setClickableHeaderSorting(boolean clickableHeaderSorting)
Set the value of the clickableHeaderSorting property.
Contents: Enabling makes the entire header container the clickable region for sort events.
setClickableHeaderSorting in interface IDataTablepublic boolean isClickableHeaderSorting()
Return the value of the clickableHeaderSorting property.
Contents: Enabling makes the entire header container the clickable region for sort events. Default = 'true'.
isClickableHeaderSorting in interface IDataTablepublic void setColumnOrdering(java.util.List columnOrdering)
Set the value of the columnOrdering property.
Contents: Defines a list of integers representing a rendering order for the Column children of the table.
setColumnOrdering in interface IDataTablepublic java.util.List getColumnOrdering()
Return the value of the columnOrdering property.
Contents: Defines a list of integers representing a rendering order for the Column children of the table.
getColumnOrdering in interface IDataTablepublic void setColumnPinning(boolean columnPinning)
Set the value of the columnPinning property.
Contents: Enable statically positioned columns along the left hand side of a scrollable table.
setColumnPinning in interface IDataTablepublic boolean isColumnPinning()
Return the value of the columnPinning property.
Contents: Enable statically positioned columns along the left hand side of a scrollable table.
isColumnPinning in interface IDataTablepublic void setColumnPinningControlsInHeader(boolean columnPinningControlsInHeader)
Set the value of the columnPinningControlsInHeader property.
Contents: Enable client controls to add column to the list of statically positioned columns.
setColumnPinningControlsInHeader in interface IDataTablepublic boolean isColumnPinningControlsInHeader()
Return the value of the columnPinningControlsInHeader property.
Contents: Enable client controls to add column to the list of statically positioned columns.
isColumnPinningControlsInHeader in interface IDataTablepublic void setColumnsInheritProperties(boolean columnsInheritProperties)
Set the value of the columnsInheritProperties property.
Contents: To reduce redundancy in markup, body columns can detect which header column that they correspond to, and inherit sorting, filtering and grouping properties from it. Previously, it was necessary to provide the same properties and values on both components, but now it's possible to specify them on the header column, and have the body column inherit them automatically. If a property is specified on the body column, then that will take precedence for it.
setColumnsInheritProperties in interface IDataTablepublic boolean isColumnsInheritProperties()
Return the value of the columnsInheritProperties property.
Contents: To reduce redundancy in markup, body columns can detect which header column that they correspond to, and inherit sorting, filtering and grouping properties from it. Previously, it was necessary to provide the same properties and values on both components, but now it's possible to specify them on the header column, and have the body column inherit them automatically. If a property is specified on the body column, then that will take precedence for it. Default = 'true'.
isColumnsInheritProperties in interface IDataTablepublic void setConstantRefilter(boolean constantRefilter)
Set the value of the constantRefilter property.
Contents: Enable to force creation of the filtered data set from the bound value every render. Alternately attempt to use hashCodes of the value property to detect changes and prompt refiltering.
setConstantRefilter in interface IDataTablepublic boolean isConstantRefilter()
Return the value of the constantRefilter property.
Contents: Enable to force creation of the filtered data set from the bound value every render. Alternately attempt to use hashCodes of the value property to detect changes and prompt refiltering. Default = 'false'.
isConstantRefilter in interface IDataTablepublic void setCurrentPageReportTemplate(java.lang.String currentPageReportTemplate)
Set the value of the currentPageReportTemplate property.
Contents: Defines a coded string representing the layout of the text displaying the current page. The keywords available are {currentPage}, {totalPages}, {startRecord}, {endRecord}, and {totalRecords}. Default is: "({currentPage} of {totalPages})".
setCurrentPageReportTemplate in interface IDataTablepublic java.lang.String getCurrentPageReportTemplate()
Return the value of the currentPageReportTemplate property.
Contents: Defines a coded string representing the layout of the text displaying the current page. The keywords available are {currentPage}, {totalPages}, {startRecord}, {endRecord}, and {totalRecords}. Default is: "({currentPage} of {totalPages})".
getCurrentPageReportTemplate in interface IDataTablepublic void setDisabled(boolean disabled)
Set the value of the disabled property.
Contents: Disable all features of the data table.
setDisabled in interface IDataTablepublic boolean isDisabled()
Return the value of the disabled property.
Contents: Disable all features of the data table. Default = 'false'.
isDisabled in interface IDataTablepublic void setDoubleClickSelect(boolean doubleClickSelect)
Set the value of the doubleClickSelect property.
Contents: Enable to require a double-click to fire row/cell selection events.
setDoubleClickSelect in interface IDataTablepublic boolean isDoubleClickSelect()
Return the value of the doubleClickSelect property.
Contents: Enable to require a double-click to fire row/cell selection events.
isDoubleClickSelect in interface IDataTablepublic void setEmptyMessage(java.lang.String emptyMessage)
Set the value of the emptyMessage property.
Contents: Define a string to render when there are no records to display.
setEmptyMessage in interface IDataTablepublic java.lang.String getEmptyMessage()
Return the value of the emptyMessage property.
Contents: Define a string to render when there are no records to display.
getEmptyMessage in interface IDataTablepublic void setFilterEvent(java.lang.String filterEvent)
Set the value of the filterEvent property.
Contents: Defines the Javascript event on which to trigger filter event, ex. 'keyup', 'blur', 'change' and 'enter' (Note: columns filtered based on Date values always trigger the event on change).
setFilterEvent in interface IDataTablepublic java.lang.String getFilterEvent()
Return the value of the filterEvent property.
Contents: Defines the Javascript event on which to trigger filter event, ex. 'keyup', 'blur', 'change' and 'enter' (Note: columns filtered based on Date values always trigger the event on change). Default = 'change'.
getFilterEvent in interface IDataTablepublic void setFilterListener(javax.el.MethodExpression filterListener)
Set the value of the filterListener property.
Contents: MethodExpression reference called whenever the table row is filtered. The method receives a single argument, TableFilterEvent.
setFilterListener in interface IDataTablepublic javax.el.MethodExpression getFilterListener()
Return the value of the filterListener property.
Contents: MethodExpression reference called whenever the table row is filtered. The method receives a single argument, TableFilterEvent.
getFilterListener in interface IDataTablepublic void setFilterValue(java.lang.String filterValue)
Set the value of the filterValue property.
Contents: Defines the input to the column non-specific filter, coming from the client, or from the app via a value binding.
setFilterValue in interface IDataTablepublic java.lang.String getFilterValue()
Return the value of the filterValue property.
Contents: Defines the input to the column non-specific filter, coming from the client, or from the app via a value binding.
getFilterValue in interface IDataTablepublic void setGroupedFilterResults(boolean groupedFilterResults)
Set the value of the groupedFilterResults property.
Contents: Enable to display all members of groups (as defined by ace:column groupBy) that contain a matching row during filtering.
setGroupedFilterResults in interface IDataTablepublic boolean isGroupedFilterResults()
Return the value of the groupedFilterResults property.
Contents: Enable to display all members of groups (as defined by ace:column groupBy) that contain a matching row during filtering.
isGroupedFilterResults in interface IDataTablepublic void setHeaderColumnOrdering(java.util.List headerColumnOrdering)
Set the value of the headerColumnOrdering property.
Contents: Defines a list of integers representing a rendering order for the Column children of the header columnGroup. This is separate from the columnOrdering property to maintain backwards compatibility and simplify application code when columns are added or removed. Both properties should be maintained in sync with each other.
setHeaderColumnOrdering in interface IDataTablepublic java.util.List getHeaderColumnOrdering()
Return the value of the headerColumnOrdering property.
Contents: Defines a list of integers representing a rendering order for the Column children of the header columnGroup. This is separate from the columnOrdering property to maintain backwards compatibility and simplify application code when columns are added or removed. Both properties should be maintained in sync with each other.
getHeaderColumnOrdering in interface IDataTablepublic void setHiddenScrollableSizing(java.lang.Boolean hiddenScrollableSizing)
Set the value of the hiddenScrollableSizing property.
Contents: Enable the default handling of the scrollable table when rendered into a hidden page region. The table attempts to poll its hidden status, looking for when it is shown and then call the scrollable table sizing JavaScript. This can be expensive in environments of reduced JavaScript performance with many tables and a complex DOM. When this is disabled, upon revealing a hidden scrollable table, to ensure it is sized correctly the JS resizeScrolling() function must be called on the table instance in the client side.
setHiddenScrollableSizing in interface IDataTablepublic java.lang.Boolean isHiddenScrollableSizing()
Return the value of the hiddenScrollableSizing property.
Contents: Enable the default handling of the scrollable table when rendered into a hidden page region. The table attempts to poll its hidden status, looking for when it is shown and then call the scrollable table sizing JavaScript. This can be expensive in environments of reduced JavaScript performance with many tables and a complex DOM. When this is disabled, upon revealing a hidden scrollable table, to ensure it is sized correctly the JS resizeScrolling() function must be called on the table instance in the client side. Default = 'true'.
isHiddenScrollableSizing in interface IDataTablepublic void setLazy(boolean lazy)
Set the value of the lazy property.
Contents: Enables lazy loading. Lazy loading expects the 'value' property to reference an instance of LazyDataModel, an interface to support incremental fetching of table entities. Note that it is necessary that the data object implement custom hashCode() and equals() methods for advanced features to work correctly. see wiki for more information.
setLazy in interface IDataTablepublic boolean isLazy()
Return the value of the lazy property.
Contents: Enables lazy loading. Lazy loading expects the 'value' property to reference an instance of LazyDataModel, an interface to support incremental fetching of table entities. Note that it is necessary that the data object implement custom hashCode() and equals() methods for advanced features to work correctly. see wiki for more information.
isLazy in interface IDataTablepublic void setLiveScroll(boolean liveScroll)
Set the value of the liveScroll property.
Contents: When set to true, a number of rows will be automatically loaded after reaching the bottom of the table scroll bar. The rows correspond to the data items in the data model that follow the rows currently displayed. The number of rows to load is determined by the 'rows' and the 'liveScrollBufferPages' attributes.
setLiveScroll in interface IDataTablepublic boolean isLiveScroll()
Return the value of the liveScroll property.
Contents: When set to true, a number of rows will be automatically loaded after reaching the bottom of the table scroll bar. The rows correspond to the data items in the data model that follow the rows currently displayed. The number of rows to load is determined by the 'rows' and the 'liveScrollBufferPages' attributes.
isLiveScroll in interface IDataTablepublic void setLiveScrollBufferPages(java.lang.Integer liveScrollBufferPages)
Set the value of the liveScrollBufferPages property.
Contents: When using live scrolling, the number of pages specified by this attribute will be rendered before and after the current page. This means that if the value is 2, there will be 5 pages worth of rows displayed on the table.
setLiveScrollBufferPages in interface IDataTablepublic java.lang.Integer getLiveScrollBufferPages()
Return the value of the liveScrollBufferPages property.
Contents: When using live scrolling, the number of pages specified by this attribute will be rendered before and after the current page. This means that if the value is 2, there will be 5 pages worth of rows displayed on the table. Default = '2'.
getLiveScrollBufferPages in interface IDataTablepublic void setPage(int page)
Set the value of the page property.
Contents: Defines the index of the current page, beginning at 1.
setPage in interface IDataTablepublic int getPage()
Return the value of the page property.
Contents: Defines the index of the current page, beginning at 1.
getPage in interface IDataTablepublic void setPageCount(java.lang.Integer pageCount)
Set the value of the pageCount property.
Contents: Defines the maximum number of individual page links to display in paginator.
setPageCount in interface IDataTablepublic java.lang.Integer getPageCount()
Return the value of the pageCount property.
Contents: Defines the maximum number of individual page links to display in paginator. Default = '10'.
getPageCount in interface IDataTablepublic void setPagesToSkip(int pagesToSkip)
Set the value of the pagesToSkip property.
Contents: Defines the number of pages to skip when pressing the FastRewind and FastForward buttons.
setPagesToSkip in interface IDataTablepublic int getPagesToSkip()
Return the value of the pagesToSkip property.
Contents: Defines the number of pages to skip when pressing the FastRewind and FastForward buttons. Default = '3'.
getPagesToSkip in interface IDataTablepublic void setPaginator(boolean paginator)
Set the value of the paginator property.
Contents: Enables pagination on the table. Note that the paginator works by adjusting the 'first' and 'page' properties and that disabling the paginator will not return these properties to their defaults; instead leaving the table at the position that was paginated to. To return the table to the first page, 'first' must be set to 0, or 'page' must be set to 1.Alternately the table has a convenience method for this, DataTable.resetPagination().
setPaginator in interface IDataTablepublic boolean isPaginator()
Return the value of the paginator property.
Contents: Enables pagination on the table. Note that the paginator works by adjusting the 'first' and 'page' properties and that disabling the paginator will not return these properties to their defaults; instead leaving the table at the position that was paginated to. To return the table to the first page, 'first' must be set to 0, or 'page' must be set to 1.Alternately the table has a convenience method for this, DataTable.resetPagination().
isPaginator in interface IDataTablepublic void setPaginatorAccesskey(java.lang.String paginatorAccesskey)
Set the value of the paginatorAccesskey property.
Contents: Access key that, when pressed, transfers focus to the current page button.
setPaginatorAccesskey in interface IDataTablepublic java.lang.String getPaginatorAccesskey()
Return the value of the paginatorAccesskey property.
Contents: Access key that, when pressed, transfers focus to the current page button.
getPaginatorAccesskey in interface IDataTablepublic void setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)
Set the value of the paginatorAlwaysVisible property.
Contents: Defines whether the paginator always displays, even when fewer then 1 page full of items are displayed.
setPaginatorAlwaysVisible in interface IDataTablepublic boolean isPaginatorAlwaysVisible()
Return the value of the paginatorAlwaysVisible property.
Contents: Defines whether the paginator always displays, even when fewer then 1 page full of items are displayed.
isPaginatorAlwaysVisible in interface IDataTablepublic void setPaginatorPosition(java.lang.String paginatorPosition)
Set the value of the paginatorPosition property.
Contents: Defines the location of the paginator if enabled. Available options are top, bottom, or the default, both.
setPaginatorPosition in interface IDataTablepublic java.lang.String getPaginatorPosition()
Return the value of the paginatorPosition property.
Contents: Defines the location of the paginator if enabled. Available options are top, bottom, or the default, both. Default = 'both'.
getPaginatorPosition in interface IDataTablepublic void setPaginatorTemplate(java.lang.String paginatorTemplate)
Set the value of the paginatorTemplate property.
Contents: Defines a coded string representing the controls available as part of the paginator. Default is: "{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}". The {FastRewind} and {FastForward} controls are also available. They skip a number of pages backward or forward, respectively. This number is defined by the 'pagesToSkip' property.
setPaginatorTemplate in interface IDataTablepublic java.lang.String getPaginatorTemplate()
Return the value of the paginatorTemplate property.
Contents: Defines a coded string representing the controls available as part of the paginator. Default is: "{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}". The {FastRewind} and {FastForward} controls are also available. They skip a number of pages backward or forward, respectively. This number is defined by the 'pagesToSkip' property.
getPaginatorTemplate in interface IDataTablepublic void setRenderRowTabindex(boolean renderRowTabindex)
Set the value of the renderRowTabindex property.
Contents: Row tabindex is required for dataTable Find feature. If Find feature is not used and the tabindex interferes with tabbing through inputs in the table, set this to false.
setRenderRowTabindex in interface IDataTablepublic boolean isRenderRowTabindex()
Return the value of the renderRowTabindex property.
Contents: Row tabindex is required for dataTable Find feature. If Find feature is not used and the tabindex interferes with tabbing through inputs in the table, set this to false. Default = 'true'.
isRenderRowTabindex in interface IDataTablepublic void setReorderableColumns(boolean reorderableColumns)
Set the value of the reorderableColumns property.
Contents: Enable reordering of the table columns via header dragging.
setReorderableColumns in interface IDataTablepublic boolean isReorderableColumns()
Return the value of the reorderableColumns property.
Contents: Enable reordering of the table columns via header dragging.
isReorderableColumns in interface IDataTablepublic void setResizableColumns(boolean resizableColumns)
Set the value of the resizableColumns property.
Contents: Enable resizing of the table columns via handles on the column headers.
setResizableColumns in interface IDataTablepublic boolean isResizableColumns()
Return the value of the resizableColumns property.
Contents: Enable resizing of the table columns via handles on the column headers.
isResizableColumns in interface IDataTablepublic void setRowIndexVar(java.lang.String rowIndexVar)
Set the value of the rowIndexVar property.
Contents: The request-scope attribute (if any) under which the data object index for the current row will be exposed when iterating.
setRowIndexVar in interface IDataTablepublic java.lang.String getRowIndexVar()
Return the value of the rowIndexVar property.
Contents: The request-scope attribute (if any) under which the data object index for the current row will be exposed when iterating.
getRowIndexVar in interface IDataTablepublic void setRowSelectListener(javax.el.MethodExpression rowSelectListener)
Set the value of the rowSelectListener property.
Contents: MethodExpression reference called whenever a table element is selected. The method receives a single argument, SelectEvent.
setRowSelectListener in interface IDataTablepublic javax.el.MethodExpression getRowSelectListener()
Return the value of the rowSelectListener property.
Contents: MethodExpression reference called whenever a table element is selected. The method receives a single argument, SelectEvent.
getRowSelectListener in interface IDataTablepublic void setRowStateVar(java.lang.String rowStateVar)
Set the value of the rowStateVar property.
Contents: The request-scope attribute (if any) under which the table state object for the current row will be exposed when iterating.
setRowStateVar in interface IDataTablepublic java.lang.String getRowStateVar()
Return the value of the rowStateVar property.
Contents: The request-scope attribute (if any) under which the table state object for the current row will be exposed when iterating. Default = 'rowState'.
getRowStateVar in interface IDataTablepublic void setRowStyleClass(java.lang.String rowStyleClass)
Set the value of the rowStyleClass property.
Contents: Define css classes for each row of the dataTable. EL can be used in this attribute to produce conditional row styling.
setRowStyleClass in interface IDataTablepublic java.lang.String getRowStyleClass()
Return the value of the rowStyleClass property.
Contents: Define css classes for each row of the dataTable. EL can be used in this attribute to produce conditional row styling.
getRowStyleClass in interface IDataTablepublic void setRowUnselectListener(javax.el.MethodExpression rowUnselectListener)
Set the value of the rowUnselectListener property.
Contents: MethodExpression reference called whenever a table element is deselected. The method receives a single argument, UnselectEvent.
setRowUnselectListener in interface IDataTablepublic javax.el.MethodExpression getRowUnselectListener()
Return the value of the rowUnselectListener property.
Contents: MethodExpression reference called whenever a table element is deselected. The method receives a single argument, UnselectEvent.
getRowUnselectListener in interface IDataTablepublic void setRows(int rows)
Set the value of the rows property.
Contents: The number of rows to be displayed, or zero to display the entire set of available rows.
setRows in interface IDataTablesetRows in class javax.faces.component.UIDatapublic int getRows()
Return the value of the rows property.
Contents: The number of rows to be displayed, or zero to display the entire set of available rows. Default = '0'.
getRows in interface IDataTablegetRows in class javax.faces.component.UIDatapublic void setRowsPerPageTemplate(java.lang.String rowsPerPageTemplate)
Set the value of the rowsPerPageTemplate property.
Contents: Defines a list of comma separated integer values that represent the options of "number of items per page" presented to the user. "all" is a special keyword that allowsa user to reset the pagination offset show all rows. The "all" option label is defined by the message key "org.icefaces.ace.component.datatable.ALL_LABEL". Any non-numerical value other than "all" will cause a NumberFormatException.
setRowsPerPageTemplate in interface IDataTablepublic java.lang.String getRowsPerPageTemplate()
Return the value of the rowsPerPageTemplate property.
Contents: Defines a list of comma separated integer values that represent the options of "number of items per page" presented to the user. "all" is a special keyword that allowsa user to reset the pagination offset show all rows. The "all" option label is defined by the message key "org.icefaces.ace.component.datatable.ALL_LABEL". Any non-numerical value other than "all" will cause a NumberFormatException.
getRowsPerPageTemplate in interface IDataTablepublic void setScrollHeight(java.lang.Integer scrollHeight)
Set the value of the scrollHeight property.
Contents: Defines a fixed height for the scrollable table in pixels.
setScrollHeight in interface IDataTablepublic java.lang.Integer getScrollHeight()
Return the value of the scrollHeight property.
Contents: Defines a fixed height for the scrollable table in pixels. Default = '100'.
getScrollHeight in interface IDataTablepublic void setScrollWidthIE7(java.lang.String scrollWidthIE7)
Set the value of the scrollWidthIE7 property.
Contents: (Deprecated) This attribute was used to support scrolling on IE7 in previous versions and has no effect now.
setScrollWidthIE7 in interface IDataTablepublic java.lang.String getScrollWidthIE7()
Return the value of the scrollWidthIE7 property.
Contents: (Deprecated) This attribute was used to support scrolling on IE7 in previous versions and has no effect now.
getScrollWidthIE7 in interface IDataTablepublic void setScrollable(boolean scrollable)
Set the value of the scrollable property.
Contents: Enabling renders a table that overflows the fixed height and adds a scrollbar. Note, used in combination with multi-row headers defined by a ColumnGroupcomponent, it is assumed that every body column of the table will have a associated single column spanning header column on the bottom row of the multi-row header. This is to allow for appropriate sizing of the scrollable column and the associated header td.
setScrollable in interface IDataTablepublic boolean isScrollable()
Return the value of the scrollable property.
Contents: Enabling renders a table that overflows the fixed height and adds a scrollbar. Note, used in combination with multi-row headers defined by a ColumnGroupcomponent, it is assumed that every body column of the table will have a associated single column spanning header column on the bottom row of the multi-row header. This is to allow for appropriate sizing of the scrollable column and the associated header td.
isScrollable in interface IDataTablepublic void setSelectionMode(java.lang.String selectionMode)
Set the value of the selectionMode property.
Contents: Defines a code word indicating method of table element selection. Available values include: "multiple", "single", "enhMultiple", "cellblock", "cellrange", "multiplecell" and "singlecell". The enhanced multiple mode ("enhMultiple") works in the following way. Single clicking a row will select it and deselect all other rows. No toggling occurs unless the Ctrl/Command key is held, in which case the other rows won't be deselected. Holding the Shift key will cause the range of rows between the last selected row and the current one to be selected.
setSelectionMode in interface IDataTablepublic java.lang.String getSelectionMode()
Return the value of the selectionMode property.
Contents: Defines a code word indicating method of table element selection. Available values include: "multiple", "single", "enhMultiple", "cellblock", "cellrange", "multiplecell" and "singlecell". The enhanced multiple mode ("enhMultiple") works in the following way. Single clicking a row will select it and deselect all other rows. No toggling occurs unless the Ctrl/Command key is held, in which case the other rows won't be deselected. Holding the Shift key will cause the range of rows between the last selected row and the current one to be selected.
getSelectionMode in interface IDataTablepublic void setSingleSort(boolean singleSort)
Set the value of the singleSort property.
Contents: Disables sorting for multiple columns at once. Sorting is enabled by the use of sortBy on ace:column components.
setSingleSort in interface IDataTablepublic boolean isSingleSort()
Return the value of the singleSort property.
Contents: Disables sorting for multiple columns at once. Sorting is enabled by the use of sortBy on ace:column components. Default = 'false'.
isSingleSort in interface IDataTablepublic void setStateMap(RowStateMap stateMap)
Set the value of the stateMap property.
Contents: Defines a map of your row data objects to UI states. Row-level features (selection, expansion, etc.) are manipulable through this repository. Note that it is necessary that the data object implement custom hashCode() and equals() methods for advanced features to work correctly. see wiki for more information.
setStateMap in interface IDataTablepublic RowStateMap getStateMap()
Return the value of the stateMap property.
Contents: Defines a map of your row data objects to UI states. Row-level features (selection, expansion, etc.) are manipulable through this repository. Note that it is necessary that the data object implement custom hashCode() and equals() methods for advanced features to work correctly. see wiki for more information.
getStateMap in interface IDataTablepublic void setStaticHeaders(java.lang.Boolean staticHeaders)
Set the value of the staticHeaders property.
Contents: Enable the default scrollable table behaviour of using JavaScript to size a table header and footer that are in a fixed position regardless of table body scrolling.
setStaticHeaders in interface IDataTablepublic java.lang.Boolean isStaticHeaders()
Return the value of the staticHeaders property.
Contents: Enable the default scrollable table behaviour of using JavaScript to size a table header and footer that are in a fixed position regardless of table body scrolling. Default = 'true'.
isStaticHeaders in interface IDataTablepublic void setStyle(java.lang.String style)
Set the value of the style property.
Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
setStyle in interface IDataTablepublic java.lang.String getStyle()
Return the value of the style property.
Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
getStyle in interface IDataTablepublic void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property.
Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
setStyleClass in interface IDataTablepublic java.lang.String getStyleClass()
Return the value of the styleClass property.
Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
getStyleClass in interface IDataTablepublic void setTabIndex(java.lang.Integer tabIndex)
Set the value of the tabIndex property.
Contents: Defines a tabindex to be shared by all keyboard navigable elements of the table. This includes sort controls, filter fields and individual rows themselves.
setTabIndex in interface IDataTablepublic java.lang.Integer getTabIndex()
Return the value of the tabIndex property.
Contents: Defines a tabindex to be shared by all keyboard navigable elements of the table. This includes sort controls, filter fields and individual rows themselves. Default = '0'.
getTabIndex in interface IDataTablepublic void setToggleOnInvalidEdit(java.lang.Boolean toggleOnInvalidEdit)
Set the value of the toggleOnInvalidEdit property.
Contents: Enable the the client to revert the edited row with the default state following a failed edit. By default when validation fails during a row editing request the row remains in editing mode.
setToggleOnInvalidEdit in interface IDataTablepublic java.lang.Boolean isToggleOnInvalidEdit()
Return the value of the toggleOnInvalidEdit property.
Contents: Enable the the client to revert the edited row with the default state following a failed edit. By default when validation fails during a row editing request the row remains in editing mode. Default = 'false'.
isToggleOnInvalidEdit in interface IDataTablepublic void setApplyingFilters(java.lang.Boolean applyingFilters)
Set the value of the applyingFilters property.
setApplyingFilters in interface IDataTablepublic java.lang.Boolean isApplyingFilters()
Return the value of the applyingFilters property.
isApplyingFilters in interface IDataTablepublic void setApplyingSorts(java.lang.Boolean applyingSorts)
Set the value of the applyingSorts property.
setApplyingSorts in interface IDataTablepublic java.lang.Boolean isApplyingSorts()
Return the value of the applyingSorts property.
isApplyingSorts in interface IDataTablepublic void setCachedGlobalFilter(java.lang.Object cachedGlobalFilter)
Set the value of the cachedGlobalFilter property.
setCachedGlobalFilter in interface IDataTablepublic java.lang.Object getCachedGlobalFilter()
Return the value of the cachedGlobalFilter property.
getCachedGlobalFilter in interface IDataTablepublic void setFilteredData(java.util.List filteredData)
Set the value of the filteredData property.
setFilteredData in interface IDataTablepublic java.util.List getFilteredData()
Return the value of the filteredData property.
getFilteredData in interface IDataTablepublic void setForcedUpdateCounter(java.lang.Integer forcedUpdateCounter)
Set the value of the forcedUpdateCounter property.
setForcedUpdateCounter in interface IDataTablepublic java.lang.Integer getForcedUpdateCounter()
Return the value of the forcedUpdateCounter property.
getForcedUpdateCounter in interface IDataTablepublic void setLastReordering(java.lang.Long lastReordering)
Set the value of the lastReordering property.
setLastReordering in interface IDataTablepublic java.lang.Long getLastReordering()
Return the value of the lastReordering property.
getLastReordering in interface IDataTablepublic void setTableConfigPanel(java.lang.String tableConfigPanel)
Set the value of the tableConfigPanel property.
setTableConfigPanel in interface IDataTablepublic java.lang.String getTableConfigPanel()
Return the value of the tableConfigPanel property.
getTableConfigPanel in interface IDataTablepublic void setValueHashCode(java.lang.Integer valueHashCode)
Set the value of the valueHashCode property.
setValueHashCode in interface IDataTablepublic java.lang.Integer getValueHashCode()
Return the value of the valueHashCode property.
getValueHashCode in interface IDataTableprotected boolean isPropertySet(java.lang.String finder)
public void setValueExpression(java.lang.String name,
javax.el.ValueExpression binding)
setValueExpression in class javax.faces.component.UIDatapublic java.util.Collection<java.lang.String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic java.lang.String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender in interface IceClientBehaviorHolderpublic java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute in interface IceClientBehaviorHolderpublic java.lang.String getListenerArgument(java.lang.String event)
getListenerArgument in interface IceClientBehaviorHolderpublic void addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior in class javax.faces.component.UIComponentBaseCopyright 2017 ICEsoft Technologies Canada Corp., All Rights Reserved.