Changes between Version 21 and Version 22 of DeveloperGuidelines/DataTables

Timestamp:

09/04/12 10:10:10 (13 years ago)

Author:

graeme

Comment:

--

DeveloperGuidelines/DataTables

@@ -2 +2 @@
 = !DataTables =
 == Introduction ==
-Sahana Eden uses the !JavaScript library !DataTables http://www.datatables.net to display results returned from the database. The !DataTables library provides a lot of properties and functions that customise the table that is produced. Sahana Eden doesn't expose all of the functionality that is available within the !DataTables library this makes it easy to get !DataTables up and running and it also ensures a consistent look and feel. However, it is possible to customise the !DataTables through the Sahana Eden framework.
+Sahana Eden uses the !JavaScript library !DataTables http://www.datatables.net to display results returned from the database. The !DataTables library provides a lot of properties and functions that can customise the table that will be produced. Sahana Eden doesn't expose all of the functionality that is available within the !DataTables library this makes it easy to get !DataTables up and running and it also ensures a consistent look and feel. However, it is possible to customise the !DataTables through the Sahana Eden framework.
+== Changes ==
+'''This section is being reworked...'''
+The Sahana Eden framework will produce a list of resources and put them in a !DataTable however sometimes it is necessary to build a table for a specific task or to have multiple tables on the same page. To do this is it necessary to build a controller to manage the table.
+
+Probably the simplest type of table will be one where all the data is sent from the server to the client and no server side pagination is required. This can be set up as follows:
+{{{
+#!div style="font-size: 80%"
+Model code snippet:
+  {{{#!python
+        from s3.s3utils import S3DataTable
+        # Set up the resource
+        resource = s3db.resource("inv_warehouse")
+        # Find out how many records are in the resource
+        totalrows = resource.count()
+        list_fields = ["id",
+                       "name",
+                       "organisation_id",
+                       ]
+        # Get all the data from the resource
+        rows = resource.select(list_fields,
+                               orderby="organisation_id",
+                               start=0,
+                               limit=totalrows,
+                               )
+        if rows:
+            # Format the resource data and pass them through their default represent
+            data = resource.extract(rows,
+                                    list_fields,
+                                    represent=True,
+                                    )
+            # Get the resource fields
+            rfields = resource.resolve_selectors(list_fields)[0]
+            # Create the default S3DataTable 
+            dt = S3DataTable(rfields, data)
+            # create default actions buttons for the dataTable
+            dt.defaultActionButtons(resource)
+            # Create the html for the dataTable
+            warehouses = dt.html(totalrows,
+                                 totalrows,
+                                 "warehouse_list",
+                                 dt_pagination="false",
+                                 )
+        else:
+            warehouses = "No warehouses exist"
+   }}}
+}}}
+
+To add a table the controller will need first initialise the table and then manage requests from !DataTables for more data.
+
 == Properties ==
 A number of properties are set by the framework and rarely need to be changed. These have been marked in the following table as '''auto'''. Some properties are set with a default value, the default value (and where it is set) is indicated in the table below: