| <!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:33 CET 2023 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CommonMarkupOutputFormat (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="CommonMarkupOutputFormat (FreeMarker 2.3.32 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":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/CommonMarkupOutputFormat.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/CommandLine.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../freemarker/core/CommonTemplateMarkupOutputModel.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/CommonMarkupOutputFormat.html" target="_top">Frames</a></li> |
| <li><a href="CommonMarkupOutputFormat.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 CommonMarkupOutputFormat" class="title">Class CommonMarkupOutputFormat<MO extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">freemarker.core.OutputFormat</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">freemarker.core.MarkupOutputFormat</a><MO></li> |
| <li> |
| <ul class="inheritance"> |
| <li>freemarker.core.CommonMarkupOutputFormat<MO></li> |
| </ul> |
| </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/CombinedMarkupOutputFormat.html" title="class in freemarker.core">CombinedMarkupOutputFormat</a>, <a href="../../freemarker/core/HTMLOutputFormat.html" title="class in freemarker.core">HTMLOutputFormat</a>, <a href="../../freemarker/core/RTFOutputFormat.html" title="class in freemarker.core">RTFOutputFormat</a>, <a href="../../freemarker/core/XMLOutputFormat.html" title="class in freemarker.core">XMLOutputFormat</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">CommonMarkupOutputFormat<MO extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></span> |
| extends <a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><MO></pre> |
| <div class="block">Common superclass for implementing <a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core"><code>MarkupOutputFormat</code></a>-s that use a <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core"><code>CommonTemplateMarkupOutputModel</code></a> |
| subclass.</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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#CommonMarkupOutputFormat--">CommonMarkupOutputFormat</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="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#concat-MO-MO-">concat</a></span>(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo1, |
| <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo2)</code> |
| <div class="block">Returns a <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> that contains the content of both <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> |
| objects concatenated.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#fromMarkup-java.lang.String-">fromMarkup</a></span>(java.lang.String markupText)</code> |
| <div class="block">Wraps a <code>String</code> that's already markup to <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> interface, to indicate its |
| format.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-">fromPlainTextByEscaping</a></span>(java.lang.String textToEsc)</code> |
| <div class="block">Converts a <code>String</code> that's assumed to be plain text to <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>, by escaping any |
| special characters in the plain text.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#getMarkupString-MO-">getMarkupString</a></span>(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo)</code> |
| <div class="block">Returns the content as markup text; never <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#getSourcePlainText-MO-">getSourcePlainText</a></span>(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo)</code> |
| <div class="block">If this <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> was created with <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a>, it returns |
| the original plain text, otherwise it returns <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#isAutoEscapedByDefault--">isAutoEscapedByDefault</a></span>()</code> |
| <div class="block">Tells if by default auto-escaping should be on for this format.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#isEmpty-MO-">isEmpty</a></span>(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo)</code> |
| <div class="block">Returns if the markup is empty (0 length).</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#isOutputFormatMixingAllowed--">isOutputFormatMixingAllowed</a></span>()</code> |
| <div class="block">Tells if this output format allows inserting <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>-s of another output formats into |
| it.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#newTemplateMarkupOutputModel-java.lang.String-java.lang.String-">newTemplateMarkupOutputModel</a></span>(java.lang.String plainTextContent, |
| java.lang.String markupContent)</code> |
| <div class="block">Creates a new <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core"><code>CommonTemplateMarkupOutputModel</code></a> that's bound to this <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#output-MO-java.io.Writer-">output</a></span>(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo, |
| java.io.Writer out)</code> |
| <div class="block">Prints the parameter model to the output.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CommonMarkupOutputFormat.html#output-java.lang.String-java.io.Writer-">output</a></span>(java.lang.String textToEsc, |
| java.io.Writer out)</code> |
| <div class="block">Equivalent to calling <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a> and then |
| <a href="../../freemarker/core/MarkupOutputFormat.html#output-MO-java.io.Writer-"><code>MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer)</code></a>, but the implementation may use a more efficient solution.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.freemarker.core.MarkupOutputFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a></h3> |
| <code><a href="../../freemarker/core/MarkupOutputFormat.html#escapePlainText-java.lang.String-">escapePlainText</a>, <a href="../../freemarker/core/MarkupOutputFormat.html#isLegacyBuiltInBypassed-java.lang.String-">isLegacyBuiltInBypassed</a>, <a href="../../freemarker/core/MarkupOutputFormat.html#outputForeign-MO2-java.io.Writer-">outputForeign</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.freemarker.core.OutputFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></h3> |
| <code><a href="../../freemarker/core/OutputFormat.html#getMimeType--">getMimeType</a>, <a href="../../freemarker/core/OutputFormat.html#getName--">getName</a>, <a href="../../freemarker/core/OutputFormat.html#toString--">toString</a>, <a href="../../freemarker/core/OutputFormat.html#toStringExtraProperties--">toStringExtraProperties</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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="CommonMarkupOutputFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CommonMarkupOutputFormat</h4> |
| <pre>protected CommonMarkupOutputFormat()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="fromPlainTextByEscaping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromPlainTextByEscaping</h4> |
| <pre>public final <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> fromPlainTextByEscaping(java.lang.String textToEsc) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Converts a <code>String</code> that's assumed to be plain text to <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>, by escaping any |
| special characters in the plain text. This corresponds to <code>?esc</code>, or, to outputting with auto-escaping if |
| that wasn't using <a href="../../freemarker/core/MarkupOutputFormat.html#output-java.lang.String-java.io.Writer-"><code>MarkupOutputFormat.output(String, Writer)</code></a> as an optimization.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-">fromPlainTextByEscaping</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../freemarker/core/MarkupOutputFormat.html#escapePlainText-java.lang.String-"><code>MarkupOutputFormat.escapePlainText(String)</code></a>, |
| <a href="../../freemarker/core/MarkupOutputFormat.html#getSourcePlainText-MO-"><code>MarkupOutputFormat.getSourcePlainText(TemplateMarkupOutputModel)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromMarkup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromMarkup</h4> |
| <pre>public final <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> fromMarkup(java.lang.String markupText) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#fromMarkup-java.lang.String-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Wraps a <code>String</code> that's already markup to <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> interface, to indicate its |
| format. This corresponds to <code>?noEsc</code>. (This methods is allowed to throw <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template"><code>TemplateModelException</code></a> if |
| the parameter markup text is malformed, but it's unlikely that an implementation chooses to parse the parameter |
| until, and if ever, that becomes necessary.)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#fromMarkup-java.lang.String-">fromMarkup</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../freemarker/core/MarkupOutputFormat.html#getMarkupString-MO-"><code>MarkupOutputFormat.getMarkupString(TemplateMarkupOutputModel)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="output-freemarker.core.CommonTemplateMarkupOutputModel-java.io.Writer-"> |
| <!-- --> |
| </a><a name="output-MO-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>output</h4> |
| <pre>public final void output(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo, |
| java.io.Writer out) |
| throws java.io.IOException, |
| <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#output-MO-java.io.Writer-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Prints the parameter model to the output.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#output-MO-java.io.Writer-">output</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| <dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="output-java.lang.String-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>output</h4> |
| <pre>public abstract void output(java.lang.String textToEsc, |
| java.io.Writer out) |
| throws java.io.IOException, |
| <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#output-java.lang.String-java.io.Writer-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Equivalent to calling <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a> and then |
| <a href="../../freemarker/core/MarkupOutputFormat.html#output-MO-java.io.Writer-"><code>MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer)</code></a>, but the implementation may use a more efficient solution.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#output-java.lang.String-java.io.Writer-">output</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| <dd><code><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSourcePlainText-freemarker.core.CommonTemplateMarkupOutputModel-"> |
| <!-- --> |
| </a><a name="getSourcePlainText-MO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourcePlainText</h4> |
| <pre>public final java.lang.String getSourcePlainText(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#getSourcePlainText-MO-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">If this <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> was created with <a href="../../freemarker/core/MarkupOutputFormat.html#fromPlainTextByEscaping-java.lang.String-"><code>MarkupOutputFormat.fromPlainTextByEscaping(String)</code></a>, it returns |
| the original plain text, otherwise it returns <code>null</code>. Useful for converting between different types |
| of markups, as if the source format can be converted to plain text without loss, then that just has to be |
| re-escaped with the target format to do the conversion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#getSourcePlainText-MO-">getSourcePlainText</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <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> |
| <a name="getMarkupString-freemarker.core.CommonTemplateMarkupOutputModel-"> |
| <!-- --> |
| </a><a name="getMarkupString-MO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMarkupString</h4> |
| <pre>public final java.lang.String getMarkupString(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#getMarkupString-MO-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Returns the content as markup text; never <code>null</code>. If this <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> was created |
| with <a href="../../freemarker/core/MarkupOutputFormat.html#fromMarkup-java.lang.String-"><code>MarkupOutputFormat.fromMarkup(String)</code></a>, it might return the original markup text literally, but this is not required |
| as far as the returned markup means the same. If this <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> wasn't created |
| with <a href="../../freemarker/core/MarkupOutputFormat.html#fromMarkup-java.lang.String-"><code>MarkupOutputFormat.fromMarkup(String)</code></a> and it doesn't yet have the markup, it has to generate the markup now.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#getMarkupString-MO-">getMarkupString</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <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> |
| <a name="concat-freemarker.core.CommonTemplateMarkupOutputModel-freemarker.core.CommonTemplateMarkupOutputModel-"> |
| <!-- --> |
| </a><a name="concat-MO-MO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>concat</h4> |
| <pre>public final <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> concat(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo1, |
| <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo2) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#concat-MO-MO-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Returns a <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> that contains the content of both <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> |
| objects concatenated.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#concat-MO-MO-">concat</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <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> |
| <a name="isEmpty-freemarker.core.CommonTemplateMarkupOutputModel-"> |
| <!-- --> |
| </a><a name="isEmpty-MO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>public boolean isEmpty(<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> mo) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#isEmpty-MO-">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Returns if the markup is empty (0 length). This is used by at least <code>?hasContent</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#isEmpty-MO-">isEmpty</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <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> |
| <a name="isOutputFormatMixingAllowed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOutputFormatMixingAllowed</h4> |
| <pre>public boolean isOutputFormatMixingAllowed()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/OutputFormat.html#isOutputFormatMixingAllowed--">OutputFormat</a></code></span></div> |
| <div class="block">Tells if this output format allows inserting <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a>-s of another output formats into |
| it. |
| |
| <p>If <code>true</code>, the foreign <a href="../../freemarker/core/TemplateMarkupOutputModel.html" title="interface in freemarker.core"><code>TemplateMarkupOutputModel</code></a> will be inserted into the output. If the current |
| output format is a <a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core"><code>MarkupOutputFormat</code></a> this is done using the |
| <a href="../../freemarker/core/MarkupOutputFormat.html#outputForeign-MO2-java.io.Writer-"><code>MarkupOutputFormat.outputForeign(TemplateMarkupOutputModel, Writer)</code></a> method, which can implement smart |
| conversions. The default behavior (and the only behavior for non-markup outputs) is to behave as if the surrounding |
| output format was the same; this is usually a bad idea to allow, as such an event could |
| indicate application bugs. |
| |
| <p>If this method returns <code>false</code> (recommended), then FreeMarker will try to assimilate the inserted value by |
| converting its format to this format, which will currently (2.3.24) cause exception, unless the inserted value is |
| made by escaping plain text and the target format is non-escaping, in which case format conversion is trivially |
| possible. (It's not impossible that conversions will be extended beyond this, if there will be demand for that.) |
| |
| <p> |
| <code>true</code> value is used by <a href="../../freemarker/core/UndefinedOutputFormat.html" title="class in freemarker.core"><code>UndefinedOutputFormat</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/OutputFormat.html#isOutputFormatMixingAllowed--">isOutputFormatMixingAllowed</a></code> in class <code><a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core">OutputFormat</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAutoEscapedByDefault--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAutoEscapedByDefault</h4> |
| <pre>public boolean isAutoEscapedByDefault()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/MarkupOutputFormat.html#isAutoEscapedByDefault--">MarkupOutputFormat</a></code></span></div> |
| <div class="block">Tells if by default auto-escaping should be on for this format. It should be <code>true</code> if you need to escape |
| on most of the places where you insert values.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../freemarker/core/MarkupOutputFormat.html#isAutoEscapedByDefault--">isAutoEscapedByDefault</a></code> in class <code><a href="../../freemarker/core/MarkupOutputFormat.html" title="class in freemarker.core">MarkupOutputFormat</a><<a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> extends <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core">CommonTemplateMarkupOutputModel</a>></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../freemarker/template/Configuration.html#setAutoEscapingPolicy-int-"><code>Configuration.setAutoEscapingPolicy(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newTemplateMarkupOutputModel-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newTemplateMarkupOutputModel</h4> |
| <pre>protected abstract <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="type parameter in CommonMarkupOutputFormat">MO</a> newTemplateMarkupOutputModel(java.lang.String plainTextContent, |
| java.lang.String markupContent) |
| throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> |
| <div class="block">Creates a new <a href="../../freemarker/core/CommonTemplateMarkupOutputModel.html" title="class in freemarker.core"><code>CommonTemplateMarkupOutputModel</code></a> that's bound to this <a href="../../freemarker/core/OutputFormat.html" title="class in freemarker.core"><code>OutputFormat</code></a> instance. |
| When this is called from <a href="../../freemarker/core/CommonMarkupOutputFormat.html" title="class in freemarker.core"><code>CommonMarkupOutputFormat</code></a>, exactly one of the parameters will be |
| non-<code>null</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plainTextContent</code> - <code>null</code> if the content is markup that possibly can be described as plain text without loss.</dd> |
| <dd><code>markupContent</code> - Typically will be <code>null</code> if <code>plainTextContent</code> is not <code>null</code>. While the plain text always |
| can be converted to markup via <a href="../../freemarker/core/MarkupOutputFormat.html#escapePlainText-java.lang.String-"><code>MarkupOutputFormat.escapePlainText(String)</code></a>, it's up to the implementation if it wants |
| to do that now and store the markup, or later on demand (like each time when |
| <a href="../../freemarker/core/CommonMarkupOutputFormat.html#getMarkupString-MO-"><code>getMarkupString(CommonTemplateMarkupOutputModel)</code></a> is called).</dd> |
| <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/CommonMarkupOutputFormat.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/CommandLine.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../freemarker/core/CommonTemplateMarkupOutputModel.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/CommonMarkupOutputFormat.html" target="_top">Frames</a></li> |
| <li><a href="CommonMarkupOutputFormat.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> |
