| <!doctype html> |
| <!-- Generated by FreeMarker/Docgen from DocBook --> |
| <html lang="en" class="page-type-section"> |
| <head prefix="og: http://ogp.me/ns#"> |
| <meta charset="utf-8"> |
| <title>Jython wrapper - FreeMarker Manual</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="format-detection" content="telephone=no"> |
| <meta property="og:site_name" content="FreeMarker Manual"> |
| <meta property="og:title" content="Jython wrapper"> |
| <meta property="og:locale" content="en_US"> |
| <meta property="og:url" content="http://example.com/pgui_misc_jythonwrapper.html"> |
| <link rel="canonical" href="http://example.com/pgui_misc_jythonwrapper.html"> |
| <link rel="icon" href="favicon.png" type="image/png"> |
| <link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338517553"> |
| </head> |
| <body itemscope itemtype="https://schema.org/Code"> |
| <meta itemprop="url" content="http://example.com/"> |
| <meta itemprop="name" content="FreeMarker Manual"> |
| |
| <!--[if lte IE 9]> |
| <div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div> |
| <![endif]--><div class="header-top-bg"><div class="site-width header-top"><a class="logo" href="http://example.com" role="banner"> <img itemprop="image" src="logo.png" alt="My Logo"> |
| </a></div></div><div class="header-bottom-bg"><div class="site-width search-row"><a href="index.html" class="navigation-header">FreeMarker Manual</a><div class="navigation-header"></div></div><div class="site-width breadcrumb-row"><ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="index.html"><span itemprop="name">FreeMarker Manual</span></a></li><li class="step-1" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui.html"><span itemprop="name">Programmer's Guide</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc.html"><span itemprop="name">Miscellaneous</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc_jythonwrapper.html"><span itemprop="name">Jython wrapper</span></a></li></ul><div class="bookmarks" title="Bookmarks"><span class="sr-only">Bookmarks:</span><ul class="bookmark-list"><li><a href="alphaidx.html">Index</a></li><li><a href="gloss.html">Glossary</a></li><li><a href="ref.html">Reference</a></li><li><a href="app_faq.html">FAQ</a></li><li><a href="preface.html#test_target">Bőregér</a></li></ul></div></div></div> <div class="main-content site-width"> |
| <div class="content-wrapper no-toc"> |
| <div id="table-of-contents-wrapper" class="col-left"> |
| </div> |
| <div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="pgui_misc_ant.html"><span>Previous</span></a><a class="paging-arrow next" href="xgui.html"><span>Next</span></a></div><div class="title-wrapper"> |
| <h1 class="content-header header-section1" id="pgui_misc_jythonwrapper" itemprop="headline">Jython wrapper</h1> |
| </div></div><div class="page-menu"> |
| <div class="page-menu-title">Page Contents</div> |
| <ul><li><a class="page-menu-link" href="#autoid_63" data-menu-target="autoid_63">TemplateHashModel functionality</a></li><li><a class="page-menu-link" href="#autoid_64" data-menu-target="autoid_64">TemplateScalarModel functionality</a></li><li><a class="page-menu-link" href="#autoid_65" data-menu-target="autoid_65">TemplateBooleanModel functionality</a></li><li><a class="page-menu-link" href="#autoid_66" data-menu-target="autoid_66">TemplateNumberModel functionality</a></li><li><a class="page-menu-link" href="#autoid_67" data-menu-target="autoid_67">TemplateSequenceModel functionality</a></li></ul> </div><p>The <code class="inline-code">freemarker.ext.jython</code> package consists of |
| models that enable any Jython object to be used as a |
| <code class="inline-code">TemplateModel</code>. In the very basic case, you only |
| need to call the</p> |
| |
| <div class="code-wrapper"><pre class="code-block code-unspecified">public TemplateModel wrap(Object obj);</pre></div><p>method of the |
| <code class="inline-code">freemarker.ext.jython.JythonWrapper</code> class. This |
| method will wrap the passed object into an appropriate |
| <code class="inline-code">TemplateModel</code>. Below is a summary of the properties |
| of returned model wrappers. Let's assume that the model that resulted |
| from the <code class="inline-code">JythonWrapper</code> call on object |
| <code class="inline-code">obj</code> is named <code class="inline-code">model</code> in the |
| template model root for the sake of the following discussion.</p> |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_63">TemplateHashModel functionality</h2> |
| |
| |
| <p><code class="inline-code">PyDictionary</code> and |
| <code class="inline-code">PyStringMap</code> will be wrapped into a hash model. |
| Key lookups are mapped to the <code class="inline-code">__finditem__</code> |
| method; if an item is not found, a model for <code class="inline-code">None</code> |
| is returned.</p> |
| |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_64">TemplateScalarModel functionality</h2> |
| |
| |
| <p>Every python object will implement |
| <code class="inline-code">TemplateScalarModel</code> whose |
| <code class="inline-code">getAsString()</code> method simply delegates to |
| <code class="inline-code">toString()</code>.</p> |
| |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_65">TemplateBooleanModel functionality</h2> |
| |
| |
| <p>Every python object will implement |
| <code class="inline-code">TemplateBooleanModel</code> whose |
| <code class="inline-code">getAsBoolean()</code> method simply delegates to |
| <code class="inline-code">__nonzero__()</code> in accordance with Python semantics |
| of true/false.</p> |
| |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_66">TemplateNumberModel functionality</h2> |
| |
| |
| <p>Model wrappers for <code class="inline-code">PyInteger</code>, |
| <code class="inline-code">PyLong</code>, and <code class="inline-code">PyFloat</code> objects |
| implement <code class="inline-code">TemplateNumberModel</code> whose |
| <code class="inline-code">getAsNumber()</code> method returns |
| <code class="inline-code">__tojava__(java.lang.Number.class)</code>.</p> |
| |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_67">TemplateSequenceModel functionality</h2> |
| |
| |
| <p>Model wrappers for all classes that extend |
| <code class="inline-code">PySequence</code> will implement |
| <code class="inline-code">TemplateSequenceModel</code> and thus their elements |
| will be accessible by index using the <code class="inline-code">model[i]</code> |
| syntax, which will delegate to <code class="inline-code">__finditem__(i)</code>. |
| You can also query the length of the array or the size of the list |
| using the <code class="inline-code">model?size</code> built-in, which will |
| delegate to <code class="inline-code">__len__()</code>.</p> |
| <div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="pgui_misc_ant.html"><span>Previous</span></a><a class="paging-arrow next" href="xgui.html"><span>Next</span></a></div></div></div></div> </div> |
| </div> |
| <div class="site-footer"><div class="site-width"><div class="footer-bottom"> <p class="last-generated"> |
| Last generated: |
| <time itemprop="dateModified" datetime="2020-07-09T23:48:37Z" title="Thursday, July 9, 2020 11:48:37 PM GMT">2020-07-09 23:48:37 GMT</time> </p> |
| <p class="copyright"> |
| © <span itemprop="copyrightYear">1999</span>–2020 |
| <a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="https://apache.org/">The Apache Software Foundation</a> </p> |
| </div></div></div></body> |
| </html> |
