dolmen.app.layout 0.4.0

Content providers

Description

>>> for name, attr in API.IContentProviders.namesAndDescriptions():
...   print "%s: %s" % (name, attr.getDoc())
Footer: Viewlet manager for the bottom part of the body.
AboveBody: Viewlet manager located above the main content.
BelowBody: Viewlet manager located below the main content.
Header: Viewlet manager involved in rendering the HTML head.
Top: Viewlet manager for the top part of the body.
Resources: Viewlet manager including resources.

Layout

Description

>>> interfaceDescription(API.IGlobalUI)
Master: Base layout using all the `IContentProviders` components to build a coherent yet overridable rendering.

Description

>>> interfaceDescription(API.IContextualUI)
ContextualActions: Viewlet rendering contextual actions.
FlashMessages: Viewlet displaying site-wide messages.

Models

Models are base classes to be used in your own classes. dolmen.app.layout provides a collections of ready-to-use models:

>>> API.IModels.providedBy(models)
True
>>> verify.verifyObject(API.IModels, models)
True

>>> from megrok.layout import IPage

>>> for name in list(API.IModels):
...    model = getattr(models, name)
...    print "%s:\t%s" % (name, IPage.implementedBy(model))
Index:        True
SubForm:      True
TablePage:    True
Page:         True
Form:         True

Default views

dolmen.app.layout registers some views, out-of-the-box, to allow you to interact with your dolmen.content objects and your application:

>>> API.IBaseViews.providedBy(models)
True
>>> verify.verifyObject(API.IBaseViews, models)
True

>>> view = getMultiAdapter((manfred, request), name="index")
>>> view
<dolmen.app.layout.models.DefaultView object at ...>

>>> edit = getMultiAdapter((manfred, request), name="edit")
>>> edit
<dolmen.app.layout.models.Edit object at ...>

>>> from dolmen.forms.crud import Adder

>>> adding = Adder(root, request)
>>> adding
<dolmen.forms.crud.addview.Adder object at ...>

>>> adding.traverse("dolmen.app.layout.Mammoth", None)
<dolmen.app.layout.models.Add object at ...>

Description

>>> interfaceDescription(API.ISkin)
IBaseSkin: Skin providing the IBaseLayer. Can be applied directly or inherited.
IBaseLayer: Layer used to register all the Dolmen centric view components.
Resource: Viewlet component used to include resources

Form compatibility

>>> from megrok.z3cform.base import IFormLayer
>>> skin.IBaseLayer.extends(IFormLayer)
True

Description

>>> interfaceDescription(API.IMenus)
MenuViewlet: Generic viewlet rendering a `IBrowserMenu`.
ContextualMenu: Menu defining contextual actions.
ContextualMenuEntry: Entry of the contextual actions menu.

Contextual menu

>>> manager = master.Top(manfred, request, view)
>>> manager
<dolmen.app.layout.master.Top object at ...>

>>> manager.update()
>>> print manager.render()
<dl id="contextual-actions" class="menu">
  <dt>Contextual actions</dt>
  <dd>
    <ul class="menu">
      <li class="entry selected">
        <a title="View">View</a>
      </li>
      <li class="entry">
        <a href="http://127.0.0.1/manfred/edit" title="Edit">Edit</a>
      </li>
      <li class="entry">
        <a href="http://127.0.0.1/manfred/delete" title="Delete">Delete</a>
      </li>
    </ul>
  </dd>
</dl>
<BLANKLINE>

Declaring a new entry:

>>> class MyEntry(grok.View, menus.ContextualMenuEntry):
...   grok.context(Mammoth)
...   grok.title("A menu entry for tests")
...   def render(self):
...      return u"nothing to say"

>>> grok.testing.grok_component('menu_entry', MyEntry)
True

>>> manager.update()
>>> print manager.render()
<dl id="contextual-actions" class="menu">
  <dt>Contextual actions</dt>
  <dd>
    <ul class="menu">
      <li class="entry">
        <a href="http://127.0.0.1/manfred/myentry"
      title="A menu entry for tests">A menu entry for tests</a>
      </li>
      <li class="entry selected">
        <a title="View">View</a>
      </li>
      <li class="entry">
        <a href="http://127.0.0.1/manfred/edit" title="Edit">Edit</a>
      </li>
      <li class="entry">
        <a href="http://127.0.0.1/manfred/delete" title="Delete">Delete</a>
      </li>
    </ul>
  </dd>
</dl>

0.4.0 (2010-02-17)

• INotFound errors are not located in the index.html view. This allows to use a layout transparently. The __parent__ is set to the ob attribute of the INotFound object.

• The contextual menu is no longer restricted to IBaseContent objects. It is now registered for Interface.

• The dependencies have been greatly reduced by the removal of all the zope.app packages.

0.3.1 (2010-01-21)

• Bug fix: the success message of a Delete form is a property and can’t be called directly through the class. We need to use fget.

0.3 (2009-12-26)

• The layout now provides and uses a way to include resources, using megrok.resourceviewlet. Two components have been added for that: ResourcesManager and Resource, respectively a viewletmanager and a viewlet base class.

• The imports has been modified to avoid using any zope.app package.

0.2.2 (2009-11-03)

• Now the configure.zcml includes the megrok.z3ctable meta.zcml.

• Updated dependencies in setup.py

0.2.1 (2009-11-02)

• Corrected flash messages and redirection in the delete form.

0.2 (2009-11-02)

• Added Delete form to complete the CRUD actions.

0.1 (2009-11-02)

• Initial release