Author: atsebro Date: 2008-09-02 13:21:09 -0400 (Tue, 02 Sep 2008) New Revision: 10282 Modified: trunk/ui/extendedDataTable/src/main/config/component/ExtendedDataTable.xml Log: RF-4131:extendedDataTable-Documenting Modified: trunk/ui/extendedDataTable/src/main/config/component/ExtendedDataTable.xml =================================================================== --- trunk/ui/extendedDataTable/src/main/config/component/ExtendedDataTable.xml 2008-09-02 17:03:38 UTC (rev 10281) +++ trunk/ui/extendedDataTable/src/main/config/component/ExtendedDataTable.xml 2008-09-02 17:21:09 UTC (rev 10282) @@ -1,237 +1,238 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE components PUBLIC "-//AJAX4JSF//CDK Generator config/EN" "http://labs.jboss.com/jbossrichfaces/component-config.dtd"> <components> - <component> - <name>org.richfaces.ExtendedDataTable</name> - <family>org.richfaces.ExtendedDataTable</family> - <classname>org.richfaces.component.html.HtmlExtendedDataTable</classname> - <superclass>org.richfaces.component.UIExtendedDataTable</superclass> - <description> - The &lt;rich:extendedDataTable&gt; component is used for tables extending standard component &lt;rich:dataTable&gt; . - </description> - <renderer generate="true" override="true"> - <name>org.richfaces.ExtendedDataTableRenderer</name> - <template>org/richfaces/htmlExtendedDataTable.jspx</template> - </renderer> - <tag> - <name>extendedDataTable</name> - <classname>org.richfaces.taglib.ExtendedDataTableTag</classname> - <superclass> - org.ajax4jsf.webapp.taglib.HtmlComponentTagBase - </superclass> - </tag> - <!-- + <component> + <name>org.richfaces.ExtendedDataTable</name> + <family>org.richfaces.ExtendedDataTable</family> + <classname>org.richfaces.component.html.HtmlExtendedDataTable</classname> + <superclass>org.richfaces.component.UIExtendedDataTable</superclass> + <description> The &lt;rich:extendedDataTable&gt; component is used for + tables extending standard component &lt;rich:dataTable&gt; . </description> + <renderer generate="true" override="true"> + <name>org.richfaces.ExtendedDataTableRenderer</name> + <template>org/richfaces/htmlExtendedDataTable.jspx</template> + </renderer> + <tag> + <name>extendedDataTable</name> + <classname>org.richfaces.taglib.ExtendedDataTableTag</classname> + <superclass> org.ajax4jsf.webapp.taglib.HtmlComponentTagBase + </superclass> + </tag> + <!-- <taghandler> <classname>org.ajax4jsf.tag.TestHandler</classname> </taghandler> --> - &ui_component_attributes; - &ui_data_attributes; - &html_universal_attributes; - &html_table_attributes; - &html_events; - &spec_table_attributes; - <property> - <name>onselectionchange</name> - <classname>java.lang.String</classname> - <description> - HTML: script expression to invoke on changing of rows selection - </description> - </property> - <property> - <name>selectionMode</name> - <classname>java.lang.String</classname> - <description> - single [default]: Single row can be selected. - multi: Multiple rows can be selected. - none: no rows can be selected. - </description> - <defaultvalue> - "single" - </defaultvalue> - </property> - <property> - <name>height</name> - <classname>java.lang.String</classname> - <description>Defines a height of the component. Default value is 500px</description> - <defaultvalue>"500px"</defaultvalue> - </property> - <property> - <name>selectedClass</name> - <classname>java.lang.String</classname> - <description> - CSS class for selected rows - </description> - </property> - <property> - <name>activeClass</name> - <classname>java.lang.String</classname> - <description> - CSS class for active row - </description> - </property> - - <property> - <name>ajaxKeys</name> - <classname>java.util.Set</classname> - <description>This attribute defines row keys that are updated after an AJAX request</description> - </property> - <property> - <name>border</name> - <classname>java.lang.String</classname> - <description>This attributes specifies the width of the frame around a component</description> - <defaultvalue>"0"</defaultvalue> - </property> - <property> - <name>cellpadding</name> - <classname>java.lang.String</classname> - <description>This attribute specifies the amount of space between the border of the cell and its contents</description> - <defaultvalue>"0"</defaultvalue> - </property> - <property> - <name>cellspacing</name> - <classname>java.lang.String</classname> - <description>This attribute specifies the amount of space between the border of the cell and its contents. The attribute also specifies the amount of space to leave between cells - </description> - <defaultvalue>"0"</defaultvalue> - </property> - <property> - <name>captionClass</name> - <classname>java.lang.String</classname> - <description>Space-separated list of CSS style class(es) that are be applied to caption for this component</description> - <defaultvalue>""</defaultvalue> - </property> - <property> - <name>captionStyle</name> - <classname>java.lang.String</classname> - <description>CSS style(s) is/are to be applied to caption when this component is rendered</description> - </property> - <property> - <name>headerClass</name> - <classname>java.lang.String</classname> - <description>Space-separated list of CSS style class(es) that are be applied to header for this component - </description> - <defaultvalue>""</defaultvalue> - </property> - <property> - <name>footerClass</name> - <classname>java.lang.String</classname> - <description>Space-separated list of CSS style class(es) that are be applied to footer for this component - </description> - <defaultvalue>""</defaultvalue> - </property> - - <property> - <name>componentState</name> - <classname>org.ajax4jsf.model.DataComponentState</classname> - <description>It defines EL-binding for a component state for saving or redefinition</description> - </property> - <property hidden="true" existintag="false" exist="false" > - <name>rowKey</name> - <classname>java.lang.Object</classname> - <description> - RowKey is a representation of an identifier for a specific data row - </description> - </property> - <property> - <name>rowKeyVar</name> - <classname>java.lang.String</classname> - <description>The attribute provides access to a row key in a Request scope</description> - </property> - <property> - <name>stateVar</name> - <classname>java.lang.String</classname> - <description> - The attribute provides access to a component state on the client side - </description> - </property> - <property> - <name>value</name> - <classname>java.lang.Object</classname> - <description> - The current value for this component - </description> - </property> - <!-- rows javascript events --> - <property> - <name>onRowClick</name> - <classname>java.lang.String</classname> - <description> - HTML: a script expression; a pointer button is clicked on row - </description> - </property> - <property> - <name>onRowDblClick</name> - <classname>java.lang.String</classname> - <description>HTML: a script expression; a pointer button is double-clicked on row - </description> - </property> - <property> - <name>onRowMouseUp</name> - <classname>java.lang.String</classname> - <description>HTML: script expression; a pointer button is released on row - </description> - </property> - <property> - <name>onRowMouseDown</name> - <classname>java.lang.String</classname> - <description>HTML: script expression; a pointer button is pressed down on row - </description> - </property> - <property> - <name>onRowMouseOver</name> - <classname>java.lang.String</classname> - <description>HTML: a script expression; a pointer is moved onto of row - </description> - </property> - <property> - <name>onRowMouseOut</name> - <classname>java.lang.String</classname> - <description>HTML: a script expression; a pointer is moved away of row - </description> - </property> - <property> - <name>onRowMouseMove</name> - <classname>java.lang.String</classname> - <description>HTML: a script expression; a pointer is moved within of row - </description> - </property> - <property> - <name>sortPriority</name> - <classname>java.util.Collection</classname> - <description>Defines a set of column ids in the order the columns could be set</description> - </property> - <property hidden="true" existintag="false" exist="false" > - <name>sortFields</name> - </property> - <property hidden="true" existintag="false" exist="false" > - <name>filterFields</name> - </property> - <property> - <name>sortMode</name> - <classname>java.lang.String</classname> - <description> - Defines mode of sorting. Possible values are 'single' for sorting of one column and 'multi' for some. - </description> - </property> - <property hidden="true" existintag="false" exist="false" > - <name>summary</name> - <classname>java.lang.Object</classname> - </property> - - <property elonly="true"> - <name>tableState</name> - <classname>java.lang.String</classname> - <description> - ValueBinding pointing at a property of a String to hold table state - </description> - </property> - - <property attachedstate="true" elonly="true"> - <name>selection</name> - <classname>org.richfaces.model.selection.Selection</classname> - <description>Value binding representing selected rows</description> - </property> - - </component> + &ui_component_attributes; &ui_data_attributes; + &html_universal_attributes; &html_table_attributes; &html_events; + &spec_table_attributes; <property> + <name>activeRowKey</name> + + <description>Request scope attribute under which the activeRowKey will + be accessible</description> + </property> + <property> + <name>rowKeyConverter</name> + + <description>Converter for a row key object</description> + </property> + <property> + <name>groupingColumn</name> + + <description>The information in the table wiil be grouped by the + information in the column, which id is provided with this + attribute.</description> + </property> + <property> + <name>onselectionchange</name> + <classname>java.lang.String</classname> + <description> HTML: script expression to invoke on changing of rows + selection </description> + </property> + <property> + <name>selectionMode</name> + <classname>java.lang.String</classname> + <description> single [default]: Single row can be selected. multi: + Multiple rows can be selected. none: no rows can be + selected. </description> + <defaultvalue> "single" </defaultvalue> + </property> + <property> + <name>height</name> + <classname>java.lang.String</classname> + <description>Defines a height of the component. Default value is 500px</description> + <defaultvalue>"500px"</defaultvalue> + </property> + <property> + <name>selectedClass</name> + <classname>java.lang.String</classname> + <description> CSS class for selected rows </description> + </property> + <property> + <name>activeClass</name> + <classname>java.lang.String</classname> + <description> CSS class for active row </description> + </property> + <property> + <name>ajaxKeys</name> + <classname>java.util.Set</classname> + <description>This attribute defines row keys that are updated after an + AJAX request</description> + </property> + <property> + <name>border</name> + <classname>java.lang.String</classname> + <description>This attributes specifies the width of the frame around a + component</description> + <defaultvalue>"0"</defaultvalue> + </property> + <property> + <name>cellpadding</name> + <classname>java.lang.String</classname> + <description>This attribute specifies the amount of space between the + border of the cell and its contents</description> + <defaultvalue>"0"</defaultvalue> + </property> + <property> + <name>cellspacing</name> + <classname>java.lang.String</classname> + <description>This attribute specifies the amount of space between the + border of the cell and its contents. The attribute also + specifies the amount of space to leave between cells </description> + <defaultvalue>"0"</defaultvalue> + </property> + <property> + <name>captionClass</name> + <classname>java.lang.String</classname> + <description>Space-separated list of CSS style class(es) that are be + applied to caption for this component</description> + <defaultvalue>""</defaultvalue> + </property> + <property> + <name>captionStyle</name> + <classname>java.lang.String</classname> + <description>CSS style(s) is/are to be applied to caption when this + component is rendered</description> + </property> + <property> + <name>headerClass</name> + <classname>java.lang.String</classname> + <description>Space-separated list of CSS style class(es) that are be + applied to header for this component </description> + <defaultvalue>""</defaultvalue> + </property> + <property> + <name>footerClass</name> + <classname>java.lang.String</classname> + <description>Space-separated list of CSS style class(es) that are be + applied to footer for this component </description> + <defaultvalue>""</defaultvalue> + </property> + <property> + <name>componentState</name> + <classname>org.ajax4jsf.model.DataComponentState</classname> + <description>It defines EL-binding for a component state for saving or + redefinition</description> + </property> + <property hidden="true" existintag="false" exist="false"> + <name>rowKey</name> + <classname>java.lang.Object</classname> + <description> RowKey is a representation of an identifier for a + specific data row </description> + </property> + <property> + <name>rowKeyVar</name> + <classname>java.lang.String</classname> + <description>The attribute provides access to a row key in a Request + scope</description> + </property> + <property> + <name>stateVar</name> + <classname>java.lang.String</classname> + <description> The attribute provides access to a component state on + the client side </description> + </property> + <property> + <name>value</name> + <classname>java.lang.Object</classname> + <description> The current value for this component </description> + </property> + <!-- rows javascript events --> + <property> + <name>onRowClick</name> + <classname>java.lang.String</classname> + <description> HTML: a script expression; a pointer button is clicked + on row </description> + </property> + <property> + <name>onRowDblClick</name> + <classname>java.lang.String</classname> + <description>HTML: a script expression; a pointer button is + double-clicked on row </description> + </property> + <property> + <name>onRowMouseUp</name> + <classname>java.lang.String</classname> + <description>HTML: script expression; a pointer button is released on + row </description> + </property> + <property> + <name>onRowMouseDown</name> + <classname>java.lang.String</classname> + <description>HTML: script expression; a pointer button is pressed down + on row </description> + </property> + <property> + <name>onRowMouseOver</name> + <classname>java.lang.String</classname> + <description>HTML: a script expression; a pointer is moved onto of row + </description> + </property> + <property> + <name>onRowMouseOut</name> + <classname>java.lang.String</classname> + <description>HTML: a script expression; a pointer is moved away of row + </description> + </property> + <property> + <name>onRowMouseMove</name> + <classname>java.lang.String</classname> + <description>HTML: a script expression; a pointer is moved within of + row </description> + </property> + <property> + <name>sortPriority</name> + <classname>java.util.Collection</classname> + <description>Defines a set of column ids in the order the columns + could be set</description> + </property> + <property hidden="true" existintag="false" exist="false"> + <name>sortFields</name> + </property> + <property hidden="true" existintag="false" exist="false"> + <name>filterFields</name> + </property> + <property> + <name>sortMode</name> + <classname>java.lang.String</classname> + <description> Defines mode of sorting. Possible values are 'single' + for sorting of one column and 'multi' for some. + </description> + </property> + <property hidden="true" existintag="false" exist="false"> + <name>summary</name> + <classname>java.lang.Object</classname> + </property> + <property elonly="true"> + <name>tableState</name> + <classname>java.lang.String</classname> + <description> ValueBinding pointing at a property of a String to hold + table state </description> + </property> + <property attachedstate="true" elonly="true"> + <name>selection</name> + <classname>org.richfaces.model.selection.Selection</classname> + <description>Value binding representing selected rows</description> + </property> + </component> </components>