ICEfaces ACE Components
Tag dataTable


Renders an HTML table element. This table and its associated components offers support for features like: scrolling, sorting, filtering, row selection, row editing, lazy loading and expandable subrows and subpanels.

For more information, see the DataTable Wiki Documentation.


Facets
emptyMessageAn optional facet that is rendered in place of data rows when the dataTable view contains no rows.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
pageFired when the page is changed on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
rowsPerPageFired when the rows per page is changed on the DataTable via the paginator control.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
cellClickFired when a cell is clicked on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
cellDblClickFired when a cell is double clicked on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
selectFired when a row or cell is selected on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
deselectFired when a row or cell is deselected on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
sortFired when a change to the current sort occurs on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
filterFired when a change to the current filters occurs on the DataTable.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
reorderFired when a column is dragged and dropped into a new ordering.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
editStartFired when a row is enabled for editing.javax.faces.event.AjaxBehaviorEventexecute=@this render=@this
editSubmitFired when a row is submits its edits.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
editCancelFired when a row cancels an in-progress edit.javax.faces.event.AjaxBehaviorEventexecute=@this render=@this
expandFired when a child ExpansionToggler component is clicked to expand (Note: for nested tables, the execute value should be @form or @all for the expansion to work).javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
contractFired when a child ExpansionToggler component is clicked to contract (Note: for nested tables, the execute value should be @form or @all for the contraction to work).javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
pinFired when a column is added to the pinning region of the table.javax.faces.event.AjaxBehaviorEventexecute=@this render=@this
unpinFired when a column is removed to the pinning region of the table.javax.faces.event.AjaxBehaviorEventexecute=@this render=@this
findFired for a find request.org.icefaces.ace.event.DataTableFindEventexecute=@all render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.datatable.DataTableTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to this component.
allColumnClicksnotruebooleanEnable 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.
allowTableResizingnotruebooleanWhen 'resizableColumns' is enabled, allow the table to also increase or decrease in width proportionally to the column being resized. In the normal mode, when resizing a column, tables maintain their original widths, and a specific column is made wider by making other columns narrower. HTML has a limitation that prevents table columns to be narrower than their contents. This mode is mainly oriented to tables that have too many columns that they can't fit in the viewport width, resulting impossible to make a column wider in the normal mode due to this HTML limitation.
alwaysExecuteContentsnotruejava.lang.BooleanEnable 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'.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
captionnotruejava.lang.StringCauses a caption element to be rendered with the specified text, in order to facilitate better screen reader support and accessibility for this table.
clickableHeaderSortingnotruebooleanEnabling makes the entire header container the clickable region for sort events. Default = 'true'.
columnOrderingnotruejava.util.ListDefines a list of integers representing a rendering order for the Column children of the table.
columnPinningnotruebooleanEnable statically positioned columns along the left hand side of a scrollable table (i.e. the 'scrollable' attribute must be set to 'true' for this feature to work).
columnPinningControlsInHeadernotruebooleanEnable client controls to add column to the list of statically positioned columns.
columnsInheritPropertiesnotruebooleanTo 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'.
constantRefilternotruebooleanEnable 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'.
currentPageReportTemplatenotruejava.lang.StringDefines 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})".
disablednotruebooleanDisable all features of the data table. Default = 'false'.
doubleClickSelectnotruebooleanEnable to require a double-click to fire row/cell selection events.
emptyMessagenotruejava.lang.StringDefine a string to render when there are no records to display. The 'emptyMessage' facet takes precedence over this attribute.
filterEventnotruejava.lang.StringDefines 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'.
filterListenernotruejavax.el.MethodExpressionMethodExpression reference called whenever the table row is filtered. The method receives a single argument, TableFilterEvent.
filterValuenotruejava.lang.StringDefines the input to the column non-specific filter, coming from the client, or from the app via a value binding.
firstnotrueintZero-relative row number of the first row in the underlying data model to be displayed, or zero to start at the beginning of the data model. Default = '0'.
groupedFilterResultsnotruebooleanEnable to display all members of groups (as defined by ace:column groupBy) that contain a matching row during filtering.
headerColumnOrderingnotruejava.util.ListDefines 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.
hiddenScrollableSizingnotruejava.lang.BooleanEnable 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'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
lazynotruebooleanEnables 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.
liveScrollnotruebooleanWhen 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.
liveScrollBufferPagesnotruejava.lang.IntegerWhen 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'.
pagenotrueintDefines the index of the current page, beginning at 1.
pageCountnotruejava.lang.IntegerDefines the maximum number of individual page links to display in paginator. Default = '10'.
pagesToSkipnotrueintDefines the number of pages to skip when pressing the FastRewind and FastForward buttons. Default = '3'.
paginatornotruebooleanEnables 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().
paginatorAccesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to the current page button.
paginatorAlwaysVisiblenotruebooleanDefines whether the paginator always displays, even when fewer then 1 page full of items are displayed.
paginatorPositionnotruejava.lang.StringDefines the location of the paginator if enabled. Available options are top, bottom, or the default, both. Default = 'both'.
paginatorTemplatenotruejava.lang.StringDefines 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.
renderRowTabindexnotruebooleanRow tabindex is required for dataTable Find feature and for selecting rows by using the keyboard. If the Find or Row Selection features are not used and the tabindex interferes with tabbing through inputs in the table, set this to false. Default = 'true'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
reorderableColumnsnotruebooleanEnable reordering of the table columns via header dragging.
resizableColumnsnotruebooleanEnable resizing of the table columns via handles on the column headers.
rowIndexnotrueintZero-relative index of the row currently being accessed in the underlying DataModel, or -1 for no current row. Default = '0'.
rowIndexVarnotruejava.lang.StringThe request-scope attribute (if any) under which the data object index for the current row will be exposed when iterating.
rowSelectListenernotruejavax.el.MethodExpressionMethodExpression reference called whenever a table element is selected. The method receives a single argument, SelectEvent.
rowStateVarnotruejava.lang.StringThe request-scope attribute (if any) under which the table state object for the current row will be exposed when iterating. Default = 'rowState'.
rowStyleClassnotruejava.lang.StringDefine css classes for each row of the dataTable. EL can be used in this attribute to produce conditional row styling.
rowUnselectListenernotruejavax.el.MethodExpressionMethodExpression reference called whenever a table element is deselected. The method receives a single argument, UnselectEvent.
rowsnotrueintThe number of rows to be displayed, or zero to display the entire set of available rows. Default = '0'.
rowsPerPageTemplatenotruejava.lang.StringDefines 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.
scrollHeightnotruejava.lang.IntegerDefines a fixed height for the scrollable table in pixels. Default = '100'.
scrollWidthIE7notruejava.lang.String(Deprecated) This attribute was used to support scrolling on IE7 in previous versions and has no effect now.
scrollablenotruebooleanEnabling 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.
selectionModenotruejava.lang.StringDefines 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.
singleSortnotruebooleanDisables sorting for multiple columns at once. Sorting is enabled by the use of sortBy on ace:column components. Default = 'false'.
stateMapnotrueorg.icefaces.ace.model.table.RowStateMapDefines 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.
staticHeadersnotruejava.lang.BooleanEnable 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'.
stylenotruejava.lang.StringCustom 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.
styleClassnotruejava.lang.StringCustom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
tabIndexnotruejava.lang.IntegerDefines 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'.
toggleOnInvalidEditnotruejava.lang.BooleanEnable 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'.
valuenotruejava.lang.ObjectThe DataModel instance representing the data to which this component is bound, or a collection of data for which a DataModel instance is synthesized.
varnotruejava.lang.StringThe request-scope attribute (if any) under which the data object for the current row will be exposed when iterating.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.