Changeset 4420 for waeup/branches/ulif-rewrite/src

Timestamp:

23 Jul 2009, 00:49:50 (15 years ago)

Author:

uli

Message:

Extend widget tests. Test coverage for waeup.widgets now 100%.

File:

• waeup/branches/ulif-rewrite/src/waeup/widgets/table.txt (modified) (1 diff)

waeup/branches/ulif-rewrite/src/waeup/widgets/table.txt

@@ -36 +36 @@
     mytable
 
+YUITable
+--------
+
+A YUI table extends a regular table by adding some JavaScript
+code-generation facilities suitable for rendering YUI based
+datatables. Futhermore they provide a `need` method, which includes
+all needed YUI scripts and stylesheets.
+
+
+    >>> from waeup.widgets.table import YUITable
+    >>> table = YUITable('My YUI Table', cols=(id, mycol1, mycol2))
+    >>> print table.getJSTableCode()
+    <BLANKLINE>
+    YAHOO.util.Event.addListener(window, "load", function() {...
+    ...
+    draggableColumns:true });
+    });
+
+Naturally, YUITable objects are suited for use by views.
+
+
+YUIStaticTableView
+==================
+
+This is a view named ``yuistatictables.js`` which from a users'
+perspective can be used like a static file. It is, however, not
+static, but returns the JavaScript code suitable for a given table.
+
+We define some content object that contains a table for which we want
+the JavaScript to be generated:
+
+    >>> class SomeContent(object):
+    ...   mytable = table
+
+    >>> obj = SomeContent()
+
+Now we need an adapter, that knows how to get a table from this kind
+of object. The YUIStaticTableView looks up such an adapter for a given
+context to find a table to manage. The adapter has to implement
+`ITableProvider` from `waeup.widgets.interfaces` and should provide a
+`getTable` method.
+
+We define and register such an adapter using grok:
+
+    >>> import grok
+    >>> grok.testing.grok('waeup')
+    >>> from waeup.widgets.interfaces import ITableProvider
+    >>> class TableAdapter(grok.Adapter):
+    ...   grok.context(SomeContent)
+    ...   grok.provides(ITableProvider)
+    ...
+    ...   def getTable(self):
+    ...     # We know that our context stores a table in `mytable`
+    ...     return self.context.mytable
+    >>> grok.testing.grok_component('TableAdapter', TableAdapter)
+    True
+
+Now let's get a view on the object defined above. We want the view
+named ``yuistatictables.js``:
+
+    >>> from zope.publisher.browser import TestRequest
+    >>> from zope.component import getMultiAdapter
+    >>> from zope.interface import Interface
+    >>> view = getMultiAdapter((obj, TestRequest()), Interface, 
+    ...                        name='yuistatictables.js')
+    >>> view
+    <waeup.widgets.table.YUIStaticTableView object at 0x...>
+
+When we call the view we get pure JavaScript:
+
+    >>> print view()
+    <BLANKLINE>
+    YAHOO.util.Event.addListener(window, "load", function() {
+    ...
+    draggableColumns:true });
+    });
+
+Table views for objects that have no table
+------------------------------------------
+
+What happens, when no `ITableProvider` can be found for an object? The
+view will return an empty string.
+
+Let's try this with a simple object for which no adapter is
+registered. We can get the view:
+
+    >>> obj = object()
+    >>> view = getMultiAdapter((obj, TestRequest()), Interface, 
+    ...                        name='yuistatictables.js')
+    >>> view
+    <waeup.widgets.table.YUIStaticTableView object at 0x...>
+
+But if we call this adapter, we will get an empty result, because
+there is no ITableProvider adapter registered for the 'viewed' object:
+
+    >>> view()
+    ''