seitime-frappe/docs/_build/html/_modules/webnotes/widgets/page.html
2011-06-29 14:41:49 +05:30

183 lines
No EOL
16 KiB
HTML

<!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>webnotes.widgets.page &mdash; WNFramework v1.8 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.8',
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>
<link rel="top" title="WNFramework v1.8 documentation" href="../../../index.html" />
<link rel="up" title="webnotes" href="../../webnotes.html" />
</head>
<body>
<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">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
<li><a href="../../webnotes.html" accesskey="U">webnotes</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for webnotes.widgets.page</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="kn">import</span> <span class="nn">webnotes.model.doc</span>
<span class="kn">import</span> <span class="nn">webnotes.model.code</span>
<span class="n">conn</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span>
<div class="viewcode-block" id="Page"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.page.Page">[docs]</a><span class="k">class</span> <span class="nc">Page</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A page class helps in loading a Page in the system. On loading</span>
<span class="sd"> </span>
<span class="sd"> * Page will import Client Script from other pages where specified by `$import(page_name)`</span>
<span class="sd"> * Execute dynamic HTML if the `content` starts with `#python`</span>
<span class="sd"> &quot;&quot;&quot;</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">name</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="n">name</span>
<div class="viewcode-block" id="Page.load"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.page.Page.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns :term:`doclist` of the `Page`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">webnotes.modules</span> <span class="kn">import</span> <span class="n">compress</span>
<span class="kn">from</span> <span class="nn">webnotes.model.code</span> <span class="kn">import</span> <span class="n">get_code</span>
<span class="n">doclist</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;Page&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">doc</span> <span class="o">=</span> <span class="n">doclist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">doc</span><span class="o">.</span><span class="n">fields</span><span class="p">[</span><span class="s">&#39;__script&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">compress</span><span class="o">.</span><span class="n">get_page_js</span><span class="p">(</span><span class="n">doc</span><span class="p">)</span>
<span class="n">doc</span><span class="o">.</span><span class="n">script</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">template</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%(content)s</span><span class="s">&#39;</span>
<span class="c"># load code from template</span>
<span class="k">if</span> <span class="n">doc</span><span class="o">.</span><span class="n">template</span><span class="p">:</span>
<span class="n">template</span> <span class="o">=</span> <span class="n">get_code</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s">&#39;Page Template&#39;</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">template</span><span class="p">,</span> <span class="s">&#39;module&#39;</span><span class="p">),</span> <span class="s">&#39;Page Template&#39;</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">template</span><span class="p">,</span> <span class="s">&#39;html&#39;</span><span class="p">,</span> <span class="n">fieldname</span><span class="o">=</span><span class="s">&#39;template&#39;</span><span class="p">)</span>
<span class="n">doc</span><span class="o">.</span><span class="n">content</span> <span class="o">=</span> <span class="n">get_code</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">module</span><span class="p">,</span> <span class="s">&#39;page&#39;</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s">&#39;html&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">doc</span><span class="o">.</span><span class="n">content</span>
<span class="c"># execute content</span>
<span class="k">if</span> <span class="n">doc</span><span class="o">.</span><span class="n">content</span> <span class="ow">and</span> <span class="n">doc</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">&#39;#!python&#39;</span><span class="p">):</span>
<span class="n">doc</span><span class="o">.</span><span class="n">__content</span> <span class="o">=</span> <span class="n">template</span> <span class="o">%</span> <span class="p">{</span><span class="s">&#39;content&#39;</span><span class="p">:</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">code</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">content</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;content&#39;</span><span class="p">)}</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">doc</span><span class="o">.</span><span class="n">__content</span> <span class="o">=</span> <span class="n">template</span> <span class="o">%</span> <span class="p">{</span><span class="s">&#39;content&#39;</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">content</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span><span class="p">}</span>
<span class="c"># local stylesheet</span>
<span class="n">css</span> <span class="o">=</span> <span class="n">get_code</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">module</span><span class="p">,</span> <span class="s">&#39;page&#39;</span><span class="p">,</span> <span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s">&#39;css&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">css</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">style</span> <span class="o">=</span> <span class="n">css</span>
<span class="c"># add stylesheet</span>
<span class="k">if</span> <span class="n">doc</span><span class="o">.</span><span class="n">stylesheet</span><span class="p">:</span>
<span class="n">doclist</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">load_stylesheet</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">stylesheet</span><span class="p">)</span>
<span class="k">return</span> <span class="n">doclist</span>
</div>
<div class="viewcode-block" id="Page.load_stylesheet"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.page.Page.load_stylesheet">[docs]</a> <span class="k">def</span> <span class="nf">load_stylesheet</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stylesheet</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">webnotes</span>
<span class="c"># load stylesheet</span>
<span class="n">loaded</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">form_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;stylesheets&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;[]&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">stylesheet</span> <span class="ow">in</span> <span class="n">loaded</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">webnotes.model.doc</span>
<span class="kn">from</span> <span class="nn">webnotes.model.code</span> <span class="kn">import</span> <span class="n">get_code</span>
<span class="c"># doclist</span>
<span class="n">sslist</span> <span class="o">=</span> <span class="n">webnotes</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">doc</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;Stylesheet&#39;</span><span class="p">,</span> <span class="n">stylesheet</span><span class="p">)</span>
<span class="c"># stylesheet from file</span>
<span class="n">css</span> <span class="o">=</span> <span class="n">get_code</span><span class="p">(</span><span class="n">sslist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">module</span><span class="p">,</span> <span class="s">&#39;Stylesheet&#39;</span><span class="p">,</span> <span class="n">stylesheet</span><span class="p">,</span> <span class="s">&#39;css&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">css</span><span class="p">:</span> <span class="n">sslist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">stylesheet</span> <span class="o">=</span> <span class="n">css</span>
<span class="k">return</span> <span class="n">sslist</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[]</span>
</div></div>
<div class="viewcode-block" id="get"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.page.get">[docs]</a><span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the :term:`doclist` of the `Page` specified by `name`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">Page</span><span class="p">(</span><span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="getpage"><a class="viewcode-back" href="../../../webnotes.widgets.html#webnotes.widgets.page.getpage">[docs]</a><span class="k">def</span> <span class="nf">getpage</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Load the page from `webnotes.form` and send it via `webnotes.response`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">doclist</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">webnotes</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getvalue</span><span class="p">(</span><span class="s">&#39;name&#39;</span><span class="p">))</span>
<span class="c"># send</span>
<span class="n">webnotes</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">&#39;docs&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">doclist</span>
</div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/wnflogo200.gif" alt="Logo"/>
</a></p>
<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"
>index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../index.html">WNFramework v1.8 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Module code</a> &raquo;</li>
<li><a href="../../webnotes.html" >webnotes</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>