Class t.w.w.w.List(Widget):

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

Known subclasses: twisted.web.woven.widgets.KeyedList

I am a widget which knows how to generateDOM for a python list.

A List should be specified in the template HTML as so:
  | <ul model="blah" view="List">
  |     <li pattern="emptyList">This will be displayed if the list
  |         is empty.</li>
  |     <li pattern="listItem" view="Text">Foo</li>
  | </ul>
If you have nested lists, you may also do something like this:
  | <table model="blah" view="List">
  |     <tr pattern="listHeader"><th>A</th><th>B</th></tr>
  |     <tr pattern="emptyList"><td colspan='2'>***None***</td></tr>
  |     <tr pattern="listItem">
  |         <td><span view="Text" model="1" /></td>
  |         <td><span view="Text" model="2" /></td>
  |     </tr>
  |     <tr pattern="listFooter"><td colspan="2">All done!</td></tr>
  | </table>
Where blah is the name of a list on the model; eg:
  | self.model.blah = ['foo', 'bar']
Method generateDOM
Method _iterateData Undocumented

Inherited from Widget:

Method __init__
Method _reset Undocumented
Method initialize Use this method instead of __init__ to initialize your Widget, so you
Method setSubmodel I use the submodel to know which attribute in self.model I am responsible for
Method getData I have a model; however since I am a widget I am only responsible
Method setData If the return value of getData is a Deferred, I am called
Method add Add `item' to the children of the resultant DOM Node of this widget.
Method appendChild Add `item' to the children of the resultant DOM Node of this widget.
Method insert Insert `item' at `index' in the children list of the resultant DOM Node
Method setNode Set a node for this widget to use instead of creating one programatically.
Method cleanNode Do your part, prevent infinite recursion!
Method generate Undocumented
Method _regenerate Undocumented
Method setDataCallback Undocumented
Method setUp Override this method to set up your Widget prior to generateDOM. This
Method modelChanged Undocumented
Method __setitem__ Convenience syntax for adding attributes to the resultant DOM Node of
Method __getitem__ Convenience syntax for getting an attribute from the resultant DOM Node
Method setError Convenience method for allowing a Controller to report an error to the
Method getTopModel Get a reference to this page's top model object.
Method getAllPatterns Get all nodes below this one which have a matching pattern attribute.
Method getPattern Get a named slot from the incoming template node. Returns a copy
Method addUpdateMethod Add a method to this widget that will be called when the widget
Method addEventHandler Add an event handler to this widget. eventName is a string
Method onEvent Dispatch a client-side event to an event handler that was
def generateDOM(self, request, node): (source)
ReturnsA DOM Node to replace the Node in the template that this Widget handles. This Node is created based on tagName, children, and attributes (You should populate these in setUp, probably).
def _iterateData(self, parentNode, submodel, data): (source)
Undocumented
API Documentation for twisted, generated by pydoctor.