You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/10/20 17:35:13 UTC
[38/51] [partial] incubator-juneau-website git commit: Update
javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/encoders/EncoderMatch.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/encoders/EncoderMatch.html b/content/site/apidocs/org/apache/juneau/encoders/EncoderMatch.html
index 46056c4..8ecff02 100644
--- a/content/site/apidocs/org/apache/juneau/encoders/EncoderMatch.html
+++ b/content/site/apidocs/org/apache/juneau/encoders/EncoderMatch.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>EncoderMatch (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>EncoderMatch (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="EncoderMatch (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="EncoderMatch (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/encoders/GzipEncoder.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/encoders/GzipEncoder.html b/content/site/apidocs/org/apache/juneau/encoders/GzipEncoder.html
index c34c102..05fdc85 100644
--- a/content/site/apidocs/org/apache/juneau/encoders/GzipEncoder.html
+++ b/content/site/apidocs/org/apache/juneau/encoders/GzipEncoder.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GzipEncoder (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>GzipEncoder (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="GzipEncoder (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="GzipEncoder (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/encoders/IdentityEncoder.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/encoders/IdentityEncoder.html b/content/site/apidocs/org/apache/juneau/encoders/IdentityEncoder.html
index ebe353e..7080cb7 100644
--- a/content/site/apidocs/org/apache/juneau/encoders/IdentityEncoder.html
+++ b/content/site/apidocs/org/apache/juneau/encoders/IdentityEncoder.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>IdentityEncoder (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>IdentityEncoder (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="IdentityEncoder (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="IdentityEncoder (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/encoders/package-frame.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/encoders/package-frame.html b/content/site/apidocs/org/apache/juneau/encoders/package-frame.html
index 0b5765c..31587f1 100644
--- a/content/site/apidocs/org/apache/juneau/encoders/package-frame.html
+++ b/content/site/apidocs/org/apache/juneau/encoders/package-frame.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>org.apache.juneau.encoders (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>org.apache.juneau.encoders (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/encoders/package-summary.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/encoders/package-summary.html b/content/site/apidocs/org/apache/juneau/encoders/package-summary.html
index ae04407..558ec73 100644
--- a/content/site/apidocs/org/apache/juneau/encoders/package-summary.html
+++ b/content/site/apidocs/org/apache/juneau/encoders/package-summary.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>org.apache.juneau.encoders (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>org.apache.juneau.encoders (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="org.apache.juneau.encoders (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="org.apache.juneau.encoders (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/encoders/package-tree.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/encoders/package-tree.html b/content/site/apidocs/org/apache/juneau/encoders/package-tree.html
index 354aa8e..597dec6 100644
--- a/content/site/apidocs/org/apache/juneau/encoders/package-tree.html
+++ b/content/site/apidocs/org/apache/juneau/encoders/package-tree.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>org.apache.juneau.encoders Class Hierarchy (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>org.apache.juneau.encoders Class Hierarchy (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="org.apache.juneau.encoders Class Hierarchy (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="org.apache.juneau.encoders Class Hierarchy (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/html/AnchorText.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/html/AnchorText.html b/content/site/apidocs/org/apache/juneau/html/AnchorText.html
new file mode 100644
index 0000000..a1fb1bd
--- /dev/null
+++ b/content/site/apidocs/org/apache/juneau/html/AnchorText.html
@@ -0,0 +1,440 @@
+<!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 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>AnchorText (Apache Juneau 7.0.0-SNAPSHOT)</title>
+<link rel="stylesheet" type="text/css" href="../../../../javadoc.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="AnchorText (Apache Juneau 7.0.0-SNAPSHOT)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":9,"i1":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="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>Prev Class</li>
+<li><a href="../../../../org/apache/juneau/html/HtmlBeanPropertyMeta.html" title="class 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/AnchorText.html" target="_top">Frames</a></li>
+<li><a href="AnchorText.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><a href="#enum.constant.summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
+<li>Field | </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">org.apache.juneau.html</div>
+<h2 title="Enum AnchorText" class="title">Enum AnchorText</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a>></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.juneau.html.AnchorText</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a>></dd>
+</dl>
+<hr>
+<br>
+<pre>public enum <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.18">AnchorText</a>
+extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a>></pre>
+<div class="block">Identifies possible values for the <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_uriAnchorText"><code>HtmlSerializer.HTML_uriAnchorText</code></a> setting.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ENUM CONSTANT SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum.constant.summary">
+<!-- -->
+</a>
+<h3>Enum Constant Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
+<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Enum Constant and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#CONTEXT_RELATIVE">CONTEXT_RELATIVE</a></span></code>
+<div class="block">Same as <a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING"><code>TO_STRING</code></a> but assumes it's a context-relative path.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#LAST_TOKEN">LAST_TOKEN</a></span></code>
+<div class="block">Set to the last token of the URI value.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#PATH_RELATIVE">PATH_RELATIVE</a></span></code>
+<div class="block">Same as <a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING"><code>TO_STRING</code></a> but assumes it's a path-relative path.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#PROPERTY_NAME">PROPERTY_NAME</a></span></code>
+<div class="block">Set to the bean property name.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#SERVLET_RELATIVE">SERVLET_RELATIVE</a></span></code>
+<div class="block">Same as <a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING"><code>TO_STRING</code></a> but assumes it's a servlet-relative path.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING">TO_STRING</a></span></code>
+<div class="block">Set to whatever is returned by <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang"><code>Enum.toString()</code></a> on the object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#URI">URI</a></span></code>
+<div class="block">Set to the URI value.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#URI_ANCHOR">URI_ANCHOR</a></span></code>
+<div class="block">Set to the anchor of the URL.</div>
+</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#valueOf-java.lang.String-">valueOf</a></span>(<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> name)</code>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/html/AnchorText.html#values--">values</a></span>()</code>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
+<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/
api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ENUM CONSTANT DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum.constant.detail">
+<!-- -->
+</a>
+<h3>Enum Constant Detail</h3>
+<a name="PROPERTY_NAME">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PROPERTY_NAME</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.23">PROPERTY_NAME</a></pre>
+<div class="block">Set to the bean property name.</div>
+</li>
+</ul>
+<a name="TO_STRING">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>TO_STRING</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.28">TO_STRING</a></pre>
+<div class="block">Set to whatever is returned by <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang"><code>Enum.toString()</code></a> on the object.</div>
+</li>
+</ul>
+<a name="URI">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>URI</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.33">URI</a></pre>
+<div class="block">Set to the URI value.</div>
+</li>
+</ul>
+<a name="LAST_TOKEN">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>LAST_TOKEN</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.38">LAST_TOKEN</a></pre>
+<div class="block">Set to the last token of the URI value.</div>
+</li>
+</ul>
+<a name="URI_ANCHOR">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>URI_ANCHOR</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.46">URI_ANCHOR</a></pre>
+<div class="block">Set to the anchor of the URL.
+
+ <p>
+ (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)</div>
+</li>
+</ul>
+<a name="CONTEXT_RELATIVE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CONTEXT_RELATIVE</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.51">CONTEXT_RELATIVE</a></pre>
+<div class="block">Same as <a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING"><code>TO_STRING</code></a> but assumes it's a context-relative path.</div>
+</li>
+</ul>
+<a name="SERVLET_RELATIVE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SERVLET_RELATIVE</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.56">SERVLET_RELATIVE</a></pre>
+<div class="block">Same as <a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING"><code>TO_STRING</code></a> but assumes it's a servlet-relative path.</div>
+</li>
+</ul>
+<a name="PATH_RELATIVE">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>PATH_RELATIVE</h4>
+<pre>public static final <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.61">PATH_RELATIVE</a></pre>
+<div class="block">Same as <a href="../../../../org/apache/juneau/html/AnchorText.html#TO_STRING"><code>TO_STRING</code></a> but assumes it's a path-relative path.</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="values--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>values</h4>
+<pre>public static <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a>[] <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.18">values</a>()</pre>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+<pre>
+for (AnchorText c : AnchorText.values())
+ System.out.println(c);
+</pre></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an array containing the constants of this enum type, in the order they are declared</dd>
+</dl>
+</li>
+</ul>
+<a name="valueOf-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>valueOf</h4>
+<pre>public static <a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html">AnchorText</a> <a href="../../../../src-html/org/apache/juneau/html/AnchorText.html#line.18">valueOf</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> name)</pre>
+<div class="block">Returns the enum constant of this type with the specified name.
+The string must match <i>exactly</i> an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the enum constant to be returned.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the enum constant with the specified name</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</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="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>Prev Class</li>
+<li><a href="../../../../org/apache/juneau/html/HtmlBeanPropertyMeta.html" title="class 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/AnchorText.html" target="_top">Frames</a></li>
+<li><a href="AnchorText.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><a href="#enum.constant.summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/">Apache</a>. All rights reserved.</small></p>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/html/HtmlBeanPropertyMeta.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/html/HtmlBeanPropertyMeta.html b/content/site/apidocs/org/apache/juneau/html/HtmlBeanPropertyMeta.html
index 66f68d7..a27d54d 100644
--- a/content/site/apidocs/org/apache/juneau/html/HtmlBeanPropertyMeta.html
+++ b/content/site/apidocs/org/apache/juneau/html/HtmlBeanPropertyMeta.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>HtmlBeanPropertyMeta (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>HtmlBeanPropertyMeta (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="HtmlBeanPropertyMeta (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="HtmlBeanPropertyMeta (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
@@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
-<li>Prev Class</li>
+<li><a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/apache/juneau/html/HtmlClassMeta.html" title="class in org.apache.juneau.html"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
@@ -387,7 +387,7 @@ extends <a href="../../../../org/apache/juneau/BeanPropertyMetaExtended.html" ti
</div>
<div class="subNav">
<ul class="navList">
-<li>Prev Class</li>
+<li><a href="../../../../org/apache/juneau/html/AnchorText.html" title="enum in org.apache.juneau.html"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/apache/juneau/html/HtmlClassMeta.html" title="class in org.apache.juneau.html"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/html/HtmlClassMeta.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/html/HtmlClassMeta.html b/content/site/apidocs/org/apache/juneau/html/HtmlClassMeta.html
index 0ec8c16..93b5e02 100644
--- a/content/site/apidocs/org/apache/juneau/html/HtmlClassMeta.html
+++ b/content/site/apidocs/org/apache/juneau/html/HtmlClassMeta.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>HtmlClassMeta (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>HtmlClassMeta (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="HtmlClassMeta (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="HtmlClassMeta (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/db550d07/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializer.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializer.html b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializer.html
index cba268c..e83c701 100644
--- a/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializer.html
+++ b/content/site/apidocs/org/apache/juneau/html/HtmlDocSerializer.html
@@ -4,7 +4,7 @@
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>HtmlDocSerializer (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)</title>
+<title>HtmlDocSerializer (Apache Juneau 7.0.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="HtmlDocSerializer (Apache Juneau (incubating) 6.4.1-incubating-SNAPSHOT)";
+ parent.document.title="HtmlDocSerializer (Apache Juneau 7.0.0-SNAPSHOT)";
}
}
catch(err) {
@@ -142,7 +142,7 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<br>
-<pre>public class <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.41">HtmlDocSerializer</a>
+<pre>public class <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.72">HtmlDocSerializer</a>
extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.html" title="class in org.apache.juneau.html">HtmlStrippedDocSerializer</a></pre>
<div class="block">Serializes POJOs to HTTP responses as HTML documents.
@@ -157,13 +157,44 @@ extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.ht
Same as <a href="../../../../org/apache/juneau/html/HtmlSerializer.html" title="class in org.apache.juneau.html"><code>HtmlSerializer</code></a>, except wraps the response in <code><xt><html></code>,
<code><xt><head></code>, and <code><xt><body></code> tags so that it can be rendered in a browser.
- <h5 class='section'>Configurable properties:</h5>
+ <p>
+ Configurable properties are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja>
+ annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.
- This class has the following properties associated with it:
- <ul>
- <li><a href="../../../../org/apache/juneau/html/HtmlDocSerializerContext.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializerContext</code></a>
- <li><a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau"><code>BeanContext</code></a>
- </ul></div>
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ messages=<js>"nls/AddressBookResource"</js>,
+ properties={
+ <ja>@Property</ja>(name=HtmlDocSerializer.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>),
+ <ja>@Property</ja>(name=HtmlDocSerializer.<jsf>HTMLDOC_description</jsf>, value=<js>"$L{description}"</js>),
+ <ja>@Property</ja>(name=HtmlDocSerializer.<jsf>HTMLDOC_navlinks</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)
+ }
+ )
+ <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
+ </p>
+
+ <p>
+ Note that shortcut annotations are also provided for these particular settings:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ messages=<js>"nls/AddressBookResource"</js>,
+ htmldoc=<ja>@HtmlDoc</ja>(
+ title=<js>"$L{title}"</js>,
+ description=<js>"$L{description}"</js>,
+ navlinks={
+ <js>"options: ?method=OPTIONS"</js>,
+ <js>"doc: doc"</js>
+ }
+ )
+ )
+ </p>
+
+ <p>
+ The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the
+ <code>messages</code> annotation.
+ These variables are replaced at runtime based on the HTTP request locale.
+ Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.</div>
</li>
</ul>
</div>
@@ -210,20 +241,129 @@ extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.ht
<div class="block">Default serializer, all default settings.</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/HtmlDocSerializer.html#HTMLDOC_aside">HTMLDOC_aside</a></span></code>
+<div class="block"><b>Configuration property:</b> Aside 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/HtmlDocSerializer.html#HTMLDOC_footer">HTMLDOC_footer</a></span></code>
+<div class="block"><b>Configuration property:</b> Footer 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/HtmlDocSerializer.html#HTMLDOC_head">HTMLDOC_head</a></span></code>
+<div class="block"><b>Configuration property:</b> Additional head section content.</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/HtmlDocSerializer.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/HtmlDocSerializer.html#HTMLDOC_links_add">HTMLDOC_links_add</a></span></code>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_head"><code>HTMLDOC_head</code></a> property.</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/HtmlDocSerializer.html#HTMLDOC_nav">HTMLDOC_nav</a></span></code>
+<div class="block"><b>Configuration property:</b> Nav 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/HtmlDocSerializer.html#HTMLDOC_navlinks">HTMLDOC_navlinks</a></span></code>
+<div class="block"><b>Configuration property:</b> Page navigation links.</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/HtmlDocSerializer.html#HTMLDOC_navlinks_add">HTMLDOC_navlinks_add</a></span></code>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_navlinks"><code>HTMLDOC_navlinks</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/HtmlDocSerializer.html#HTMLDOC_noResultsMessage">HTMLDOC_noResultsMessage</a></span></code>
+<div class="block"><b>Configuration property:</b> No-results message.</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/HtmlDocSerializer.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="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/HtmlDocSerializer.html#HTMLDOC_script">HTMLDOC_script</a></span></code>
+<div class="block"><b>Configuration property:</b> Javascript 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/HtmlDocSerializer.html#HTMLDOC_script_add">HTMLDOC_script_add</a></span></code>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_script"><code>HTMLDOC_script</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/HtmlDocSerializer.html#HTMLDOC_style">HTMLDOC_style</a></span></code>
+<div class="block"><b>Configuration property:</b> CSS style 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/HtmlDocSerializer.html#HTMLDOC_style_add">HTMLDOC_style_add</a></span></code>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_style"><code>HTMLDOC_style</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/HtmlDocSerializer.html#HTMLDOC_stylesheet">HTMLDOC_stylesheet</a></span></code>
+<div class="block"><b>Configuration property:</b> Stylesheet import URLs.</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/HtmlDocSerializer.html#HTMLDOC_stylesheet_add">HTMLDOC_stylesheet_add</a></span></code>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_stylesheet"><code>HTMLDOC_stylesheet</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/HtmlDocSerializer.html#HTMLDOC_template">HTMLDOC_template</a></span></code>
+<div class="block"><b>Configuration property:</b> HTML document template.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.html.HtmlSerializer">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.juneau.html.<a href="../../../../org/apache/juneau/html/HtmlSerializer.html" title="class in org.apache.juneau.html">HtmlSerializer</a></h3>
-<code><a href="../../../../org/apache/juneau/html/HtmlSerializer.html#DEFAULT_SQ">DEFAULT_SQ</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#DEFAULT_SQ_READABLE">DEFAULT_SQ_READABLE</a></code></li>
+<code><a href="../../../../org/apache/juneau/html/HtmlSerializer.html#DEFAULT_SQ">DEFAULT_SQ</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#DEFAULT_SQ_READABLE">DEFAULT_SQ_READABLE</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_addBeanTypeProperties">HTML_addBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_addKeyValueTableHeaders">HTML_addKeyValueTableHeaders</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_detectLinksInStrings">HTML_detectLinksInStrings</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_labelParameter">HTML_labelParameter</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_lookForLabelParameters">HTML_lookForLabelParameters</a>, <a href="../../../../org/apache/juneau/html/HtmlSerializer.html#HTML_uriAnchorText">HTML_uriAnchorText</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.xml.XmlSerializer">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.juneau.xml.<a href="../../../../org/apache/juneau/xml/XmlSerializer.html" title="class in org.apache.juneau.xml">XmlSerializer</a></h3>
-<code><a href="../../../../org/apache/juneau/xml/XmlSerializer.html#DEFAULT_NS">DEFAULT_NS</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#DEFAULT_NS_SQ">DEFAULT_NS_SQ</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#DEFAULT_NS_SQ_READABLE">DEFAULT_NS_SQ_READABLE</a></code></li>
+<code><a href="../../../../org/apache/juneau/xml/XmlSerializer.html#DEFAULT_NS">DEFAULT_NS</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#DEFAULT_NS_SQ">DEFAULT_NS_SQ</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#DEFAULT_NS_SQ_READABLE">DEFAULT_NS_SQ_READABLE</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#XML_addBeanTypeProperties">XML_addBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#XML_addNamespaceUrisToRoot">XML_addNamespaceUrisToRoot</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#XML_autoDetectNamespaces">XML_autoDetectNamespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#XML_defaultNamespace">XML_defaultNamespace</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#XML_enableNamespaces">XML_enableNamespaces</a>, <a href="../../../../org/apache/juneau/xml/XmlSerializer.html#XML_namespaces">XML_namespaces</a>, <a href="../.
./../../org/apache/juneau/xml/XmlSerializer.html#XML_xsNamespace">XML_xsNamespace</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.serializer.Serializer">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.juneau.serializer.<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></h3>
+<code><a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_abridged">SERIALIZER_abridged</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_addBeanTypeProperties">SERIALIZER_addBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_detectRecursions">SERIALIZER_detectRecursions</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_ignoreRecursions">SERIALIZER_ignoreRecursions</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_initialDepth">SERIALIZER_initialDepth</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_listener">SERIALIZER_listener</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_maxDepth">SERIALIZER_maxDepth</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_maxIndent">SERIALIZER_maxIndent</a>, <a href="../../../../org/ap
ache/juneau/serializer/Serializer.html#SERIALIZER_quoteChar">SERIALIZER_quoteChar</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_sortCollections">SERIALIZER_sortCollections</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_sortMaps">SERIALIZER_sortMaps</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_trimEmptyCollections">SERIALIZER_trimEmptyCollections</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_trimEmptyMaps">SERIALIZER_trimEmptyMaps</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_trimNullProperties">SERIALIZER_trimNullProperties</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_trimStrings">SERIALIZER_trimStrings</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_uriContext">SERIALIZER_uriContext</a>, <a href="../../../../org/apache/juneau/serialize
r/Serializer.html#SERIALIZER_uriRelativity">SERIALIZER_uriRelativity</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_uriResolution">SERIALIZER_uriResolution</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_useWhitespace">SERIALIZER_useWhitespace</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.CoreObject">
@@ -328,13 +468,577 @@ extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.ht
<!-- -->
</a>
<h3>Field Detail</h3>
+<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/HtmlDocSerializer.html#line.105">HTMLDOC_header</a></pre>
+<div class="block"><b>Configuration property:</b> Header section contents.
+
+ <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.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=<ja>@HtmlDoc</ja>(
+ header={
+ <js>"<h1>My own header</h1>"</js>
+ }
+ )
+ )
+ </p></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_header">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_navlinks">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_navlinks</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/HtmlDocSerializer.html#line.170">HTMLDOC_navlinks</a></pre>
+<div class="block"><b>Configuration property:</b> Page navigation links.
+
+ <ul>
+ <li><b>Name:</b> <js>"HtmlDocSerializer.navlinks.list"</js>
+ <li><b>Data type:</b> <code>String[]</code>
+ <li><b>Default:</b> empty array
+ <li><b>Session-overridable:</b> <jk>true</jk>
+ </ul>
+
+ <p>
+ Adds a list of hyperlinks immediately under the title and description but above the content of the page.
+
+ <p>
+ This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.
+
+ <p>
+ The value is an array of strings with two possible values:
+ <ul>
+ <li>A key-value pair representing a hyperlink label and href:
+ <br><js>"google: http://google.com"</js>
+ <li>Arbitrary HTML.
+ </ul>
+
+ <p>
+ Relative URLs are considered relative to the servlet path.
+ 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 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>
+ The <code>AddressBookResource</code> sample class uses this property...
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_navlinks</jsf>,
+ value=<js>"['options: ?method=OPTIONS', 'doc: doc']"</js>)
+ }
+ )
+ <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
+ </p>
+
+ <p>
+ ...to produce this list of links on the HTML page...
+ <img class='bordered' src='doc-files/HTML_LINKS.png'>
+
+ <p>
+ A shortcut on <ja>@RestResource</ja> is also provided for this setting:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=@HtmlDoc(
+ navlinks={
+ <js>"options: ?method=OPTIONS"</js>,
+ <js>"doc: doc"</js>
+ }
+ )
+ )
+ <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
+ </p></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_navlinks">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_navlinks_add">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_navlinks_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/HtmlDocSerializer.html#line.175">HTMLDOC_navlinks_add</a></pre>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_navlinks"><code>HTMLDOC_navlinks</code></a> property.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_navlinks_add">Constant Field Values</a></dd>
+</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/HtmlDocSerializer.html#line.205">HTMLDOC_nav</a></pre>
+<div class="block"><b>Configuration property:</b> Nav section contents.
+
+ <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.
+
+ <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/HtmlDocSerializer.html#HTMLDOC_navlinks"><code>HTMLDOC_navlinks</code></a> property is ignored.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.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/HtmlDocSerializer.html#line.240">HTMLDOC_aside</a></pre>
+<div class="block"><b>Configuration property:</b> Aside section contents.
+
+ <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 specify 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.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=<ja>@HtmlDoc</ja>(
+ aside={
+ <js>"<ul>"</js>,
+ <js>" <li>Item 1"</js>,
+ <js>" <li>Item 2"</js>,
+ <js>" <li>Item 3"</js>,
+ <js>"</ul>"</js>
+ }
+ )
+ )
+ </p></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.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/HtmlDocSerializer.html#line.269">HTMLDOC_footer</a></pre>
+<div class="block"><b>Configuration property:</b> Footer section contents.
+
+ <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.
+
+ <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></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.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/HtmlDocSerializer.html#line.296">HTMLDOC_noResultsMessage</a></pre>
+<div class="block"><b>Configuration property:</b> No-results message.
+
+ <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.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=<ja>@HtmlDoc</ja>(
+ noResultsMessage=<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.HtmlDocSerializer.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/HtmlDocSerializer.html#line.311">HTMLDOC_nowrap</a></pre>
+<div class="block"><b>Configuration property:</b> Prevent word wrap on page.
+
+ <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.HtmlDocSerializer.HTMLDOC_nowrap">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_stylesheet">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_stylesheet</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/HtmlDocSerializer.html#line.329">HTMLDOC_stylesheet</a></pre>
+<div class="block"><b>Configuration property:</b> Stylesheet import URLs.
+
+ <ul>
+ <li><b>Name:</b> <js>"HtmlDocSerializer.stylesheet"</js>
+ <li><b>Data type:</b> <code>String[]</code>
+ <li><b>Default:</b> empty array
+ <li><b>Session-overridable:</b> <jk>true</jk>
+ </ul>
+
+ <p>
+ Adds a link to the specified stylesheet URL.
+
+ <p>
+ Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_stylesheet">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_stylesheet_add">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_stylesheet_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/HtmlDocSerializer.html#line.334">HTMLDOC_stylesheet_add</a></pre>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_stylesheet"><code>HTMLDOC_stylesheet</code></a> property.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_stylesheet_add">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_style">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_style</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/HtmlDocSerializer.html#line.372">HTMLDOC_style</a></pre>
+<div class="block"><b>Configuration property:</b> CSS style code.
+
+ <ul>
+ <li><b>Name:</b> <js>"HtmlDocSerializer.style.list"</js>
+ <li><b>Data type:</b> <code>String[]</code>
+ <li><b>Default:</b> empty array
+ <li><b>Session-overridable:</b> <jk>true</jk>
+ </ul>
+
+ <p>
+ Adds the specified CSS instructions to the HTML page.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_style</jsf>,
+ value=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js>)
+ }
+ )
+ </p>
+
+ <p>
+ A shortcut on <ja>@RestResource</ja> is also provided for this setting:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=@HtmlDoc(
+ style={
+ <js>"h3 { color: red; }"</js>,
+ <js>"h5 { 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.HtmlDocSerializer.HTMLDOC_style">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_style_add">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_style_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/HtmlDocSerializer.html#line.377">HTMLDOC_style_add</a></pre>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_style"><code>HTMLDOC_style</code></a> property.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_style_add">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_script">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_script</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/HtmlDocSerializer.html#line.414">HTMLDOC_script</a></pre>
+<div class="block"><b>Configuration property:</b> Javascript code.
+
+ <ul>
+ <li><b>Name:</b> <js>"HtmlDocSerializer.script.list"</js>
+ <li><b>Data type:</b> <code>String[]</code>
+ <li><b>Default:</b> empty array
+ <li><b>Session-overridable:</b> <jk>true</jk>
+ </ul>
+
+ <p>
+ Adds the specified Javascript code to the HTML page.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_script</jsf>,
+ value=<js>"alert('hello!');"</js>)
+ }
+ )
+ </p>
+
+ <p>
+ A shortcut on <ja>@RestResource</ja> is also provided for this setting:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=@HtmlDoc(
+ script={
+ <js>"alert('hello!');"</js>
+ }
+ )
+ )
+ </p></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_script">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_script_add">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_script_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/HtmlDocSerializer.html#line.419">HTMLDOC_script_add</a></pre>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_script"><code>HTMLDOC_script</code></a> property.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_script_add">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_head">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_head</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/HtmlDocSerializer.html#line.456">HTMLDOC_head</a></pre>
+<div class="block"><b>Configuration property:</b> Additional head section content.
+
+ <ul>
+ <li><b>Name:</b> <js>"HtmlDocSerializer.head.list"</js>
+ <li><b>Data type:</b> <code>String[]</code>
+ <li><b>Default:</b> empty array
+ <li><b>Session-overridable:</b> <jk>true</jk>
+ </ul>
+
+ <p>
+ Adds the specified HTML content to the head section of the page.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ properties={
+ <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>,
+ value=<js>"['<link rel=\"icon\" href=\"htdocs/mypageicon.ico\">']"</js>)
+ }
+ )
+ </p>
+
+ <p>
+ A shortcut on <ja>@RestResource</ja> is also provided for this setting:
+ <p class='bcode'>
+ <ja>@RestResource</ja>(
+ htmldoc=@HtmlDoc(
+ head={
+ <js>"<link rel='icon' href='$U{servlet:/htdocs/mypageicon.ico}'>"</js>
+ }
+ )
+ )
+ </p></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_head">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_links_add">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>HTMLDOC_links_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/HtmlDocSerializer.html#line.461">HTMLDOC_links_add</a></pre>
+<div class="block"><b>Configuration property:</b> Add to the <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html#HTMLDOC_head"><code>HTMLDOC_head</code></a> property.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.juneau.html.HtmlDocSerializer.HTMLDOC_links_add">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="HTMLDOC_template">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<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/HtmlDocSerializer.html#line.489">HTMLDOC_template</a></pre>
+<div class="block"><b>Configuration property:</b> HTML document template.
+
+ <ul>
+ <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>
+ 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.HtmlDocSerializer.HTMLDOC_template">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
-<pre>public static final <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html">HtmlDocSerializer</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.44">DEFAULT</a></pre>
+<pre>public static final <a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html">HtmlDocSerializer</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.497">DEFAULT</a></pre>
<div class="block">Default serializer, all default settings.</div>
</li>
</ul>
@@ -352,7 +1056,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.ht
<ul class="blockList">
<li class="blockList">
<h4>HtmlDocSerializer</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.54">HtmlDocSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore)</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.511">HtmlDocSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -366,7 +1070,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.ht
<ul class="blockListLast">
<li class="blockList">
<h4>HtmlDocSerializer</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.79">HtmlDocSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore,
+<pre>public <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.536">HtmlDocSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore,
<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> produces,
<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>... accept)</pre>
<div class="block">Constructor.</div>
@@ -403,7 +1107,7 @@ extends <a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.ht
<ul class="blockListLast">
<li class="blockList">
<h4>createSession</h4>
-<pre>public <a href="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html" title="class in org.apache.juneau.html">HtmlDocSerializerSession</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.85">createSession</a>(<a href="../../../../org/apache/juneau/serializer/SerializerSessionArgs.html" title="class in org.apache.juneau.serializer">SerializerSessionArgs</a> args)</pre>
+<pre>public <a href="../../../../org/apache/juneau/html/HtmlDocSerializerSession.html" title="class in org.apache.juneau.html">HtmlDocSerializerSession</a> <a href="../../../../src-html/org/apache/juneau/html/HtmlDocSerializer.html#line.542">createSession</a>(<a href="../../../../org/apache/juneau/serializer/SerializerSessionArgs.html" title="class in org.apache.juneau.serializer">SerializerSessionArgs</a> args)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession-org.apache.juneau.serializer.SerializerSessionArgs-">Serializer</a></code></span></div>
<div class="block">Create the session object used for actual serialization of objects.</div>
<dl>