Home       Trees       Index       Help   
Package twisted :: Package web :: Package woven :: Module tapestry :: Class Tapestry
[show private | hide private]
[frames | no frames]

Class Tapestry

Collection --+            
             |            
   Constrained --+        
                 |        
  ConfigCollection --+    
                     |    
              Resource --+
                         |
                        Tapestry

I am a top-level aggregation of Woven objects: a full `site' or `application'.
Method Summary
  __init__(self, templateDirectory, viewFactory, metaTemplate)
Create a tapestry with a specified template directory.
  delEntity(self, name)
Remove a static reference for 'name'. (inherited from Resource)
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me. (inherited from ConfigCollection)
  getChild(self, path, request)
Retrieve a 'child' resource from me.
  getChildForRequest(self, request)
(internal) Get a child of mine dependant on a particular request. (inherited from Resource)
  getChildWithDefault(self, path, request)
Retrieve a static or dynamically generated child resource from me. (inherited from Resource)
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand. (inherited from Resource)
  getEntity(self, name, request)
Retrieve an entity from me. (inherited from Collection)
  getEntityType(self)
(inherited from ConfigCollection)
  getNameType(self)
(inherited from ConfigCollection)
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity. (inherited from Resource)
  getSubview(self, request, node, model, viewName)
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand. (inherited from Resource)
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to. (inherited from Resource)
  listEntities(self)
(inherited from Resource)
  listNames(self)
(inherited from Resource)
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to. (inherited from Resource)
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to. (inherited from Resource)
  makeView(self, model, name, parentCount)
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name. (inherited from Constrained)
  putChild(self, path, child)
Register a static child. (inherited from Resource)
  putEntity(self, name, entity)
Store an entity if it meets both constraints. (inherited from Constrained)
  reallyPutEntity(self, name, entity)
(inherited from Resource)
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'. (inherited from Collection)
  render(self, request)
Render a given resource.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'. (inherited from Collection)
  templateMutate(self, document, parentCount)

Class Variable Summary
class TapestryView

Method Details

__init__(self, templateDirectory, viewFactory=None, metaTemplate=None)
(Constructor)

Create a tapestry with a specified template directory.

getChild(self, path, request)

Retrieve a 'child' resource from me.

Implement this to create dynamic resource generation -- resources which are always available may be registered with self.putChild().

This will not be called if the class-level variable 'isLeaf' is set in your subclass; instead, the 'postpath' attribute of the request will be left as a list of the remaining path elements.

For example, the URL /foo/bar/baz will normally be: 
 | site.resource.getChild('foo').getChild('bar').getChild('baz').
However, if the resource returned by 'bar' has isLeaf set to true, then the getChild call will never be made on it.
Parameters:
path - a string, describing the child
request - a twisted.web.server.Request specifying meta-information about the request that is being made for this child.
Overrides:
twisted.web.resource.Resource.getChild (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.resource.Resource.render (inherited documentation)

Class Variable Details

TapestryView

TapestryView = twisted.web.woven.tapestry.TapestryView

   Home       Trees       Index       Help   
Generated by Epydoc 1.1 on Fri Jun 27 03:49:12 2003 http://epydoc.sf.net