http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/core/TemplateDateFormat.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/core/TemplateDateFormat.html b/builds/fm2.3.27/api/freemarker/core/TemplateDateFormat.html new file mode 100644 index 0000000..b17a9ed --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/core/TemplateDateFormat.html @@ -0,0 +1,414 @@ +<!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_144) on Wed Sep 20 18:42:01 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateDateFormat (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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="TemplateDateFormat (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateDateFormat.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/core/TemplateConfiguration.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateDateFormatFactory.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateDateFormat.html" target="_top">Frames</a></li> +<li><a href="TemplateDateFormat.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">freemarker.core</div> +<h2 title="Class TemplateDateFormat" class="title">Class TemplateDateFormat</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/TemplateValueFormat.html" title="class in freemarker.core">freemarker.core.TemplateValueFormat</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.TemplateDateFormat</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">TemplateDateFormat</span> +extends <a href="../../freemarker/core/TemplateValueFormat.html" title="class in freemarker.core">TemplateValueFormat</a></pre> +<div class="block">Represents a date/time/dateTime format; used in templates for formatting and parsing with that format. This is + similar to Java's <a href="http://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text"><code>DateFormat</code></a>, but made to fit the requirements of FreeMarker. Also, it makes easier to define + formats that can't be represented with Java's existing <a href="http://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text"><code>DateFormat</code></a> implementations. + + <p> + Implementations need not be thread-safe if the <a href="../../freemarker/core/TemplateNumberFormatFactory.html" title="class in freemarker.core"><code>TemplateNumberFormatFactory</code></a> doesn't recycle them among + different <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>-s. As far as FreeMarker's concerned, instances are bound to a single + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>, and <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>-s are thread-local objects.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormat.html#TemplateDateFormat--">TemplateDateFormat</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormat.html#format-freemarker.template.TemplateDateModel-">format</a></span>(<a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a> dateModel)</code> +<div class="block">Formats the model to markup instead of to plain text if the result markup will be more than just plain text + escaped, otherwise falls back to formatting to plain text.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormat.html#formatToPlainText-freemarker.template.TemplateDateModel-">formatToPlainText</a></span>(<a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a> dateModel)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormat.html#isLocaleBound--">isLocaleBound</a></span>()</code> +<div class="block">Tells if this formatter should be re-created if the locale changes.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormat.html#isTimeZoneBound--">isTimeZoneBound</a></span>()</code> +<div class="block">Tells if this formatter should be re-created if the time zone changes.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormat.html#parse-java.lang.String-int-">parse</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s, + int dateType)</code> +<div class="block">Parsers a string to date/time/datetime, according to this format.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.core.TemplateValueFormat"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/TemplateValueFormat.html" title="class in freemarker.core">TemplateValueFormat</a></h3> +<code><a href="../../freemarker/core/TemplateValueFormat.html#getDescription--">getDescription</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TemplateDateFormat--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TemplateDateFormat</h4> +<pre>public TemplateDateFormat()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="formatToPlainText-freemarker.template.TemplateDateModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>formatToPlainText</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatToPlainText(<a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a> dateModel) + throws <a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a>, + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dateModel</code> - The date/time/dateTime to format; not <code>null</code>. Most implementations will just work with the return value of + <a href="../../freemarker/template/TemplateDateModel.html#getAsDate--"><code>TemplateDateModel.getAsDate()</code></a>, but some may format differently depending on the properties of + a custom <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a> implementation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The date/time/dateTime as text, with no escaping (like no HTML escaping); can't be <code>null</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></code> - When a problem occurs during the formatting of the value. Notable subclass: + <a href="../../freemarker/core/UnknownDateTypeFormattingUnsupportedException.html" title="class in freemarker.core"><code>UnknownDateTypeFormattingUnsupportedException</code></a></dd> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code> - Exception thrown by the <code>dateModel</code> object when calling its methods.</dd> +</dl> +</li> +</ul> +<a name="format-freemarker.template.TemplateDateModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>format</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> format(<a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a> dateModel) + throws <a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a>, + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<div class="block">Formats the model to markup instead of to plain text if the result markup will be more than just plain text + escaped, otherwise falls back to formatting to plain text. If the markup result would be just the result of + <a href="../../freemarker/core/TemplateDateFormat.html#formatToPlainText-freemarker.template.TemplateDateModel-"><code>formatToPlainText(TemplateDateModel)</code></a> escaped, it must return the <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> that + <a href="../../freemarker/core/TemplateDateFormat.html#formatToPlainText-freemarker.template.TemplateDateModel-"><code>formatToPlainText(TemplateDateModel)</code></a> does. + + <p>The implementation in <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a> simply calls <a href="../../freemarker/core/TemplateDateFormat.html#formatToPlainText-freemarker.template.TemplateDateModel-"><code>formatToPlainText(TemplateDateModel)</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> or a <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>; not <code>null</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></code></dd> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +</dl> +</li> +</ul> +<a name="parse-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> parse(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s, + int dateType) + throws <a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></pre> +<div class="block">Parsers a string to date/time/datetime, according to this format. Some format implementations may throw + <a href="../../freemarker/core/ParsingNotSupportedException.html" title="class in freemarker.core"><code>ParsingNotSupportedException</code></a> here.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - The string to parse</dd> +<dd><code>dateType</code> - The expected date type of the result. Not all <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a>-s will care about this; + though those who return a <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a> instead of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> often will. When strings + are parsed via <code>?date</code>, <code>?time</code>, or <code>?datetime</code>, then this parameter is + <a href="../../freemarker/template/TemplateDateModel.html#DATE"><code>TemplateDateModel.DATE</code></a>, <a href="../../freemarker/template/TemplateDateModel.html#TIME"><code>TemplateDateModel.TIME</code></a>, or <a href="../../freemarker/template/TemplateDateModel.html#DATETIME"><code>TemplateDateModel.DATETIME</code></a>, + respectively. This parameter rarely if ever <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a>, but the implementation + that cares about this parameter should be prepared for that. If nothing else, it should throw + <a href="../../freemarker/core/UnknownDateTypeParsingUnsupportedException.html" title="class in freemarker.core"><code>UnknownDateTypeParsingUnsupportedException</code></a> then.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The interpretation of the text either as a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> or <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a>. Typically, a + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a>. <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a> is used if you have to attach some application-specific + meta-information thats also extracted during <a href="../../freemarker/core/TemplateDateFormat.html#formatToPlainText-freemarker.template.TemplateDateModel-"><code>formatToPlainText(TemplateDateModel)</code></a> (so if you format + something and then parse it, you get back an equivalent result). It can't be <code>null</code>. Known issue + (at least in FTL 2): <code>?date</code>/<code>?time</code>/<code>?datetime</code>, when not invoked as a method, can't + return the <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a>, only the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> from inside it, hence the additional + application-specific meta-info will be lost.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></code></dd> +</dl> +</li> +</ul> +<a name="isLocaleBound--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLocaleBound</h4> +<pre>public abstract boolean isLocaleBound()</pre> +<div class="block">Tells if this formatter should be re-created if the locale changes.</div> +</li> +</ul> +<a name="isTimeZoneBound--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isTimeZoneBound</h4> +<pre>public abstract boolean isTimeZoneBound()</pre> +<div class="block">Tells if this formatter should be re-created if the time zone changes. Currently always <code>true</code>.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateDateFormat.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/core/TemplateConfiguration.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateDateFormatFactory.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateDateFormat.html" target="_top">Frames</a></li> +<li><a href="TemplateDateFormat.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/core/TemplateDateFormatFactory.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/core/TemplateDateFormatFactory.html b/builds/fm2.3.27/api/freemarker/core/TemplateDateFormatFactory.html new file mode 100644 index 0000000..3f6a306 --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/core/TemplateDateFormatFactory.html @@ -0,0 +1,342 @@ +<!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_144) on Wed Sep 20 18:42:01 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateDateFormatFactory (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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="TemplateDateFormatFactory (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateDateFormatFactory.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/core/TemplateDateFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateFormatUtil.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateDateFormatFactory.html" target="_top">Frames</a></li> +<li><a href="TemplateDateFormatFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">freemarker.core</div> +<h2 title="Class TemplateDateFormatFactory" class="title">Class TemplateDateFormatFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/TemplateValueFormatFactory.html" title="class in freemarker.core">freemarker.core.TemplateValueFormatFactory</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.TemplateDateFormatFactory</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../freemarker/core/AliasTemplateDateFormatFactory.html" title="class in freemarker.core">AliasTemplateDateFormatFactory</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">TemplateDateFormatFactory</span> +extends <a href="../../freemarker/core/TemplateValueFormatFactory.html" title="class in freemarker.core">TemplateValueFormatFactory</a></pre> +<div class="block">Factory for a certain kind of date/time/dateTime formatting (<a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a>). Usually a singleton + (one-per-VM or one-per-<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>), and so must be thread-safe.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../freemarker/core/Configurable.html#setCustomDateFormats-java.util.Map-"><code>Configurable.setCustomDateFormats(java.util.Map)</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormatFactory.html#TemplateDateFormatFactory--">TemplateDateFormatFactory</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>abstract <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateDateFormatFactory.html#get-java.lang.String-int-java.util.Locale-java.util.TimeZone-boolean-freemarker.core.Environment-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params, + int dateType, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a> timeZone, + boolean zonelessInput, + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env)</code> +<div class="block">Returns a formatter for the given parameters.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TemplateDateFormatFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TemplateDateFormatFactory</h4> +<pre>public TemplateDateFormatFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get-java.lang.String-int-java.util.Locale-java.util.TimeZone-boolean-freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>get</h4> +<pre>public abstract <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a> get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params, + int dateType, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a> timeZone, + boolean zonelessInput, + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env) + throws <a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></pre> +<div class="block">Returns a formatter for the given parameters. + + <p> + The returned formatter can be a new instance or a reused (cached) instance. Note that <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> itself + caches the returned instances, though that cache is lost with the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> (i.e., when the top-level + template execution ends), also it might flushes lot of entries if the locale or time zone is changed during + template execution. So caching on the factory level is still useful, unless creating the formatters is + sufficiently cheap.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>params</code> - The string that further describes how the format should look. For example, when the + <a href="../../freemarker/core/Configurable.html#getDateFormat--"><code>dateFormat</code></a> is <code>"@fooBar 1, 2"</code>, then it will be + <code>"1, 2"</code> (and <code>"@fooBar"</code> selects the factory). The format of this string is up to the + <a href="../../freemarker/core/TemplateDateFormatFactory.html" title="class in freemarker.core"><code>TemplateDateFormatFactory</code></a> implementation. Not <code>null</code>, often an empty string.</dd> +<dd><code>dateType</code> - <a href="../../freemarker/template/TemplateDateModel.html#DATE"><code>TemplateDateModel.DATE</code></a>, <a href="../../freemarker/template/TemplateDateModel.html#TIME"><code>TemplateDateModel.TIME</code></a>, <a href="../../freemarker/template/TemplateDateModel.html#DATETIME"><code>TemplateDateModel.DATETIME</code></a> or + <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a>. Supporting <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a> is not necessary, in + which case the method should throw an <a href="../../freemarker/core/UnknownDateTypeFormattingUnsupportedException.html" title="class in freemarker.core"><code>UnknownDateTypeFormattingUnsupportedException</code></a> exception.</dd> +<dd><code>locale</code> - The locale to format for. Not <code>null</code>. The resulting format should be bound to this locale + forever (i.e. locale changes in the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> must not be followed).</dd> +<dd><code>timeZone</code> - The time zone to format for. Not <code>null</code>. The resulting format must be bound to this time zone + forever (i.e. time zone changes in the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> must not be followed).</dd> +<dd><code>zonelessInput</code> - Indicates that the input Java <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> is not from a time zone aware source. When this is + <code>true</code>, the formatters shouldn't override the time zone provided to its constructor (most + formatters don't do that anyway), and it shouldn't show the time zone, if it can hide it (like a + <a href="http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a> pattern-based formatter may can't do that, as the pattern prescribes what to + show). + <p> + As of FreeMarker 2.3.21, this is <code>true</code> exactly when the date is an SQL "date without time of + the day" (i.e., a <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Date.html?is-external=true" title="class or interface in java.sql"><code>java.sql.Date</code></a>) or an SQL "time of the day" value (i.e., a + <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Time.html?is-external=true" title="class or interface in java.sql"><code>java.sql.Time</code></a>, although this rule can change in future, depending on + configuration settings and such, so you shouldn't rely on this rule, just accept what this parameter + says.</dd> +<dd><code>env</code> - The runtime environment from which the formatting was called. This is mostly meant to be used for + <a href="../../freemarker/core/Environment.html#setCustomState-java.lang.Object-java.lang.Object-"><code>Environment.setCustomState(Object, Object)</code></a>/<a href="../../freemarker/core/Environment.html#getCustomState-java.lang.Object-"><code>Environment.getCustomState(Object)</code></a>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></code> - If any problem occurs while parsing/getting the format. Notable subclasses: + <a href="../../freemarker/core/InvalidFormatParametersException.html" title="class in freemarker.core"><code>InvalidFormatParametersException</code></a> if <code>params</code> is malformed; + <a href="../../freemarker/core/UnknownDateTypeFormattingUnsupportedException.html" title="class in freemarker.core"><code>UnknownDateTypeFormattingUnsupportedException</code></a> if <code>dateType</code> is + <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a> and that's unsupported by this factory.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateDateFormatFactory.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/core/TemplateDateFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateFormatUtil.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateDateFormatFactory.html" target="_top">Frames</a></li> +<li><a href="TemplateDateFormatFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/core/TemplateFormatUtil.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/core/TemplateFormatUtil.html b/builds/fm2.3.27/api/freemarker/core/TemplateFormatUtil.html new file mode 100644 index 0000000..f6ae353 --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/core/TemplateFormatUtil.html @@ -0,0 +1,300 @@ +<!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_144) on Wed Sep 20 18:42:01 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateFormatUtil (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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="TemplateFormatUtil (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateFormatUtil.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/core/TemplateDateFormatFactory.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateFormatUtil.html" target="_top">Frames</a></li> +<li><a href="TemplateFormatUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">freemarker.core</div> +<h2 title="Class TemplateFormatUtil" class="title">Class TemplateFormatUtil</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.TemplateFormatUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">TemplateFormatUtil</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility classes for implementing <a href="../../freemarker/core/TemplateValueFormat.html" title="class in freemarker.core"><code>TemplateValueFormat</code></a>-s.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateFormatUtil.html#checkHasNoParameters-java.lang.String-">checkHasNoParameters</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateFormatUtil.html#getNonNullDate-freemarker.template.TemplateDateModel-">getNonNullDate</a></span>(<a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a> dateModel)</code> +<div class="block">Utility method to extract the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> from an <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a>, and throw + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template"><code>TemplateModelException</code></a> with a standard error message if that's <code>null</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateFormatUtil.html#getNonNullNumber-freemarker.template.TemplateNumberModel-">getNonNullNumber</a></span>(<a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template">TemplateNumberModel</a> numberModel)</code> +<div class="block">Utility method to extract the <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang"><code>Number</code></a> from an <a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template"><code>TemplateNumberModel</code></a>, and throws + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template"><code>TemplateModelException</code></a> with a standard error message if that's <code>null</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="checkHasNoParameters-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkHasNoParameters</h4> +<pre>public static void checkHasNoParameters(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params) + throws <a href="../../freemarker/core/InvalidFormatParametersException.html" title="class in freemarker.core">InvalidFormatParametersException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/core/InvalidFormatParametersException.html" title="class in freemarker.core">InvalidFormatParametersException</a></code></dd> +</dl> +</li> +</ul> +<a name="getNonNullNumber-freemarker.template.TemplateNumberModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNonNullNumber</h4> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> getNonNullNumber(<a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template">TemplateNumberModel</a> numberModel) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a>, + <a href="../../freemarker/core/UnformattableValueException.html" title="class in freemarker.core">UnformattableValueException</a></pre> +<div class="block">Utility method to extract the <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang"><code>Number</code></a> from an <a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template"><code>TemplateNumberModel</code></a>, and throws + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template"><code>TemplateModelException</code></a> with a standard error message if that's <code>null</code>. <a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template"><code>TemplateNumberModel</code></a> + that store <code>null</code> are in principle not allowed, and so are considered to be bugs in the + <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> or <a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template"><code>TemplateNumberModel</code></a> implementation.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +<dd><code><a href="../../freemarker/core/UnformattableValueException.html" title="class in freemarker.core">UnformattableValueException</a></code></dd> +</dl> +</li> +</ul> +<a name="getNonNullDate-freemarker.template.TemplateDateModel-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getNonNullDate</h4> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getNonNullDate(<a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a> dateModel) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<div class="block">Utility method to extract the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> from an <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a>, and throw + <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template"><code>TemplateModelException</code></a> with a standard error message if that's <code>null</code>. <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template"><code>TemplateDateModel</code></a> + that store <code>null</code> are in principle not allowed, and so are considered to be bugs in the + <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> or <a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template"><code>TemplateNumberModel</code></a> implementation.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateFormatUtil.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/core/TemplateDateFormatFactory.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateFormatUtil.html" target="_top">Frames</a></li> +<li><a href="TemplateFormatUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/core/TemplateHTMLOutputModel.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/core/TemplateHTMLOutputModel.html b/builds/fm2.3.27/api/freemarker/core/TemplateHTMLOutputModel.html new file mode 100644 index 0000000..7ebdbe1 --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/core/TemplateHTMLOutputModel.html @@ -0,0 +1,277 @@ +<!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_144) on Wed Sep 20 18:42:01 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateHTMLOutputModel (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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="TemplateHTMLOutputModel (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateHTMLOutputModel.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/core/TemplateFormatUtil.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateHTMLOutputModel.html" target="_top">Frames</a></li> +<li><a href="TemplateHTMLOutputModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">freemarker.core</div> +<h2 title="Class TemplateHTMLOutputModel" class="title">Class TemplateHTMLOutputModel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">freemarker.core.CommonTemplateMarkupOutputModel</a><<a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core">TemplateHTMLOutputModel</a>></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.TemplateHTMLOutputModel</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core">TemplateMarkupOutputModel</a><<a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core">TemplateHTMLOutputModel</a>>, <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">TemplateHTMLOutputModel</span> +extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a><<a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core">TemplateHTMLOutputModel</a>></pre> +<div class="block">Stores HTML markup to be printed; used with <a href="../../freemarker/core/HTMLOutputFormat.html" title="class in freemarker.core"><code>HTMLOutputFormat</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.freemarker.template.TemplateModel"> +<!-- --> +</a> +<h3>Fields inherited from interface freemarker.template.<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></h3> +<code><a href="../../freemarker/template/TemplateModel.html#NOTHING">NOTHING</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../freemarker/core/HTMLOutputFormat.html" title="class in freemarker.core">HTMLOutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/TemplateHTMLOutputModel.html#getOutputFormat--">getOutputFormat</a></span>()</code> +<div class="block">Returns the singleton <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a> object that implements the operations for the "markup output" value.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getOutputFormat--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOutputFormat</h4> +<pre>public <a href="../../freemarker/core/HTMLOutputFormat.html" title="class in freemarker.core">HTMLOutputFormat</a> getOutputFormat()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/core/TemplateMarkupOutputModel.html#getOutputFormat--">TemplateMarkupOutputModel</a></code></span></div> +<div class="block">Returns the singleton <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a> object that implements the operations for the "markup output" value.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/TemplateMarkupOutputModel.html#getOutputFormat--">getOutputFormat</a></code> in interface <code><a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core">TemplateMarkupOutputModel</a><<a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core">TemplateHTMLOutputModel</a>></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html#getOutputFormat--">getOutputFormat</a></code> in class <code><a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a><<a href="../../freemarker/core/TemplateHTMLOutputModel.html" title="class in freemarker.core">TemplateHTMLOutputModel</a>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateHTMLOutputModel.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/core/TemplateFormatUtil.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/TemplateHTMLOutputModel.html" target="_top">Frames</a></li> +<li><a href="TemplateHTMLOutputModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All 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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>