t.w.w.t.DOMTemplate(Resource) : class documentation

Part of twisted.web.woven.template View Source View In Hierarchy

A resource that renders pages using DOM.
Method __init__
Method render Render a given resource. See IResource's render method.
Method getTemplate Override this if you want to have your subclass look up its template using a different method.
Method lookupTemplate No summary
Method setUp Undocumented
Method handleDocument Handle the root node, and send the page if there are no outstanding callbacks when it returns.
Method dispatchResult Check a given result from handling a node and hand it to a process* method which will convert the result into a node and insert it into the DOM tree. Return the new node.
Method recurseChildren If this node has children, handle them.
Method dispatchResultCallback Deal with a callback from a deferred, dispatching the result and recursing children.
Method handleNode Handle a single node by looking up a method for it, calling the method and dispatching the result.
Method sendPage Send the results of the DOM mutation to the browser.
Method renderFailure Undocumented

Inherited from Resource:

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.
def __init__(self, templateFile=None): (source)
ParameterstemplateFileThe name of a file containing a template. (type: String )
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.
def getTemplate(self, request): (source)
Override this if you want to have your subclass look up its template using a different method.
def lookupTemplate(self, request): (source)
Use acquisition to look up the template named by self.templateFile, located anywhere above this object in the heirarchy, and use it as the template. The first time the template is used it is cached for speed.
def setUp(self, request, document): (source)
Undocumented
def handleDocument(self, request, document): (source)
Handle the root node, and send the page if there are no outstanding callbacks when it returns.
def dispatchResult(self, request, node, result): (source)
Check a given result from handling a node and hand it to a process* method which will convert the result into a node and insert it into the DOM tree. Return the new node.
def recurseChildren(self, request, node): (source)
If this node has children, handle them.
def dispatchResultCallback(self, result, request, node): (source)
Deal with a callback from a deferred, dispatching the result and recursing children.
def handleNode(self, request, node): (source)

Handle a single node by looking up a method for it, calling the method and dispatching the result.

Also, handle all childNodes of this node using recursion.
def sendPage(self, request): (source)
Send the results of the DOM mutation to the browser.
def renderFailure(self, failure, request): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.