blob: da9fa44702f91308e608e916e084b476c953ef13 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_281) on Sun Jan 15 15:58:36 CET 2023 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>freemarker.ext.jython (FreeMarker 2.3.32 API)</title>
<meta name="date" content="2023-01-15">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="freemarker.ext.jython (FreeMarker 2.3.32 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../freemarker/ext/jsp/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../freemarker/ext/rhino/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?freemarker/ext/jython/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;freemarker.ext.jython</h1>
<div class="docSummary">
<div class="block">Exposes <a href="http://www.jython.org" target="_blank">Jython</a> objects to templates.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../freemarker/ext/jython/JythonHashModel.html" title="class in freemarker.ext.jython">JythonHashModel</a></td>
<td class="colLast">
<div class="block">Model for Jython dictionaries (<code>PyDictionary</code>
and <code>PyStringMap</code>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../freemarker/ext/jython/JythonModel.html" title="class in freemarker.ext.jython">JythonModel</a></td>
<td class="colLast">
<div class="block">Generic model for arbitrary Jython objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../freemarker/ext/jython/JythonNumberModel.html" title="class in freemarker.ext.jython">JythonNumberModel</a></td>
<td class="colLast">
<div class="block">Model for Jython numeric objects (<code>PyInteger</code>, <code>PyLong</code>,
<code>PyFloat</code>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../freemarker/ext/jython/JythonSequenceModel.html" title="class in freemarker.ext.jython">JythonSequenceModel</a></td>
<td class="colLast">
<div class="block">Model for Jython sequence objects (<code>PySequence</code> descendants).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../freemarker/ext/jython/JythonVersionAdapter.html" title="class in freemarker.ext.jython">JythonVersionAdapter</a></td>
<td class="colLast">
<div class="block">Functions that has a different implementation depending on the Jython version
used.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../freemarker/ext/jython/JythonWrapper.html" title="class in freemarker.ext.jython">JythonWrapper</a></td>
<td class="colLast">
<div class="block">An object wrapper that wraps Jython objects into FreeMarker template models
and vice versa.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package freemarker.ext.jython Description">Package freemarker.ext.jython Description</h2>
<div class="block"><p>Exposes <a href="http://www.jython.org" target="_blank">Jython</a> objects to templates.
The <a href="../../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template"><code>default object wrapper</code></a> of FreeMarker
automatically wraps Jython nodes with this.
<p>Most of the issues dealing with Jython objects are handled by the
<a href="../../../freemarker/ext/jython/JythonWrapper.html#wrap-java.lang.Object-"><code>JythonWrapper.wrap(Object)</code></a> method. In
normal cases, this is the only method you should use to turn an
arbitrary Jython object into a FreeMarker
<a href="../../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>. Additionally, you can
manually create instances of any wrapper class using its constructors.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../freemarker/ext/jsp/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../freemarker/ext/rhino/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?freemarker/ext/jython/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>