Back to index

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

List of all members.

Public Member Functions

def initializing
def deferred_update
def update
def url
def siteurl
def feedlink
def title
def feedAvailable
def items
def enabled
def render_full
def render
def available

Public Attributes

 context
 request
 view
 manager
 data

Static Public Attributes

tuple render_full = ZopeTwoPageTemplateFile('rss.pt')
tuple render_preload = ViewPageTemplateFile('deferred_portlet.pt')

Private Member Functions

def _getFeed

Detailed Description

Definition at line 224 of file rss.py.


Member Function Documentation

return a feed object but do not update it

Definition at line 248 of file rss.py.

00248 
00249     def _getFeed(self):
00250         """return a feed object but do not update it"""
00251         feed = FEED_DATA.get(self.data.url,None)
00252         if feed is None:
00253             # create it
00254             feed = FEED_DATA[self.data.url] = RSSFeed(self.data.url,self.data.timeout)
00255         return feed
        

Here is the caller graph for this function:

refresh data for serving via KSS

Definition at line 238 of file rss.py.

00238 
00239     def deferred_update(self):
00240         """refresh data for serving via KSS"""
00241         feed = self._getFeed()
00242         feed.update()

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 287 of file rss.py.

00287 
00288     def enabled(self):
00289         return self._getFeed().ok

Here is the call graph for this function:

checks if the feed data is available

Definition at line 278 of file rss.py.

00278 
00279     def feedAvailable(self):
00280         """checks if the feed data is available"""
00281         return self._getFeed().ok
    

Here is the call graph for this function:

return rss url of feed for portlet

Definition at line 268 of file rss.py.

00268 
00269     def feedlink(self):
00270         """return rss url of feed for portlet"""
00271         return self.data.url.replace("http://","feed://")
    
should return True if deferred template should be displayed

Definition at line 229 of file rss.py.

00229 
00230     def initializing(self):
00231         """should return True if deferred template should be displayed"""
00232         feed=self._getFeed()
00233         if not feed.loaded:
00234             return True
00235         if feed.needs_update:
00236             return True
00237         return False
            

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 283 of file rss.py.

00283 
00284     def items(self):
00285         return self._getFeed().items[:self.data.count]
    

Here is the call graph for this function:

Here is the caller graph for this function:

render the portlet

the template gets choosen depending on the initialize state

Reimplemented from plone.app.portlets.portlets.base.Renderer.

Definition at line 109 of file base.py.

00109 
00110     def render(self):
00111         """render the portlet
00112 
00113         the template gets choosen depending on the initialize state
00114         """
00115         if self.initializing:
00116             return self.render_preload()
00117         else:
00118             return self.render_full()
00119 

Here is the call graph for this function:

Definition at line 106 of file base.py.

00106 
00107     def render_full(self):
00108         raise NotImplemented, "You must implement 'render_full' as a method or page template file attribute"

Here is the caller graph for this function:

return url of site for portlet

Definition at line 263 of file rss.py.

00263 
00264     def siteurl(self):
00265         """return url of site for portlet"""
00266         return self._getFeed().siteurl
            

Here is the call graph for this function:

return title of feed for portlet

Definition at line 273 of file rss.py.

00273 
00274     def title(self):
00275         """return title of feed for portlet"""
00276         return self._getFeed().title
    

Here is the call graph for this function:

Here is the caller graph for this function:

update data before rendering. We can not wait for KSS since users
may not be using KSS.

Reimplemented from plone.app.portlets.portlets.base.Renderer.

Definition at line 243 of file rss.py.

00243 
00244     def update(self):
00245         """update data before rendering. We can not wait for KSS since users
00246         may not be using KSS."""
00247         self.deferred_update()

Here is the call graph for this function:

Here is the caller graph for this function:

return url of feed for portlet

Definition at line 257 of file rss.py.

00257 
00258     def url(self):
00259         """return url of feed for portlet"""
00260         return self._getFeed().url
00261      
     

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

Reimplemented in plone.app.portlets.portlets.classic.Renderer.

Definition at line 75 of file base.py.

Reimplemented in plone.app.portlets.portlets.classic.Renderer.

Definition at line 80 of file base.py.

Definition at line 79 of file base.py.

tuple plone.app.portlets.portlets.rss.Renderer.render_full = ZopeTwoPageTemplateFile('rss.pt') [static]

Definition at line 226 of file rss.py.

tuple plone.app.portlets.portlets.base.DeferredRenderer.render_preload = ViewPageTemplateFile('deferred_portlet.pt') [static, inherited]

Definition at line 104 of file base.py.

Definition at line 76 of file base.py.

Definition at line 77 of file base.py.


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