[Checkins] SVN: z3c.table/trunk/ merge test-split branch
Jean-Francois Roche
jfroche at jfroche.be
Thu Aug 5 04:20:47 EDT 2010
Log message for revision 115484:
merge test-split branch
Changed:
U z3c.table/trunk/CHANGES.txt
U z3c.table/trunk/buildout.cfg
U z3c.table/trunk/setup.py
U z3c.table/trunk/src/z3c/table/README.txt
A z3c.table/trunk/src/z3c/table/batch.txt
A z3c.table/trunk/src/z3c/table/miscellaneous.txt
A z3c.table/trunk/src/z3c/table/sequence.txt
A z3c.table/trunk/src/z3c/table/sort.txt
U z3c.table/trunk/src/z3c/table/table.py
U z3c.table/trunk/src/z3c/table/testing.py
U z3c.table/trunk/src/z3c/table/tests.py
-=-
Modified: z3c.table/trunk/CHANGES.txt
===================================================================
--- z3c.table/trunk/CHANGES.txt 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/CHANGES.txt 2010-08-05 08:20:47 UTC (rev 115484)
@@ -5,7 +5,7 @@
0.8.2 (unreleased)
------------------
-- Nothing changed yet.
+- Split single doctest file (README.txt) into different files
0.8.1 (2010-07-31)
Modified: z3c.table/trunk/buildout.cfg
===================================================================
--- z3c.table/trunk/buildout.cfg 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/buildout.cfg 2010-08-05 08:20:47 UTC (rev 115484)
@@ -1,6 +1,7 @@
[buildout]
develop = .
parts = test checker coverage-test coverage-report
+versions = versions
[test]
@@ -24,3 +25,7 @@
eggs = z3c.coverage
scripts = coverage=coverage-report
arguments = ('coverage', 'coverage/report')
+
+[versions]
+# pin ZODB as ZODB 3.10 doesn't support python 2.4
+ZODB3 = 3.9.4
Modified: z3c.table/trunk/setup.py
===================================================================
--- z3c.table/trunk/setup.py 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/setup.py 2010-08-05 08:20:47 UTC (rev 115484)
@@ -12,16 +12,16 @@
#
##############################################################################
"""Setup
-
-$Id:$
"""
import os
from setuptools import setup, find_packages
+
def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
-setup (
+
+setup(
name='z3c.table',
version='0.8.2dev',
author = "Stephan Richter, Roger Ineichen and the Zope Community",
@@ -32,13 +32,20 @@
+ '\n\n' +
read('src', 'z3c', 'table', 'README.txt')
+ '\n\n' +
+ read('src', 'z3c', 'table', 'sort.txt')
+ + '\n\n' +
+ read('src', 'z3c', 'table', 'batch.txt')
+ + '\n\n' +
+ read('src', 'z3c', 'table', 'sequence.txt')
+ + '\n\n' +
read('src', 'z3c', 'table', 'column.txt')
+ '\n\n' +
- read('CHANGES.txt')
- ),
- license = "ZPL 2.1",
- keywords = "zope3 z3c table content provider",
- classifiers = [
+ read('src', 'z3c', 'table', 'miscellaneous.txt')
+ + '\n\n' +
+ read('CHANGES.txt')),
+ license="ZPL 2.1",
+ keywords="zope3 z3c table content provider",
+ classifiers=[
'Development Status :: 4 - Beta',
'Environment :: Web Environment',
'Intended Audience :: Developers',
@@ -48,13 +55,13 @@
'Operating System :: OS Independent',
'Topic :: Internet :: WWW/HTTP',
'Framework :: Zope3'],
- url = 'http://pypi.python.org/pypi/z3c.table',
- packages = find_packages('src'),
- include_package_data = True,
- package_dir = {'':'src'},
- namespace_packages = ['z3c'],
- extras_require = dict(
- test = [
+ url='http://pypi.python.org/pypi/z3c.table',
+ packages=find_packages('src'),
+ include_package_data=True,
+ package_dir={'': 'src'},
+ namespace_packages=['z3c'],
+ extras_require=dict(
+ test=[
'z3c.testing',
'zope.app.testing',
'zope.publisher',
@@ -62,7 +69,7 @@
'zope.testing',
],
),
- install_requires = [
+ install_requires=[
'setuptools',
'z3c.batching>=1.1.0',
'zope.component',
@@ -76,5 +83,5 @@
'zope.security',
'zope.traversing',
],
- zip_safe = False,
+ zip_safe=False,
)
Modified: z3c.table/trunk/src/z3c/table/README.txt
===================================================================
--- z3c.table/trunk/src/z3c/table/README.txt 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/src/z3c/table/README.txt 2010-08-05 08:20:47 UTC (rev 115484)
@@ -422,209 +422,6 @@
</table>
-Sorting Table
--------------
-
-Another table feature is the support for sorting data given from columns. Since
-sorting table data is an important feature, we offer this by default. But it
-only gets used if there is a ``sortOn`` value set. You can set this value at
-class level by adding a ``defaultSortOn`` value or set it as a request value.
-We show you how to do this later. We also need a columns which allows us to do
-a better sort sample. Our new sorting column will use the content items number
-value for sorting:
-
- >>> class NumberColumn(column.Column):
- ...
- ... header = u'Number'
- ... weight = 20
- ...
- ... def getSortKey(self, item):
- ... return item.number
- ...
- ... def renderCell(self, item):
- ... return 'number: %s' % item.number
-
-
-Now let's setup a table:
-
- >>> class SortingTable(table.Table):
- ...
- ... def setUpColumns(self):
- ... firstColumn = TitleColumn(self.context, self.request, self)
- ... firstColumn.__name__ = u'title'
- ... firstColumn.__parent__ = self
- ... secondColumn = NumberColumn(self.context, self.request, self)
- ... secondColumn.__name__ = u'number'
- ... secondColumn.__parent__ = self
- ... return [firstColumn, secondColumn]
-
-We also need some more container items that we can use for sorting:
-
- >>> container[u'fourth'] = Content('Fourth', 4)
- >>> container[u'zero'] = Content('Zero', 0)
-
-And render them without set a ``sortOn`` value:
-
- >>> sortingTable = SortingTable(container, request)
- >>> sortingTable.update()
- >>> print sortingTable.render()
- <table>
- <thead>
- <tr>
- <th>Title</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Title: First</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Title: Fourth</td>
- <td>number: 4</td>
- </tr>
- <tr>
- <td>Title: Second</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Title: Third</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Title: Zero</td>
- <td>number: 0</td>
- </tr>
- </tbody>
- </table>
-
-As you can see this table doesn't provide any explicit order. Let's find out
-the index of our column that we like to sort on:
-
- >>> sortOnId = sortingTable.rows[0][1][1].id
- >>> sortOnId
- u'table-number-1'
-
-And let's use this id as ``sortOn`` value:
-
- >>> sortingTable.sortOn = sortOnId
-
-An important thing is to update the table after set an ``sortOn`` value:
-
- >>> sortingTable.update()
- >>> print sortingTable.render()
- <table>
- <thead>
- <tr>
- <th>Title</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Title: Zero</td>
- <td>number: 0</td>
- </tr>
- <tr>
- <td>Title: First</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Title: Second</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Title: Third</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Title: Fourth</td>
- <td>number: 4</td>
- </tr>
- </tbody>
- </table>
-
-We can also reverse the sorting order:
-
- >>> sortingTable.sortOrder = 'reverse'
- >>> sortingTable.update()
- >>> print sortingTable.render()
- <table>
- <thead>
- <tr>
- <th>Title</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Title: Fourth</td>
- <td>number: 4</td>
- </tr>
- <tr>
- <td>Title: Third</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Title: Second</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Title: First</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Title: Zero</td>
- <td>number: 0</td>
- </tr>
- </tbody>
- </table>
-
-The table implementation is also able to get the sorting criteria given from a
-request. Let's setup such a request:
-
- >>> sorterRequest = TestRequest(form={'table-sortOn': 'table-number-1',
- ... 'table-sortOrder':'descending'})
-
-and another time, update and render. As you can see the new table gets sorted
-by the second column and ordered in reverse order:
-
- >>> requestSortedTable = SortingTable(container, sorterRequest)
- >>> requestSortedTable.update()
- >>> print requestSortedTable.render()
- <table>
- <thead>
- <tr>
- <th>Title</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Title: Fourth</td>
- <td>number: 4</td>
- </tr>
- <tr>
- <td>Title: Third</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Title: Second</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Title: First</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Title: Zero</td>
- <td>number: 0</td>
- </tr>
- </tbody>
- </table>
-
-
Class based Table setup
-----------------------
@@ -663,6 +460,11 @@
... cssClasses = {'th':'thCol', 'td':'tdCol'})
... ]
+Add some more content::
+
+ >>> container[u'fourth'] = Content('Fourth', 4)
+ >>> container[u'zero'] = Content('Zero', 0)
+
>>> addColumnTable = AddColumnTable(container, request)
>>> addColumnTable.update()
>>> print addColumnTable.render()
@@ -747,887 +549,6 @@
{'td': 'tdCol', 'th': 'thCol'}
-Batching
---------
-
-Our table implements batching out of the box. If the amount of
-row items is smaller than the given ``startBatchingAt`` size, the table starts
-to batch at this size. Let's define a new Table.
-
-We need to configure our batch provider for the next step first. See the
-section ``BatchProvider`` below for more infos about batch rendering:
-
- >>> from zope.configuration.xmlconfig import XMLConfig
- >>> import z3c.table
- >>> XMLConfig('meta.zcml', zope.component)()
- >>> XMLConfig('configure.zcml', z3c.table)()
-
- >>> class BatchingTable(table.Table):
- ...
- ... def setUpColumns(self):
- ... return [
- ... column.addColumn(self, TitleColumn, u'title',
- ... cellRenderer=cellRenderer,
- ... headCellRenderer=headCellRenderer,
- ... weight=1),
- ... column.addColumn(self, NumberColumn, name=u'number',
- ... weight=2, header=u'Number')
- ... ]
-
-Now we can create our table:
-
- >>> batchingTable = BatchingTable(container, request)
-
-We also need to give the table a location and a name like we normally setup
-in traversing:
-
- >>> batchingTable.__parent__ = container
- >>> batchingTable.__name__ = u'batchingTable.html'
-
-And add some more items to our container:
-
- >>> container[u'sixth'] = Content('Sixth', 6)
- >>> container[u'seventh'] = Content('Seventh', 7)
- >>> container[u'eighth'] = Content('Eighth', 8)
- >>> container[u'ninth'] = Content('Ninth', 9)
- >>> container[u'tenth'] = Content('Tenth', 10)
- >>> container[u'eleventh'] = Content('Eleventh', 11)
- >>> container[u'twelfth '] = Content('Twelfth', 12)
- >>> container[u'thirteenth'] = Content('Thirteenth', 13)
- >>> container[u'fourteenth'] = Content('Fourteenth', 14)
- >>> container[u'fifteenth '] = Content('Fifteenth', 15)
- >>> container[u'sixteenth'] = Content('Sixteenth', 16)
- >>> container[u'seventeenth'] = Content('Seventeenth', 17)
- >>> container[u'eighteenth'] = Content('Eighteenth', 18)
- >>> container[u'nineteenth'] = Content('Nineteenth', 19)
- >>> container[u'twentieth'] = Content('Twentieth', 20)
-
-Now let's show the full table without batching:
-
- >>> batchingTable.update()
- >>> print batchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Eighteenth item</td>
- <td>number: 18</td>
- </tr>
- <tr>
- <td>Eighth item</td>
- <td>number: 8</td>
- </tr>
- <tr>
- <td>Eleventh item</td>
- <td>number: 11</td>
- </tr>
- <tr>
- <td>Fifteenth item</td>
- <td>number: 15</td>
- </tr>
- <tr>
- <td>First item</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Fourteenth item</td>
- <td>number: 14</td>
- </tr>
- <tr>
- <td>Fourth item</td>
- <td>number: 4</td>
- </tr>
- <tr>
- <td>Nineteenth item</td>
- <td>number: 19</td>
- </tr>
- <tr>
- <td>Ninth item</td>
- <td>number: 9</td>
- </tr>
- <tr>
- <td>Second item</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Seventeenth item</td>
- <td>number: 17</td>
- </tr>
- <tr>
- <td>Seventh item</td>
- <td>number: 7</td>
- </tr>
- <tr>
- <td>Sixteenth item</td>
- <td>number: 16</td>
- </tr>
- <tr>
- <td>Sixth item</td>
- <td>number: 6</td>
- </tr>
- <tr>
- <td>Tenth item</td>
- <td>number: 10</td>
- </tr>
- <tr>
- <td>Third item</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Thirteenth item</td>
- <td>number: 13</td>
- </tr>
- <tr>
- <td>Twelfth item</td>
- <td>number: 12</td>
- </tr>
- <tr>
- <td>Twentieth item</td>
- <td>number: 20</td>
- </tr>
- <tr>
- <td>Zero item</td>
- <td>number: 0</td>
- </tr>
- </tbody>
- </table>
-
-As you can see, the table is not ordered and it uses all items. If we like
-to use the batch, we need to set the startBatchingAt size to a lower value than
-it is set by default.
-The default value which a batch is used is set to ``50``:
-
- >>> batchingTable.startBatchingAt
- 50
-
-We will set the batch start to ``5`` for now. This means the first 5 items
-do not get used:
-
- >>> batchingTable.startBatchingAt = 5
- >>> batchingTable.startBatchingAt
- 5
-
-There is also a ``batchSize`` value which we need to set to ``5``. By default
-the value gets initialized by the ``batchSize`` value:
-
- >>> batchingTable.batchSize
- 50
-
- >>> batchingTable.batchSize = 5
- >>> batchingTable.batchSize
- 5
-
-Now we can update and render the table again. But you will see that we only get
-a table size of 5 rows, which is correct. But the order doesn't depend on the
-numbers we see in cells:
-
- >>> batchingTable.update()
- >>> print batchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Eighteenth item</td>
- <td>number: 18</td>
- </tr>
- <tr>
- <td>Eighth item</td>
- <td>number: 8</td>
- </tr>
- <tr>
- <td>Eleventh item</td>
- <td>number: 11</td>
- </tr>
- <tr>
- <td>Fifteenth item</td>
- <td>number: 15</td>
- </tr>
- <tr>
- <td>First item</td>
- <td>number: 1</td>
- </tr>
- </tbody>
- </table>
-
-I think we should order the table by the second column before we show the next
-batch values. We do this by simply set the ``defaultSortOn``:
-
- >>> batchingTable.sortOn = u'table-number-1'
-
-Now we should see a nice ordered and batched table:
-
- >>> batchingTable.update()
- >>> print batchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Zero item</td>
- <td>number: 0</td>
- </tr>
- <tr>
- <td>First item</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Second item</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Third item</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Fourth item</td>
- <td>number: 4</td>
- </tr>
- </tbody>
- </table>
-
-The batch concept allows us to choose from all batches and render the rows
-for this batched items. We can do this by set any batch as rows. as you can see
-we have ``4`` batched row data available:
-
- >>> len(batchingTable.rows.batches)
- 4
-
-We can set such a batch as row values, then this batch data are used for
-rendering. But take care, if we update the table, our rows get overriden
-and reset to the previous values. this means you can set any bath as rows
-data and only render them. This is possible since the update method sorted all
-items and all batch contain ready-to-use data. This concept could be important
-if you need to cache batches etc. :
-
- >>> batchingTable.rows = batchingTable.rows.batches[1]
- >>> print batchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Sixth item</td>
- <td>number: 6</td>
- </tr>
- <tr>
- <td>Seventh item</td>
- <td>number: 7</td>
- </tr>
- <tr>
- <td>Eighth item</td>
- <td>number: 8</td>
- </tr>
- <tr>
- <td>Ninth item</td>
- <td>number: 9</td>
- </tr>
- <tr>
- <td>Tenth item</td>
- <td>number: 10</td>
- </tr>
- </tbody>
- </table>
-
-And like described above, if you call ``update`` our batch to rows setup get
-reset:
-
- >>> batchingTable.update()
- >>> print batchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Zero item</td>
- <td>number: 0</td>
- </tr>
- <tr>
- <td>First item</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Second item</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Third item</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Fourth item</td>
- <td>number: 4</td>
- </tr>
- </tbody>
- </table>
-
-This means you can probably update all batches, cache them and use them alter.
-but this is not usefull for normal usage in a page without an enhanced concept
-which is not a part of this implementation. This also means, there must be
-another way to set the batch index. Yes there is, there are two other ways how
-we can set the batch position. We can set a batch position by setting the
-``batchStart`` value in our table or we can use a request variable. Let's show
-the first one first:
-
- >>> batchingTable.batchStart = 6
- >>> batchingTable.update()
- >>> print batchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Seventh item</td>
- <td>number: 7</td>
- </tr>
- <tr>
- <td>Eighth item</td>
- <td>number: 8</td>
- </tr>
- <tr>
- <td>Ninth item</td>
- <td>number: 9</td>
- </tr>
- <tr>
- <td>Tenth item</td>
- <td>number: 10</td>
- </tr>
- <tr>
- <td>Eleventh item</td>
- <td>number: 11</td>
- </tr>
- </tbody>
- </table>
-
-We can also set the batch position by using the batchStart value in a request.
-Note that we need the table ``prefix`` and column ``__name__`` like we use in
-the sorting concept:
-
- >>> batchingRequest = TestRequest(form={'table-batchStart': '11',
- ... 'table-batchSize': '5',
- ... 'table-sortOn': 'table-number-1'})
- >>> requestBatchingTable = BatchingTable(container, batchingRequest)
-
-We also need to give the table a location and a name like we normaly setup
-in traversing:
-
- >>> requestBatchingTable.__parent__ = container
- >>> requestBatchingTable.__name__ = u'requestBatchingTable.html'
-
-Note; our table needs to start batching at smaller amount of items than we
-have by default otherwise we don't get a batch:
-
- >>> requestBatchingTable.startBatchingAt = 5
- >>> requestBatchingTable.update()
- >>> print requestBatchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Twelfth item</td>
- <td>number: 12</td>
- </tr>
- <tr>
- <td>Thirteenth item</td>
- <td>number: 13</td>
- </tr>
- <tr>
- <td>Fourteenth item</td>
- <td>number: 14</td>
- </tr>
- <tr>
- <td>Fifteenth item</td>
- <td>number: 15</td>
- </tr>
- <tr>
- <td>Sixteenth item</td>
- <td>number: 16</td>
- </tr>
- </tbody>
- </table>
-
-
-BatchProvider
--------------
-
-The batch provider allows us to render the batch HTML independently of our
-table. This means by default the batch gets not rendered in the render method.
-You can change this in your custom table implementation and return the batch
-and the table in the render method.
-
-As we can see, our table rows provides IBatch if it comes to batching:
-
- >>> from z3c.batching.interfaces import IBatch
- >>> IBatch.providedBy(requestBatchingTable.rows)
- True
-
-Let's check some batch variables before we render our test. This let us compare
-the rendered result. For more information about batching see the README.txt in
-z3c.batching:
-
- >>> requestBatchingTable.rows.start
- 11
-
- >>> requestBatchingTable.rows.index
- 2
-
- >>> requestBatchingTable.rows.batches
- <z3c.batching.batch.Batches object at ...>
-
- >>> len(requestBatchingTable.rows.batches)
- 4
-
-We use our previous batching table and render the batch with the built-in
-``renderBatch`` method:
-
- >>> requestBatchingTable.update()
- >>> print requestBatchingTable.renderBatch()
- <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
- <a href="...html?table-batchStart=5&table-batchSize=5">2</a>
- <a href="...html?table-batchStart=11&table-batchSize=5" class="current">3</a>
- <a href="...html?table-batchStart=15&table-batchSize=5" class="last">4</a>
-
-Now let's add more items so that we can test the skipped links in large
-batches:
-
- >>> for i in range(1000):
- ... idx = i+20
- ... container[str(idx)] = Content(str(idx), idx)
-
-Now let's test the batching table again with the new amount of items and
-the same ``startBatchingAt`` of 5 but starting the batch at item ``100``
-and sorted on the second numbered column:
-
- >>> batchingRequest = TestRequest(form={'table-batchStart': '100',
- ... 'table-batchSize': '5',
- ... 'table-sortOn': 'table-number-1'})
- >>> requestBatchingTable = BatchingTable(container, batchingRequest)
- >>> requestBatchingTable.startBatchingAt = 5
-
-We also need to give the table a location and a name like we normally setup
-in traversing:
-
- >>> requestBatchingTable.__parent__ = container
- >>> requestBatchingTable.__name__ = u'requestBatchingTable.html'
-
- >>> requestBatchingTable.update()
- >>> print requestBatchingTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>100 item</td>
- <td>number: 100</td>
- </tr>
- <tr>
- <td>101 item</td>
- <td>number: 101</td>
- </tr>
- <tr>
- <td>102 item</td>
- <td>number: 102</td>
- </tr>
- <tr>
- <td>103 item</td>
- <td>number: 103</td>
- </tr>
- <tr>
- <td>104 item</td>
- <td>number: 104</td>
- </tr>
- </tbody>
- </table>
-
-And test the batch. Note the three dots between the links are rendered by the
-batch provider and are not a part of the doctest:
-
- >>> print requestBatchingTable.renderBatch()
- <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
- ...
- <a href="...html?table-batchStart=85&table-batchSize=5">18</a>
- <a href="...html?table-batchStart=90&table-batchSize=5">19</a>
- <a href="...html?table-batchStart=95&table-batchSize=5">20</a>
- <a href="...html?table-batchStart=100&table-batchSize=5" class="current">21</a>
- <a href="...html?table-batchStart=105&table-batchSize=5">22</a>
- <a href="...html?table-batchStart=110&table-batchSize=5">23</a>
- <a href="...html?table-batchStart=115&table-batchSize=5">24</a>
- ...
- <a href="...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
-
-You can change the spacer in the batch provider if you set the ``batchSpacer``
-value:
-
- >>> from z3c.table.batch import BatchProvider
- >>> class XBatchProvider(BatchProvider):
- ... """Just another batch provider."""
- ... batchSpacer = u'xxx'
-
-Now register the new batch provider for our batching table:
-
- >>> import zope.publisher.interfaces.browser
- >>> zope.component.provideAdapter(XBatchProvider,
- ... (zope.interface.Interface,
- ... zope.publisher.interfaces.browser.IBrowserRequest,
- ... BatchingTable), name='batch')
-
-If we update and render our table, the new batch provider should get used.
-As you can see the spacer get changed now:
-
- >>> requestBatchingTable.update()
- >>> print requestBatchingTable.renderBatch()
- <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
- xxx
- <a href="...html?table-batchStart=85&table-batchSize=5">18</a>
- <a href="...html?table-batchStart=90&table-batchSize=5">19</a>
- <a href="...html?table-batchStart=95&table-batchSize=5">20</a>
- <a href="...html?table-batchStart=100&table-batchSize=5" class="current">21</a>
- <a href="...html?table-batchStart=105&table-batchSize=5">22</a>
- <a href="...html?table-batchStart=110&table-batchSize=5">23</a>
- <a href="...html?table-batchStart=115&table-batchSize=5">24</a>
- xxx
- <a href="...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
-
-
-Now test the extremities, need to define a new batchingRequest:
-Beginning by the left end point:
-
- >>> leftBatchingRequest = TestRequest(form={'table-batchStart': '10',
- ... 'table-batchSize': '5',
- ... 'table-sortOn': 'table-number-1'})
- >>> leftRequestBatchingTable = BatchingTable(container, leftBatchingRequest)
- >>> leftRequestBatchingTable.__parent__ = container
- >>> leftRequestBatchingTable.__name__ = u'leftRequestBatchingTable.html'
- >>> leftRequestBatchingTable.update()
- >>> print leftRequestBatchingTable.renderBatch()
- <a href="http://...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
- <a href="http://...html?table-batchStart=5&table-batchSize=5">2</a>
- <a href="http://...html?table-batchStart=10&table-batchSize=5" class="current">3</a>
- <a href="http://...html?table-batchStart=15&table-batchSize=5">4</a>
- <a href="http://...html?table-batchStart=20&table-batchSize=5">5</a>
- <a href="http://...html?table-batchStart=25&table-batchSize=5">6</a>
- xxx
- <a href="http://...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
-
-Go on with the right extremity:
-
- >>> rightBatchingRequest = TestRequest(form={'table-batchStart': '1005',
- ... 'table-batchSize': '5',
- ... 'table-sortOn': 'table-number-1'})
- >>> rightRequestBatchingTable = BatchingTable(container, rightBatchingRequest)
- >>> rightRequestBatchingTable.__parent__ = container
- >>> rightRequestBatchingTable.__name__ = u'rightRequestBatchingTable.html'
- >>> rightRequestBatchingTable.update()
- >>> print rightRequestBatchingTable.renderBatch()
- <a href="http://...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
- xxx
- <a href="http://...html?table-batchStart=990&table-batchSize=5">199</a>
- <a href="http://...html?table-batchStart=995&table-batchSize=5">200</a>
- <a href="http://...html?table-batchStart=1000&table-batchSize=5">201</a>
- <a href="http://...html?table-batchStart=1005&table-batchSize=5" class="current">202</a>
- <a href="http://...html?table-batchStart=1010&table-batchSize=5">203</a>
- <a href="http://...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
-
-
-None previous and next batch size. Probably it doesn't make sense but let's
-show what happens if we set the previous and next batch size to 0 (zero):
-
- >>> from z3c.table.batch import BatchProvider
- >>> class ZeroBatchProvider(BatchProvider):
- ... """Just another batch provider."""
- ... batchSpacer = u'xxx'
- ... previousBatchSize = 0
- ... nextBatchSize = 0
-
-Now register the new batch provider for our batching table:
-
- >>> import zope.publisher.interfaces.browser
- >>> zope.component.provideAdapter(ZeroBatchProvider,
- ... (zope.interface.Interface,
- ... zope.publisher.interfaces.browser.IBrowserRequest,
- ... BatchingTable), name='batch')
-
-Update the table and render the batch:
-
- >>> requestBatchingTable.update()
- >>> print requestBatchingTable.renderBatch()
- <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
- xxx
- <a href="...html?table-batchStart=100&table-batchSize=5" class="current">21</a>
- xxx
- <a href="...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
-
-
-SequenceTable
--------------
-
-A sequence table can be used if we need to provide a table for a sequence
-of items instead of a mapping. Define the same sequence of items we used before
-we added the other 1000 items:
-
- >>> dataSequence = []
- >>> dataSequence.append(Content('Zero', 0))
- >>> dataSequence.append(Content('First', 1))
- >>> dataSequence.append(Content('Second', 2))
- >>> dataSequence.append(Content('Third', 3))
- >>> dataSequence.append(Content('Fourth', 4))
- >>> dataSequence.append(Content('Fifth', 5))
- >>> dataSequence.append(Content('Sixth', 6))
- >>> dataSequence.append(Content('Seventh', 7))
- >>> dataSequence.append(Content('Eighth', 8))
- >>> dataSequence.append(Content('Ninth', 9))
- >>> dataSequence.append(Content('Tenth', 10))
- >>> dataSequence.append(Content('Eleventh', 11))
- >>> dataSequence.append(Content('Twelfth', 12))
- >>> dataSequence.append(Content('Thirteenth', 13))
- >>> dataSequence.append(Content('Fourteenth', 14))
- >>> dataSequence.append(Content('Fifteenth', 15))
- >>> dataSequence.append(Content('Sixteenth', 16))
- >>> dataSequence.append(Content('Seventeenth', 17))
- >>> dataSequence.append(Content('Eighteenth', 18))
- >>> dataSequence.append(Content('Nineteenth', 19))
- >>> dataSequence.append(Content('Twentieth', 20))
-
-Now let's define a new SequenceTable:
-
- >>> class SequenceTable(table.SequenceTable):
- ...
- ... def setUpColumns(self):
- ... return [
- ... column.addColumn(self, TitleColumn, u'title',
- ... cellRenderer=cellRenderer,
- ... headCellRenderer=headCellRenderer,
- ... weight=1),
- ... column.addColumn(self, NumberColumn, name=u'number',
- ... weight=2, header=u'Number')
- ... ]
-
-Now we can create our table adapting our sequence:
-
- >>> sequenceRequest = TestRequest(form={'table-batchStart': '0',
- ... 'table-sortOn': 'table-number-1'})
- >>> sequenceTable = SequenceTable(dataSequence, sequenceRequest)
-
-We also need to give the table a location and a name like we normaly setup
-in traversing:
-
- >>> sequenceTable.__parent__ = container
- >>> sequenceTable.__name__ = u'sequenceTable.html'
-
-And update and render the sequence table:
-
- >>> sequenceTable.update()
- >>> print sequenceTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Zero item</td>
- <td>number: 0</td>
- </tr>
- <tr>
- <td>First item</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Second item</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Third item</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Fourth item</td>
- <td>number: 4</td>
- </tr>
- <tr>
- <td>Fifth item</td>
- <td>number: 5</td>
- </tr>
- <tr>
- <td>Sixth item</td>
- <td>number: 6</td>
- </tr>
- <tr>
- <td>Seventh item</td>
- <td>number: 7</td>
- </tr>
- <tr>
- <td>Eighth item</td>
- <td>number: 8</td>
- </tr>
- <tr>
- <td>Ninth item</td>
- <td>number: 9</td>
- </tr>
- <tr>
- <td>Tenth item</td>
- <td>number: 10</td>
- </tr>
- <tr>
- <td>Eleventh item</td>
- <td>number: 11</td>
- </tr>
- <tr>
- <td>Twelfth item</td>
- <td>number: 12</td>
- </tr>
- <tr>
- <td>Thirteenth item</td>
- <td>number: 13</td>
- </tr>
- <tr>
- <td>Fourteenth item</td>
- <td>number: 14</td>
- </tr>
- <tr>
- <td>Fifteenth item</td>
- <td>number: 15</td>
- </tr>
- <tr>
- <td>Sixteenth item</td>
- <td>number: 16</td>
- </tr>
- <tr>
- <td>Seventeenth item</td>
- <td>number: 17</td>
- </tr>
- <tr>
- <td>Eighteenth item</td>
- <td>number: 18</td>
- </tr>
- <tr>
- <td>Nineteenth item</td>
- <td>number: 19</td>
- </tr>
- <tr>
- <td>Twentieth item</td>
- <td>number: 20</td>
- </tr>
- </tbody>
- </table>
-
-As you can see, the items get rendered based on a data sequence. Now we set
-the ``start batch at`` size to ``5``:
-
- >>> sequenceTable.startBatchingAt = 5
-
-And the ``batchSize`` to ``5``:
-
- >>> sequenceTable.batchSize = 5
-
-Now we can update and render the table again. But you will see that we only get
-a table size of 5 rows:
-
- >>> sequenceTable.update()
- >>> print sequenceTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Zero item</td>
- <td>number: 0</td>
- </tr>
- <tr>
- <td>First item</td>
- <td>number: 1</td>
- </tr>
- <tr>
- <td>Second item</td>
- <td>number: 2</td>
- </tr>
- <tr>
- <td>Third item</td>
- <td>number: 3</td>
- </tr>
- <tr>
- <td>Fourth item</td>
- <td>number: 4</td>
- </tr>
- </tbody>
- </table>
-
-And we set the sort order to ``reverse`` even if we use batching:
-
- >>> sequenceTable.sortOrder = u'reverse'
- >>> sequenceTable.update()
- >>> print sequenceTable.render()
- <table>
- <thead>
- <tr>
- <th>My items</th>
- <th>Number</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>Twentieth item</td>
- <td>number: 20</td>
- </tr>
- <tr>
- <td>Nineteenth item</td>
- <td>number: 19</td>
- </tr>
- <tr>
- <td>Eighteenth item</td>
- <td>number: 18</td>
- </tr>
- <tr>
- <td>Seventeenth item</td>
- <td>number: 17</td>
- </tr>
- <tr>
- <td>Sixteenth item</td>
- <td>number: 16</td>
- </tr>
- </tbody>
- </table>
-
Headers
-------
@@ -1717,103 +638,3 @@
-Miscellaneous
--------------
-
-Make coverage report happy and test different things.
-
-Test if the getWeight method returns 0 (zero) on AttributeError:
-
- >>> from z3c.table.table import getWeight
- >>> getWeight(None)
- 0
-
-Try to call a simple table and call renderBatch which should return an empty
-string:
-
- >>> simpleTable = table.Table(container, request)
- >>> simpleTable.renderBatch()
- u''
-
-Try to render an empty table adapting an empty mapping:
-
- >>> simpleTable = table.Table({}, request)
- >>> simpleTable.render()
- u''
-
-Since we have registered 3 adapters for IColumn on None (IOW on an empty mapping),
-initializing rows definitions for the empty table will initiliaze the columns attribute list
-
- >>> simpleTable.columns
-
- >>> simpleTable.initColumns()
- >>> simpleTable.columns
- [<CorrectColspanColumn u'colspanColumn'>, <NameColumn u'secondColumn'>, <TitleColumn u'firstColumn'>]
-
-Rendering the empty table now return the string:
-
- >>> print simpleTable.render()
- <table>
- <thead>
- <tr>
- <th>Colspan</th>
- <th><a href="?table-sortOrder=ascending&table-sortOn=table-secondColumn-1" title="Sort">Name</a></th>
- <th><a href="?table-sortOrder=ascending&table-sortOn=table-firstColumn-2" title="Sort">Title</a></th>
- </tr>
- </thead>
- <tbody>
- </tbody>
- </table>
-
-
-Let's see if the addColumn raises a ValueError if there is no Column class:
-
- >>> column.addColumn(simpleTable, column.Column, u'dummy')
- <Column u'dummy'>
-
- >>> column.addColumn(simpleTable, None, u'dummy')
- Traceback (most recent call last):
- ...
- ValueError: class_ None must implement IColumn.
-
-Test if we can set additional kws in addColumn:
-
- >>> simpleColumn = column.addColumn(simpleTable, column.Column, u'dummy',
- ... foo='foo value', bar=u'something else', counter=99)
- >>> simpleColumn.foo
- 'foo value'
-
- >>> simpleColumn.bar
- u'something else'
-
- >>> simpleColumn.counter
- 99
-
-The NoneCell class provides some methods which never get. But this methods must
-be there because the interfaces defines them. Let's test the default values
-and make coverage report happy.
-
-Let's get an container item first:
-
- >>> firstItem = container[u'first']
- >>> noneCellColumn = column.addColumn(simpleTable, column.NoneCell, u'none')
- >>> noneCellColumn.renderCell(firstItem)
- u''
-
- >>> noneCellColumn.getColspan(firstItem)
- 0
-
- >>> noneCellColumn.renderHeadCell()
- u''
-
- >>> noneCellColumn.renderCell(firstItem)
- u''
-
-The default ``Column`` implementation raises an NotImplementedError if we
-do not override the renderCell method:
-
- >>> defaultColumn = column.addColumn(simpleTable, column.Column, u'default')
- >>> defaultColumn.renderCell(firstItem)
- Traceback (most recent call last):
- ...
- NotImplementedError: Subclass must implement renderCell
Copied: z3c.table/trunk/src/z3c/table/batch.txt (from rev 115478, z3c.table/branches/test-split/src/z3c/table/batch.txt)
===================================================================
--- z3c.table/trunk/src/z3c/table/batch.txt (rev 0)
+++ z3c.table/trunk/src/z3c/table/batch.txt 2010-08-05 08:20:47 UTC (rev 115484)
@@ -0,0 +1,649 @@
+Batching
+--------
+
+Our table implements batching out of the box. If the amount of
+row items is smaller than the given ``startBatchingAt`` size, the table starts
+to batch at this size. Let's define a new Table.
+
+We need to configure our batch provider for the next step first. See the
+section ``BatchProvider`` below for more infos about batch rendering:
+
+ >>> from zope.configuration.xmlconfig import XMLConfig
+ >>> import z3c.table
+ >>> import zope.component
+ >>> XMLConfig('meta.zcml', zope.component)()
+ >>> XMLConfig('configure.zcml', z3c.table)()
+
+Now we can create our table:
+
+ >>> from zope.publisher.browser import TestRequest
+ >>> from z3c.table.testing import Container, Content, SimpleTable
+ >>> container = Container()
+ >>> root['container-1'] = container
+ >>> request = TestRequest()
+ >>> batchingTable = SimpleTable(container, request)
+
+We also need to give the table a location and a name like we normally setup
+in traversing:
+
+ >>> batchingTable.__parent__ = container
+ >>> batchingTable.__name__ = u'batchingTable.html'
+
+Now setup some items:
+
+ >>> container[u'zero'] = Content('Zero', 0)
+ >>> container[u'first'] = Content('First', 1)
+ >>> container[u'second'] = Content('Second', 2)
+ >>> container[u'third'] = Content('Third', 3)
+ >>> container[u'fourth'] = Content('Fourth', 4)
+ >>> container[u'sixth'] = Content('Sixth', 6)
+ >>> container[u'seventh'] = Content('Seventh', 7)
+ >>> container[u'eighth'] = Content('Eighth', 8)
+ >>> container[u'ninth'] = Content('Ninth', 9)
+ >>> container[u'tenth'] = Content('Tenth', 10)
+ >>> container[u'eleventh'] = Content('Eleventh', 11)
+ >>> container[u'twelfth '] = Content('Twelfth', 12)
+ >>> container[u'thirteenth'] = Content('Thirteenth', 13)
+ >>> container[u'fourteenth'] = Content('Fourteenth', 14)
+ >>> container[u'fifteenth '] = Content('Fifteenth', 15)
+ >>> container[u'sixteenth'] = Content('Sixteenth', 16)
+ >>> container[u'seventeenth'] = Content('Seventeenth', 17)
+ >>> container[u'eighteenth'] = Content('Eighteenth', 18)
+ >>> container[u'nineteenth'] = Content('Nineteenth', 19)
+ >>> container[u'twentieth'] = Content('Twentieth', 20)
+
+Now let's show the full table without batching:
+
+ >>> batchingTable.update()
+ >>> print batchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Eighteenth item</td>
+ <td>number: 18</td>
+ </tr>
+ <tr>
+ <td>Eighth item</td>
+ <td>number: 8</td>
+ </tr>
+ <tr>
+ <td>Eleventh item</td>
+ <td>number: 11</td>
+ </tr>
+ <tr>
+ <td>Fifteenth item</td>
+ <td>number: 15</td>
+ </tr>
+ <tr>
+ <td>First item</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Fourteenth item</td>
+ <td>number: 14</td>
+ </tr>
+ <tr>
+ <td>Fourth item</td>
+ <td>number: 4</td>
+ </tr>
+ <tr>
+ <td>Nineteenth item</td>
+ <td>number: 19</td>
+ </tr>
+ <tr>
+ <td>Ninth item</td>
+ <td>number: 9</td>
+ </tr>
+ <tr>
+ <td>Second item</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Seventeenth item</td>
+ <td>number: 17</td>
+ </tr>
+ <tr>
+ <td>Seventh item</td>
+ <td>number: 7</td>
+ </tr>
+ <tr>
+ <td>Sixteenth item</td>
+ <td>number: 16</td>
+ </tr>
+ <tr>
+ <td>Sixth item</td>
+ <td>number: 6</td>
+ </tr>
+ <tr>
+ <td>Tenth item</td>
+ <td>number: 10</td>
+ </tr>
+ <tr>
+ <td>Third item</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Thirteenth item</td>
+ <td>number: 13</td>
+ </tr>
+ <tr>
+ <td>Twelfth item</td>
+ <td>number: 12</td>
+ </tr>
+ <tr>
+ <td>Twentieth item</td>
+ <td>number: 20</td>
+ </tr>
+ <tr>
+ <td>Zero item</td>
+ <td>number: 0</td>
+ </tr>
+ </tbody>
+ </table>
+
+As you can see, the table is not ordered and it uses all items. If we like
+to use the batch, we need to set the startBatchingAt size to a lower value than
+it is set by default.
+The default value which a batch is used is set to ``50``:
+
+ >>> batchingTable.startBatchingAt
+ 50
+
+We will set the batch start to ``5`` for now. This means the first 5 items
+do not get used:
+
+ >>> batchingTable.startBatchingAt = 5
+ >>> batchingTable.startBatchingAt
+ 5
+
+There is also a ``batchSize`` value which we need to set to ``5``. By default
+the value gets initialized by the ``batchSize`` value:
+
+ >>> batchingTable.batchSize
+ 50
+
+ >>> batchingTable.batchSize = 5
+ >>> batchingTable.batchSize
+ 5
+
+Now we can update and render the table again. But you will see that we only get
+a table size of 5 rows, which is correct. But the order doesn't depend on the
+numbers we see in cells:
+
+ >>> batchingTable.update()
+ >>> print batchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Eighteenth item</td>
+ <td>number: 18</td>
+ </tr>
+ <tr>
+ <td>Eighth item</td>
+ <td>number: 8</td>
+ </tr>
+ <tr>
+ <td>Eleventh item</td>
+ <td>number: 11</td>
+ </tr>
+ <tr>
+ <td>Fifteenth item</td>
+ <td>number: 15</td>
+ </tr>
+ <tr>
+ <td>First item</td>
+ <td>number: 1</td>
+ </tr>
+ </tbody>
+ </table>
+
+I think we should order the table by the second column before we show the next
+batch values. We do this by simply set the ``defaultSortOn``:
+
+ >>> batchingTable.sortOn = u'table-number-1'
+
+Now we should see a nice ordered and batched table:
+
+ >>> batchingTable.update()
+ >>> print batchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Zero item</td>
+ <td>number: 0</td>
+ </tr>
+ <tr>
+ <td>First item</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Second item</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Third item</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Fourth item</td>
+ <td>number: 4</td>
+ </tr>
+ </tbody>
+ </table>
+
+The batch concept allows us to choose from all batches and render the rows
+for this batched items. We can do this by set any batch as rows. as you can see
+we have ``4`` batched row data available:
+
+ >>> len(batchingTable.rows.batches)
+ 4
+
+We can set such a batch as row values, then this batch data are used for
+rendering. But take care, if we update the table, our rows get overriden
+and reset to the previous values. this means you can set any bath as rows
+data and only render them. This is possible since the update method sorted all
+items and all batch contain ready-to-use data. This concept could be important
+if you need to cache batches etc. :
+
+ >>> batchingTable.rows = batchingTable.rows.batches[1]
+ >>> print batchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Sixth item</td>
+ <td>number: 6</td>
+ </tr>
+ <tr>
+ <td>Seventh item</td>
+ <td>number: 7</td>
+ </tr>
+ <tr>
+ <td>Eighth item</td>
+ <td>number: 8</td>
+ </tr>
+ <tr>
+ <td>Ninth item</td>
+ <td>number: 9</td>
+ </tr>
+ <tr>
+ <td>Tenth item</td>
+ <td>number: 10</td>
+ </tr>
+ </tbody>
+ </table>
+
+And like described above, if you call ``update`` our batch to rows setup get
+reset:
+
+ >>> batchingTable.update()
+ >>> print batchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Zero item</td>
+ <td>number: 0</td>
+ </tr>
+ <tr>
+ <td>First item</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Second item</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Third item</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Fourth item</td>
+ <td>number: 4</td>
+ </tr>
+ </tbody>
+ </table>
+
+This means you can probably update all batches, cache them and use them alter.
+but this is not usefull for normal usage in a page without an enhanced concept
+which is not a part of this implementation. This also means, there must be
+another way to set the batch index. Yes there is, there are two other ways how
+we can set the batch position. We can set a batch position by setting the
+``batchStart`` value in our table or we can use a request variable. Let's show
+the first one first:
+
+ >>> batchingTable.batchStart = 6
+ >>> batchingTable.update()
+ >>> print batchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Seventh item</td>
+ <td>number: 7</td>
+ </tr>
+ <tr>
+ <td>Eighth item</td>
+ <td>number: 8</td>
+ </tr>
+ <tr>
+ <td>Ninth item</td>
+ <td>number: 9</td>
+ </tr>
+ <tr>
+ <td>Tenth item</td>
+ <td>number: 10</td>
+ </tr>
+ <tr>
+ <td>Eleventh item</td>
+ <td>number: 11</td>
+ </tr>
+ </tbody>
+ </table>
+
+We can also set the batch position by using the batchStart value in a request.
+Note that we need the table ``prefix`` and column ``__name__`` like we use in
+the sorting concept:
+
+ >>> batchingRequest = TestRequest(form={'table-batchStart': '11',
+ ... 'table-batchSize': '5',
+ ... 'table-sortOn': 'table-number-1'})
+ >>> requestBatchingTable = SimpleTable(container, batchingRequest)
+
+We also need to give the table a location and a name like we normaly setup
+in traversing:
+
+ >>> requestBatchingTable.__parent__ = container
+ >>> requestBatchingTable.__name__ = u'requestBatchingTable.html'
+
+Note; our table needs to start batching at smaller amount of items than we
+have by default otherwise we don't get a batch:
+
+ >>> requestBatchingTable.startBatchingAt = 5
+ >>> requestBatchingTable.update()
+ >>> print requestBatchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Twelfth item</td>
+ <td>number: 12</td>
+ </tr>
+ <tr>
+ <td>Thirteenth item</td>
+ <td>number: 13</td>
+ </tr>
+ <tr>
+ <td>Fourteenth item</td>
+ <td>number: 14</td>
+ </tr>
+ <tr>
+ <td>Fifteenth item</td>
+ <td>number: 15</td>
+ </tr>
+ <tr>
+ <td>Sixteenth item</td>
+ <td>number: 16</td>
+ </tr>
+ </tbody>
+ </table>
+
+
+BatchProvider
+-------------
+
+The batch provider allows us to render the batch HTML independently of our
+table. This means by default the batch gets not rendered in the render method.
+You can change this in your custom table implementation and return the batch
+and the table in the render method.
+
+As we can see, our table rows provides IBatch if it comes to batching:
+
+ >>> from z3c.batching.interfaces import IBatch
+ >>> IBatch.providedBy(requestBatchingTable.rows)
+ True
+
+Let's check some batch variables before we render our test. This let us compare
+the rendered result. For more information about batching see the README.txt in
+z3c.batching:
+
+ >>> requestBatchingTable.rows.start
+ 11
+
+ >>> requestBatchingTable.rows.index
+ 2
+
+ >>> requestBatchingTable.rows.batches
+ <z3c.batching.batch.Batches object at ...>
+
+ >>> len(requestBatchingTable.rows.batches)
+ 4
+
+We use our previous batching table and render the batch with the built-in
+``renderBatch`` method:
+
+ >>> requestBatchingTable.update()
+ >>> print requestBatchingTable.renderBatch()
+ <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
+ <a href="...html?table-batchStart=5&table-batchSize=5">2</a>
+ <a href="...html?table-batchStart=11&table-batchSize=5" class="current">3</a>
+ <a href="...html?table-batchStart=15&table-batchSize=5" class="last">4</a>
+
+Now let's add more items so that we can test the skipped links in large
+batches:
+
+ >>> for i in range(1000):
+ ... idx = i+20
+ ... container[str(idx)] = Content(str(idx), idx)
+
+Now let's test the batching table again with the new amount of items and
+the same ``startBatchingAt`` of 5 but starting the batch at item ``100``
+and sorted on the second numbered column:
+
+ >>> batchingRequest = TestRequest(form={'table-batchStart': '100',
+ ... 'table-batchSize': '5',
+ ... 'table-sortOn': 'table-number-1'})
+ >>> requestBatchingTable = SimpleTable(container, batchingRequest)
+ >>> requestBatchingTable.startBatchingAt = 5
+
+We also need to give the table a location and a name like we normally setup
+in traversing:
+
+ >>> requestBatchingTable.__parent__ = container
+ >>> requestBatchingTable.__name__ = u'requestBatchingTable.html'
+
+ >>> requestBatchingTable.update()
+ >>> print requestBatchingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>100 item</td>
+ <td>number: 100</td>
+ </tr>
+ <tr>
+ <td>101 item</td>
+ <td>number: 101</td>
+ </tr>
+ <tr>
+ <td>102 item</td>
+ <td>number: 102</td>
+ </tr>
+ <tr>
+ <td>103 item</td>
+ <td>number: 103</td>
+ </tr>
+ <tr>
+ <td>104 item</td>
+ <td>number: 104</td>
+ </tr>
+ </tbody>
+ </table>
+
+And test the batch. Note the three dots between the links are rendered by the
+batch provider and are not a part of the doctest:
+
+ >>> print requestBatchingTable.renderBatch()
+ <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
+ ...
+ <a href="...html?table-batchStart=85&table-batchSize=5">18</a>
+ <a href="...html?table-batchStart=90&table-batchSize=5">19</a>
+ <a href="...html?table-batchStart=95&table-batchSize=5">20</a>
+ <a href="...html?table-batchStart=100&table-batchSize=5" class="current">21</a>
+ <a href="...html?table-batchStart=105&table-batchSize=5">22</a>
+ <a href="...html?table-batchStart=110&table-batchSize=5">23</a>
+ <a href="...html?table-batchStart=115&table-batchSize=5">24</a>
+ ...
+ <a href="...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
+
+You can change the spacer in the batch provider if you set the ``batchSpacer``
+value:
+
+ >>> from z3c.table.batch import BatchProvider
+ >>> from z3c.table.interfaces import IBatchProvider
+ >>> from zope.interface import implements
+ >>> class XBatchProvider(BatchProvider):
+ ... """Just another batch provider."""
+ ... implements(IBatchProvider)
+ ... batchSpacer = u'xxx'
+
+Now register the new batch provider for our batching table:
+
+ >>> import zope.publisher.interfaces.browser
+ >>> from zope.component import getSiteManager
+ >>> sm = getSiteManager(container)
+ >>> sm.registerAdapter(XBatchProvider,
+ ... (zope.interface.Interface,
+ ... zope.publisher.interfaces.browser.IBrowserRequest,
+ ... SimpleTable), name='batch')
+
+If we update and render our table, the new batch provider should get used.
+As you can see the spacer get changed now:
+
+ >>> requestBatchingTable.update()
+ >>> requestBatchingTable.batchProvider
+ <XBatchProvider object at ...>
+ >>> print requestBatchingTable.renderBatch()
+ <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
+ xxx
+ <a href="...html?table-batchStart=85&table-batchSize=5">18</a>
+ <a href="...html?table-batchStart=90&table-batchSize=5">19</a>
+ <a href="...html?table-batchStart=95&table-batchSize=5">20</a>
+ <a href="...html?table-batchStart=100&table-batchSize=5" class="current">21</a>
+ <a href="...html?table-batchStart=105&table-batchSize=5">22</a>
+ <a href="...html?table-batchStart=110&table-batchSize=5">23</a>
+ <a href="...html?table-batchStart=115&table-batchSize=5">24</a>
+ xxx
+ <a href="...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
+
+
+Now test the extremities, need to define a new batchingRequest:
+Beginning by the left end point:
+
+ >>> leftBatchingRequest = TestRequest(form={'table-batchStart': '10',
+ ... 'table-batchSize': '5',
+ ... 'table-sortOn': 'table-number-1'})
+ >>> leftRequestBatchingTable = SimpleTable(container, leftBatchingRequest)
+ >>> leftRequestBatchingTable.__parent__ = container
+ >>> leftRequestBatchingTable.__name__ = u'leftRequestBatchingTable.html'
+ >>> leftRequestBatchingTable.update()
+ >>> print leftRequestBatchingTable.renderBatch()
+ <a href="http://...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
+ <a href="http://...html?table-batchStart=5&table-batchSize=5">2</a>
+ <a href="http://...html?table-batchStart=10&table-batchSize=5" class="current">3</a>
+ <a href="http://...html?table-batchStart=15&table-batchSize=5">4</a>
+ <a href="http://...html?table-batchStart=20&table-batchSize=5">5</a>
+ <a href="http://...html?table-batchStart=25&table-batchSize=5">6</a>
+ xxx
+ <a href="http://...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
+
+Go on with the right extremity:
+
+ >>> rightBatchingRequest = TestRequest(form={'table-batchStart': '1005',
+ ... 'table-batchSize': '5',
+ ... 'table-sortOn': 'table-number-1'})
+ >>> rightRequestBatchingTable = SimpleTable(container, rightBatchingRequest)
+ >>> rightRequestBatchingTable.__parent__ = container
+ >>> rightRequestBatchingTable.__name__ = u'rightRequestBatchingTable.html'
+ >>> rightRequestBatchingTable.update()
+ >>> print rightRequestBatchingTable.renderBatch()
+ <a href="http://...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
+ xxx
+ <a href="http://...html?table-batchStart=990&table-batchSize=5">199</a>
+ <a href="http://...html?table-batchStart=995&table-batchSize=5">200</a>
+ <a href="http://...html?table-batchStart=1000&table-batchSize=5">201</a>
+ <a href="http://...html?table-batchStart=1005&table-batchSize=5" class="current">202</a>
+ <a href="http://...html?table-batchStart=1010&table-batchSize=5">203</a>
+ <a href="http://...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
+
+
+None previous and next batch size. Probably it doesn't make sense but let's
+show what happens if we set the previous and next batch size to 0 (zero):
+
+ >>> from z3c.table.batch import BatchProvider
+ >>> class ZeroBatchProvider(BatchProvider):
+ ... """Just another batch provider."""
+ ... batchSpacer = u'xxx'
+ ... previousBatchSize = 0
+ ... nextBatchSize = 0
+
+Now register the new batch provider for our batching table:
+
+ >>> import zope.publisher.interfaces.browser
+ >>> sm.registerAdapter(ZeroBatchProvider,
+ ... (zope.interface.Interface,
+ ... zope.publisher.interfaces.browser.IBrowserRequest,
+ ... SimpleTable), name='batch')
+
+Update the table and render the batch:
+
+ >>> requestBatchingTable.update()
+ >>> print requestBatchingTable.renderBatch()
+ <a href="...html?table-batchStart=0&table-batchSize=5" class="first">1</a>
+ xxx
+ <a href="...html?table-batchStart=100&table-batchSize=5" class="current">21</a>
+ xxx
+ <a href="...html?table-batchStart=1015&table-batchSize=5" class="last">204</a>
Copied: z3c.table/trunk/src/z3c/table/miscellaneous.txt (from rev 115478, z3c.table/branches/test-split/src/z3c/table/miscellaneous.txt)
===================================================================
--- z3c.table/trunk/src/z3c/table/miscellaneous.txt (rev 0)
+++ z3c.table/trunk/src/z3c/table/miscellaneous.txt 2010-08-05 08:20:47 UTC (rev 115484)
@@ -0,0 +1,116 @@
+Miscellaneous
+-------------
+
+Make coverage report happy and test different things.
+
+Test if the getWeight method returns 0 (zero) on AttributeError:
+
+ >>> from z3c.table.table import getWeight
+ >>> getWeight(None)
+ 0
+
+Create a container:
+
+ >>> from z3c.table.testing import Container
+ >>> container = Container()
+
+Try to call a simple table and call renderBatch which should return an empty
+string:
+
+ >>> from z3c.table import table
+ >>> from zope.publisher.browser import TestRequest
+ >>> request = TestRequest()
+ >>> simpleTable = table.Table(container, request)
+ >>> simpleTable.renderBatch()
+ u''
+
+Try to render an empty table adapting an empty mapping:
+
+ >>> simpleTable = table.Table({}, request)
+ >>> simpleTable.render()
+ u''
+
+Since we register an adapter for IColumn on None (IOW on an empty mapping).
+
+ >>> from zope.component import provideAdapter
+ >>> from z3c.table import column
+ >>> from z3c.table import interfaces
+ >>> provideAdapter(column.NameColumn,
+ ... (None, None, interfaces.ITable), provides=interfaces.IColumn,
+ ... name='secondColumn')
+
+Initializing rows definitions for the empty table initializes the columns
+attribute list.
+
+ >>> simpleTable.columns
+
+ >>> simpleTable.initColumns()
+ >>> simpleTable.columns
+ [<NameColumn u'secondColumn'>]
+
+Rendering the empty table now return the string:
+
+ >>> print simpleTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ </tr>
+ </thead>
+ <tbody>
+ </tbody>
+ </table>
+
+
+Let's see if the addColumn raises a ValueError if there is no Column class:
+
+ >>> column.addColumn(simpleTable, column.Column, u'dummy')
+ <Column u'dummy'>
+
+ >>> column.addColumn(simpleTable, None, u'dummy')
+ Traceback (most recent call last):
+ ...
+ ValueError: class_ None must implement IColumn.
+
+Test if we can set additional kws in addColumn:
+
+ >>> simpleColumn = column.addColumn(simpleTable, column.Column, u'dummy',
+ ... foo='foo value', bar=u'something else', counter=99)
+ >>> simpleColumn.foo
+ 'foo value'
+
+ >>> simpleColumn.bar
+ u'something else'
+
+ >>> simpleColumn.counter
+ 99
+
+The NoneCell class provides some methods which never get called. But these
+are defined in the interface. Let's test the default values
+and make coverage report happy.
+
+Let's get an container item first:
+
+ >>> from z3c.table.testing import Content
+ >>> firstItem = Content('First', 1)
+ >>> noneCellColumn = column.addColumn(simpleTable, column.NoneCell, u'none')
+ >>> noneCellColumn.renderCell(firstItem)
+ u''
+
+ >>> noneCellColumn.getColspan(firstItem)
+ 0
+
+ >>> noneCellColumn.renderHeadCell()
+ u''
+
+ >>> noneCellColumn.renderCell(firstItem)
+ u''
+
+The default ``Column`` implementation raises an NotImplementedError if we
+do not override the renderCell method:
+
+ >>> defaultColumn = column.addColumn(simpleTable, column.Column, u'default')
+ >>> defaultColumn.renderCell(firstItem)
+ Traceback (most recent call last):
+ ...
+ NotImplementedError: Subclass must implement renderCell
Copied: z3c.table/trunk/src/z3c/table/sequence.txt (from rev 115478, z3c.table/branches/test-split/src/z3c/table/sequence.txt)
===================================================================
--- z3c.table/trunk/src/z3c/table/sequence.txt (rev 0)
+++ z3c.table/trunk/src/z3c/table/sequence.txt 2010-08-05 08:20:47 UTC (rev 115484)
@@ -0,0 +1,253 @@
+SequenceTable
+-------------
+
+A sequence table can be used if we need to provide a table for a sequence
+of items instead of a mapping. Define the same sequence of items we used before
+we added the other 1000 items:
+
+ >>> from z3c.table.testing import Content
+ >>> dataSequence = []
+ >>> dataSequence.append(Content('Zero', 0))
+ >>> dataSequence.append(Content('First', 1))
+ >>> dataSequence.append(Content('Second', 2))
+ >>> dataSequence.append(Content('Third', 3))
+ >>> dataSequence.append(Content('Fourth', 4))
+ >>> dataSequence.append(Content('Fifth', 5))
+ >>> dataSequence.append(Content('Sixth', 6))
+ >>> dataSequence.append(Content('Seventh', 7))
+ >>> dataSequence.append(Content('Eighth', 8))
+ >>> dataSequence.append(Content('Ninth', 9))
+ >>> dataSequence.append(Content('Tenth', 10))
+ >>> dataSequence.append(Content('Eleventh', 11))
+ >>> dataSequence.append(Content('Twelfth', 12))
+ >>> dataSequence.append(Content('Thirteenth', 13))
+ >>> dataSequence.append(Content('Fourteenth', 14))
+ >>> dataSequence.append(Content('Fifteenth', 15))
+ >>> dataSequence.append(Content('Sixteenth', 16))
+ >>> dataSequence.append(Content('Seventeenth', 17))
+ >>> dataSequence.append(Content('Eighteenth', 18))
+ >>> dataSequence.append(Content('Nineteenth', 19))
+ >>> dataSequence.append(Content('Twentieth', 20))
+
+Now let's define a new SequenceTable:
+
+ >>> from z3c.table import table, column
+ >>> from z3c.table.testing import (TitleColumn, NumberColumn, cellRenderer,
+ ... headCellRenderer)
+ >>> class SequenceTable(table.SequenceTable):
+ ...
+ ... def setUpColumns(self):
+ ... return [
+ ... column.addColumn(self, TitleColumn, u'title',
+ ... cellRenderer=cellRenderer,
+ ... headCellRenderer=headCellRenderer,
+ ... weight=1),
+ ... column.addColumn(self, NumberColumn, name=u'number',
+ ... weight=2, header=u'Number')
+ ... ]
+
+Now we can create our table adapting our sequence:
+
+ >>> from zope.publisher.browser import TestRequest
+ >>> sequenceRequest = TestRequest(form={'table-batchStart': '0',
+ ... 'table-sortOn': 'table-number-1'})
+ >>> sequenceTable = SequenceTable(dataSequence, sequenceRequest)
+
+We also need to give the table a location and a name like we normaly setup
+in traversing:
+
+ >>> from z3c.table.testing import Container
+ >>> container = Container()
+ >>> root['container-1'] = container
+ >>> sequenceTable.__parent__ = container
+ >>> sequenceTable.__name__ = u'sequenceTable.html'
+
+We need to configure our batch provider for the next step first. See the
+section ``BatchProvider`` below for more infos about batch rendering:
+
+ >>> from zope.configuration.xmlconfig import XMLConfig
+ >>> import z3c.table
+ >>> import zope.component
+ >>> XMLConfig('meta.zcml', zope.component)()
+ >>> XMLConfig('configure.zcml', z3c.table)()
+
+And update and render the sequence table:
+
+ >>> sequenceTable.update()
+ >>> print sequenceTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Zero item</td>
+ <td>number: 0</td>
+ </tr>
+ <tr>
+ <td>First item</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Second item</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Third item</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Fourth item</td>
+ <td>number: 4</td>
+ </tr>
+ <tr>
+ <td>Fifth item</td>
+ <td>number: 5</td>
+ </tr>
+ <tr>
+ <td>Sixth item</td>
+ <td>number: 6</td>
+ </tr>
+ <tr>
+ <td>Seventh item</td>
+ <td>number: 7</td>
+ </tr>
+ <tr>
+ <td>Eighth item</td>
+ <td>number: 8</td>
+ </tr>
+ <tr>
+ <td>Ninth item</td>
+ <td>number: 9</td>
+ </tr>
+ <tr>
+ <td>Tenth item</td>
+ <td>number: 10</td>
+ </tr>
+ <tr>
+ <td>Eleventh item</td>
+ <td>number: 11</td>
+ </tr>
+ <tr>
+ <td>Twelfth item</td>
+ <td>number: 12</td>
+ </tr>
+ <tr>
+ <td>Thirteenth item</td>
+ <td>number: 13</td>
+ </tr>
+ <tr>
+ <td>Fourteenth item</td>
+ <td>number: 14</td>
+ </tr>
+ <tr>
+ <td>Fifteenth item</td>
+ <td>number: 15</td>
+ </tr>
+ <tr>
+ <td>Sixteenth item</td>
+ <td>number: 16</td>
+ </tr>
+ <tr>
+ <td>Seventeenth item</td>
+ <td>number: 17</td>
+ </tr>
+ <tr>
+ <td>Eighteenth item</td>
+ <td>number: 18</td>
+ </tr>
+ <tr>
+ <td>Nineteenth item</td>
+ <td>number: 19</td>
+ </tr>
+ <tr>
+ <td>Twentieth item</td>
+ <td>number: 20</td>
+ </tr>
+ </tbody>
+ </table>
+
+As you can see, the items get rendered based on a data sequence. Now we set
+the ``start batch at`` size to ``5``:
+
+ >>> sequenceTable.startBatchingAt = 5
+
+And the ``batchSize`` to ``5``:
+
+ >>> sequenceTable.batchSize = 5
+
+Now we can update and render the table again. But you will see that we only get
+a table size of 5 rows:
+
+ >>> sequenceTable.update()
+ >>> print sequenceTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Zero item</td>
+ <td>number: 0</td>
+ </tr>
+ <tr>
+ <td>First item</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Second item</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Third item</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Fourth item</td>
+ <td>number: 4</td>
+ </tr>
+ </tbody>
+ </table>
+
+And we set the sort order to ``reverse`` even if we use batching:
+
+ >>> sequenceTable.sortOrder = u'reverse'
+ >>> sequenceTable.update()
+ >>> print sequenceTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>My items</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Twentieth item</td>
+ <td>number: 20</td>
+ </tr>
+ <tr>
+ <td>Nineteenth item</td>
+ <td>number: 19</td>
+ </tr>
+ <tr>
+ <td>Eighteenth item</td>
+ <td>number: 18</td>
+ </tr>
+ <tr>
+ <td>Seventeenth item</td>
+ <td>number: 17</td>
+ </tr>
+ <tr>
+ <td>Sixteenth item</td>
+ <td>number: 16</td>
+ </tr>
+ </tbody>
+ </table>
+
Copied: z3c.table/trunk/src/z3c/table/sort.txt (from rev 115478, z3c.table/branches/test-split/src/z3c/table/sort.txt)
===================================================================
--- z3c.table/trunk/src/z3c/table/sort.txt (rev 0)
+++ z3c.table/trunk/src/z3c/table/sort.txt 2010-08-05 08:20:47 UTC (rev 115484)
@@ -0,0 +1,214 @@
+Sorting Table
+-------------
+
+Another table feature is the support for sorting data given from columns. Since
+sorting table data is an important feature, we offer this by default. But it
+only gets used if there is a ``sortOn`` value set. You can set this value at
+class level by adding a ``defaultSortOn`` value or set it as a request value.
+We show you how to do this later. We also need a columns which allows us to do
+a better sort sample. Our new sorting column will use the content items number
+value for sorting:
+
+ >>> from z3c.table import column, table
+ >>> class NumberColumn(column.Column):
+ ...
+ ... header = u'Number'
+ ... weight = 20
+ ...
+ ... def getSortKey(self, item):
+ ... return item.number
+ ...
+ ... def renderCell(self, item):
+ ... return 'number: %s' % item.number
+
+
+Now let's setup a table:
+
+ >>> from z3c.table.testing import TitleColumn
+ >>> class SortingTable(table.Table):
+ ...
+ ... def setUpColumns(self):
+ ... firstColumn = TitleColumn(self.context, self.request, self)
+ ... firstColumn.__name__ = u'title'
+ ... firstColumn.__parent__ = self
+ ... secondColumn = NumberColumn(self.context, self.request, self)
+ ... secondColumn.__name__ = u'number'
+ ... secondColumn.__parent__ = self
+ ... return [firstColumn, secondColumn]
+
+Create a container:
+
+ >>> from z3c.table.testing import Container
+ >>> container = Container()
+
+We also need some container items that we can use for sorting:
+
+ >>> from z3c.table.testing import Content
+ >>> container[u'first'] = Content('First', 1)
+ >>> container[u'second'] = Content('Second', 2)
+ >>> container[u'third'] = Content('Third', 3)
+ >>> container[u'fourth'] = Content('Fourth', 4)
+ >>> container[u'zero'] = Content('Zero', 0)
+
+And render them without set a ``sortOn`` value:
+
+ >>> from zope.publisher.browser import TestRequest
+ >>> request = TestRequest()
+ >>> sortingTable = SortingTable(container, request)
+ >>> sortingTable.update()
+ >>> print sortingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>Title</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Title: First</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Title: Fourth</td>
+ <td>number: 4</td>
+ </tr>
+ <tr>
+ <td>Title: Second</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Title: Third</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Title: Zero</td>
+ <td>number: 0</td>
+ </tr>
+ </tbody>
+ </table>
+
+As you can see this table doesn't provide any explicit order. Let's find out
+the index of our column that we like to sort on:
+
+ >>> sortOnId = sortingTable.rows[0][1][1].id
+ >>> sortOnId
+ u'table-number-1'
+
+And let's use this id as ``sortOn`` value:
+
+ >>> sortingTable.sortOn = sortOnId
+
+An important thing is to update the table after set an ``sortOn`` value:
+
+ >>> sortingTable.update()
+ >>> print sortingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>Title</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Title: Zero</td>
+ <td>number: 0</td>
+ </tr>
+ <tr>
+ <td>Title: First</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Title: Second</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Title: Third</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Title: Fourth</td>
+ <td>number: 4</td>
+ </tr>
+ </tbody>
+ </table>
+
+We can also reverse the sorting order:
+
+ >>> sortingTable.sortOrder = 'reverse'
+ >>> sortingTable.update()
+ >>> print sortingTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>Title</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Title: Fourth</td>
+ <td>number: 4</td>
+ </tr>
+ <tr>
+ <td>Title: Third</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Title: Second</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Title: First</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Title: Zero</td>
+ <td>number: 0</td>
+ </tr>
+ </tbody>
+ </table>
+
+The table implementation is also able to get the sorting criteria given from a
+request. Let's setup such a request:
+
+ >>> sorterRequest = TestRequest(form={'table-sortOn': 'table-number-1',
+ ... 'table-sortOrder':'descending'})
+
+and another time, update and render. As you can see the new table gets sorted
+by the second column and ordered in reverse order:
+
+ >>> requestSortedTable = SortingTable(container, sorterRequest)
+ >>> requestSortedTable.update()
+ >>> print requestSortedTable.render()
+ <table>
+ <thead>
+ <tr>
+ <th>Title</th>
+ <th>Number</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>Title: Fourth</td>
+ <td>number: 4</td>
+ </tr>
+ <tr>
+ <td>Title: Third</td>
+ <td>number: 3</td>
+ </tr>
+ <tr>
+ <td>Title: Second</td>
+ <td>number: 2</td>
+ </tr>
+ <tr>
+ <td>Title: First</td>
+ <td>number: 1</td>
+ </tr>
+ <tr>
+ <td>Title: Zero</td>
+ <td>number: 0</td>
+ </tr>
+ </tbody>
+ </table>
Modified: z3c.table/trunk/src/z3c/table/table.py
===================================================================
--- z3c.table/trunk/src/z3c/table/table.py 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/src/z3c/table/table.py 2010-08-05 08:20:47 UTC (rev 115484)
@@ -140,7 +140,6 @@
append = cols.append
colspanCounter = 0
countdown = len(self.columns)
- counter = 0
for col in self.columns:
countdown -= 1
colspan = 0
Modified: z3c.table/trunk/src/z3c/table/testing.py
===================================================================
--- z3c.table/trunk/src/z3c/table/testing.py 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/src/z3c/table/testing.py 2010-08-05 08:20:47 UTC (rev 115484)
@@ -19,12 +19,69 @@
import datetime
import zope.interface
import zope.component
+from zope.container import btree
from zope.dublincore.interfaces import IZopeDublinCore
from zope.security import checker
from zope.app.testing import setup
+from z3c.table import column, table
import z3c.table.value
+
+class TitleColumn(column.Column):
+
+ weight = 10
+ header = u'Title'
+
+ def renderCell(self, item):
+ return u'Title: %s' % item.title
+
+
+class NumberColumn(column.Column):
+
+ header = u'Number'
+ weight = 20
+
+ def getSortKey(self, item):
+ return item.number
+
+ def renderCell(self, item):
+ return 'number: %s' % item.number
+
+
+class Container(btree.BTreeContainer):
+ """Sample container."""
+ __name__ = u'container'
+
+
+class Content(object):
+ """Sample content."""
+
+ def __init__(self, title, number):
+ self.title = title
+ self.number = number
+
+
+class SimpleTable(table.Table):
+
+ def setUpColumns(self):
+ return [
+ column.addColumn(self, TitleColumn, u'title',
+ cellRenderer=cellRenderer,
+ headCellRenderer=headCellRenderer,
+ weight=1),
+ column.addColumn(self, NumberColumn, name=u'number',
+ weight=2, header=u'Number')]
+
+
+def headCellRenderer():
+ return u'My items'
+
+
+def cellRenderer(item):
+ return u'%s item' % item.title
+
+
class DublinCoreAdapterStub(object):
"""Dublin core adapter stub."""
Modified: z3c.table/trunk/src/z3c/table/tests.py
===================================================================
--- z3c.table/trunk/src/z3c/table/tests.py 2010-08-05 08:20:43 UTC (rev 115483)
+++ z3c.table/trunk/src/z3c/table/tests.py 2010-08-05 08:20:47 UTC (rev 115484)
@@ -30,6 +30,7 @@
class FakeContainer(object):
+
def values(self):
pass
@@ -152,6 +153,22 @@
setUp=testing.setUp, tearDown=testing.tearDown,
optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
),
+ doctest.DocFileSuite('sequence.txt',
+ setUp=testing.setUp, tearDown=testing.tearDown,
+ optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
+ ),
+ doctest.DocFileSuite('sort.txt',
+ setUp=testing.setUp, tearDown=testing.tearDown,
+ optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
+ ),
+ doctest.DocFileSuite('batch.txt',
+ setUp=testing.setUp, tearDown=testing.tearDown,
+ optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS|doctest.REPORT_UDIFF,
+ ),
+ doctest.DocFileSuite('miscellaneous.txt',
+ setUp=testing.setUp, tearDown=testing.tearDown,
+ optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
+ ),
doctest.DocFileSuite('column.txt',
setUp=testing.setUp, tearDown=testing.tearDown,
optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
More information about the checkins
mailing list