megrok.layout 1.2.0

The megrok.layout package provides a simple way to write view components which can be included into a defined layout. It turns around two main components : the Page and the Layout.<br />Layout<br /><br />The layout is a component allowing you to design your site. Often, it's the common structure shared between all the pages. Technically, it is a class based on the view components interface, providing a 'render' and 'update' method.<br /><br />Let's implement a simple Layout:<br /><br /> >>> from megrok.layout import Layout<br /> >>> from zope.interface import Interface<br /> >>> import grokcore.component as grok<br /><br /> >>> class MyLayout(Layout):<br /> ... grok.name('mylayout')<br /> ... grok.context(Interface)<br /> ...<br /> ... def render(self):<br /> ... return u"a simple layout"<br /><br />We grok our component:<br /><br /> >>> grok_component('MyLayout', MyLayout)<br /> True<br /><br />We check it has been correctly registered:<br /><br /> >>> from megrok.layout import ILayout<br /> >>> from zope.component import getMultiAdapter<br /> >>> from zope.publisher.browser import TestRequest<br /><br /> >>> layout = getMultiAdapter((TestRequest(), Interface), ILayout)<br /> >>> isinstance(layout, MyLayout)<br /> True<br /> >>> layout.render()<br /> u'a simple layout'<br /><br />Now let's see how to use this Layout in a specific context using a Page.<br />Page<br /><br />The page is the specific code that you want to control. It is based on the grokcore.View browser page implementation and therefore provides a render and update method. The render method will simply return the specific HTML code generated by the template or the render method code while __call__ will lookup for a Layout component and renders itself inside it.<br /><br />First, we'll create 2 models that will serve as exemples.<br /><br /> >>> class Aurochs(grok.Context):<br /> ... description = u'Looks like a bull'<br /><br /> >>> class Mammoth(grok.Context):<br /> ... description = u'Looks like an elephant'<br /><br />Let's create now a page that will display their description.<br /><br /> >>> from megrok.layout import Page<br /> >>> class AnimalDisplay(Page):<br /> ... grok.name('display')<br /> ... grok.context(Interface)<br /> ...<br /> ... def render(self):<br /> ... return self.context.description<br /><br />Grokking our Page will let us use it.<br /><br /> >>> grok_component('AnimalDisplay', AnimalDisplay)<br /> True<br /> >>> wooly = Mammoth()<br /> >>> page = getMultiAdapter((wooly, TestRequest()), name='display')<br /> >>> page.content()<br /> u'Looks like an elephant'<br /> >>> page()<br /> u'a simple layout'<br /><br />As we can see, the page is using the layout, on the __call__ to render. Of course, this example Layout doesn't provide any interesting feature. Let's create something more interesting, by using our page with the help of the 'content' method:<br /><br /> >>> class MammothLayout(Layout):<br /> ... grok.context(Mammoth)<br /> ...<br /> ... def render(self):<br /> ... return u'Header. Page: %s. Footer' % self.view.content()<br /><br /> >>> grok_component('MammothLayout', MammothLayout)<br /> True<br /> >>> page()<br /> u'Header. Page: Looks like an elephant. Footer'

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Class,  Component,  Components,  Create,  Description,  Gtgtgt,  Import,  Interface,  Layout,  Megroklayout,  Method,  Render,  Renderself,  Return,  Simple,  Specific,  Testrequest,  U039looks
Users rating:	0/10