Home | Trees | Index | Help |
---|
Package twisted :: Package web :: Module widgets :: Class Gadget |
|
Collection
--+ |Constrained
--+ |ConfigCollection
--+ |Resource
--+ | Gadget
ConfigRoot
,
Test
,
NewIdentityForm
,
IdentitiesGadget
,
NewPerspectiveForm
,
PerspectivesGadget
,
RemoveIdentityForm
,
RemovePerspectiveForm
,
ChangePasswordForm
,
UserDirectory
,
WordsGadget
,
ParticipantListWidget
Method Summary | |
---|---|
Initialize. | |
Gadget.addFile(path) Add a static path to this Gadget. | |
Remove a static reference for 'name'. (inherited from Resource )
| |
A method that determines whether an entity may be added to me. (inherited from ConfigCollection )
| |
Retrieve a 'child' resource from me. | |
(internal) Get a child of mine dependant on a particular request. (inherited from Resource )
| |
(internal) Retrieve a static or dynamically generated child resource from me. (inherited from Resource )
| |
Subclass this to generate an entity on demand. (inherited from Resource )
| |
Retrieve an entity from me. (inherited from Collection )
| |
(inherited from ConfigCollection )
| |
(inherited from ConfigCollection )
| |
Get an entity that was added to me using putEntity. (inherited from Resource )
| |
getWidget(self,
path,
request)
| |
A list of all name, entity that I can generate on demand. (inherited from Resource )
| |
Retrieve a list of the names of entities that I store references to. (inherited from Resource )
| |
Retrieve a list of all name, entity pairs that I store references to. (inherited from Resource )
| |
Retrieve a list of the names of entities that I store references to. (inherited from Resource )
| |
Retrieve a list of all name, entity pairs that I store references to. (inherited from Resource )
| |
Retrieve a list of the names of entities that I store references to. (inherited from Resource )
| |
A method that determines whether an entity may be added to me with a given name. (inherited from Constrained )
| |
Gadget.pageFactory(*args, **kwargs) -> Resource By default, this method returns self.page(*args, **kwargs). | |
Register a child with me. (inherited from Resource )
| |
Store an entity if it meets both constraints. (inherited from Constrained )
| |
Gadget.putPath(path, pathname) Add a static path to this Gadget. | |
Gadget.putWidget(path, widget) Add a Widget to this Gadget. | |
(inherited from Resource )
| |
Remove an entity for 'name', based on the content of 'request'. (inherited from Collection )
| |
Render a given resource. | |
Store an entity for 'name', based on the content of 'request'. (inherited from Collection )
|
Class Variable Summary | |
---|---|
int |
isLeaf
|
Method Details |
---|
__init__(self)
Initialize.
|
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.
|
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().
|
Class Variable Details |
---|
isLeaf
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:29:17 2003 | http://epydoc.sf.net |