Tomahawk sandbox tag library.
Tag autoUpdateDataTable


Extended data_table that adds some additional features to the standard data_table action: see attribute descriptions for preserveDataModel, sortColumn, sortAscending and preserveSort. NOTE: This component is deprecated. Use periodicalUpdate mechanism of partial page rendering instead


Tag Information
Tag Classorg.apache.myfaces.custom.autoupdatedatatable.AutoUpdateDataTableTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
frequencyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines in seconds the interval of reloads. if no value is specified 2 seconds will be default.
onSuccessfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Define javascript function to call after successful refresh.
firstfalsefalsejavax.el.ValueExpression
(must evaluate to int)
The index of the first row to be displayed, where 0 is the first row.
rowsfalsefalsejavax.el.ValueExpression
(must evaluate to int)
The number of rows to be displayed. Specify zero for all remaining rows in the table.
forceIdIndexFormulafalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A formula that overrides the default row index in the construction of table's body components. Example : #{myRowVar.key} Warning, the EL should evaluate to a unique value for each row !
sortColumnfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Value reference to a model property that gives the current sort column name. The target String property is set to the "columnName" of whichever column has been chosen to sort by, and the method which is bound to the "value" attribute of this table (ie which provides the DataModel used) is expected to use this property to determine how to sort the DataModel's contents.
sortAscendingfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Value reference to a model property that gives the current sort direction. The target Boolean property is set to true when the selected sortColumn should be sorted in ascending order, and false otherwise. The method which is bound to the "value" attribute of this table (ie which provides the DataModel used) is expected to use this property to determine how to sort the DataModel's contents.
sortablefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Define if the table is sortable or not
embeddedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Avoids rendering the html table tags, thus, giving you a table rendering just rows. You can use this together with the detailStamp faces of the parent datatable to render child-tables using the same layout as the parent. Notice: You have to ensure both tables do have the same number of columns. Using the colspan attribute of the column tag might help alot.
detailStampExpandedDefaultfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
true|false - true if the detailStamp should be expanded by default. default: false
detailStampLocationfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
before|after - where to render the detailStamp, before the actual row or after it. default: after
rowOnMouseOverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onmouseover event handler for each table row
rowOnMouseOutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onmouseout event handler for each table row
rowOnClickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onclick event handler for each table row
rowOnDblClickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript ondblclick event handler for each table row
rowOnKeyDownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onkeydown event handler for each table row
rowOnKeyPressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onkeypress event handler for each table row
rowOnKeyUpfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onkeyup event handler for each table row
rowStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Corresponds to the HTML class attribute for the row tr tag.
rowStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Corresponds to the HTML style attribute for the row tr tag.
rowOnMouseDownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onmpusedown event handler for each table row
rowOnMouseMovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onmousemove event handler for each table row
rowOnMouseUpfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Defines a JavaScript onmouseup event handler for each table row
varDetailTogglerfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
This variable has the boolean property "currentdetailExpanded" which is true if the current detail row is expanded and the action method "toggleDetail" which expand/collapse the current detail row.
rowGroupStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Corresponds to the HTML style attribute for grouped rows.
rowGroupStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass for grouped rows.
bodyStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Corresponds to the HTML style attribute for the table body tag
bodyStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Corresponds to the HTML class attribute for the table body tag.
newspaperColumnsfalsefalsejavax.el.ValueExpression
(must evaluate to int)
The number of columns to wrap the table over. Default: 1 Set the number of columns the table will be divided over.
newspaperOrientationfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". Default: vertical
preserveDataModelfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Indicates whether the state of the whole DataModel should be saved and restored. When set to false, the value-binding for the "value" attribute of this table is executed each time the page is rendered. When set to true, that value-binding is only executed when the component is first created, and the DataModel state is thereafter saved/restored automatically by the component. When column sorting is used for a table this property needs to be false so that the DataModel can be updated to reflect any changes in the sort criteria. Default: false
preserveSortfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Indicates whether the state of the sortColumn and sortAscending attribute should be saved and restored and written back to the model during the update model phase. Default: true
renderedIfEmptyfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Indicates whether this table should be rendered if the underlying DataModel is empty. You could as well use rendered="#{not empty bean.list}", but this one causes the getList method of your model bean beeing called up to five times per request, which is not optimal when the list is backed by a DB table. Using renderedIfEmpty="false" solves this problem, because the MyFaces extended HtmlDataTable automatically caches the DataModel and calles the model getter only once per request. Default: true
rowIndexVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.
rowCountVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A parameter name, under which the rowCount is set in request scope similar to the var parameter.
previousRowDataVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters. Mind that the value of this request scope attribute is null in the first row or when isRowAvailable returns false for the previous row.
sortedColumnVarfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A parameter name, under which the a boolean is set in request scope similar to the var parameter. TRUE for the column that is currently sorted, FALSE otherwise.
alignfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
rowIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The id to use for
datafldfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reserved for future use.
datasrcfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reserved for future use.
dataformatasfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reserved for future use.
valueTypefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Indicate the expected type of the EL expression pointed by value property. It is useful when vb.getType() cannot found the type, like when a map value is resolved on the expression.
enabledOnUserRolefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
preserveRowStatesfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Indicates whether the state for each row should not be discarded before the datatable is rendered again. Setting this to true might be hepful if an input component inside the datatable has no valuebinding and the value entered in there should be displayed again. This will only work reliable if the datamodel of the datatable did not change either by sorting, removing or adding rows. Default: false
forceIdfalsefalsejava.lang.StringIf true, this component will force the use of the specified id when rendering.
forceIdIndexfalsefalsejava.lang.StringIf false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
rowKeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Used to assign a value expression that identify in a unique way a row. This value will be used later instead of rowIndex as a key to be appended to the container client id using getDerivedSubClientId() method.
derivedRowKeyPrefixfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
This attribute is used to append an unique prefix when rowKey is not used, to prevent a key match a existing component id (note two different components can't have the same unique id).
bgcolorfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: The background color of this element.
borderfalsefalsejavax.el.ValueExpression
(must evaluate to int)
HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
cellpaddingfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage.
cellspacingfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies the amount of space between the cells of the table. It can be either a pixel length or a percentage of available space.
columnClassesfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A comma separated list of CSS class names to apply to td elements in each column.
footerClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The CSS class to be applied to footer cells.
framefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Controls what part of the frame that surrounds a table is visible. Values include: void, above, below, hsides, lhs, rhs, vsides, box, and border.
headerClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The CSS class to be applied to header cells.
rowClassesfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A comma separated list of CSS class names to apply to td elements in each row.
rulesfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.
summaryfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Provides a summary of the contents of the table, for accessibility purposes.
widthfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies the desired width of the table, as a pixel length or a percentage of available space.
captionClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A comma separated list of CSS class names to apply to all captions. If there are less classes than the number of rows, apply the same sequence of classes to the remaining captions, so the pattern is repeated. More than one class can be applied to a row by separating the classes with a space.
captionStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Gets The CSS class to be applied to the Caption.
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: CSS styling instructions.
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The CSS class for this element. Corresponds to the HTML 'class' attribute.
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the element is double-clicked.
onkeydownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when a key is pressed down over this element.
onkeypressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when a key is pressed over this element.
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when a key is released over this element.
onmousedownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is moved into this element.
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is released over this element.
dirfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: The base language of this document.
titlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: An advisory title for this element. Often used by the user agent as a tooltip.
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
An EL expression that specifies the data model that backs this table.

The value referenced by the EL expression can be of any type.

  • A value of type DataModel is used directly.
  • Array-like parameters of type array-of-Object, java.util.List, java.sql.ResultSet or javax.servlet.jsp.jstl.sql.Result are wrapped in a corresponding DataModel that knows how to iterate over the elements.
  • Other values are wrapped in a DataModel as a single row.

Note in particular that unordered collections, eg Set are not supported. Therefore if the value expression references such an object then the table will be considered to contain just one element - the collection itself.

varfalsefalsejava.lang.StringDefines the name of the request-scope variable that will hold the current row during iteration.

During rendering of child components of this UIData, the variable with this name can be read to learn what the "rowData" object for the row currently being rendered is.

This value must be a static value, ie an EL expression is not permitted.

idfalsetruejava.lang.StringGet a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
A boolean value that indicates whether this component should be rendered. Default value: true.
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

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.