| |||||||
| FRAMES NO FRAMES | |||||||
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 Class | org.rcfaces.core.internal.taglib.DataGridTag |
| TagExtraInfo Class | org.rcfaces.core.internal.taglib.CameliaTagExtraInfo |
| Body Content | JSP |
| Display Name | None |
| Attributes | ||||
| Name | Required | Request-time | Type | Description |
| id | false | true | java.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. |
| binding | false | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| The value binding expression linking this component to a property in a backing bean. |
| rendered | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. |
| saveCompleteState | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| No Description |
| marginBottom | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom). |
| marginLeft | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the margin size for the component's left (compliant to CSS margin-left). |
| marginRight | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the margin size for the component's right (compliant to CSS margin-right). |
| marginTop | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the margin size for the component's top (compliant to CSS margin-top). |
| resetListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| keyUpListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| keyDownListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| keyPressListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| x | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value (as specified by CSS) for the x position of the component. |
| y | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value (as specified by CSS) for the x position of the component. |
| userEventListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| helpMessage | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the message to be shown by a helpMessageZone Component. |
| helpURL | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| An URL that points to a help page for the component. it is used for example by a helpButton Component. |
| toolTipText | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the tooltip for the component (shown when the pointe hover the component). |
| styleClass | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| lookId | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the choosen look of the component. |
| width | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value (as specified by CSS) for the width of the component. |
| height | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value (as specified by CSS) for the height of the component. |
| blurListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| focusListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| backgroundColor | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A color value (as specified by CSS) for the background. |
| foregroundColor | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A color value (as specified by CSS) for the text. |
| visible | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indicating wether the composant is visible. |
| errorListener | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| waiRole | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| sortManager | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| sortListener | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Executed when the component is sorted. 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. |
| mouseOutListener | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Executed when the pointer leaves the area of the component. A string that represent a javascript expression to evaluate. |
| mouseOverListener | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Executed when the pointer hover the component's area. A string that represent a javascript expression to evaluate. |
| unlockedClientAttributeNames | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value holding a comma separated list of the client modifiable properties. |
| tabIndex | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| An int value specifying the position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767. |
| initListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| propertyChangeListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| hiddenMode | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the management of invisible state on the client. Authorized values are :
|
| margins | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the margins for the component (compliant to CSS margin). |
| first | false | false | javax.el.ValueExpression
(must evaluate to int)
| A number identifying the row to be displayed at the top of the component. |
| var | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| value | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| A string value holding the current value of the component. |
| rows | false | false | javax.el.ValueExpression
(must evaluate to int)
| 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. |
| selectionListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| selectable | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indicating wether the component can receive a user's selection |
| selectionCardinality | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the type of multiple selection authorized:
|
| selectedValues | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| A table of the values associated with selected nodes for the component. (Binding only) |
| checkListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| checkable | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indcating wether the component can be checked. cf. checkCardinality. |
| checkCardinality | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string indicating the cardinality (number of check allowed) for this componenent. |
| checkedValues | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| A table of the values associated with checked nodes for the component. (Binding only) |
| additionalInformationListener | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| additionalInformationValues | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| No Description |
| clientAdditionalInformationFullState | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| additionalInformationCardinality | false | false | javax.el.ValueExpression
(must evaluate to int)
| No Description |
| doubleClickListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| loadListener | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Executed when the component is fully loaded (similar to init for AJAX). 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. |
| required | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indicating that the user is required to provide a submitted value for this input component. |
| border | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value that indicates if the component should show a border or not. |
| rowStyleClass | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A space-separated list of CSS style class(es) to be applied when the row is rendered. This value will be passed through as the "class" attribute on generated markup. |
| emptyDataMessage | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| readOnly | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. |
| disabled | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value that represents the disabled state of the component. |
| horizontalScrollPosition | false | false | javax.el.ValueExpression
(must evaluate to int)
| A string value specifying the position of the horizontal scroolbar. |
| verticalScrollPosition | false | false | javax.el.ValueExpression
(must evaluate to int)
| A string value specifying the position of the vertical scroolbar (Browser dependant). |
| filterProperties | false | false | javax.el.ValueExpression
(must evaluate to org.rcfaces.core.model.IFilterProperties)
| A binded object that hold the filters to use on the server side. This property is often set via javascript code. |
| showValue | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| No Description |
| keySearchColumnId | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
| preferences | false | false | javax.el.ValueExpression
(must evaluate to org.rcfaces.core.preference.IComponentPreferences)
| No Description |
| paged | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| 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. |
| clientSelectionFullState | false | false | javax.el.ValueExpression
(must evaluate to java.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). |
| clientCheckFullState | false | false | javax.el.ValueExpression
(must evaluate to java.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). |
| headerVisible | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| A boolean value indicating wether the header should be visible. |
| cursorValue | false | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| No Description |
| rowValueColumnId | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| An id for the column containing the key for the row. |
| rowCountVar | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the name of the variable receiving the number of rows. |
| rowIndexVar | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A string value specifying the name of the variable receiving the index of the current row. |
| cellTextWrap | false | false | javax.el.ValueExpression
(must evaluate to boolean)
| No Description |
| action | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| actionListener | false | false | javax.el.ValueExpression
(must evaluate to java.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. |
| |||||||
| FRAMES NO FRAMES | |||||||