twisted.web.woven.interfaces.IView.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.web.woven.interfaces.IView</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.web.html">Package web</a> ::
<a href="twisted.web.woven.html">Package woven</a> ::
<a href="twisted.web.woven.interfaces.html">Module interfaces</a> ::
Class IView
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.woven.interfaces.IView.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IView</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IView</b>
</pre><br />
<hr/>
A MVC View
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>model</span>,
<span class=summary-sig-arg>controller</span>)</span></code>
<br />
A view must be told what its model is, and may be told what its
controller is, but can also look up its controller if none specified.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__adapt__"></a><span class="summary-sig"><span class="summary-sig-name">__adapt__</span>(<span class=summary-sig-arg>adaptable</span>,
<span class=summary-sig-arg>default</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#controllerFactory" class="summary-sig-name"><code>controllerFactory</code></a>()</span></code>
<br />
Hook for subclasses to customize the controller that is associated
with the model associated with this view.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#getSubview" class="summary-sig-name"><code>getSubview</code></a>(<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>node</span>,
<span class=summary-sig-arg>model</span>,
<span class=summary-sig-arg>viewName</span>)</span></code>
<br />
Look for a view named "viewName" to handle the node
"node".</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#importViewLibrary" class="summary-sig-name"><code>importViewLibrary</code></a>(<span class=summary-sig-arg>moduleOrObject</span>)</span></code>
<br />
Import the given object or module into this View's view namespace
stack.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#modelChanged" class="summary-sig-name"><code>modelChanged</code></a>(<span class=summary-sig-arg>changed</span>)</span></code>
<br />
Dispatch changed messages to any update_* methods which may have been
defined, then pass the update notification on to the controller.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#setController" class="summary-sig-name"><code>setController</code></a>(<span class=summary-sig-arg>controller</span>)</span></code>
<br />
Set the controller that this view is related to.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.woven.interfaces.IView.html#setSubviewFactory" class="summary-sig-name"><code>setSubviewFactory</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>setup</span>)</span></code>
<br />
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.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>model</span>,
<span class=sig-arg>controller</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
A view must be told what its model is, and may be told what its
controller is, but can also look up its controller if none
specified.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="controllerFactory"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">controllerFactory</span>()</span>
</h3>
<p>Hook for subclasses to customize the controller that is associated
with the model associated with this view.</p>
Default behavior: Look up a component that implements IController
for the self.model instance.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getSubview"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSubview</span>(<span class=sig-arg>request</span>,
<span class=sig-arg>node</span>,
<span class=sig-arg>model</span>,
<span class=sig-arg>viewName</span>)</span>
</h3>
<p>Look for a view named "viewName" to handle the node
"node". When a node <div view="foo" /> is
present in the template, this method will be called with viewName set
to "foo".</p>
Return None if this View doesn't want to provide a Subview for the
given name.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="importViewLibrary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">importViewLibrary</span>(<span class=sig-arg>moduleOrObject</span>)</span>
</h3>
Import the given object or module into this View's view namespace
stack. If the given object or module has a getSubview function or
method, it will be called when a node has a view="foo"
attribute. If no getSubview method is defined, a default one will be
provided which looks for the literal name in the namespace.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="modelChanged"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">modelChanged</span>(<span class=sig-arg>changed</span>)</span>
</h3>
Dispatch changed messages to any update_* methods which may have
been defined, then pass the update notification on to the
controller.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setController"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setController</span>(<span class=sig-arg>controller</span>)</span>
</h3>
Set the controller that this view is related to.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setSubviewFactory"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setSubviewFactory</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>setup</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>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.</p>
<p>This would generally be used like this:</p>
<p>view.setSubviewFactory("foo", MyFancyWidgetClass)</p>
This is equivalent to:
<pre class="literalblock">
def wvfactory_foo(self, request, node, m):
return MyFancyWidgetClass(m)
</pre>
<p>Which will cause an instance of MyFancyWidgetClass to be
instanciated when template node <div view="foo" /> is
encountered.</p>
<p>If setup is passed, it will be passed to new instances returned from
this factory as a setup method. The setup method is called each time
the Widget is generated. Setup methods take (request, widget, model) as
arguments.</p>
This is equivalent to:
<pre class="literalblock">
def wvupdate_foo(self, request, widget, model):
# whatever you want
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:05 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>