Changeset 5380 for main/waeup.sirp/trunk/src

Timestamp:

7 Aug 2010, 14:03:41 (14 years ago)

Author:

uli

Message:

Change viewlets for links in upper-left box:

• All respective viewlets defined in here now are displayed on every page, not only the homepage. To do this we changed the context and view each of the viewlets is bound to to IWAeUPObject and WAeUPPage. That means, that these links are displayed on all views that derive from WAeUPPage and whose context is of type IWAeUPObject or derived.

• Turned ManageLink into a reusable base class for other viewlets of that kind. This made the other changed viewlets much shorter and now we only have to change one line of HTML code (the ManageLink.render() method) when we wish to change the HTML displayed by all these links.

• In order to make the ManageLink base class reusable, there are now two attributes, deriving classes should set: text and link which tell how the link to create in the upper left box should look like.

• Documented the viewlets with docstrings.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/browser/viewlets.py (modified) (3 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/browser/viewlets.py

@@ -15 +15 @@
 from waeup.sirp.interfaces import (IWAeUPObject, IWAeUPXMLExporter,
                                    IWAeUPXMLImporter, IDataCenter)
+from waeup.sirp.browser.layout import WAeUPPage
 
 grok.templatedir('templates')
@@ -226 +227 @@
 
 class ManageLink(grok.Viewlet):
+    """A link displayed in the upper left box.
+
+    This viewlet renders a link to the application object's settings
+    form (the 'manage' view).
+
+    In derived classes you can create different links by setting a
+    different link and text attribute. The `link` parameter is
+    understood relative to the respective application object, so that
+    ``@@manage`` will create a link to
+    ``localhost:8080/app/@@manage``.
+
+    Links defined by descendants from this viewlet are displayed on
+    every page the user is allowed to go to, if the user has also the
+    permissions set by `grok.require()`. By default only users with
+    ``waeup.manageUniversity`` permission will see links defined by
+    this or derivated classes.
+    """
     grok.viewletmanager(LeftSidebar)
-    grok.context(IUniversity)
-    grok.view(UniversityPage)
+    grok.context(IWAeUPObject)
+    grok.view(WAeUPPage)
     grok.order(5)
     # This link is only displayed, if the user is
     # allowed to use it!
     grok.require('waeup.manageUniversity')
+
+    link = '@@manage'
+    text = u'Portal Settings'
     
     def render(self):
-        return u'<div class="portlet"><a href="manage">Settings</a></div>'
+        url = self.view.url(grok.getSite(), self.link)
+        return u'<div class="portlet"><a href="%s">%s</a></div>' % (
+                url, self.text)
+
 
 class ManageFacultiesLink(grok.Viewlet):
@@ -245 +269 @@
     # allowed to use it!
     grok.require('waeup.manageUniversity')
-    
+
     def render(self):
         return u'<div class="portlet"><a href="faculties">Manage faculties</a></div>'
 
-class ManageUsersLink(grok.Viewlet):
-    grok.viewletmanager(LeftSidebar)
-    grok.context(IUniversity)
-    grok.view(UniversityPage)
+class ManageUsersLink(ManageLink):
+    """A link to users management, placed in upper left box.
+    """
     grok.order(6)
     grok.require('waeup.manageUsers')
 
-    def render(self):
-        return u'<div class="portlet"><a href="users">Manage users</a></div>'
-
-class ManageDataCenter(grok.Viewlet):
-    grok.viewletmanager(LeftSidebar)
-    grok.context(IUniversity)
-    grok.view(UniversityPage)
+    link = u'users'
+    text = u'Portal Users'
+
+class ManageDataCenter(ManageLink):
+    """A link to datacenter, placed in upper left box.
+    """
     grok.order(6)
     grok.require('waeup.manageUniversity')
 
-    def render(self):
-        return u'<div class="portlet"><a href="datacenter">Data Center</a></div>'
+    link = u'datacenter'
+    text = u'Data Center'
 
 #