<!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>horizon.browsers.base — 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="horizon" href="../../horizon.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">
<h1>Source code for horizon.browsers.base</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span>
<span class="c"># Copyright 2012 Nebula, Inc.</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span>
<span class="c"># not use this file except in compliance with the License. You may obtain</span>
<span class="c"># a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span>
<span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c"># License for the specific language governing permissions and limitations</span>
<span class="c"># under the License.</span>
<span class="kn">from</span> <span class="nn">django</span> <span class="kn">import</span> <span class="n">template</span>
<span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="kn">import</span> <span class="n">ugettext_lazy</span> <span class="k">as</span> <span class="n">_</span>
<span class="kn">from</span> <span class="nn">horizon.tables</span> <span class="kn">import</span> <span class="n">DataTable</span>
<span class="kn">from</span> <span class="nn">horizon.utils</span> <span class="kn">import</span> <span class="n">html</span>
<span class="kn">from</span> <span class="nn">.breadcrumb</span> <span class="kn">import</span> <span class="n">Breadcrumb</span>
<div class="viewcode-block" id="ResourceBrowser"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.browsers.base.html#horizon.browsers.base.ResourceBrowser">[docs]</a><span class="k">class</span> <span class="nc">ResourceBrowser</span><span class="p">(</span><span class="n">html</span><span class="o">.</span><span class="n">HTMLElement</span><span class="p">):</span>
<span class="sd">"""A class which defines a browser for displaying data.</span>
<span class="sd"> .. attribute:: name</span>
<span class="sd"> A short name or slug for the browser.</span>
<span class="sd"> .. attribute:: verbose_name</span>
<span class="sd"> A more verbose name for the browser meant for display purposes.</span>
<span class="sd"> .. attribute:: navigation_table_class</span>
<span class="sd"> This table displays data on the left side of the browser.</span>
<span class="sd"> Set the ``navigation_table_class`` attribute with</span>
<span class="sd"> the desired :class:`~horizon.tables.DataTable` class.</span>
<span class="sd"> This table class must set browser_table attribute in Meta to</span>
<span class="sd"> ``"navigation"``.</span>
<span class="sd"> .. attribute:: content_table_class</span>
<span class="sd"> This table displays data on the right side of the browser.</span>
<span class="sd"> Set the ``content_table_class`` attribute with</span>
<span class="sd"> the desired :class:`~horizon.tables.DataTable` class.</span>
<span class="sd"> This table class must set browser_table attribute in Meta to</span>
<span class="sd"> ``"content"``.</span>
<span class="sd"> .. attribute:: navigation_kwarg_name</span>
<span class="sd"> This attribute represents the key of the navigatable items in the</span>
<span class="sd"> kwargs property of this browser's view.</span>
<span class="sd"> Defaults to ``"navigation_kwarg"``.</span>
<span class="sd"> .. attribute:: content_kwarg_name</span>
<span class="sd"> This attribute represents the key of the content items in the</span>
<span class="sd"> kwargs property of this browser's view.</span>
<span class="sd"> Defaults to ``"content_kwarg"``.</span>
<span class="sd"> .. attribute:: template</span>
<span class="sd"> String containing the template which should be used to render</span>
<span class="sd"> the browser. Defaults to ``"horizon/common/_resource_browser.html"``.</span>
<span class="sd"> .. attribute:: context_var_name</span>
<span class="sd"> The name of the context variable which will contain the browser when</span>
<span class="sd"> it is rendered. Defaults to ``"browser"``.</span>
<span class="sd"> .. attribute:: has_breadcrumb</span>
<span class="sd"> Indicates if the content table of the browser would have breadcrumb.</span>
<span class="sd"> Defaults to false.</span>
<span class="sd"> .. attribute:: breadcrumb_template</span>
<span class="sd"> This is a template used to render the breadcrumb.</span>
<span class="sd"> Defaults to ``"horizon/common/_breadcrumb.html"``.</span>
<span class="sd"> """</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">verbose_name</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">navigation_table_class</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">content_table_class</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">navigation_kwarg_name</span> <span class="o">=</span> <span class="s">"navigation_kwarg"</span>
<span class="n">content_kwarg_name</span> <span class="o">=</span> <span class="s">"content_kwarg"</span>
<span class="n">navigable_item_name</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">"Navigation Item"</span><span class="p">)</span>
<span class="n">template</span> <span class="o">=</span> <span class="s">"horizon/common/_resource_browser.html"</span>
<span class="n">context_var_name</span> <span class="o">=</span> <span class="s">"browser"</span>
<span class="n">has_breadcrumb</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">breadcrumb_template</span> <span class="o">=</span> <span class="s">"horizon/common/_breadcrumb.html"</span>
<span class="n">breadcrumb_url</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">tables_dict</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">attrs</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">ResourceBrowser</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>
<span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">title</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">request</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span> <span class="o">=</span> <span class="n">kwargs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">has_breadcrumb</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">"has_breadcrumb"</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_breadcrumb</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">breadcrumb_template</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">"breadcrumb_template"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">breadcrumb_url</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">"breadcrumb_url"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">breadcrumb_url</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"You must specify a breadcrumb_url "</span>
<span class="s">"if the has_breadcrumb is set to True."</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">attrs</span> <span class="ow">or</span> <span class="p">{})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_table_class</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content_table_class</span><span class="p">,</span> <span class="s">"content_table_class"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_table_class</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">navigation_table_class</span><span class="p">,</span>
<span class="s">"navigation_table_class"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">tables_dict</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_tables</span><span class="p">(</span><span class="n">tables_dict</span><span class="p">)</span>
<div class="viewcode-block" id="ResourceBrowser.check_table_class"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.browsers.base.html#horizon.browsers.base.ResourceBrowser.check_table_class">[docs]</a> <span class="k">def</span> <span class="nf">check_table_class</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cls</span><span class="p">,</span> <span class="n">attr_name</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">cls</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">DataTable</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"You must specify a DataTable subclass for "</span>
<span class="s">"the </span><span class="si">%s</span><span class="s"> attribute on </span><span class="si">%s</span><span class="s">."</span>
<span class="o">%</span> <span class="p">(</span><span class="n">attr_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="ResourceBrowser.set_tables"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.browsers.base.html#horizon.browsers.base.ResourceBrowser.set_tables">[docs]</a> <span class="k">def</span> <span class="nf">set_tables</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tables</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets the table instances on the browser from a dictionary mapping table</span>
<span class="sd"> names to table instances (as constructed by MultiTableView).</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">navigation_table</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">navigation_table_class</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">content_table</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">content_table_class</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
<span class="n">navigation_item</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">navigation_kwarg_name</span><span class="p">)</span>
<span class="n">content_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content_kwarg_name</span><span class="p">)</span>
<span class="c"># Tells the navigation table what is selected.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">navigation_table</span><span class="o">.</span><span class="n">current_item_id</span> <span class="o">=</span> <span class="n">navigation_item</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_breadcrumb</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prepare_breadcrumb</span><span class="p">(</span><span class="n">tables</span><span class="p">,</span> <span class="n">navigation_item</span><span class="p">,</span> <span class="n">content_path</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="ResourceBrowser.prepare_breadcrumb"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.browsers.base.html#horizon.browsers.base.ResourceBrowser.prepare_breadcrumb">[docs]</a> <span class="k">def</span> <span class="nf">prepare_breadcrumb</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tables</span><span class="p">,</span> <span class="n">navigation_item</span><span class="p">,</span> <span class="n">content_path</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_breadcrumb</span> <span class="ow">and</span> <span class="n">navigation_item</span> <span class="ow">and</span> <span class="n">content_path</span><span class="p">:</span>
<span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">tables</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">table</span><span class="o">.</span><span class="n">breadcrumb</span> <span class="o">=</span> <span class="n">Breadcrumb</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">breadcrumb_template</span><span class="p">,</span>
<span class="n">navigation_item</span><span class="p">,</span>
<span class="n">content_path</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">breadcrumb_url</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="ResourceBrowser.render"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.browsers.base.html#horizon.browsers.base.ResourceBrowser.render">[docs]</a> <span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">browser_template</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">loader</span><span class="o">.</span><span class="n">get_template</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">template</span><span class="p">)</span>
<span class="n">extra_context</span> <span class="o">=</span> <span class="p">{</span><span class="bp">self</span><span class="o">.</span><span class="n">context_var_name</span><span class="p">:</span> <span class="bp">self</span><span class="p">}</span>
<span class="n">context</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">RequestContext</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="n">extra_context</span><span class="p">)</span>
<span class="k">return</span> <span class="n">browser_template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">context</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<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><a href="../../../index.html">Horizon 2012.2.3 documentation</a> »</li>
<li><a href="../../index.html" >Module code</a> »</li>
<li><a href="../../horizon.html" accesskey="U">horizon</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>
