twisted.words.webwords.WordsGadget

Package twisted :: Package words :: Module webwords :: Class WordsGadget

Class WordsGadget

Collection --+                
             |                
   Constrained --+            
                 |            
  ConfigCollection --+        
                     |        
              Resource --+    
                         |    
                    Gadget --+
                             |
                 Versioned --+
                             |
                    Widget --+
                             |
                            WordsGadget

Method Summary
	`__init__(self, svc)`
	`display(self, request)` Implement me to represent your widget.
	`upgradeToVersion1(self)`
	`upgradeToVersion2(self)`
Inherited from Gadget
	`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'.
Inherited from Widget
	`getTitle(self, request)`
Inherited from Versioned
	`__getstate__(self, dict)` Get state, adding a version number to it on its way out.
	`__setstate__(self, state)`
	`versionUpgrade(self)` (internal) Do a version upgrade.

Class Variable Summary
`int`	`persistenceVersion` = 2
`str`	`title` = `'Welcome to WebWords'`
Inherited from Gadget
`int`	`isLeaf` = 0
Inherited from Resource
`tuple`	`__implements__` = `(<class twisted.web.resource.IResource ...`
`NoneType`	`server` = None
Inherited from Versioned
`tuple`	`persistenceForgets` = `()`

Method Details

display(self, request)

Implement me to represent your widget.

I must return a list of strings and twisted.internet.defer.Deferred instances.

Overrides:: twisted.web.widgets.Widget.display (inherited documentation)

Class Variable Details

persistenceVersion

Type:: int
Value:: 2

title

Type:: str
Value:: 'Welcome to WebWords'

Generated by Epydoc 2.0 on Sat Sep 13 04:20:38 2003

http://epydoc.sf.net