twisted.web.woven.widgets.Widget : API documentation

A Widget wraps an object, its model, for display. The model can be a simple Python object (string, list, etc.) or it can be an instance of model.Model. (The former case is for interface purposes, so that the rest of the code does not have to treat simple objects differently from Model instances.)

If the model is-a Model, there are two possibilities:

we are being called to enable an operation on the model
we are really being called to enable an operation on an attribute of the model, which we will call the submodel

Instance Variables	model	If the current model is an `model.Model`, then the result of model.getData(). Otherwise the original object itself.
Class Variables	tagName	The tag name of the element that this widget creates. If this is None, then the original Node will be cloned.
	wantsAllNotifications	Indicate that this widget wants to recieve every change notification from the main model, not just notifications that affect its model.

Method	__init__
Method	initialize	Use this method instead of __init__ to initialize your Widget, so you don't have to deal with calling the __init__ of the superclass.
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 for a portion of that model. This method returns the portion I am responsible for.
Method	setData	If the return value of `getData` is a Deferred, I am called when the result of the Deferred is available.
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 of this widget.
Method	setNode	Set a node for this widget to use instead of creating one programatically. Useful for looking up a node in a template and using that.
Method	cleanNode	Do your part, prevent infinite recursion!
Method	generate	Allow a view to be used like a widget. Will look up the template file and return it in place of the incoming node.
Method	setDataCallback	Undocumented
Method	setUp	Override this method to set up your Widget prior to generateDOM. This is a good place to call methods like `add`, `insert`, `__setitem__` and `__getitem__`.
Method	generateDOM	No summary
Method	modelChanged	Rerender this view, because our model has changed.
Method	__setitem__	Convenience syntax for adding attributes to the resultant DOM Node of this widget.
Method	__getitem__	Convenience syntax for getting an attribute from the resultant DOM Node of this widget.
Method	setError	No summary
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 of the node and all its children. If there was more than one node with the same slot identifier, they will be returned in a round-robin fashion.
Method	addUpdateMethod	No summary
Method	addEventHandler	No summary
Method	onEvent	Dispatch a client-side event to an event handler that was registered using addEventHandler.
Method	_reset	Undocumented
Method	_regenerate	Undocumented

Inherited from View:

Method	getChild	Undocumented
Method	getChildWithDefault	No summary
Method	setupAllStacks	Undocumented
Method	setupViewStack	Undocumented
Method	importViewLibrary	No summary
Method	render	No summary
Method	getTemplate	Override this if you want to have your subclass look up its template using a different method.
Method	lookupTemplate	No summary
Method	handleDocument	Handle the root node, and send the page if there are no outstanding callbacks when it returns.
Method	handleOutstanding	Undocumented
Method	recurseChildren	If this node has children, handle them.
Method	dispatchResult	Check a given result from handling a node and look up a NodeMutator adapter which will convert the result into a node and insert it into the DOM tree. Return the new node.
Method	setController	Set the controller that this view is related to.
Method	getNodeModel	Get the model object associated with this node. If this node has a model= attribute, call getSubmodel on the current model object. If not, return the top of the model stack.
Method	getNodeController	Get a controller object to handle this node. If the node has no controller= attribute, first check to see if there is an IController adapter for our model.
Method	getSubview	Get a sub-view from me.
Method	getNodeView	Undocumented
Method	handleNode	Undocumented
Method	handleControllerResults	Handle a deferred from a controller.
Method	handleNewNode	Undocumented
Method	sendPage	Check to see if handlers recorded any errors before sending the page
Method	setSubviewFactory	Set the callable "factory", which takes a model and should return a Widget, to be called by the default implementation of getSubview when the viewName "name" is present in the template.
Method	unlinkViews	Undocumented
Method	dispatchResultCallback	Deal with a callback from a deferred, checking to see if it is ok to send the page yet or not.
Method	renderFailure	Undocumented

Parameters	model	(type: `interfaces.IModel` )
	submodel	see `Widget.setSubmodel` (type: String )
	setup	(type: Callable )

Use this method instead of __init__ to initialize your Widget, so you don't have to deal with calling the __init__ of the superclass.

I use the submodel to know which attribute in self.model I am responsible for

I have a model; however since I am a widget I am only responsible for a portion of that model. This method returns the portion I am responsible for.

The return value of this may be a Deferred; if it is, then setData will be called once the result is available.

If the return value of getData is a Deferred, I am called when the result of the Deferred is available.

Add `item' to the children of the resultant DOM Node of this widget.

Parameters item (type: A DOM node or Widget. )

Add `item' to the children of the resultant DOM Node of this widget.

Parameters item (type: A DOM node or Widget. )

Insert `item' at `index' in the children list of the resultant DOM Node of this widget.

Parameters item (type: A DOM node or Widget. )

Set a node for this widget to use instead of creating one programatically. Useful for looking up a node in a template and using that.

Do your part, prevent infinite recursion!

Allow a view to be used like a widget. Will look up the template file and return it in place of the incoming node.

Override this method to set up your Widget prior to generateDOM. This is a good place to call methods like add, insert, __setitem__ and __getitem__.

Overriding this method obsoletes overriding generateDOM directly, in most cases.

Parameters	request	(type: `twisted.web.server.Request`. )
	node	The DOM node which this Widget is operating on.
	data	The Model data this Widget is meant to operate upon.

Returns A 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).

Rerender this view, because our model has changed.

Convenience syntax for adding attributes to the resultant DOM Node of this widget.

Convenience syntax for getting an attribute from the resultant DOM Node of this widget.

Convenience method for allowing a Controller to report an error to the user. When this is called, a Widget of class self.errorFactory is instanciated and set to self.become. When generate is subsequently called, self.become will be responsible for mutating the DOM instead of this widget.

Get a reference to this page's top model object.

Get all nodes below this one which have a matching pattern attribute.

Get a named slot from the incoming template node. Returns a copy of the node and all its children. If there was more than one node with the same slot identifier, they will be returned in a round-robin fashion.

Add a method to this widget that will be called when the widget is being rendered. The signature for this method should be updateMethod(request, widget, data) where widget will be the instance you are calling addUpdateMethod on.

Add an event handler to this widget. eventName is a string indicating which javascript event handler should cause this handler to fire. Handler is a callable that has the signature handler(request, widget, *args).

Dispatch a client-side event to an event handler that was registered using addEventHandler.

t.w.w.w.Widget(view.View) : class documentation