Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:dataTable

f:javax.faces.Component
   f:javax.faces.Data
      xp:com.ibm.xsp.Data
         xp:dataTable

Description

A control that displays a set of repeating data in a table.

Properties

Java

Java Class: com.ibm.xsp.component.xp.XspDataTableEx


accessibility

title, string
Advisory Title
Provides title information for controls.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
caption, string
Caption
The caption which will be displayed above the table
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
summary, string
Table Summary
Provides a summary of the purpose and structure of the table.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
role, string
Control Identifier
Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

basics

binding, object - javax.faces.component.UIComponent  [Inherited]
Control Binding
Specifies an expression that binds the control to a particular control property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding false
loaded, boolean  [Inherited]
Loaded
Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
id, string  [Inherited]
Control Identifier
Specifies the name identifier for the control. No two controls can have the same name identifier in a single page.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
rendered, boolean  [Inherited]
Rendered Flag
Indicates whether or not the control should be displayed or processed on any subsequent form submission.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rendererType, string  [Inherited]
Renderer Type
Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
dir, string
Direction
Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
lang, string
Language Code
Describes the language used in the generated markup of the control.
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
disabled, boolean
Disabled Flag
Determines whether or not the page can receive focus or be included in page submissions.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rules, string
Table Rules
Specifies rules between table cells. Valid values are 'none' (no rules, default), 'groups' (between row groups), 'rows' (between rows), 'cols' (between columns), and 'all' (between all rows and columns).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
partialRefresh, boolean
Partial Refresh
Only refreshes the control when a table action is triggered (collapse/expand...), using an Ajax request.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
partialExecute, boolean
Partial Execute
Specifies to only execute this control, thus bypassing the lifecycle for other controls.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
refreshId, string
Refresh Id
The id of the component to refresh via an Ajax request if partial refresh is enabled
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

first, int  [Inherited]
First Row Index
Specifies the row number of the first row to be displayed. Index is zero-based.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rows, int  [Inherited]
Rows To Display
Specifies the number of rows to display, starting with the row identified by the "first" property. If set to zero, all available rows in the underlying data model will be displayed.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
value, generic  [Inherited]
Value
Specifies the data model. This must either be of type DataModel, or a type that can be adapted into a DataModel using one of the registered DataModelFactorys.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
var, string  [Inherited]
Var
Request-scope attribute under which a row data will be made available
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
indexVar, string  [Inherited]
Index Variable
Specifies the variable name under which the row index is made available to children
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
data, xp:dataInterface - com.ibm.xsp.model.DataSource  [Inherited]
Data
Specifies the data associated with this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

events

onclick, string
Click Script
JavaScript code executed when a pointer control is clicked over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
ondblclick, string
Double Click Script
JavaScript code executed when a pointer control is double clicked over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmousedown, string
Mouse Down Script
JavaScript code executed when a pointer control is pressed down over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseup, string
Mouse Up Script
JavaScript code executed when a pointer control is released over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseover, string
Mouse Over Script
JavaScript code executed when a pointer control is moved onto this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmousemove, string
Mouse Move Script
JavaScript code executed when a pointer control is moved within this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onmouseout, string
Mouse Out Script
JavaScript code executed when a pointer control is moved away from this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeypress, string
Key Press Script
JavaScript code executed when a key is pressed and released over this control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeydown, string
Key Down Script
JavaScript code executed when a key is pressed down over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onkeyup, string
Key Up Script
JavaScript code executed when a key is released over this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

format

showUnreadMarks, boolean
Show Unread Marks
Boolean flag indicating if the unread entries should be specially marked for display in the view
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
border, int
Table Border
Specifies the pixel width of the table border
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
cellpadding, string
Cell Padding
Defines how much space should be left between the border of each cell and its contents
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
cellspacing, string
Cell Spacing
Defines how much space should left between the sides of a table and the edge rows and columns. Also specifies the amount of space to leave between cells.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
width, string
Table Width
Width of the entire table
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
bgcolor, string
Background Color
Specifies the name or code of the table background color
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
frame, string
Table Frame
Specifies which sides of the frame surrounding a table will be visible
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

styling

disableTheme, boolean  [Inherited]
Disable Theme
A flag used to determine if the theme should be applied to this control.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
themeId, string  [Inherited]
Theme Id
The theme id that should be used to set the component properties when a theme is applied
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
style, string
CSS Styles
Specifies CSS style(s) to be applied when this control is rendered.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
styleClass, string
CSS Style Classes
Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
captionStyleClass, string
Caption CSS Style Classes
Space-separated list of CSS style class(es) to be applied to the caption
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
unreadMarksClass, string
Unread Marks Style Class
The name of a style class to use to format unread view entries for display
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
readMarksClass, string
Read Marks Style Class
The name of a style class to use to format read view entries for display
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rowClasses, string
Row CSS Classes
A comma separated list of style classes that are iterated through for each row. So applying two style classes here will result in every second row referencing the second style class. Space separated style classes can be used too.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
columnClasses, string
Column CSS Classes
Specifies a comma-delimited list of CSS style classes that will be applied to table columns
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
footerClass, string
Footer CSS Classes
Specifies a space-separated list of CSS style class(es) that will be applied to any table footer
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
headerClass, string
Header CSS Classes
Specifies a space-separated list of CSS style class(es) that will be applied to any table header
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true