http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html index e2ee9b0..a015632 100644 --- a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html +++ b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerContext.html @@ -133,7 +133,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.65">HtmlDocSerializerContext</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.66">HtmlDocSerializerContext</a> extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" title="class in org.apache.juneau.html">HtmlSerializerContext</a></pre> <div class="block">Properties associated with the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> class. <p> @@ -157,11 +157,12 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <p class='bcode'> <ja>@RestResource</ja>( messages=<js>"nls/AddressBookResource"</js>, - title=<js>"$L{title}"</js>, <jc>// or pageTitle</jc> - description=<js>"$L{description}"</js>, <jc>// or pageText</jc> - pageLinks=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js> + htmldoc=<ja>@HtmlDoc</ja>( + title=<js>"$L{title}"</js>, + description=<js>"$L{description}"</js>, + links=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js> + ) ) - <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault { </p> <p> @@ -199,22 +200,46 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports">HTMLDOC_cssImports</a></span></code> -<div class="block"><b>Configuration property:</b> CSS imports.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_aside">HTMLDOC_aside</a></span></code> +<div class="block"><b>Configuration property:</b> Aside section contents.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports_add">HTMLDOC_cssImports_add</a></span></code> -<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports"><code>HTMLDOC_cssImports</code></a> property.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css">HTMLDOC_css</a></span></code> +<div class="block"><b>Configuration property:</b> CSS code.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css_add">HTMLDOC_css_add</a></span></code> +<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css"><code>HTMLDOC_css</code></a> property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl">HTMLDOC_cssUrl</a></span></code> <div class="block"><b>Configuration property:</b> Stylesheet URL.</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_description">HTMLDOC_description</a></span></code> +<div class="block"><b>Configuration property:</b> Page description.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_footer">HTMLDOC_footer</a></span></code> +<div class="block"><b>Configuration property:</b> Footer section contents.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_header">HTMLDOC_header</a></span></code> +<div class="block"><b>Configuration property:</b> Header section contents.</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links">HTMLDOC_links</a></span></code> @@ -229,14 +254,26 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nav">HTMLDOC_nav</a></span></code> +<div class="block"><b>Configuration property:</b> Nav section contents.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_noResultsMessage">HTMLDOC_noResultsMessage</a></span></code> +<div class="block"><b>Configuration property:</b> No-results message.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nowrap">HTMLDOC_nowrap</a></span></code> <div class="block"><b>Configuration property:</b> Prevent word wrap on page.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_text">HTMLDOC_text</a></span></code> -<div class="block"><b>Configuration property:</b> Page description.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_template">HTMLDOC_template</a></span></code> +<div class="block"><b>Configuration property:</b> HTML document template.</div> </td> </tr> <tr class="rowColor"> @@ -355,7 +392,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <ul class="blockList"> <li class="blockList"> <h4>HTMLDOC_title</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.111">HTMLDOC_title</a></pre> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.123">HTMLDOC_title</a></pre> <div class="block"><b>Configuration property:</b> Page title. <p> <ul> @@ -392,25 +429,36 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <p> Shortcuts on <ja>@RestResource</ja> are also provided for this setting: <p class='bcode'> + <jc>// Example if you want the swagger doc and HTML doc to share the same title.</jc> <ja>@RestResource</ja>( messages=<js>"nls/AddressBookResource"</js>, - title=<js>"My title"</js>, <jc>// or pageTitle</jc> + title=<js>"My title"</js> ) - <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault { - </p></div> + + <jc>// Example if you want the swagger doc and HTML doc to share the same title.</jc> + <ja>@RestResource</ja>( + messages=<js>"nls/AddressBookResource"</js>, + title=<js>"My title in Swagger"</js>, + htmldoc=<ja>@HtmlDoc</ja>( + title=<js>"My title in HTML"</js> + ) + ) + </p> + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_title">Constant Field Values</a></dd> </dl> </li> </ul> -<a name="HTMLDOC_text"> +<a name="HTMLDOC_description"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>HTMLDOC_text</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.157">HTMLDOC_text</a></pre> +<h4>HTMLDOC_description</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.180">HTMLDOC_description</a></pre> <div class="block"><b>Configuration property:</b> Page description. <p> <ul> @@ -447,15 +495,64 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <p> Shortcuts on <ja>@RestResource</ja> are also provided for this setting: <p class='bcode'> + <jc>// Example if you want the swagger doc and HTML doc to share the same description.</jc> <ja>@RestResource</ja>( messages=<js>"nls/AddressBookResource"</js>, - description=<js>"My description"</js>, <jc>// or pageText</jc> + description=<js>"My description"</js> ) - <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault { - </p></div> + + <jc>// Example if you want the swagger doc and HTML doc to share the same description.</jc> + <ja>@RestResource</ja>( + messages=<js>"nls/AddressBookResource"</js>, + description=<js>"My description in Swagger"</js>, + htmldoc=<ja>@HtmlDoc</ja>( + description=<js>"My description in HTML"</js> + ) + ) + </p> + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_text">Constant Field Values</a></dd> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_description">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HTMLDOC_header"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTMLDOC_header</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.209">HTMLDOC_header</a></pre> +<div class="block"><b>Configuration property:</b> Header section contents. + <p> + <ul> + <li><b>Name:</b> <js>"HtmlDocSerializer.header"</js> + <li><b>Data type:</b> <code>String</code> + <li><b>Default:</b> <jk>null</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <p> + Allows you to override the contents of the header section on the HTML page. + The header section normally contains the title and description at the top of the page. + <p> + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + nav=<js>"<p class='special-navigation'>This is my special navigation content</p>"</js> + ) + ) + </p> + <p> + When this property is specified, the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_title"><code>HTMLDOC_title</code></a> and <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_description"><code>HTMLDOC_description</code></a> properties are ignored. + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_header">Constant Field Values</a></dd> </dl> </li> </ul> @@ -465,7 +562,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <ul class="blockList"> <li class="blockList"> <h4>HTMLDOC_links</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.208">HTMLDOC_links</a></pre> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.260">HTMLDOC_links</a></pre> <div class="block"><b>Configuration property:</b> Page links. <p> <ul> @@ -485,7 +582,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" For example, if the servlet path is <js>"http://localhost/myContext/myServlet";</js>, and the URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo";</js>. Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo";</js>) URLs - can also be used. + can also be used in addition to various other protocols specified by <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> such as <js>"servlet:/..."</js>. <h5 class='section'>Example:</h5> <p> @@ -493,7 +590,6 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" </p> <p class='bcode'> <ja>@RestResource</ja>( - messages=<js>"nls/AddressBookResource"</js>, properties={ <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>) } @@ -508,8 +604,9 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" A shortcut on <ja>@RestResource</ja> is also provided for this setting: <p class='bcode'> <ja>@RestResource</ja>( - messages=<js>"nls/AddressBookResource"</js>, - pageLinks=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js> + htmldoc=@HtmlDoc( + links=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js> + ) ) <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault { </p></div> @@ -525,7 +622,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <ul class="blockList"> <li class="blockList"> <h4>HTMLDOC_links_put</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.213">HTMLDOC_links_put</a></pre> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.265">HTMLDOC_links_put</a></pre> <div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links"><code>HTMLDOC_links</code></a> property.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -533,13 +630,185 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" </dl> </li> </ul> +<a name="HTMLDOC_nav"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTMLDOC_nav</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.294">HTMLDOC_nav</a></pre> +<div class="block"><b>Configuration property:</b> Nav section contents. + <p> + <ul> + <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js> + <li><b>Data type:</b> <code>String</code> + <li><b>Default:</b> <jk>null</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <p> + Allows you to override the contents of the nav section on the HTML page. + The nav section normally contains the page links at the top of the page. + <p> + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + nav=<js>"<p class='special-navigation'>This is my special navigation content</p>"</js> + ) + ) + </p> + <p> + When this property is specified, the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links"><code>HTMLDOC_links</code></a> property is ignored. + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_nav">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HTMLDOC_aside"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTMLDOC_aside</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.324">HTMLDOC_aside</a></pre> +<div class="block"><b>Configuration property:</b> Aside section contents. + <p> + <ul> + <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js> + <li><b>Data type:</b> <code>String</code> + <li><b>Default:</b> <jk>null</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <p> + Allows you to specifigy the contents of the aside section on the HTML page. + The aside section floats on the right of the page for providing content supporting the serialized content of + the page. + <p> + By default, the aside section is empty. + <p> + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + aside=<js>"<ul><li>Item 1<li>Item 2<li>Item 3</ul>"</js> + ) + ) + </p> + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_aside">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HTMLDOC_footer"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTMLDOC_footer</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.352">HTMLDOC_footer</a></pre> +<div class="block"><b>Configuration property:</b> Footer section contents. + <p> + <ul> + <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js> + <li><b>Data type:</b> <code>String</code> + <li><b>Default:</b> <jk>null</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <p> + Allows you to specify the contents of the footer section on the HTML page. + <p> + By default, the footer section is empty. + <p> + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + footer=<js>"<b>This interface is great!</b>"</js> + ) + ) + </p> + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_footer">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HTMLDOC_noResultsMessage"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTMLDOC_noResultsMessage</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.378">HTMLDOC_noResultsMessage</a></pre> +<div class="block"><b>Configuration property:</b> No-results message. + <p> + <ul> + <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js> + <li><b>Data type:</b> <code>String</code> + <li><b>Default:</b> <js>"<p>no results</p>"</js> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <p> + Allows you to specify the string message used when trying to serialize an empty array or empty list. + <p> + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + =<js>"<b>This interface is great!</b>"</js> + ) + ) + </p> + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_noResultsMessage">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HTMLDOC_nowrap"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTMLDOC_nowrap</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.392">HTMLDOC_nowrap</a></pre> +<div class="block"><b>Configuration property:</b> Prevent word wrap on page. + <p> + <ul> + <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js> + <li><b>Data type:</b> <code>Boolean</code> + <li><b>Default:</b> <jk>false</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <p> + Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_nowrap">Constant Field Values</a></dd> +</dl> +</li> +</ul> <a name="HTMLDOC_cssUrl"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>HTMLDOC_cssUrl</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.230">HTMLDOC_cssUrl</a></pre> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.411">HTMLDOC_cssUrl</a></pre> <div class="block"><b>Configuration property:</b> Stylesheet URL. <p> <ul> @@ -552,70 +821,102 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" Adds a link to the specified stylesheet URL. <p> If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>. - Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.</div> + Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation. + <p> + A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_cssUrl">Constant Field Values</a></dd> </dl> </li> </ul> -<a name="HTMLDOC_cssImports"> +<a name="HTMLDOC_css"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>HTMLDOC_cssImports</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.244">HTMLDOC_cssImports</a></pre> -<div class="block"><b>Configuration property:</b> CSS imports. +<h4>HTMLDOC_css</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.443">HTMLDOC_css</a></pre> +<div class="block"><b>Configuration property:</b> CSS code. <p> <ul> - <li><b>Name:</b> <js>"HtmlDocSerializer.cssImports.list"</js> + <li><b>Name:</b> <js>"HtmlDocSerializer.css.list"</js> <li><b>Data type:</b> <code>List<String></code> <li><b>Default:</b> empty list <li><b>Session-overridable:</b> <jk>true</jk> </ul> <p> - Imports the specified CSS page URLs into the page.</div> + Adds the specified CSS instructions to the HTML page. + + <h5 class='section'>Example:</h5> + </p> + <p class='bcode'> + <ja>@RestResource</ja>( + properties={ + <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_css</jsf>, value=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js>) + } + ) + </p> + A shortcut on <ja>@RestResource</ja> is also provided for this setting: + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=@HtmlDoc( + css=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js> + ) + ) + </p></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_cssImports">Constant Field Values</a></dd> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_css">Constant Field Values</a></dd> </dl> </li> </ul> -<a name="HTMLDOC_cssImports_add"> +<a name="HTMLDOC_css_add"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>HTMLDOC_cssImports_add</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.249">HTMLDOC_cssImports_add</a></pre> -<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports"><code>HTMLDOC_cssImports</code></a> property.</div> +<h4>HTMLDOC_css_add</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.448">HTMLDOC_css_add</a></pre> +<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css"><code>HTMLDOC_css</code></a> property.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_cssImports_add">Constant Field Values</a></dd> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_css_add">Constant Field Values</a></dd> </dl> </li> </ul> -<a name="HTMLDOC_nowrap"> +<a name="HTMLDOC_template"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>HTMLDOC_nowrap</h4> -<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.263">HTMLDOC_nowrap</a></pre> -<div class="block"><b>Configuration property:</b> Prevent word wrap on page. +<h4>HTMLDOC_template</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.474">HTMLDOC_template</a></pre> +<div class="block"><b>Configuration property:</b> HTML document template. <p> <ul> - <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js> - <li><b>Data type:</b> <code>Boolean</code> - <li><b>Default:</b> <jk>false</jk> + <li><b>Name:</b> <js>"HtmlDocSerializer.template"</js> + <li><b>Data type:</b> <code>Class<? <jk>extends</jk> HtmlDocTemplate></code> or <a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html"><code>HtmlDocTemplate</code></a> + <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code> <li><b>Session-overridable:</b> <jk>true</jk> </ul> <p> - Adds <js>"* {white-space:nowrap}"</js> to the style header to prevent word wrapping.</div> + Specifies the template to use for serializing the page. + <p> + By default, the <a href="../../../../org/apache/juneau/html/HtmlDocTemplateBasic.html" title="class in org.apache.juneau.html"><code>HtmlDocTemplateBasic</code></a> class is used to construct the contents of the HTML page, but + can be overridden with your own custom implementation class. + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=@HtmlDoc( + template=MySpecialDocTemplate.<jk>class</jk> + ) + ) + </p></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_nowrap">Constant Field Values</a></dd> +<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializerContext.HTMLDOC_template">Constant Field Values</a></dd> </dl> </li> </ul> @@ -633,7 +934,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <ul class="blockListLast"> <li class="blockList"> <h4>HtmlDocSerializerContext</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.277">HtmlDocSerializerContext</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.490">HtmlDocSerializerContext</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre> <div class="block">Constructor. <p> Typically only called from <a href="../../../../org/apache/juneau/PropertyStore.html#getContext-java.lang.Class-"><code>PropertyStore.getContext(Class)</code></a>.</div> @@ -657,7 +958,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerContext.html" <ul class="blockListLast"> <li class="blockList"> <h4>asMap</h4> -<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.288">asMap</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerContext.html#line.507">asMap</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/Context.html#asMap--">Context</a></code></span></div> <div class="block">Returns the properties defined on this bean context as a simple map for debugging purposes.</div> <dl>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerSession.html b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerSession.html index 35fc7cb..e7466ed 100644 --- a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerSession.html +++ b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializerSession.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html" title="class in org.apache.juneau.html"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/html/HtmlLink.html" title="annotation in org.apache.juneau.html"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/html/HtmlDocSerializerSession.html" target="_top">Frames</a></li> @@ -133,7 +133,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.33">HtmlDocSerializerSession</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.34">HtmlDocSerializerSession</a> extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" title="class in org.apache.juneau.html">HtmlSerializerSession</a></pre> <div class="block">Context object that lives for the duration of a single serialization of <a href="../../../../org/apache/juneau/html/HtmlSerializer.html" title="class in org.apache.juneau.html"><code>HtmlSerializer</code></a> and its subclasses. <p> @@ -202,42 +202,78 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" <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/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getCssImports--">getCssImports</a></span>()</code> -<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports"><code>HtmlDocSerializerContext.HTMLDOC_cssImports</code></a> setting value in this context.</div> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getAside--">getAside</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_aside"><code>HtmlDocSerializerContext.HTMLDOC_aside</code></a> setting value in this context.</div> </td> </tr> <tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getCss--">getCss</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css"><code>HtmlDocSerializerContext.HTMLDOC_css</code></a> setting value in this context.</div> +</td> +</tr> +<tr id="i2" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getCssUrl--">getCssUrl</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl"><code>HtmlDocSerializerContext.HTMLDOC_cssUrl</code></a> setting value in this context.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getDescription--">getDescription</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_description"><code>HtmlDocSerializerContext.HTMLDOC_description</code></a> setting value in this context.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getFooter--">getFooter</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_footer"><code>HtmlDocSerializerContext.HTMLDOC_footer</code></a> setting value in this context.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getHeader--">getHeader</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_header"><code>HtmlDocSerializerContext.HTMLDOC_header</code></a> setting value in this context.</div> +</td> +</tr> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getLinks--">getLinks</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links"><code>HtmlDocSerializerContext.HTMLDOC_links</code></a> setting value in this context.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getText--">getText</a></span>()</code> -<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_text"><code>HtmlDocSerializerContext.HTMLDOC_text</code></a> setting value in this context.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getNav--">getNav</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nav"><code>HtmlDocSerializerContext.HTMLDOC_nav</code></a> setting value in this context.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getNoResultsMessage--">getNoResultsMessage</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_noResultsMessage"><code>HtmlDocSerializerContext.HTMLDOC_noResultsMessage</code></a> setting value in this context.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getTemplate--">getTemplate</a></span>()</code> +<div class="block">Returns the template to use for generating the HTML page.</div> +</td> +</tr> +<tr id="i10" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getTitle--">getTitle</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_title"><code>HtmlDocSerializerContext.HTMLDOC_title</code></a> setting value in this context.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/html/HtmlWriter.html" title="class in org.apache.juneau.html">HtmlWriter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#getWriter--">getWriter</a></span>()</code> <div class="block">Wraps the specified output object inside a writer.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html#isNoWrap--">isNoWrap</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nowrap"><code>HtmlDocSerializerContext.HTMLDOC_nowrap</code></a> setting value in this context.</div> @@ -306,7 +342,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" <ul class="blockListLast"> <li class="blockList"> <h4>HtmlDocSerializerSession</h4> -<pre>protected <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.58">HtmlDocSerializerSession</a>(<a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html" title="class in org.apache.juneau.html">HtmlDocSerializerContext</a> ctx, +<pre>protected <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.60">HtmlDocSerializerSession</a>(<a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html" title="class in org.apache.juneau.html">HtmlDocSerializerContext</a> ctx, <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> op, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> javaMethod, @@ -341,31 +377,92 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" <!-- --> </a> <h3>Method Detail</h3> +<a name="getCssUrl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCssUrl</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.97">getCssUrl</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl"><code>HtmlDocSerializerContext.HTMLDOC_cssUrl</code></a> setting value in this context.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl"><code>HtmlDocSerializerContext.HTMLDOC_cssUrl</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> +</dl> +</li> +</ul> +<a name="getCss--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCss</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.106">getCss</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css"><code>HtmlDocSerializerContext.HTMLDOC_css</code></a> setting value in this context.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_css"><code>HtmlDocSerializerContext.HTMLDOC_css</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty array.</dd> +</dl> +</li> +</ul> +<a name="isNoWrap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNoWrap</h4> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.114">isNoWrap</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nowrap"><code>HtmlDocSerializerContext.HTMLDOC_nowrap</code></a> setting value in this context.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nowrap"><code>HtmlDocSerializerContext.HTMLDOC_nowrap</code></a> setting value in this context.</dd> +</dl> +</li> +</ul> <a name="getTitle--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTitle</h4> -<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.82">getTitle</a>()</pre> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.123">getTitle</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_title"><code>HtmlDocSerializerContext.HTMLDOC_title</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_title"><code>HtmlDocSerializerContext.HTMLDOC_title</code></a> setting value in this context.</dd> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_title"><code>HtmlDocSerializerContext.HTMLDOC_title</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> +</dl> +</li> +</ul> +<a name="getDescription--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.132">getDescription</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_description"><code>HtmlDocSerializerContext.HTMLDOC_description</code></a> setting value in this context.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_description"><code>HtmlDocSerializerContext.HTMLDOC_description</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> </dl> </li> </ul> -<a name="getText--"> +<a name="getHeader--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getText</h4> -<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.91">getText</a>()</pre> -<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_text"><code>HtmlDocSerializerContext.HTMLDOC_text</code></a> setting value in this context.</div> +<h4>getHeader</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.141">getHeader</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_header"><code>HtmlDocSerializerContext.HTMLDOC_header</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_text"><code>HtmlDocSerializerContext.HTMLDOC_text</code></a> setting value in this context.</dd> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_header"><code>HtmlDocSerializerContext.HTMLDOC_header</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> </dl> </li> </ul> @@ -375,53 +472,87 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" <ul class="blockList"> <li class="blockList"> <h4>getLinks</h4> -<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.100">getLinks</a>()</pre> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.150">getLinks</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links"><code>HtmlDocSerializerContext.HTMLDOC_links</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links"><code>HtmlDocSerializerContext.HTMLDOC_links</code></a> setting value in this context.</dd> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_links"><code>HtmlDocSerializerContext.HTMLDOC_links</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty map.</dd> </dl> </li> </ul> -<a name="getCssUrl--"> +<a name="getTemplate--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getCssUrl</h4> -<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.109">getCssUrl</a>()</pre> -<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl"><code>HtmlDocSerializerContext.HTMLDOC_cssUrl</code></a> setting value in this context.</div> +<h4>getTemplate</h4> +<pre>public final <a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.159">getTemplate</a>()</pre> +<div class="block">Returns the template to use for generating the HTML page.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl"><code>HtmlDocSerializerContext.HTMLDOC_cssUrl</code></a> setting value in this context.</dd> +<dd>The HTML page generator. + Never <jk>null</jk>.</dd> </dl> </li> </ul> -<a name="getCssImports--"> +<a name="getNav--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getCssImports</h4> -<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.118">getCssImports</a>()</pre> -<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports"><code>HtmlDocSerializerContext.HTMLDOC_cssImports</code></a> setting value in this context.</div> +<h4>getNav</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.168">getNav</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nav"><code>HtmlDocSerializerContext.HTMLDOC_nav</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssImports"><code>HtmlDocSerializerContext.HTMLDOC_cssImports</code></a> setting value in this context.</dd> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nav"><code>HtmlDocSerializerContext.HTMLDOC_nav</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> </dl> </li> </ul> -<a name="isNoWrap--"> +<a name="getAside--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>isNoWrap</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.127">isNoWrap</a>()</pre> -<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nowrap"><code>HtmlDocSerializerContext.HTMLDOC_nowrap</code></a> setting value in this context.</div> +<h4>getAside</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.177">getAside</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_aside"><code>HtmlDocSerializerContext.HTMLDOC_aside</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_nowrap"><code>HtmlDocSerializerContext.HTMLDOC_nowrap</code></a> setting value in this context.</dd> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_aside"><code>HtmlDocSerializerContext.HTMLDOC_aside</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> +</dl> +</li> +</ul> +<a name="getFooter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFooter</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.186">getFooter</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_footer"><code>HtmlDocSerializerContext.HTMLDOC_footer</code></a> setting value in this context.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_footer"><code>HtmlDocSerializerContext.HTMLDOC_footer</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> +</dl> +</li> +</ul> +<a name="getNoResultsMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNoResultsMessage</h4> +<pre>public final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.195">getNoResultsMessage</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_noResultsMessage"><code>HtmlDocSerializerContext.HTMLDOC_noResultsMessage</code></a> setting value in this context.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_noResultsMessage"><code>HtmlDocSerializerContext.HTMLDOC_noResultsMessage</code></a> setting value in this context. + <jk>null</jk> if not specified. Never an empty string.</dd> </dl> </li> </ul> @@ -431,7 +562,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" <ul class="blockListLast"> <li class="blockList"> <h4>getWriter</h4> -<pre>public <a href="../../../../org/apache/juneau/html/HtmlWriter.html" title="class in org.apache.juneau.html">HtmlWriter</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.132">getWriter</a>() +<pre>public <a href="../../../../org/apache/juneau/html/HtmlWriter.html" title="class in org.apache.juneau.html">HtmlWriter</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializerSession.html#line.200">getWriter</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getWriter--">SerializerSession</a></code></span></div> <div class="block">Wraps the specified output object inside a writer. @@ -481,7 +612,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlSerializerSession.html" <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html" title="class in org.apache.juneau.html"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/html/HtmlLink.html" title="annotation in org.apache.juneau.html"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/html/HtmlDocSerializerSession.html" target="_top">Frames</a></li>
