z3c.menu.simple - Простые меню на базе вьюлетов
Содержание
Простое меню
Пакет z3c.menu.simple предоставляет простую реализацию меню, которая позволяет создавать простые меню на базе контент провайдеров и вьюлетов. На данный момент в пакете присутствует несколько реализаций пунктов меню SimpleMenuItem, а также меню в форме закладок. Давайте рассмотрим более детально, что все это значит.
Контекстное меню (ContextMenu)
1 >>> from zope.viewlet.interfaces import IViewlet
2 >>> from zope.viewlet.interfaces import IViewletManager
Давайте создадим меню, что, технически, означает создание интерфейса менеджера вьюлетов:
1 >>> class IMenu(IViewletManager):
2 ... """Menu viewlet manager."""
Используя этот интерфейс можно создать менеджер вьюлетов:
1 >>> from zope.viewlet import manager
2 >>> Menu = manager.ViewletManager('left', IMenu)
Теперь нам следует определить контекст:
1 >>> import zope.interface
2 >>> from zope.app.container import contained
3 >>> from zope.app.container.interfaces import IContained
4 >>> class Content(contained.Contained):
5 ... zope.interface.implements(IContained)
6 >>> root['content'] = Content()
7 >>> content = root['content']
8 >>> from zope.publisher.browser import TestRequest
9 >>> request = TestRequest()
10 >>> from zope.publisher.interfaces.browser import IBrowserView
11 >>> class View(contained.Contained):
12 ... zope.interface.implements(IBrowserView)
13 ... def __init__(self, context, request):
14 ... self.__parent__ = context
15 ... self.context = context
16 ... self.request = request
17 >>> view = View(content, request)
18 >>> menu = Menu(content, request, view)
Так что изначально не будет отображено никакое меню:
1 >>> menu.update()
2 >>> menu.render()
3 u''
Но теперь мы регистрируем пункт меню для IMenu:
1 >>> import zope.component
2 >>> from zope.publisher.interfaces.browser import IDefaultBrowserLayer
3 >>> from z3c.menu.simple.menu import ContextMenuItem
4 >>> class MyLocalLink(ContextMenuItem):
5 ...
6 ... __name__ = u'MyLocalLink'
7 ... urlEndings = 'myLocal.html'
8 ... viewURL = 'myLocal.html'
9 >>> # Create a security checker for viewlets.
10 >>> from zope.security.checker import NamesChecker, defineChecker
11 >>> viewletChecker = NamesChecker(('update', 'render'))
12 >>> defineChecker(MyLocalLink, viewletChecker)
13 >>> zope.component.provideAdapter(
14 ... MyLocalLink,
15 ... (zope.interface.Interface, IDefaultBrowserLayer,
16 ... IBrowserView, IMenu),
17 ... IViewlet, name='MyLocalLink')
Давайте посмотрим, что случится если использовать менеджер вьюлетов IMenu:
1 >>> menu.update()
2 >>> print menu.render()
1 <a href="http://127.0.0.1/content/myLocal.html"
2 class="inactive-menu-item">MyLocalLink</a>
Глобальное меню (GlobalMenu)
1 >>> from z3c.menu.simple.menu import GlobalMenuItem
2 >>> class MyGlobalLink(GlobalMenuItem):
3 ...
4 ... __name__ = u'MyGlobalLink'
5 ... urlEndings = 'myGlobal.html'
6 ... viewURL = 'myGlobal.html'
7 >>> defineChecker(MyGlobalLink, viewletChecker)
8 >>> zope.component.provideAdapter(
9 ... MyGlobalLink,
10 ... (zope.interface.Interface, IDefaultBrowserLayer,
11 ... IBrowserView, IMenu),
12 ... IViewlet, name='MyGlobalLink')
Теперь посмотрим, что случится если использовать менеджер вьюлетов IMenu:
1 >>> menu.update()
2 >>> print menu.render()
1 <a href="http://127.0.0.1/myGlobal.html"
2 class="inactive-menu-item">MyGlobalLink</a>
3 <a href="http://127.0.0.1/content/myLocal.html"
4 class="inactive-menu-item">MyLocalLink</a>
Меню в форме закладок
Now we create a tabbed menu called MasterMenu:
1 >>> class IMasterMenu(IViewletManager):
2 ... """Master menu viewlet manager."""
Let's create a viewlet manager using this interface and the TabMenu as base class:
1 >>> from z3c.menu.simple.menu import TabMenu
2 >>> MasterMenu = manager.ViewletManager('masterMenu', IMasterMenu,
3 ... bases=(TabMenu,))
We use the same context, request and view like before:
1 >>> masterMenu = MasterMenu(content, request, view)
So initially no menu get rendered:
1 >>> masterMenu.update()
2 >>> masterMenu.render()
3 u''
Now we register a menu tab which is also a viewlet manager:
1 >>> from zope.browserpage import viewpagetemplatefile
2 >>> from z3c.menu.simple import ITab
3 >>> from z3c.menu.simple.menu import Tab
4 >>> class MyTabs(Tab):
5 ... template = viewpagetemplatefile.ViewPageTemplateFile('tab.pt')
6 >>> myTabs = MyTabs(content, request, view)
Also here, initially no tab get rendered:
1 >>> myTabs.update()
2 >>> myTabs.render()
3 u''
Now we register a menu action which is also a viewlet manager:
Also here, initially no tab get rendered:
1 >>> myActions.update()
2 >>> myActions.render()
3 u''
After setup the TabMenu, Tab and Action viewlet managers, we start to register a tab menu item:
1 >>> from z3c.menu.simple.menu import TabItem
2 >>> class MyTab(TabItem):
3 ...
4 ... __name__ = u'MyTab'
5 ... url = 'myTab.html'
6 ... selectedViewNames = ['myTab.html']
7 >>> tabChecker = NamesChecker(('update', 'render', 'css', 'selected'))
8 >>> defineChecker(MyTab, tabChecker)
9 >>> zope.component.provideAdapter(
10 ... MyTab,
11 ... (zope.interface.Interface, IDefaultBrowserLayer,
12 ... IBrowserView, ITab),
13 ... IViewlet, name='MyTab')
Now see what we get if the tab viewlet manager get rendered:
1 >>> myTabs.update()
2 >>> print myTabs.render()
After showing how a tab menu item get used, we will register a menu action item.
1 >>> from z3c.menu.simple.menu import ActionItem
2 >>> class MyAction(ActionItem):
3 ...
4 ... __name__ = u'MyAction'
5 ... title = 'myAction'
6 >>> actionChecker = NamesChecker(('update', 'render', 'title'))
7 >>> defineChecker(MyAction, actionChecker)
8 >>> zope.component.provideAdapter(
9 ... MyAction,
10 ... (zope.interface.Interface, IDefaultBrowserLayer,
11 ... IBrowserView, IAction),
12 ... IViewlet, name='MyAction')
Now see what we get if the action viewlet manager get used:
1 >>> myActions.update()
2 >>> print myActions.render()