Changeset 3895

Timestamp:

30 Jan 2009, 19:00:37 (16 years ago)

Author:

uli

Message:

Add a viewlet-mixin for rendering forms.

File:

• waeup/branches/ulif-rewrite/src/waeup/viewlets.py (modified) (2 diffs)

waeup/branches/ulif-rewrite/src/waeup/viewlets.py

@@ -2 +2 @@
 import grok
 import zope.interface
+from zope.component import getMultiAdapter
 from interfaces import IUniversity, IWAeUPObject
 
@@ -83 +84 @@
 class Copyright(grok.Viewlet):
     grok.viewletmanager(Footer)
+
+class FormWrapMixin(object):
+    """Mixin for viewlets that renders forms.
+
+    XXX: Need tests for this.
+    
+    This is a mixin that provides some convenience features for
+    viewlets that want to render forms, by overriding the default
+    `render()` and `update()` methods.
+
+    To create a viewlet that renders a form, you can define one as
+    usual but also derive from this mixin-class.
+
+    Say we have a usual form view like this::
+
+      >>> import grok
+      >>> class EditForm(grok.EditForm):
+      ...   grok.context(SomeType)
+      ...   grok.name('addsometype')
+      ...   form_fields = grok.AutoFields(IUniversity)
+      ...   @grok.action('Save')
+      ...   def save(self, **data):
+      ...     self.applyData(self.context, **data)
+      ...     return
+
+    then we can create a viewlet that displays this view like this::
+      
+      >>> import grok
+      >>> from waeup.viewlets import FormWrapMixin
+      >>> class EditFormViewlet(FormWrapMixin, grok.Viewlet):
+      ...     grok.viewletmanager(MainArea)
+      ...     grok.context(ISomeType)
+      ...     grok.view(Manage)
+      ...     formview_name = 'addsometype'
+
+    Here we define a regular viewlet with two modifications:
+
+    * it is also derived from `FormWrapMixin` and
+
+    * it provides an attribute ``formview_name`` which tells us, what
+      form we want to be rendered in this viewlet. We tell the name of
+      this form and not its class or similar.
+
+    The associated view, context, viewletmanager, etc. can be set as
+    with regular viewlets.
+    
+    """
+    formview_name = None
+    
+    def update(self):
+        self.form = getMultiAdapter((self.context, self.request),
+                                    name=self.formview_name)
+        self.form.update_form()
+        if self.request.method == 'POST':
+            #app = get_application(self.context)
+            #self.__parent__.redirect(self.__parent__.url(obj=app))
+            pass
+
+    def render(self):
+        result = self.form.render()
+        try:
+            # strip all except the form part...
+            result = re.match('^.+\(<form[^\>]+>.*</form>).+$', result,
+                              re.DOTALL).groups()[0]
+        except:
+            # except there is no such part...
+            pass
+        return result