Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
plone.portlets.interfaces.IPortletManagerRenderer Class Reference
Inheritance diagram for plone.portlets.interfaces.IPortletManagerRenderer:
Inheritance graph
[legend]
Collaboration diagram for plone.portlets.interfaces.IPortletManagerRenderer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def filter
def portletsToShow
def safe_render

Static Public Attributes

tuple template
tuple visible

Detailed Description

A content provider for rendering a portlet manager.

Definition at line 283 of file interfaces.py.


Member Function Documentation

Return a list of portlets to display that is a subset of
the list of portlets passed in. The list contains dicts as returned
by IPortletRetriever.getPortlets().

Definition at line 302 of file interfaces.py.

00302 
00303     def filter(portlets):
00304         """Return a list of portlets to display that is a subset of
00305         the list of portlets passed in. The list contains dicts as returned
00306         by IPortletRetriever.getPortlets().
00307         """
        

Here is the caller graph for this function:

Get a list of portlets that will be shown.

Returns a list of dicts with keys corresponding to that returned by
IPortletRetriever.getPortlets(), with the additional key 'renderer'
containing the appropriate IPortletRenderer.

Definition at line 308 of file interfaces.py.

00308 
00309     def portletsToShow():
00310         """Get a list of portlets that will be shown.
00311         
00312         Returns a list of dicts with keys corresponding to that returned by
00313         IPortletRetriever.getPortlets(), with the additional key 'renderer'
00314         containing the appropriate IPortletRenderer.
00315         """

Here is the caller graph for this function:

Render a portlet in such a way that exceptions are not
raised but rather logged and an error is shown in place of the
portlet.

Definition at line 316 of file interfaces.py.

00316 
00317     def safe_render(portlet_renderer):
00318         """Render a portlet in such a way that exceptions are not
00319         raised but rather logged and an error is shown in place of the
00320         portlet.
00321         """

Member Data Documentation

Initial value:
Attribute(
        """A page template object to render the manager with.If given, this will be passed an option 'portlets' that is a list ofthe IPortletRenderer objects to render.If not set, the renderers will simply be called one by one, and theiroutput will be concatenated, separated by newlines.""")
A content provider for rendering a portlet manager.

Definition at line 287 of file interfaces.py.

Initial value:
schema.Bool(title=u'Visible',
                          description=u'Whether or not this portlet manager (column) will be rendered at all',
                          required=True,
                          default=True)

Definition at line 297 of file interfaces.py.


The documentation for this class was generated from the following file: