Back to index

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

List of all members.

Public Member Functions

def deferred_update
def render_full
def render_preload
def initialized

Static Public Attributes

tuple available

Detailed Description

Provide refresh and dynamic loading functionality

Definition at line 54 of file interfaces.py.


Member Function Documentation

Provide refresh and dynamic loading functionality
refresh portlet data on KSS events (and only then)

this is similar to update() but it is only called from a KSS action
and thus can be used to do long computing/retrieval only on loading
the portlet via KSS but not in the initial page load.

Definition at line 57 of file interfaces.py.

00057 
00058     def deferred_update():
00059         """refresh portlet data on KSS events (and only then)
00060 
00061         this is similar to update() but it is only called from a KSS action
00062         and thus can be used to do long computing/retrieval only on loading
00063         the portlet via KSS but not in the initial page load.
00064         """

Here is the caller graph for this function:

return whether the portlet is initialized or not

depending on this the render() method chooses whether to render the
preload or full version (if initialized==True).

Definition at line 77 of file interfaces.py.

00077 
00078     def initialized():
00079         """return whether the portlet is initialized or not
00080 
00081         depending on this the render() method chooses whether to render the
00082         preload or full version (if initialized==True).
00083         """

method for rendering the full version of the portlet

this is usually the one called via KSS events

Definition at line 65 of file interfaces.py.

00065 
00066     def render_full():
00067         """method for rendering the full version of the portlet
00068 
00069         this is usually the one called via KSS events
00070         """

Here is the caller graph for this function:

method for rendering the portlet in preloading state

this usually just contains a class to which an KSS event is bound

Definition at line 71 of file interfaces.py.

00071 
00072     def render_preload():
00073         """method for rendering the portlet in preloading state
00074 
00075         this usually just contains a class to which an KSS event is bound
00076         """


Member Data Documentation

Initial value:
schema.Bool(title=u'Available',
                            description=u'Whether or not this portlet shuld be rendered',
                            required=True,
                            readonly=True)
A special implementation of a content provider which is managed
by an IPortletManager.

Any object providing IPortletDataProvider should be adaptable to 
IPortletRenderer in order to be renderable as a portlet. (In fact,
the return value of IPortletAssignment.data needs to have such an
adapter, regardless of whether it actually implements IPortletDataProvider)

Definition at line 156 of file interfaces.py.


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