Package twisted :: Package web :: Module widgets :: Class Gadget
[frames | no frames]

Class Gadget

Collection --+            
             |            
   Constrained --+        
                 |        
  ConfigCollection --+    
                     |    
              Resource --+
                         |
                        Gadget

Known Subclasses:
ChangePasswordForm, ConfigRoot, IdentitiesGadget, NewIdentityForm, NewPerspectiveForm, ParticipantListWidget, PerspectivesGadget, RemoveIdentityForm, RemovePerspectiveForm, Test, UserDirectory, WordsGadget

I am a collection of Widgets, to be rendered through a Page Factory. self.pageFactory should be a Resource that takes a Widget in its constructor. The default is twisted.web.widgets.WidgetPage.
Method Summary
  __init__(self)
Initialize.
  addFile(self, path)
Gadget.addFile(path) Add a static path to this Gadget.
  getChild(self, path, request)
Retrieve a 'child' resource from me.
  getWidget(self, path, request)
  pageFactory(self, *args, **kwargs)
Gadget.pageFactory(*args, **kwargs) -> Resource By default, this method returns self.page(*args, **kwargs).
  putPath(self, path, pathname)
Gadget.putPath(path, pathname) Add a static path to this Gadget.
  putWidget(self, path, widget)
Gadget.putWidget(path, widget) Add a Widget to this Gadget.
  render(self, request)
Render a given resource.
    Inherited from Resource
  delEntity(self, name)
Remove a static reference for 'name'.
  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'.

Class Variable Summary
int isLeaf = 0                                                                     
    Inherited from Resource
tuple __implements__ = (<class twisted.web.resource.IResource ...
NoneType server = None                                                                  

Method Details

__init__(self)
(Constructor)

Initialize.
Overrides:
twisted.web.resource.Resource.__init__ (inherited documentation)

addFile(self, path)

Gadget.addFile(path) Add a static path to this Gadget. This method is obsolete, use Gadget.putPath instead.

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)

pageFactory(self, *args, **kwargs)

Gadget.pageFactory(*args, **kwargs) -> Resource By default, this method returns self.page(*args, **kwargs). It is only for backwards-compatibility -- you should set the 'pageFactory' attribute on your Gadget inside of its __init__ method.

putPath(self, path, pathname)

Gadget.putPath(path, pathname) Add a static path to this Gadget. Whenever 'path' is requested, twisted.web.static.File(pathname) is sent.

putWidget(self, path, widget)

Gadget.putWidget(path, widget) Add a Widget to this Gadget. It will be rendered through the pageFactory associated with this Gadget, whenever 'path' is requested.

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

isLeaf

Type:
int
Value:
0                                                                     

Generated by Epydoc 2.0 on Sat Sep 13 04:21:00 2003 http://epydoc.sf.net