Tomahawk tag library 1.2.
Tag dataList


Similar to dataTable, but does not render a table. Instead the layout attribute controls how each dataRow is rendered. Unless otherwise specified, all attributes accept static values or EL expressions.


Tag Information
Tag Classorg.apache.myfaces.custom.datalist.HtmlDataListTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
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.
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.
layoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
simple|unorderedList|orderedList
  • simple = for each dataRow all children are simply rendered
  • unorderedList = the list is rendered as HTML unordered list (= bullet list)
  • orderedList = the list is rendered as HTML ordered list
Default: simple
itemStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
CSS class to be applied to individual items in the list
itemOnClickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
OnClick handler to be applied to individual items in the list
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.

firstfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Defines the index of the first row to be displayed, starting from 0.
rowsfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Defines the maximum number of rows of data to be displayed.

Specify zero to display all rows from the "first" row to the end of available data.

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.