<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The horizon.tables.views Module — Horizon 2012.2.3 documentation</title>
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2012.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/jquery.tweet.js"></script>
<link rel="top" title="Horizon 2012.2.3 documentation" href="../../index.html" />
<link rel="up" title="Source Code Index" href="../autoindex.html" />
<link rel="next" title="The horizon.templatetags.parse_date Module" href="horizon.templatetags.parse_date.html" />
<link rel="prev" title="The horizon.tables Module" href="horizon.tables.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="the-horizon-tables-views-module">
<h1>The <tt class="xref py py-mod docutils literal"><span class="pre">horizon.tables.views</span></tt> Module<a class="headerlink" href="#the-horizon-tables-views-module" title="Permalink to this headline">ΒΆ</a></h1>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.tables.views.</tt><tt class="descname">DataTableView</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#DataTableView"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">horizon.tables.views.MultiTableView</span></tt></p>
<p>A class-based generic view to handle basic DataTable processing.</p>
<p>Three steps are required to use this view: set the <tt class="docutils literal"><span class="pre">table_class</span></tt>
attribute with the desired <a class="reference internal" href="../../ref/tables.html#horizon.tables.DataTable" title="horizon.tables.DataTable"><tt class="xref py py-class docutils literal"><span class="pre">DataTable</span></tt></a> class;
define a <tt class="docutils literal"><span class="pre">get_data</span></tt> method which returns a set of data for the
table; and specify a template for the <tt class="docutils literal"><span class="pre">template_name</span></tt> attribute.</p>
<p>Optionally, you can override the <tt class="docutils literal"><span class="pre">has_more_data</span></tt> method to trigger
pagination handling for APIs that support it.</p>
<dl class="attribute">
<dt>
<tt class="descclassname">DataTableView.</tt><tt class="descname">context_object_name</tt><em class="property"> = 'table'</em></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">DataTableView.</tt><tt class="descname">get_context_data</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#DataTableView.get_context_data"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">DataTableView.</tt><tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#DataTableView.get_data"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">DataTableView.</tt><tt class="descname">get_table</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#DataTableView.get_table"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">DataTableView.</tt><tt class="descname">get_tables</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#DataTableView.get_tables"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<tt class="descclassname">DataTableView.</tt><tt class="descname">table_class</tt><em class="property"> = None</em></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.tables.views.</tt><tt class="descname">MixedDataTableView</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MixedDataTableView"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">horizon.tables.views.DataTableView</span></tt></p>
<p>A class-based generic view to handle DataTable with mixed data
types.</p>
<p>Basic usage is the same as DataTableView.</p>
<p>Three steps are required to use this view:
#. Set the <tt class="docutils literal"><span class="pre">table_class</span></tt> attribute with desired
<a class="reference internal" href="../../ref/tables.html#horizon.tables.DataTable" title="horizon.tables.DataTable"><tt class="xref py py-class docutils literal"><span class="pre">DataTable</span></tt></a> class. In the class the
<tt class="docutils literal"><span class="pre">data_types</span></tt> list should have at least two elements.</p>
<p>#. Define a <tt class="docutils literal"><span class="pre">get_{{</span> <span class="pre">data_type</span> <span class="pre">}}_data</span></tt> method for each data type
which returns a set of data for the table.</p>
<ol class="arabic simple">
<li>Specify a template for the <tt class="docutils literal"><span class="pre">template_name</span></tt> attribute.</li>
</ol>
<dl class="method">
<dt>
<tt class="descclassname">MixedDataTableView.</tt><tt class="descname">assign_type_string</tt><big>(</big><em>data</em>, <em>type_string</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MixedDataTableView.assign_type_string"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<tt class="descclassname">MixedDataTableView.</tt><tt class="descname">context_object_name</tt><em class="property"> = 'table'</em></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MixedDataTableView.</tt><tt class="descname">get_table</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MixedDataTableView.get_table"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<tt class="descclassname">MixedDataTableView.</tt><tt class="descname">table_class</tt><em class="property"> = None</em></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.tables.views.</tt><tt class="descname">MultiTableMixin</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>A generic mixin which provides methods for handling DataTables.</p>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">assign_type_string</tt><big>(</big><em>data</em>, <em>type_name</em>, <em>data_type</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.assign_type_string"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">check_method_exist</tt><big>(</big><em>func_pattern='%s'</em>, <em>*names</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.check_method_exist"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">data_method_pattern</tt><em class="property"> = 'get_%s_data'</em></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">get_context_data</tt><big>(</big><em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.get_context_data"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">get_data_methods</tt><big>(</big><em>table_classes</em>, <em>methods</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.get_data_methods"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">get_tables</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.get_tables"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">handle_table</tt><big>(</big><em>table</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.handle_table"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">has_more_data</tt><big>(</big><em>table</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.has_more_data"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableMixin.</tt><tt class="descname">wrap_func</tt><big>(</big><em>data_func</em>, <em>type_name</em>, <em>data_type</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableMixin.wrap_func"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.tables.views.</tt><tt class="descname">MultiTableView</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableView"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">horizon.tables.views.MultiTableMixin</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">django.views.generic.base.TemplateView</span></tt></p>
<p>A class-based generic view to handle the display and processing of
multiple <a class="reference internal" href="../../ref/tables.html#horizon.tables.DataTable" title="horizon.tables.DataTable"><tt class="xref py py-class docutils literal"><span class="pre">DataTable</span></tt></a> classes in a single view.</p>
<p>Three steps are required to use this view: set the <tt class="docutils literal"><span class="pre">table_classes</span></tt>
attribute with a tuple of the desired
<a class="reference internal" href="../../ref/tables.html#horizon.tables.DataTable" title="horizon.tables.DataTable"><tt class="xref py py-class docutils literal"><span class="pre">DataTable</span></tt></a> classes;
define a <tt class="docutils literal"><span class="pre">get_{{</span> <span class="pre">table_name</span> <span class="pre">}}_data</span></tt> method for each table class
which returns a set of data for that table; and specify a template for
the <tt class="docutils literal"><span class="pre">template_name</span></tt> attribute.</p>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableView.</tt><tt class="descname">construct_tables</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableView.construct_tables"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableView.</tt><tt class="descname">get</tt><big>(</big><em>request</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableView.get"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<tt class="descclassname">MultiTableView.</tt><tt class="descname">post</tt><big>(</big><em>request</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/horizon/tables/views.html#MultiTableView.post"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="horizon.tables.html"
title="previous chapter">The <tt class="docutils literal docutils literal docutils literal"><span class="pre">horizon.tables</span></tt> Module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="horizon.templatetags.parse_date.html"
title="next chapter">The <tt class="docutils literal"><span class="pre">horizon.templatetags.parse_date</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/sourcecode/horizon/horizon.tables.views.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="horizon.templatetags.parse_date.html" title="The horizon.templatetags.parse_date Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="horizon.tables.html" title="The horizon.tables Module"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">Horizon 2012.2.3 documentation</a> »</li>
<li><a href="../autoindex.html" accesskey="U">Source Code Index</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, OpenStack, LLC.
Last updated on Feb 08, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
