Package: megrok.navigation
.. contents::=================megrok.navigation=================Megrok.navigation lets you easily add all sorts of menus to a site.Menus are implemented as viewletmanagers, and items as viewlets.You can also override the default templates by registering your own IPageTemplateLet's first setup a simple site>>> import grok>>> class MySite(grok.Container, grok.Application):...     pass>>> grok_component('mysite', MySite)True>>> root = getRootFolder()>>> root['site'] = site = MySite()Let us now define a menuWe'll first define an Interface, so that later on we won't need to redefine some menus after we redefinedthe Navigation menu, so this is not necessary to do, although it can lessen dependencies.>>> from megrok import navigation>>> class INavigation(navigation.interfaces.IMenu):...     pass>>> class Navigation(navigation.Menu):...     grok.name('navigation')...     grok.implements(INavigation)>>> grok_component('nav', Navigation)TrueMenus are implemented as viewletmanagers>>> from zope.viewlet.interfaces import IViewletManager>>> IViewletManager.implementedBy(Navigation)TrueRendering the menu now leaves us with an empty <ul>>>> from zope.security.testing import Principal, Participation>>> from zope.security.management import newInteraction, endInteraction>>> participation = Participation(Principal('zope.anybody'))>>> from zope.publisher.browser import TestRequest>>> request = TestRequest()>>> newInteraction(participation)>>> nav = Navigation(site, request, grok.View(site, request))>>> nav.update()>>> len(nav.viewlets)0We can also get the Menu with the help of the Component Architecture::>>> from zope.component import getMultiAdapter>>> from zope.viewlet.interfaces import IContentProvider>>> component_nav = getMultiAdapter((site, request, grok.View(site, request)),...     IContentProvider, name="navigation")>>> component_nav<megrok.navigation.tests.Navigation object at 0...>>>> print nav.render()<div class=""></div>Global Menu Items-----------------Global Menu Items are links to fixed urls, typically links to other sites.You define them on the menu you want them to be rendered:>>> class Navigation(navigation.Menu):...     grok.name('navigation')...     grok.implements(INavigation)...     navigation.globalmenuitem('http://grok.zope.org', 'Grok!')>>> grok_component('nav', Navigation)TrueLet's see what that gives us now:>>> nav = Navigation(site, request, grok.View(site, request))>>> nav.update()>>> len(nav.viewlets)1>>> print nav.render()<div class=""><ul><li class=""><a href="http://grok.zope.org">Grok!</a><BLANKLINE></li></ul></div>You can set the css classes with the cssClass and cssItemClass attributes:>>> class Navigation(navigation.Menu):...     grok.name('navigation')...     grok.implements(INavigation)...     navigation.globalmenuitem('http://grok.zope.org', 'Grok!')...     cssClass='menu'...     cssItemClass='menu-item'>>> grok_component('nav', Navigation)True>>> nav = Navigation(site, request, grok.View(site, request))>>> nav.update()>>> print nav.render()<div class="menu"><ul><li class="menu-item"><a href="http://grok.zope.org">Grok!</a><BLANKLINE></li></ul></div>Site Menu Items-----------------Site menu items have links to views of the site itself,and are meant to be displayed for each view the menu is rendered in.A good example is a 'Home' link to your site root.Site Menu items are defined on the view that is to be linked toI want to be sure that my Home link is the first.>>> class Index(grok.View):...     grok.context(MySite)...     navigation.sitemenuitem(INavigation, 'Home', order=-1)...     def render(self):...         return 'test'>>> grok_component('index', Index)TrueLet's see what that gives us now:>>> nav = Navigation(site, request, grok.View(site, request))>>> nav.update()>>> print nav.render()<div class="menu"><ul><li class="menu-item"><a href="http://127.0.0.1/site/index">Home</a><BLANKLINE></li><li class="menu-item"><a href="http://grok.zope.org">Grok!</a><BLANKLINE></li></ul></div>Contextual Menu Items---------------------Context menus are meant to be used to show everything you can do (all views) with the current context.In fact all menus are context-sensitive, as a viewletmanager will only display viewlets that are appropriate fortheir current context. A Menu Item defined with the menuitem directive will inherit its contextfrom the view it is defined for.Context menus are not implemented as IBrowserMenus, but implement the same use case.We'll first need some context to demonstrate>>> from zope.interface import Interface>>> class IFoo(Interface):...     pass>>> class Foo(grok.Model):...     grok.implements(IFoo)>>> site['foo'] = foo = Foo()>>> site['foo2'] = Foo()We'll define a new menu as Context Menu to attach the views to>>> class IActions(navigation.interfaces.IMenu):...     pass>>> class Actions(navigation.Menu):...     grok.implements(IActions)...     grok.name('actions')>>> grok_component('actions', Actions)TrueNow let's define some views and attach them to the menu>>> class FooIndex(grok.View):...     grok.context(IFoo)...     navigation.menuitem(IActions, 'Details', order=0)...     def render(self):...         return 'test'>>> grok_component('fooindex', FooIndex)True>>> class FooEdit(grok.View):...     grok.context(IFoo)...     grok.title('Edit')...     navigation.menuitem(IActions, order=1)...     def render(self):...         return 'test'>>> grok_component('fooedit', FooEdit)TrueLet's render it on the site:>>> actions = Actions(site, request, grok.View(site, request))>>> actions.update()>>> actions.items[]>>> print actions.render()<div class=""></div>Since the context was the site, there were no menu items.Let's draw it on a IFoo object:>>> actions = Actions(foo, request, grok.View(foo, request))>>> actions.update()>>> len(actions.items)2>>> print actions.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/foo/fooindex">Details</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/foo/fooedit">Edit</a><BLANKLINE></li></ul></div>Note that if you don't specify a title in the menuitem directive, it will use the namespecified with the title directive, if available. Otherwise the view name is used.Of course, you would now like to have the Actions menu be a part of our global navigation menu.No problem: either use the submenu directive on the main menu:>>> class Navigation(navigation.Menu):...     grok.name('navigation')...     grok.implements(INavigation)...     navigation.globalmenuitem('http://grok.zope.org', 'Grok!', order=10)...     navigation.submenu('actions', 'Actions', order=2)>>> grok_component('nav', Navigation)True>>> nav = Navigation(foo, request, grok.View(site, request))>>> nav.update()>>> print nav.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/index">Home</a><BLANKLINE></li><li class=""><a>Actions</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/foo/fooindex">Details</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/foo/fooedit">Edit</a><BLANKLINE></li></ul></div></li><li class=""><a href="http://grok.zope.org">Grok!</a><BLANKLINE></li></ul></div>Or use the parentmenu directive on the submenu:First reinstate the old Navigation menu definition and the home link>>> class Navigation(navigation.Menu):...     grok.name('navigation')...     grok.implements(INavigation)...     navigation.globalmenuitem('http://grok.zope.org', 'Grok!', order=10)>>> grok_component('nav', Navigation)TrueNow redefine the Actions menu>>> class Actions(navigation.Menu):...     grok.implements(IActions)...     grok.name('actions')...     grok.title('Actions')...     navigation.parentmenu(INavigation)>>> grok_component('actions', Actions)True>>> nav = Navigation(foo, request, grok.View(site, request))>>> nav.update()>>> print nav.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/index">Home</a><BLANKLINE></li><li class=""><a>Actions</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/foo/fooindex">Details</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/foo/fooedit">Edit</a><BLANKLINE></li></ul></div></li><li class=""><a href="http://grok.zope.org">Grok!</a><BLANKLINE></li></ul></div>Now let's throw in permissions>>> class FooProtected(grok.View):...     grok.context(IFoo)...     grok.title('Manage')...     grok.require('zope.ManageContent')...     navigation.menuitem(IActions, order=2)...     def render(self):...         return 'test'>>> grok_component('fooprotected', FooProtected)TrueWe shouldn't see that view>>> actions.update()>>> print actions.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/foo/fooindex">Details</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/foo/fooedit">Edit</a><BLANKLINE></li></ul></div>Now use a more powerful user:>>> from zope.security.testing import Principal, Participation>>> from zope.security.management import newInteraction, endInteraction>>> endInteraction()>>> participation = Participation(Principal('zope.user'))>>> newInteraction(participation)>>> actions.update()>>> print actions.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/foo/fooindex">Details</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/foo/fooedit">Edit</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/foo/fooprotected">Manage</a><BLANKLINE></li></ul></div>You can link a view to multiple menus by repeating the menuitem directive>>> class FooAdd(grok.View):...     grok.context(MySite)...     navigation.menuitem(Actions, 'Add a Foo', order=3)...     navigation.menuitem(Navigation, 'Add a Foo', order=5)...     def render(self):...         return 'test'>>> grok_component('fooadd', FooAdd)True>>> nav = Navigation(site, request, grok.View(site, request))>>> nav.update()>>> print nav.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/index">Home</a><BLANKLINE></li><li class=""><a>Actions</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/fooadd">Add a Foo</a><BLANKLINE></li></ul></div></li><li class=""><a href="http://127.0.0.1/site/fooadd">Add a Foo</a><BLANKLINE></li><li class=""><a href="http://grok.zope.org">Grok!</a><BLANKLINE></li></ul></div>Content Menus-------------Now the icing on the cake: content menus!Content Menus are meant to be used if you want direct links to some of your content from your menu.A good example is a 'Products' menu that links directly to all products you offer on your siteLet's define and add some content:>>> from zope.schema import TextLine>>> class IProduct(Interface):...     name = TextLine()>>> class Product(grok.Container):...     grok.implements(IProduct)...     def __init__(self, name):...         super(Product, self).__init__()...         self.name=name>>> site['coffeemachine']=Product('Coffee Machine')>>> site['terminator']=Product('Terminator')Now the content menu. The content menu doesn't know where to get the content, so you need to override thegetContent() method. If you don't you'll get a NotImplementedError:>>> class ProductMenu(navigation.ContentMenu):...     grok.name('products')>>> grok_component('productmenu', ProductMenu)True>>> pm = ProductMenu(foo, request, FooIndex(foo, request))>>> pm.update()Traceback (most recent call last):NotImplementedError: Subclasses of ContentMenu must override getContent()So let's define the getContent() method, and also a getTitle() method to returnsomething else than the __name__ attribute. You can override the view to be renderedwith the viewName attribute, which defaults to 'index'There is also a getURL() method that you can override to create a link yourself.>>> class ProductMenu(navigation.ContentMenu):...     grok.name('products')...     def getContent(self):...         return [x for x in site.values() if IProduct.providedBy(x)]...     def getTitle(self, obj):...         return obj.name>>> grok_component('productmenu', ProductMenu)True>>> pm = ProductMenu(foo, request, FooIndex(foo, request))>>> pm.update()>>> print pm.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/coffeemachine/index">Coffee Machine</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/terminator/index">Terminator</a><BLANKLINE></li></ul></div>What just happened here? The items of the menu were rendered as Context Menu Items,with the context not the current view context, but the item to be rendered.Why this is done like that will become clear when content submenus are thrown into the mix.Let's define Series and Models for our Products:>>> class ISeries(Interface):...     name = TextLine()>>> class Series(grok.Container):...     grok.implements(ISeries)...     def __init__(self, name):...         super(Series, self).__init__()...         self.name=name>>> class IModel(Interface):...     name = TextLine()>>> class Model(grok.Container):...     grok.implements(IModel)...     def __init__(self, name):...         super(Model, self).__init__()...         self.name=name>>> site['terminator']['800']=Series('T-800')>>> site['terminator']['1000']=Series('T-1000')>>> site['terminator']['X']=Series('T-X')>>> site['terminator']['800']['101']=Model('101')Now we need the corresponding submenus:The ContentSubMenu class is just a ContentMenu with a default getContent method returning self.context.values()>>> class SeriesMenu(navigation.ContentSubMenu):...     navigation.contentsubmenu('model-menu')...     grok.name('series-menu')...     def getTitle(self, obj):...         return obj.name>>> grok_component('seriesmenu', SeriesMenu)True>>> class ModelMenu(navigation.ContentSubMenu):...     grok.name('model-menu')...     def getTitle(self, obj):...         return obj.name>>> grok_component('modelmenu', ModelMenu)TrueNow we need to link them to the product menu:>>> class ProductMenu(navigation.ContentMenu):...     navigation.contentsubmenu('series-menu')...     grok.name('products')...     def getContent(self):...         return [x for x in site.values() if IProduct.providedBy(x)]...     def getTitle(self, obj):...         return obj.name>>> grok_component('productmenu', ProductMenu)TrueLet's render>>> pm = ProductMenu(site, request, grok.View(site, request))>>> pm.update()>>> print pm.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/coffeemachine/index">Coffee Machine</a><div class=""><ul><BLANKLINE></ul></div></li><li class=""><a href="http://127.0.0.1/site/terminator/index">Terminator</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/terminator/1000/index">T-1000</a><div class=""><ul><BLANKLINE></ul></div></li><li class=""><a href="http://127.0.0.1/site/terminator/800/index">T-800</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/terminator/800/101/index">101</a><BLANKLINE></li></ul></div></li><li class=""><a href="http://127.0.0.1/site/terminator/X/index">T-X</a><div class=""><ul><BLANKLINE></ul></div></li></ul></div></li></ul></div>Or we could have done it like this:>>> class ProductMenu(navigation.ContentMenu):...     grok.name('products')...     def getContent(self):...         return [x for x in site.values() if IProduct.providedBy(x)]...     def getTitle(self, obj):...         return obj.name>>> grok_component('productmenu', ProductMenu)True>>> class SeriesMenu(navigation.ContentSubMenu):...     navigation.parentmenu(ProductMenu)...     grok.name('series-menu')...     def getTitle(self, obj):...         return obj.name>>> grok_component('seriesmenu', SeriesMenu)True>>> class ModelMenu(navigation.ContentSubMenu):...     navigation.parentmenu(SeriesMenu)...     grok.name('model-menu')...     def getTitle(self, obj):...         return obj.name>>> grok_component('modelmenu', ModelMenu)TrueLet's render>>> pm = ProductMenu(site, request, grok.View(site, request))>>> pm.update()>>> print pm.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/coffeemachine/index">Coffee Machine</a><div class=""><ul><BLANKLINE></ul></div></li><li class=""><a href="http://127.0.0.1/site/terminator/index">Terminator</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/terminator/1000/index">T-1000</a><div class=""><ul><BLANKLINE></ul></div></li><li class=""><a href="http://127.0.0.1/site/terminator/800/index">T-800</a><div class=""><ul><li class=""><a href="http://127.0.0.1/site/terminator/800/101/index">101</a><BLANKLINE></li></ul></div></li><li class=""><a href="http://127.0.0.1/site/terminator/X/index">T-X</a><div class=""><ul><BLANKLINE></ul></div></li></ul></div></li></ul></div>Groups------Menu Items can be categorized into groups by adding a group parameter to all menuitem, submenu and the patentmenudirectives:>>> class IGroupedMenu(navigation.interfaces.IMenu):...     pass>>> class GroupedMenu(navigation.Menu):...     grok.implements(IGroupedMenu)>>> grok_component('GroupedMenu', GroupedMenu)True>>> class Index(grok.View):...     grok.context(MySite)...     navigation.sitemenuitem(IGroupedMenu, 'Home', order=1, group='Group 1')...     def render(self):...         return 'test'>>> grok_component('Index', Index)True>>> class View2(grok.View):...     grok.context(MySite)...     navigation.sitemenuitem(IGroupedMenu, 'View 2', order=0, group='Group 2')...     def render(self):...         return 'test'>>> grok_component('View2', View2)True>>> class View3(grok.View):...     grok.context(MySite)...     navigation.sitemenuitem(IGroupedMenu, 'View 3', order=2, group='Group 1')...     def render(self):...         return 'test'>>> grok_component('View3', View3)TrueThe default templates render a separate <ul> for each group:>>> gm = GroupedMenu(site, request, grok.View(site, request))>>> gm.update()>>> print gm.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/view2">View 2</a><BLANKLINE></li></ul><ul><li class=""><a href="http://127.0.0.1/site/index">Home</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/view3">View 3</a><BLANKLINE></li></ul></div>You can change the order of the groups by setting the grouporder attribute on the Menu class:>>> class GroupedMenu(navigation.Menu):...     grok.implements(IGroupedMenu)...     grouporder=['Group 1', 'Group 2']>>> grok_component('GroupedMenu', GroupedMenu)True>>> gm = GroupedMenu(site, request, grok.View(site, request))>>> gm.update()>>> print gm.render()<div class=""><ul><li class=""><a href="http://127.0.0.1/site/index">Home</a><BLANKLINE></li><li class=""><a href="http://127.0.0.1/site/view3">View 3</a><BLANKLINE></li></ul><ul><li class=""><a href="http://127.0.0.1/site/view2">View 2</a><BLANKLINE></li></ul></div>Page Templates--------------megrok.navigation uses zope.pagetemplate (or megrok.pagetemplate) to allow you to override the default templates.Let's define a template based on divs, instead of ul>>> mt = """<div tal:attributes='class menu/cssClass'>... <div tal:repeat='group menu/groups'>...      <tal:repeat tal:repeat="item group/items"...                  tal:replace='structure item/render' />... </div>... </div>""">>> from megrok import pagetemplate>>> class DivMenu(pagetemplate.PageTemplate):...     template = grok.PageTemplate(mt)...     pagetemplate.view(navigation.interfaces.IMenu)>>> grok_component('divmenu', DivMenu)True>>> it = """<div tal:attributes='class menu/cssItemClass'>... <a tal:attributes="href item/link;...                    title viewlet/description|nothing">... <img tal:condition="item/icon | nothing"...      tal:attributes="src item/icon"/>... <span tal:replace="item/title"/></a>... <tal:replace tal:condition="item/submenu | nothing"...              tal:replace="structure provider:${item/submenu}"/>... </div>""">>> class DivMenuItem(pagetemplate.PageTemplate):...     template = grok.PageTemplate(it)...     pagetemplate.view(navigation.interfaces.IMenuItem)>>> grok_component('divmenuitem', DivMenuItem)True>>> print actions.render()<div class=""><div><div class=""><a href="http://127.0.0.1/site/foo/fooindex"><BLANKLINE>Details</a><BLANKLINE></div><div class=""><a href="http://127.0.0.1/site/foo/fooedit"><BLANKLINE>Edit</a><BLANKLINE></div><div class=""><a href="http://127.0.0.1/site/foo/fooprotected"><BLANKLINE>Manage</a><BLANKLINE></div></div></div>But what if you want 2 different templates for items to be used in different menus? You never specify any Itemsyourself, so you can't tell them to implement a different interface and register the template to that interface.To allow this, the itemsimplement directive was introduced.>>> class IIconItem(navigation.interfaces.IMenuItem):...     pass>>> class IconMenu(navigation.Menu):...     grok.name('icons')...     navigation.itemsimplement(IIconItem)...     navigation.globalmenuitem('http://grok.zope.org', 'Grok!',...                               icon='icon.jpg')>>> grok_component('nav', IconMenu)True>>> it = """<img tal:condition="item/icon | nothing"...      tal:attributes="src item/icon"/>""">>> class IconMenuItem(pagetemplate.PageTemplate):...     template = grok.PageTemplate(it)...     pagetemplate.view(IIconItem)>>> grok_component('iconmenuitem', IconMenuItem)True>>> icons = IconMenu(site, request, grok.View(site, request))>>> icons.update()>>> print icons.render()<div class=""><div><img src="icon.jpg" /></div></div>Register plain viewlets and *.items together.>>> from zope.publisher.interfaces.browser import IDefaultBrowserLayer>>> class IGlobalMenu(navigation.interfaces.IMenu):...     pass>>> class GlobalMenu(navigation.Menu):...     grok.name('globalmenu')...     grok.implements(IGlobalMenu)>>> grok_component('globalmenu', GlobalMenu)True>>> class Contact(grok.View):...     grok.context(MySite)...     grok.layer(IDefaultBrowserLayer)...     navigation.menuitem(IGlobalMenu)...     def render(self):...         return "test">>> grok_component('contact', Contact)True>>> class Logout(grok.Viewlet):...     grok.viewletmanager(IGlobalMenu)...     grok.context(MySite)...     grok.layer(IDefaultBrowserLayer)...     def render(self):...         return "logout">>> grok_component('logout', Logout)True>>> globalmenu = getMultiAdapter((site, request, grok.View(site, request)),...     IContentProvider, name="globalmenu")>>> globalmenu.update()>>> logout, contact = globalmenu.viewlets>>> logout<megrok.navigation.tests.Logout object at ...>>>> contact<megrok.navigation.util.MySite_contact object at ...>>>> grok.layer.bind().get(logout)<InterfaceClass zope.publisher.interfaces.browser.IDefaultBrowserLayer>>>> grok.layer.bind().get(contact)<InterfaceClass zope.publisher.interfaces.browser.IDefaultBrowserLayer>>>> print globalmenu.render()<div class=""><div>logout<div class=""><a href="http://127.0.0.1/site/contact">contact</a></div></div></div>Let's see if we can get the individual viewlets based on their name viathe Zope-Component Architecture>>> from zope.viewlet.interfaces import IViewlet>>> contact = getMultiAdapter(...     (site, request, grok.View(site, request), globalmenu),...     IViewlet, name=u"MySite_contact")>>> contact<megrok.navigation.util.MySite_contact object at ...>>>> class Contact(grok.View):...     grok.context(MySite)...     grok.name('othercontact')...     grok.title('Other Link')...     grok.layer(IDefaultBrowserLayer)...     navigation.menuitem(IGlobalMenu)...     def render(self):...         return "test">>> grok_component('contact', Contact)True>>> contact1 = getMultiAdapter(...     (site, request, grok.View(site, request), globalmenu),...     IViewlet, name=u"MySite_othercontact")>>> contact1<megrok.navigation.util.MySite_othercontact object at ...>=======History=======0.6.2 (2012-03-20)------------------- fix for itemsimplement on submenus: use the parents itemsimplement in the submenus main menuitem0.6.1 (2010-06-28)------------------- fix if icon is a callable0.6 (2010-05-09)----------------- update to make icon display compatible with zope.fanstaticicon paths are now traversed instead of literally used0.5 (2010-05-09)----------------- use current grok version 1.1rc1.cfg- now it's possible to register plain viewlets with the directivegrok.viewletmanager to IMenu Items.- added the layer directive (if setted) to IMenuItems- register the components now with the default_view_name of the factoryinstead of the autogenerated name. This allows us to override simpleMenuItems with the help of the ZCA.0.4 (2010-03-26)----------------Implemented groups:- contentgroup directive- grouporder attribute0.3 (2010-03-26)----------------- separate directives in directives submodule- getURL method for ContentMenus- itemsimplement directive- parenmenu directive- 'menu' and 'item' template namespace entries- 'menu' attribute for MenuItem which refers to the viewletmanager- 'items' attribute for Menu which refers to the viewlets- removed submenu/subMenu inconsistency (may break overriden templates!)- contentorder directive0.2.2 (2010-03-09)------------------- Fix getSite import issue0.2.1 (2010-02-22)------------------- Fix issue with requiring zope.site to make it work on Grok 1.00.2 (2010-02-03)----------------- Allow views to be registered to multiple menus- Scrap ContextMenu class as it's nothing more than a regular Menu anyway0.1 (2010-01-29)----------------- Initial Release