cvs: peardoc /en/package/structures/structures-datagrid/structures-datagrid-renderer checkablehtmltable.xml csv.xml flexy.xml htmleditform.xml htmlsortform.xml htmltable.xml pager.xml smarty.xml xul.xml
[email protected] ("Mark Wiesemann")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvswiesemann1197048215@cvsserver> |
wiesemann Fri Dec 7 17:23:35 2007 UTC
Modified files:
/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer
checkablehtmltable.xml
csv.xml
flexy.xml
htmleditform.xml
htmlsortform.xml
htmltable.xml
pager.xml
smarty.xml
xul.xml
Log:
- sync changes from source code (renamed options, extended comments,
new example)
wiesemann-20071207172335.txt
(text/plain, 29.3 KB)
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/checkablehtmltable.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/checkablehtmltable.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/checkablehtmltable.xml:1.3 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/checkablehtmltable.xml:1.4
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/checkablehtmltable.xml:1.3 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/checkablehtmltable.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.checkablehtmltable">
<refnamediv>
<refname>Structures_DataGrid_Renderer_CheckableHTMLTable</refname>
@@ -205,26 +205,6 @@
<entry>'checkedItems'</entry>
</row>
<row>
- <entry>jsHandler</entry>
- <entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
- <entry>null</entry>
- </row>
- <row>
- <entry>jsHandlerData</entry>
- <entry>string</entry>
- <entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
- assigned as a raw string to the "data" attribute. It's up to
- you to add quotes, slashes, etc...</entry>
- <entry>''</entry>
- </row>
- <row>
<entry>numberAlign</entry>
<entry>bool</entry>
<entry>Whether to right-align numeric values.</entry>
@@ -238,6 +218,27 @@
<entry>array()</entry>
</row>
<row>
+ <entry>onMove</entry>
+ <entry>string</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
+ <entry>null</entry>
+ </row>
+ <row>
+ <entry>onMoveData</entry>
+ <entry>string</entry>
+ <entry>User data passed in the "data" member of the object
+ argument passed to onMove. No JSON serialization is performed, this is
+ assigned as a raw string to the "data" attribute. It's up to
+ you to add quotes, slashes, etc...</entry>
+ <entry>''</entry>
+ </row>
+ <row>
<entry>primaryKey</entry>
<entry>string</entry>
<entry>The name of the primary key. This value is used for the
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/csv.xml?r1=1.12&r2=1.13&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/csv.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/csv.xml:1.12 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/csv.xml:1.13
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/csv.xml:1.12 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/csv.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.csv">
<refnamediv>
<refname>Structures_DataGrid_Renderer_CSV</refname>
@@ -141,26 +141,6 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
- <entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
- <entry>null</entry>
- </row>
- <row>
- <entry>jsHandlerData</entry>
- <entry>string</entry>
- <entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
- assigned as a raw string to the "data" attribute. It's up to
- you to add quotes, slashes, etc...</entry>
- <entry>''</entry>
- </row>
- <row>
<entry>lineBreak</entry>
<entry>string</entry>
<entry>The character(s) to use for line breaks</entry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/flexy.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/flexy.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/flexy.xml:1.3 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/flexy.xml:1.4
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/flexy.xml:1.3 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/flexy.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.flexy">
<refnamediv>
<refname>Structures_DataGrid_Renderer_Flexy</refname>
@@ -170,26 +170,6 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
- <entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
- <entry>null</entry>
- </row>
- <row>
- <entry>jsHandlerData</entry>
- <entry>string</entry>
- <entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
- assigned as a raw string to the "data" attribute. It's up to
- you to add quotes, slashes, etc...</entry>
- <entry>''</entry>
- </row>
- <row>
<entry>numberAlign</entry>
<entry>bool</entry>
<entry>Whether to right-align numeric values.</entry>
@@ -202,6 +182,27 @@
<entry>'odd'</entry>
</row>
<row>
+ <entry>onMove</entry>
+ <entry>string</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
+ <entry>null</entry>
+ </row>
+ <row>
+ <entry>onMoveData</entry>
+ <entry>string</entry>
+ <entry>User data passed in the "data" member of the object
+ argument passed to onMove. No JSON serialization is performed, this is
+ assigned as a raw string to the "data" attribute. It's up to
+ you to add quotes, slashes, etc...</entry>
+ <entry>''</entry>
+ </row>
+ <row>
<entry>pagerOptions</entry>
<entry>array</entry>
<entry>The custom options to be sent to the Pager renderer.</entry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmleditform.xml?r1=1.5&r2=1.6&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmleditform.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmleditform.xml:1.5 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmleditform.xml:1.6
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmleditform.xml:1.5 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmleditform.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.htmleditform">
<refnamediv>
<refname>Structures_DataGrid_Renderer_HTMLEditForm</refname>
@@ -130,32 +130,33 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
+ <entry>numberAlign</entry>
+ <entry>bool</entry>
+ <entry>Whether to right-align numeric values.</entry>
+ <entry>true</entry>
+ </row>
+ <row>
+ <entry>onMove</entry>
<entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
<entry>null</entry>
</row>
<row>
- <entry>jsHandlerData</entry>
+ <entry>onMoveData</entry>
<entry>string</entry>
<entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
+ argument passed to onMove. No JSON serialization is performed, this is
assigned as a raw string to the "data" attribute. It's up to
you to add quotes, slashes, etc...</entry>
<entry>''</entry>
</row>
<row>
- <entry>numberAlign</entry>
- <entry>bool</entry>
- <entry>Whether to right-align numeric values.</entry>
- <entry>true</entry>
- </row>
- <row>
<entry>textSubmit</entry>
<entry>string</entry>
<entry>Label for the submit button</entry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmlsortform.xml?r1=1.9&r2=1.10&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmlsortform.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmlsortform.xml:1.9 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmlsortform.xml:1.10
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmlsortform.xml:1.9 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmlsortform.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.htmlsortform">
<refnamediv>
<refname>Structures_DataGrid_Renderer_HTMLSortForm</refname>
@@ -136,32 +136,33 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
+ <entry>numberAlign</entry>
+ <entry>bool</entry>
+ <entry>Whether to right-align numeric values.</entry>
+ <entry>true</entry>
+ </row>
+ <row>
+ <entry>onMove</entry>
<entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
<entry>null</entry>
</row>
<row>
- <entry>jsHandlerData</entry>
+ <entry>onMoveData</entry>
<entry>string</entry>
<entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
+ argument passed to onMove. No JSON serialization is performed, this is
assigned as a raw string to the "data" attribute. It's up to
you to add quotes, slashes, etc...</entry>
<entry>''</entry>
</row>
<row>
- <entry>numberAlign</entry>
- <entry>bool</entry>
- <entry>Whether to right-align numeric values.</entry>
- <entry>true</entry>
- </row>
- <row>
<entry>sortFieldsNum</entry>
<entry>int</entry>
<entry>How many fields the user will be able to sort by. This has no
@@ -210,6 +211,38 @@
</tgroup>
</table>
</refsect1>
+ <refsect1 id="package.structures.structures-datagrid.structures-datagrid-renderer.htmlsortform.examples">
+ <title>Examples</title>
+ <example>
+ <title>Fill a form with sort fields </title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+require_once 'HTML/QuickForm.php';
+
+// Create an empty form with your settings
+$form = new HTML_QuickForm('myForm', 'POST');
+
+// Customize it, add a header, text field, etc..
+$form->addElement('header', null, 'Search & Sort Form Example');
+$form->addElement('text', 'my_search', 'Search for:');
+
+// Let the datagrid add sort fields, radio style
+$options = array('directionStyle' => 'radio');
+$datagrid->fill($form, $options, 'HTMLSortForm');
+
+// You must add a submit button. fill() never does this
+$form->addElement('submit', null, 'Submit');
+
+// Use the native HTML_QuickForm::display() to print your form
+$form->display();
+
+?>
+
+]]>
+ </programlisting>
+ </example>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmltable.xml?r1=1.10&r2=1.11&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmltable.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmltable.xml:1.10 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmltable.xml:1.11
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmltable.xml:1.10 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/htmltable.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.htmltable">
<refnamediv>
<refname>Structures_DataGrid_Renderer_HTMLTable</refname>
@@ -178,26 +178,6 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
- <entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
- <entry>null</entry>
- </row>
- <row>
- <entry>jsHandlerData</entry>
- <entry>string</entry>
- <entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
- assigned as a raw string to the "data" attribute. It's up to
- you to add quotes, slashes, etc...</entry>
- <entry>''</entry>
- </row>
- <row>
<entry>numberAlign</entry>
<entry>bool</entry>
<entry>Whether to right-align numeric values.</entry>
@@ -211,6 +191,27 @@
<entry>array()</entry>
</row>
<row>
+ <entry>onMove</entry>
+ <entry>string</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
+ <entry>null</entry>
+ </row>
+ <row>
+ <entry>onMoveData</entry>
+ <entry>string</entry>
+ <entry>User data passed in the "data" member of the object
+ argument passed to onMove. No JSON serialization is performed, this is
+ assigned as a raw string to the "data" attribute. It's up to
+ you to add quotes, slashes, etc...</entry>
+ <entry>''</entry>
+ </row>
+ <row>
<entry>selfPath</entry>
<entry>string</entry>
<entry>The complete path for sorting and paging links.</entry>
@@ -256,7 +257,7 @@
$datagrid->bind("SELECT * FROM mytable", $options);
// Set the javascript handler function for onclick events
-$datagrid->setRendererOption('jsHandler', 'updateGrid', true);
+$datagrid->setRendererOption('onMove', 'updateGrid', true);
if (isset($_GET['ajax'])) {
// Handle table AJAX requests
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/pager.xml?r1=1.11&r2=1.12&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/pager.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/pager.xml:1.11 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/pager.xml:1.12
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/pager.xml:1.11 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/pager.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.pager">
<refnamediv>
<refname>Structures_DataGrid_Renderer_Pager</refname>
@@ -133,32 +133,33 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
+ <entry>numberAlign</entry>
+ <entry>bool</entry>
+ <entry>Whether to right-align numeric values.</entry>
+ <entry>true</entry>
+ </row>
+ <row>
+ <entry>onMove</entry>
<entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
<entry>null</entry>
</row>
<row>
- <entry>jsHandlerData</entry>
+ <entry>onMoveData</entry>
<entry>string</entry>
<entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
+ argument passed to onMove. No JSON serialization is performed, this is
assigned as a raw string to the "data" attribute. It's up to
you to add quotes, slashes, etc...</entry>
<entry>''</entry>
</row>
<row>
- <entry>numberAlign</entry>
- <entry>bool</entry>
- <entry>Whether to right-align numeric values.</entry>
- <entry>true</entry>
- </row>
- <row>
<entry>pagerOptions</entry>
<entry>array</entry>
<entry>Options passed to Pager::factory(). Basic defaults are: mode:
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/smarty.xml?r1=1.11&r2=1.12&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/smarty.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/smarty.xml:1.11 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/smarty.xml:1.12
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/smarty.xml:1.11 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/smarty.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.smarty">
<refnamediv>
<refname>Structures_DataGrid_Renderer_Smarty</refname>
@@ -145,32 +145,33 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
+ <entry>numberAlign</entry>
+ <entry>bool</entry>
+ <entry>Whether to right-align numeric values.</entry>
+ <entry>true</entry>
+ </row>
+ <row>
+ <entry>onMove</entry>
<entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
<entry>null</entry>
</row>
<row>
- <entry>jsHandlerData</entry>
+ <entry>onMoveData</entry>
<entry>string</entry>
<entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
+ argument passed to onMove. No JSON serialization is performed, this is
assigned as a raw string to the "data" attribute. It's up to
you to add quotes, slashes, etc...</entry>
<entry>''</entry>
</row>
<row>
- <entry>numberAlign</entry>
- <entry>bool</entry>
- <entry>Whether to right-align numeric values.</entry>
- <entry>true</entry>
- </row>
- <row>
<entry>selfPath</entry>
<entry>string</entry>
<entry>The complete path for sorting and paging links.</entry>
@@ -225,7 +226,7 @@
'link' => sorting link,
'attributes' => attributes string,
'direction' => 'ASC', 'DESC' or '',
- 'onclick' => jsHandler call
+ 'onclick' => onMove call
),
...
)
http://cvs.php.net/viewvc.cgi/peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/xul.xml?r1=1.11&r2=1.12&diff_format=u
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/xul.xml
diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/xul.xml:1.11 peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/xul.xml:1.12
--- peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/xul.xml:1.11 Fri Nov 9 23:11:49 2007
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-renderer/xul.xml Fri Dec 7 17:23:35 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<refentry id="package.structures.structures-datagrid.structures-datagrid-renderer.xul">
<refnamediv>
<refname>Structures_DataGrid_Renderer_XUL</refname>
@@ -122,32 +122,33 @@
<entry>array()</entry>
</row>
<row>
- <entry>jsHandler</entry>
+ <entry>numberAlign</entry>
+ <entry>bool</entry>
+ <entry>Whether to right-align numeric values.</entry>
+ <entry>true</entry>
+ </row>
+ <row>
+ <entry>onMove</entry>
<entry>string</entry>
- <entry>Name of a Javascript function to call on onClick/onSubmit events.
- This function receives a single object argument of the form: { page:
- <page>, sort: [{field: <field>, direction:
- <direction>}, ...], data: <user_data> }. Remark: setting this
- option doesn't remove the href attribute, you should return false from
- your handler function to void it (eg: for AJAX, etc..).</entry>
+ <entry>Name of a Javascript function to call on onClick/onSubmit events
+ when the user is either paging or sorting the data. This function
+ receives a single object argument of the form: { page: <page>,
+ sort: [{field: <field>, direction: <direction>}, ...], data:
+ <user_data> }. Remark: setting this option doesn't remove the href
+ attribute, you should return false from your handler function to void it
+ (eg: for AJAX, etc..).</entry>
<entry>null</entry>
</row>
<row>
- <entry>jsHandlerData</entry>
+ <entry>onMoveData</entry>
<entry>string</entry>
<entry>User data passed in the "data" member of the object
- argument passed to jsHandler. No JSON serialization is performed, this is
+ argument passed to onMove. No JSON serialization is performed, this is
assigned as a raw string to the "data" attribute. It's up to
you to add quotes, slashes, etc...</entry>
<entry>''</entry>
</row>
<row>
- <entry>numberAlign</entry>
- <entry>bool</entry>
- <entry>Whether to right-align numeric values.</entry>
- <entry>true</entry>
- </row>
- <row>
<entry>selfPath</entry>
<entry>string</entry>
<entry>The complete path for sorting links</entry>