t.w.w.WidgetPage(Page) : class documentation

Part of twisted.web.widgets View Source View In Hierarchy

I am a Page that takes a Widget in its constructor, and displays that Widget wrapped up in a simple HTML template.
Method __init__ Initialize.
Method prePresent Perform any tasks which must be done before presenting the page.
Method render Render a given resource. See IResource's render method.

Inherited from Resource (via Page):

Method listStaticNames Undocumented
Method listStaticEntities Undocumented
Method listNames Undocumented
Method listEntities Undocumented
Method listDynamicNames Undocumented
Method listDynamicEntities Undocumented
Method getStaticEntity Undocumented
Method getDynamicEntity Undocumented
Method delEntity Undocumented
Method reallyPutEntity Undocumented
Method getChild Retrieve a 'child' resource from me.
Method getChildWithDefault Retrieve a static or dynamically generated child resource from me.
Method getChildForRequest Undocumented
Method putChild Register a static child.
Method render_HEAD Default handling of HEAD method.

Inherited from Presentation (via Page):

Method addClassVars Undocumented
Method addVariables Undocumented
Method formatTraceback Undocumented
Method streamCall Utility: Call a method like StreamWidget's 'stream'.
Method display Implement me to represent your widget.

Inherited from Widget (via Page, Presentation):

Method getTitle Undocumented
def __init__(self, widget): (source)
def prePresent(self, request): (source)
Perform any tasks which must be done before presenting the page.
def render(self, request): (source)

Render a given resource. See IResource's render method.

I delegate to methods of self with the form 'render_METHOD' where METHOD is the HTTP that was used to make the request. Examples: render_GET, render_HEAD, render_POST, and so on. Generally you should implement those methods instead of overriding this one.

render_METHOD methods are expected to return a string which 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().

Old code that overrides render() directly is likewise expected to return a string or NOT_DONE_YET.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.