RCFaces CORE components
Tag dataGrid


The dataGrid Component is a grid component. It can be compared to the grid found in the list part of the modern file explorer. It allows sorts, resizing, contextual menus ...

The dataGrid Component has the following capabilities :



Tag Information
Tag Classorg.rcfaces.core.internal.taglib.DataGridTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
idfalsefalsejava.lang.String A string specifying the identifier for this component. This value must be unique within the closest parent component that is a naming container.
bindingfalsefalsejava.lang.String The value binding expression linking this component to a property in a backing bean.
renderedfalsetruejava.lang.String A boolean value indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
valuefalsetruejava.lang.String A string value holding the current value of the component.
hiddenModefalsetruejava.lang.String A string value specifying the management of invisible state on the client. Authorized values are :
  • server : if not visible, nothing is sent to the client
  • phantom : if not visible, the data is sent to the client and the page estate is reserved for a futur eventual display of the component
  • ignore : if not visible, the data is sent to the client but no page estate is reserved
visiblefalsetruejava.lang.String A boolean value indicating wether the composant is visible.
heightfalsetruejava.lang.String A string value (as specified by CSS) for the height of the component.
widthfalsetruejava.lang.String A string value (as specified by CSS) for the width of the component.
helpMessagefalsetruejava.lang.String A string value specifying the message to be shown by a helpMessageZone Component.
helpURLfalsetruejava.lang.String An URL that points to a help page for the component. it is used for example by a helpButton Component.
toolTipTextfalsetruejava.lang.String A string value specifying the tooltip for the component (shown when the pointe hover the component).
mouseOutListenerfalsetruejava.lang.String Executed when the pointer leaves the area of the component. A string that represent a javascript expression to evaluate.
mouseOverListenerfalsetruejava.lang.String Executed when the pointer hover the component's area. A string that represent a javascript expression to evaluate.
unlockedClientAttributeNamesfalsetruejava.lang.String A string value holding a comma separated list of the client modifiable properties.
lookIdfalsetruejava.lang.String A string value specifying the choosen look of the component.
blurListenerfalsetruejava.lang.String Executed when the focus quits the component. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
focusListenerfalsetruejava.lang.String Executed when the component gets the focus. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
xfalsetruejava.lang.String A string value (as specified by CSS) for the x position of the component.
yfalsetruejava.lang.String A string value (as specified by CSS) for the x position of the component.
marginBottomfalsetruejava.lang.String A string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).
marginLeftfalsetruejava.lang.String A string value specifying the margin size for the component's left (compliant to CSS margin-left).
marginRightfalsetruejava.lang.String A string value specifying the margin size for the component's right (compliant to CSS margin-right).
marginTopfalsetruejava.lang.String A string value specifying the margin size for the component's top (compliant to CSS margin-top).
backgroundColorfalsetruejava.lang.String A color value (as specified by CSS) for the background.
foregroundColorfalsetruejava.lang.String A color value (as specified by CSS) for the text.
keyPressListenerfalsetruejava.lang.String Executed when the component detects a key pressed event. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
keyDownListenerfalsetruejava.lang.String Executed when the component detects a key down event. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
keyUpListenerfalsetruejava.lang.String Executed when the component detects a key up event. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
resetListenerfalsetruejava.lang.String Executed when the reset button is activated on a form. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
styleClassfalsetruejava.lang.String A space-separated list of CSS style class(es) to be applied to the component. This value will be passed through as the "class" attribute on generated markup.
userEventListenerfalsetruejava.lang.String Executed when the component is called. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
propertyChangeListenerfalsetruejava.lang.String Executed when a component's property is changed (by javascript). A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
initListenerfalsetruejava.lang.String Executed when the component is intialized. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
marginsfalsetruejava.lang.String A string value specifying the margins for the component (compliant to CSS margin).
varfalsetruejava.lang.String A string value holding the name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.
firstfalsetruejava.lang.String A number identifying the row to be displayed at the top of the component.
rowsfalsetruejava.lang.String An int value specifying the number of rows to display, starting with the one identified by the "first" property. If this value is set to zero, all available rows in the underlying data model will be displayed.
selectionListenerfalsetruejava.lang.String Executed when the component is selected. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
selectablefalsetruejava.lang.String A boolean value indicating wether the component can receive a user's selection
selectionCardinalityfalsetruejava.lang.String A string value specifying the type of multiple selection authorized:
  • zeromany|*: any number of selections or none
  • one|1: one and only one selection
  • onemany|+: one or more selection
  • optionnal|?: none or one selection
checkListenerfalsetruejava.lang.String Executed when the component is checked. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
checkablefalsetruejava.lang.String A boolean value indcating wether the component can be checked. cf. checkCardinality.
checkCardinalityfalsetruejava.lang.String A string indicating the cardinality (number of check allowed) for this componenent.
doubleClickListenerfalsetruejava.lang.String Executed when the component is double-clicked. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
requiredfalsetruejava.lang.String A boolean value indicating that the user is required to provide a submitted value for this input component.
borderfalsetruejava.lang.String A boolean value that indicates if the component should show a border or not.
readOnlyfalsetruejava.lang.String A boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.
disabledfalsetruejava.lang.String A boolean value that represents the disabled state of the component.
horizontalScrollPositionfalsetruejava.lang.String A string value specifying the position of the horizontal scroolbar.
verticalScrollPositionfalsetruejava.lang.String A string value specifying the position of the vertical scroolbar (Browser dependant).
filterPropertiesfalsetruejava.lang.String A binded object that hold the filters to use on the server side. This property is often set via javascript code.
preferencefalsetruejava.lang.String A binded object that holds the preferences for the component.
headerVisiblefalsetruejava.lang.String A boolean value indicating wether the header should be visible.
pagedfalsetruejava.lang.String A boolean value specifying wether the results should be displayed by page (thus letting the user choose what page to display via the pager). It is ignored if the attribute "rows" is undefined. The default value is true. If "rows" is defined and "paged"'s value is set to false, pages are downloaded automatically when the last displayed row is selected.
selectedValuesfalsetruejava.lang.String A table of the values associated with selected nodes for the component. (Binding only)
checkedValuesfalsetruejava.lang.String A table of the values associated with checked nodes for the component. (Binding only)
sortedColumnIdsfalsetruejava.lang.String A string value giving the ordered list of the sorted column ids. read-only
columnsOrderfalsetruejava.lang.String A list of the columns' id which represents their order from left to right.
rowValueColumnIdfalsetruejava.lang.String An id for the column containing the key for the row.
rowCountVarfalsetruejava.lang.String A string value specifying the name of the variable receiving the number of rows.
rowIndexVarfalsetruejava.lang.String A string value specifying the name of the variable receiving the index of the current row.
clientSelectionFullStatefalsetruejava.lang.String A boolean value indicating wether the client should know about the component's full state even if only a part of the data is present (AJAX).
clientCheckFullStatefalsetruejava.lang.String A boolean value indicating wether the client should know about the component's full state even if only a part of the data is present (AJAX).
actionfalsetruejava.lang.String A string that indicates the url to activate on the server when the component is actionned through a key mapping on the faces config file.
actionListenerfalsetruejava.lang.String Executed when the the component is activated by the user. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.

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.