twisted.web.widgets.WidgetPage

Package twisted :: Package web :: Module widgets :: Class WidgetPage

Class WidgetPage

            Widget --+        
                     |        
          Presentation --+    
                         |    
Collection --+           |    
             |           |    
   Constrained --+       |    
                 |       |    
  ConfigCollection --+   |    
                     |   |    
              Resource --+    
                         |    
                      Page --+
                             |
                            WidgetPage

I am a Page that takes a Widget in its constructor, and displays that Widget wrapped up in a simple HTML template.

Method Summary
	`__init__(self, widget)`
	`prePresent(self, request)` Perform any tasks which must be done before presenting the page.
	`render(self, request)` Render a given resource.
Inherited from Resource
	`delEntity(self, name)` Remove a static reference for 'name'.
	`getChild(self, path, request)` Retrieve a 'child' resource from me.
	`getChildForRequest(self, request)` (internal) Get a child of mine dependant on a particular request.
	`getChildWithDefault(self, path, request)` Retrieve a static or dynamically generated child resource from me.
	`getDynamicEntity(self, name, request)` Subclass this to generate an entity on demand.
	`getStaticEntity(self, name)` Get an entity that was added to me using putEntity.
	`listDynamicEntities(self, request)` A list of all name, entity that I can generate on demand.
	`listDynamicNames(self)` Retrieve a list of the names of entities that I store references to.
	`listEntities(self)`
	`listNames(self)`
	`listStaticEntities(self)` Retrieve a list of all name, entity pairs that I store references to.
	`listStaticNames(self)` Retrieve a list of the names of entities that I store references to.
	`putChild(self, path, child)` Register a static child.
	`reallyPutEntity(self, name, entity)`
Inherited from ConfigCollection
	`entityConstraint(self, entity)` A method that determines whether an entity may be added to me.
	`getEntityType(self)`
	`getNameType(self)`
Inherited from Constrained
	`nameConstraint(self, name)` A method that determines whether an entity may be added to me with a given name.
	`putEntity(self, name, entity)` Store an entity if it meets both constraints.
Inherited from Collection
	`getEntity(self, name, request)` Retrieve an entity from me.
	`removeEntity(self, name, request)` Remove an entity for 'name', based on the content of 'request'.
	`storeEntity(self, name, request)` Store an entity for 'name', based on the content of 'request'.
Inherited from Presentation
	`addClassVars(self, namespace, Class)`
	`addVariables(self, namespace, request)`
	`display(self, request)` Implement me to represent your widget.
	`formatTraceback(self, tb)`
	`streamCall(self, call, args, *kw)` Utility: Call a method like StreamWidget's 'stream'.
Inherited from Widget
	`getTitle(self, request)`

Class Variable Summary
`str`	`stylesheet` = `'\n a\n {\n font-family: Lucid...`
`str`	`template` = `'<html>\n <head>\n <title>%%%%self.titl...`
`str`	`title` = `'No Title'`
`str`	`widget` = `'No Widget'`
Inherited from Resource
`tuple`	`__implements__` = `(<class twisted.web.resource.IResource ...`
`int`	`isLeaf` = 0
`NoneType`	`server` = None
Inherited from Presentation
`str`	`world` = `"you didn't assign to the 'template' attribute"`

Method Details

prePresent(self, request)

Perform any tasks which must be done before presenting the page.

Overrides:: twisted.web.widgets.Presentation.prePresent (inherited documentation)

render(self, request)

Render a given resource.

This must be implemented in all subclasses of Resource.

The return value of this method will be the rendered page, unless the return value is twisted.web.server.NOT_DONE_YET, in which case it is this class's responsibility to write the results to request.write(data), then call request.finish().

Overrides:: twisted.web.widgets.Page.render (inherited documentation)

Class Variable Details

stylesheet

Type:: str
Value:: ''' a { font-family: Lucida, Verdana, Helvetica, Arial, sans-serif; color: #369; text-decoration: none; } ...

template

Type:: str
Value:: '''<html> <head> <title>%%%%self.title%%%%</title> <style> %%%%self.stylesheet%%%% </style> <base href="%%%%request.prePathURL()%%%%"> </head> ...

title

Type:: str
Value:: 'No Title'

widget

Type:: str
Value:: 'No Widget'

Generated by Epydoc 2.0 on Sat Sep 13 04:21:05 2003

http://epydoc.sf.net