http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html index 4940d59..0b87a47 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html @@ -20,630 +20,652 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.html;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import java.util.*;<a name="line.15"></a> +<span class="sourceLineNo">015</span>import org.apache.juneau.*;<a name="line.15"></a> <span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import org.apache.juneau.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>/**<a name="line.19"></a> -<span class="sourceLineNo">020</span> * Properties associated with the {@link HtmlDocSerializer} class.<a name="line.20"></a> -<span class="sourceLineNo">021</span> *<a name="line.21"></a> -<span class="sourceLineNo">022</span> * <p><a name="line.22"></a> -<span class="sourceLineNo">023</span> * These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja><a name="line.23"></a> -<span class="sourceLineNo">024</span> * annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.<a name="line.24"></a> -<span class="sourceLineNo">025</span> *<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <h5 class='section'>Example:</h5><a name="line.26"></a> -<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a> -<span class="sourceLineNo">028</span> * <ja>@RestResource</ja>(<a name="line.28"></a> -<span class="sourceLineNo">029</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.29"></a> -<span class="sourceLineNo">030</span> * properties={<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>),<a name="line.31"></a> -<span class="sourceLineNo">032</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>, value=<js>"$L{description}"</js>),<a name="line.32"></a> -<span class="sourceLineNo">033</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)<a name="line.33"></a> -<span class="sourceLineNo">034</span> * }<a name="line.34"></a> -<span class="sourceLineNo">035</span> * )<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.36"></a> -<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> -<span class="sourceLineNo">038</span> *<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> -<span class="sourceLineNo">040</span> * Note that shortcut annotations are also provided for these particular settings:<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p class='bcode'><a name="line.41"></a> -<span class="sourceLineNo">042</span> * <ja>@RestResource</ja>(<a name="line.42"></a> -<span class="sourceLineNo">043</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.43"></a> -<span class="sourceLineNo">044</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.44"></a> -<span class="sourceLineNo">045</span> * title=<js>"$L{title}"</js>,<a name="line.45"></a> -<span class="sourceLineNo">046</span> * description=<js>"$L{description}"</js>,<a name="line.46"></a> -<span class="sourceLineNo">047</span> * links=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js><a name="line.47"></a> -<span class="sourceLineNo">048</span> * )<a name="line.48"></a> -<span class="sourceLineNo">049</span> * )<a name="line.49"></a> -<span class="sourceLineNo">050</span> * </p><a name="line.50"></a> -<span class="sourceLineNo">051</span> *<a name="line.51"></a> -<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> -<span class="sourceLineNo">053</span> * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <code>messages</code> annotation.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * These variables are replaced at runtime based on the HTTP request locale.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.<a name="line.56"></a> -<span class="sourceLineNo">057</span> *<a name="line.57"></a> -<span class="sourceLineNo">058</span> * <h6 class='topic'>Inherited configurable properties</h6><a name="line.58"></a> -<span class="sourceLineNo">059</span> * <ul class='doctree'><a name="line.59"></a> -<span class="sourceLineNo">060</span> * <li class='jc'><a name="line.60"></a> -<span class="sourceLineNo">061</span> * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a><a name="line.61"></a> -<span class="sourceLineNo">062</span> * - Properties associated with handling beans on serializers and parsers.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * <ul><a name="line.63"></a> -<span class="sourceLineNo">064</span> * <li class='jc'><a name="line.64"></a> -<span class="sourceLineNo">065</span> * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a><a name="line.65"></a> -<span class="sourceLineNo">066</span> * - Configurable properties common to all serializers.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * <ul><a name="line.67"></a> -<span class="sourceLineNo">068</span> * <li class='jc'><a name="line.68"></a> -<span class="sourceLineNo">069</span> * <a class="doclink" href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a><a name="line.69"></a> -<span class="sourceLineNo">070</span> * - Configurable properties on the HTML serializer.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * </ul><a name="line.71"></a> -<span class="sourceLineNo">072</span> * </li><a name="line.72"></a> -<span class="sourceLineNo">073</span> * </ul><a name="line.73"></a> -<span class="sourceLineNo">074</span> * </li><a name="line.74"></a> -<span class="sourceLineNo">075</span> * </ul><a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span>public final class HtmlDocSerializerContext extends HtmlSerializerContext {<a name="line.77"></a> -<span class="sourceLineNo">078</span><a name="line.78"></a> -<span class="sourceLineNo">079</span> /**<a name="line.79"></a> -<span class="sourceLineNo">080</span> * <b>Configuration property:</b> Page title.<a name="line.80"></a> -<span class="sourceLineNo">081</span> *<a name="line.81"></a> -<span class="sourceLineNo">082</span> * <ul><a name="line.82"></a> -<span class="sourceLineNo">083</span> * <li><b>Name:</b> <js>"HtmlSerializer.title"</js><a name="line.83"></a> -<span class="sourceLineNo">084</span> * <li><b>Data type:</b> <code>String</code><a name="line.84"></a> -<span class="sourceLineNo">085</span> * <li><b>Default:</b> <jk>null</jk><a name="line.85"></a> -<span class="sourceLineNo">086</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.86"></a> -<span class="sourceLineNo">087</span> * </ul><a name="line.87"></a> -<span class="sourceLineNo">088</span> *<a name="line.88"></a> -<span class="sourceLineNo">089</span> * <p><a name="line.89"></a> -<span class="sourceLineNo">090</span> * Specifies the text for the title that shows up in the header section of the page generated by the basic template.<a name="line.90"></a> -<span class="sourceLineNo">091</span> *<a name="line.91"></a> -<span class="sourceLineNo">092</span> * <h5 class='section'>Example:</h5><a name="line.92"></a> -<span class="sourceLineNo">093</span> * <p><a name="line.93"></a> -<span class="sourceLineNo">094</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.94"></a> -<span class="sourceLineNo">095</span> * <p class='bcode'><a name="line.95"></a> -<span class="sourceLineNo">096</span> * <ja>@RestResource</ja>(<a name="line.96"></a> -<span class="sourceLineNo">097</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.97"></a> -<span class="sourceLineNo">098</span> * properties={<a name="line.98"></a> -<span class="sourceLineNo">099</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>)<a name="line.99"></a> -<span class="sourceLineNo">100</span> * }<a name="line.100"></a> -<span class="sourceLineNo">101</span> * )<a name="line.101"></a> -<span class="sourceLineNo">102</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.102"></a> -<span class="sourceLineNo">103</span> * </p><a name="line.103"></a> -<span class="sourceLineNo">104</span> *<a name="line.104"></a> -<span class="sourceLineNo">105</span> * <p><a name="line.105"></a> -<span class="sourceLineNo">106</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.106"></a> -<span class="sourceLineNo">107</span> * <p class='bcode'><a name="line.107"></a> -<span class="sourceLineNo">108</span> * title = <js>AddressBook sample resource</js><a name="line.108"></a> -<span class="sourceLineNo">109</span> * </p><a name="line.109"></a> -<span class="sourceLineNo">110</span> * <p><a name="line.110"></a> -<span class="sourceLineNo">111</span> * ...to produce this title on the HTML page...<a name="line.111"></a> -<span class="sourceLineNo">112</span> * <img class='bordered' src='doc-files/HTML_TITLE.png'><a name="line.112"></a> -<span class="sourceLineNo">113</span> *<a name="line.113"></a> -<span class="sourceLineNo">114</span> * <p><a name="line.114"></a> -<span class="sourceLineNo">115</span> * Shortcuts on <ja>@RestResource</ja> are also provided for this setting:<a name="line.115"></a> -<span class="sourceLineNo">116</span> * <p class='bcode'><a name="line.116"></a> -<span class="sourceLineNo">117</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same title.</jc><a name="line.117"></a> -<span class="sourceLineNo">118</span> * <ja>@RestResource</ja>(<a name="line.118"></a> -<span class="sourceLineNo">119</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.119"></a> -<span class="sourceLineNo">120</span> * title=<js>"My title"</js><a name="line.120"></a> -<span class="sourceLineNo">121</span> * )<a name="line.121"></a> -<span class="sourceLineNo">122</span> *<a name="line.122"></a> -<span class="sourceLineNo">123</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same title.</jc><a name="line.123"></a> -<span class="sourceLineNo">124</span> * <ja>@RestResource</ja>(<a name="line.124"></a> -<span class="sourceLineNo">125</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.125"></a> -<span class="sourceLineNo">126</span> * title=<js>"My title in Swagger"</js>,<a name="line.126"></a> -<span class="sourceLineNo">127</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.127"></a> -<span class="sourceLineNo">128</span> * title=<js>"My title in HTML"</js><a name="line.128"></a> -<span class="sourceLineNo">129</span> * )<a name="line.129"></a> -<span class="sourceLineNo">130</span> * )<a name="line.130"></a> -<span class="sourceLineNo">131</span> * </p><a name="line.131"></a> -<span class="sourceLineNo">132</span> *<a name="line.132"></a> -<span class="sourceLineNo">133</span> * <p><a name="line.133"></a> -<span class="sourceLineNo">134</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.134"></a> -<span class="sourceLineNo">135</span> */<a name="line.135"></a> -<span class="sourceLineNo">136</span> public static final String HTMLDOC_title = "HtmlSerializer.title";<a name="line.136"></a> -<span class="sourceLineNo">137</span><a name="line.137"></a> -<span class="sourceLineNo">138</span> /**<a name="line.138"></a> -<span class="sourceLineNo">139</span> * <b>Configuration property:</b> Page description.<a name="line.139"></a> -<span class="sourceLineNo">140</span> *<a name="line.140"></a> -<span class="sourceLineNo">141</span> * <ul><a name="line.141"></a> -<span class="sourceLineNo">142</span> * <li><b>Name:</b> <js>"HtmlSerializer.description"</js><a name="line.142"></a> -<span class="sourceLineNo">143</span> * <li><b>Data type:</b> <code>String</code><a name="line.143"></a> -<span class="sourceLineNo">144</span> * <li><b>Default:</b> <jk>null</jk><a name="line.144"></a> -<span class="sourceLineNo">145</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.145"></a> -<span class="sourceLineNo">146</span> * </ul><a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * <p><a name="line.148"></a> -<span class="sourceLineNo">149</span> * Specifies the text for the subtitle that shows up in the header section of the page generated by the basic<a name="line.149"></a> -<span class="sourceLineNo">150</span> * template.<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * <h5 class='section'>Example:</h5><a name="line.152"></a> -<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> -<span class="sourceLineNo">154</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.154"></a> -<span class="sourceLineNo">155</span> * </p><a name="line.155"></a> -<span class="sourceLineNo">156</span> * <p class='bcode'><a name="line.156"></a> -<span class="sourceLineNo">157</span> * <ja>@RestResource</ja>(<a name="line.157"></a> -<span class="sourceLineNo">158</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.158"></a> -<span class="sourceLineNo">159</span> * properties={<a name="line.159"></a> -<span class="sourceLineNo">160</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>,<a name="line.160"></a> -<span class="sourceLineNo">161</span> alue=<js>"My description"</js>)<a name="line.161"></a> -<span class="sourceLineNo">162</span> * }<a name="line.162"></a> -<span class="sourceLineNo">163</span> * )<a name="line.163"></a> -<span class="sourceLineNo">164</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.164"></a> -<span class="sourceLineNo">165</span> * </p><a name="line.165"></a> -<span class="sourceLineNo">166</span> *<a name="line.166"></a> -<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> -<span class="sourceLineNo">168</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.168"></a> -<span class="sourceLineNo">169</span> * <p class='bcode'><a name="line.169"></a> -<span class="sourceLineNo">170</span> * description = <js>Simple address book POJO sample resource</js><a name="line.170"></a> -<span class="sourceLineNo">171</span> * </p><a name="line.171"></a> -<span class="sourceLineNo">172</span> *<a name="line.172"></a> -<span class="sourceLineNo">173</span> * <p><a name="line.173"></a> -<span class="sourceLineNo">174</span> * ...to produce this description on the HTML page...<a name="line.174"></a> -<span class="sourceLineNo">175</span> * <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'><a name="line.175"></a> -<span class="sourceLineNo">176</span> *<a name="line.176"></a> -<span class="sourceLineNo">177</span> * <p><a name="line.177"></a> -<span class="sourceLineNo">178</span> * Shortcuts on <ja>@RestResource</ja> are also provided for this setting:<a name="line.178"></a> -<span class="sourceLineNo">179</span> * <p class='bcode'><a name="line.179"></a> -<span class="sourceLineNo">180</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same description.</jc><a name="line.180"></a> -<span class="sourceLineNo">181</span> * <ja>@RestResource</ja>(<a name="line.181"></a> -<span class="sourceLineNo">182</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.182"></a> -<span class="sourceLineNo">183</span> * description=<js>"My description"</js><a name="line.183"></a> -<span class="sourceLineNo">184</span> * )<a name="line.184"></a> -<span class="sourceLineNo">185</span> *<a name="line.185"></a> -<span class="sourceLineNo">186</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same description.</jc><a name="line.186"></a> -<span class="sourceLineNo">187</span> * <ja>@RestResource</ja>(<a name="line.187"></a> -<span class="sourceLineNo">188</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.188"></a> -<span class="sourceLineNo">189</span> * description=<js>"My description in Swagger"</js>,<a name="line.189"></a> -<span class="sourceLineNo">190</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.190"></a> -<span class="sourceLineNo">191</span> * description=<js>"My description in HTML"</js><a name="line.191"></a> -<span class="sourceLineNo">192</span> * )<a name="line.192"></a> -<span class="sourceLineNo">193</span> * )<a name="line.193"></a> -<span class="sourceLineNo">194</span> * </p><a name="line.194"></a> -<span class="sourceLineNo">195</span> *<a name="line.195"></a> -<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> -<span class="sourceLineNo">197</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.197"></a> -<span class="sourceLineNo">198</span> */<a name="line.198"></a> -<span class="sourceLineNo">199</span> public static final String HTMLDOC_description = "HtmlSerializer.description";<a name="line.199"></a> -<span class="sourceLineNo">200</span><a name="line.200"></a> -<span class="sourceLineNo">201</span> /**<a name="line.201"></a> -<span class="sourceLineNo">202</span> * <b>Configuration property:</b> Page branding.<a name="line.202"></a> -<span class="sourceLineNo">203</span> *<a name="line.203"></a> -<span class="sourceLineNo">204</span> * <ul><a name="line.204"></a> -<span class="sourceLineNo">205</span> * <li><b>Name:</b> <js>"HtmlSerializer.branding"</js><a name="line.205"></a> -<span class="sourceLineNo">206</span> * <li><b>Data type:</b> <code>String</code><a name="line.206"></a> -<span class="sourceLineNo">207</span> * <li><b>Default:</b> <jk>null</jk><a name="line.207"></a> -<span class="sourceLineNo">208</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.208"></a> -<span class="sourceLineNo">209</span> * </ul><a name="line.209"></a> -<span class="sourceLineNo">210</span> *<a name="line.210"></a> -<span class="sourceLineNo">211</span> * <p><a name="line.211"></a> -<span class="sourceLineNo">212</span> * Specifies arbitrary HTML for the header that can be used for adding custom branding to the page generated by the<a name="line.212"></a> -<span class="sourceLineNo">213</span> * basic template.<a name="line.213"></a> -<span class="sourceLineNo">214</span> *<a name="line.214"></a> -<span class="sourceLineNo">215</span> * <p><a name="line.215"></a> -<span class="sourceLineNo">216</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.216"></a> -<span class="sourceLineNo">217</span> */<a name="line.217"></a> -<span class="sourceLineNo">218</span> public static final String HTMLDOC_branding = "HtmlSerializer.branding";<a name="line.218"></a> -<span class="sourceLineNo">219</span><a name="line.219"></a> -<span class="sourceLineNo">220</span> /**<a name="line.220"></a> -<span class="sourceLineNo">221</span> * <b>Configuration property:</b> Header section contents.<a name="line.221"></a> -<span class="sourceLineNo">222</span> *<a name="line.222"></a> -<span class="sourceLineNo">223</span> * <ul><a name="line.223"></a> -<span class="sourceLineNo">224</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.header"</js><a name="line.224"></a> -<span class="sourceLineNo">225</span> * <li><b>Data type:</b> <code>String</code><a name="line.225"></a> -<span class="sourceLineNo">226</span> * <li><b>Default:</b> <jk>null</jk><a name="line.226"></a> -<span class="sourceLineNo">227</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.227"></a> -<span class="sourceLineNo">228</span> * </ul><a name="line.228"></a> -<span class="sourceLineNo">229</span> *<a name="line.229"></a> -<span class="sourceLineNo">230</span> * <p><a name="line.230"></a> -<span class="sourceLineNo">231</span> * Allows you to override the contents of the header section on the HTML page.<a name="line.231"></a> -<span class="sourceLineNo">232</span> * The header section normally contains the title and description at the top of the page.<a name="line.232"></a> -<span class="sourceLineNo">233</span> *<a name="line.233"></a> -<span class="sourceLineNo">234</span> * <h5 class='section'>Example:</h5><a name="line.234"></a> -<span class="sourceLineNo">235</span> * <p class='bcode'><a name="line.235"></a> -<span class="sourceLineNo">236</span> * <ja>@RestResource</ja>(<a name="line.236"></a> -<span class="sourceLineNo">237</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.237"></a> -<span class="sourceLineNo">238</span> * nav=<js>"&lt;p class='special-navigation'&gt;This is my special navigation content&lt;/p&gt;"</js><a name="line.238"></a> -<span class="sourceLineNo">239</span> * )<a name="line.239"></a> -<span class="sourceLineNo">240</span> * )<a name="line.240"></a> -<span class="sourceLineNo">241</span> * </p><a name="line.241"></a> -<span class="sourceLineNo">242</span> *<a name="line.242"></a> -<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> -<span class="sourceLineNo">244</span> * When this property is specified, the {@link #HTMLDOC_title} and {@link #HTMLDOC_description} properties are<a name="line.244"></a> -<span class="sourceLineNo">245</span> * ignored.<a name="line.245"></a> -<span class="sourceLineNo">246</span> *<a name="line.246"></a> -<span class="sourceLineNo">247</span> * <p><a name="line.247"></a> -<span class="sourceLineNo">248</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.248"></a> -<span class="sourceLineNo">249</span> */<a name="line.249"></a> -<span class="sourceLineNo">250</span> public static final String HTMLDOC_header = "HtmlDocSerializer.header";<a name="line.250"></a> -<span class="sourceLineNo">251</span><a name="line.251"></a> -<span class="sourceLineNo">252</span> /**<a name="line.252"></a> -<span class="sourceLineNo">253</span> * <b>Configuration property:</b> Page links.<a name="line.253"></a> -<span class="sourceLineNo">254</span> *<a name="line.254"></a> -<span class="sourceLineNo">255</span> * <ul><a name="line.255"></a> -<span class="sourceLineNo">256</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.links.map"</js><a name="line.256"></a> -<span class="sourceLineNo">257</span> * <li><b>Data type:</b> <code>Map&lt;String,String&gt;</code><a name="line.257"></a> -<span class="sourceLineNo">258</span> * <li><b>Default:</b> empty map<a name="line.258"></a> -<span class="sourceLineNo">259</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.259"></a> -<span class="sourceLineNo">260</span> * </ul><a name="line.260"></a> -<span class="sourceLineNo">261</span> *<a name="line.261"></a> -<span class="sourceLineNo">262</span> * <p><a name="line.262"></a> -<span class="sourceLineNo">263</span> * Adds a list of hyperlinks immediately under the title and description but above the content of the page.<a name="line.263"></a> +<span class="sourceLineNo">017</span>/**<a name="line.17"></a> +<span class="sourceLineNo">018</span> * Properties associated with the {@link HtmlDocSerializer} class.<a name="line.18"></a> +<span class="sourceLineNo">019</span> *<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <p><a name="line.20"></a> +<span class="sourceLineNo">021</span> * These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja><a name="line.21"></a> +<span class="sourceLineNo">022</span> * annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <h5 class='section'>Example:</h5><a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p class='bcode'><a name="line.25"></a> +<span class="sourceLineNo">026</span> * <ja>@RestResource</ja>(<a name="line.26"></a> +<span class="sourceLineNo">027</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.27"></a> +<span class="sourceLineNo">028</span> * properties={<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>),<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>, value=<js>"$L{description}"</js>),<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)<a name="line.31"></a> +<span class="sourceLineNo">032</span> * }<a name="line.32"></a> +<span class="sourceLineNo">033</span> * )<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * Note that shortcut annotations are also provided for these particular settings:<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p class='bcode'><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <ja>@RestResource</ja>(<a name="line.40"></a> +<span class="sourceLineNo">041</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.41"></a> +<span class="sourceLineNo">042</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.42"></a> +<span class="sourceLineNo">043</span> * title=<js>"$L{title}"</js>,<a name="line.43"></a> +<span class="sourceLineNo">044</span> * description=<js>"$L{description}"</js>,<a name="line.44"></a> +<span class="sourceLineNo">045</span> * links={<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <js>"options: ?method=OPTIONS"</js>,<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <js>"doc: doc"</js><a name="line.47"></a> +<span class="sourceLineNo">048</span> * }<a name="line.48"></a> +<span class="sourceLineNo">049</span> * )<a name="line.49"></a> +<span class="sourceLineNo">050</span> * )<a name="line.50"></a> +<span class="sourceLineNo">051</span> * </p><a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <code>messages</code> annotation.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * These variables are replaced at runtime based on the HTTP request locale.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.<a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <h6 class='topic'>Inherited configurable properties</h6><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <ul class='doctree'><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <li class='jc'><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a><a name="line.62"></a> +<span class="sourceLineNo">063</span> * - Properties associated with handling beans on serializers and parsers.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * <ul><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <li class='jc'><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a><a name="line.66"></a> +<span class="sourceLineNo">067</span> * - Configurable properties common to all serializers.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <ul><a name="line.68"></a> +<span class="sourceLineNo">069</span> * <li class='jc'><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <a class="doclink" href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a><a name="line.70"></a> +<span class="sourceLineNo">071</span> * - Configurable properties on the HTML serializer.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * </ul><a name="line.72"></a> +<span class="sourceLineNo">073</span> * </li><a name="line.73"></a> +<span class="sourceLineNo">074</span> * </ul><a name="line.74"></a> +<span class="sourceLineNo">075</span> * </li><a name="line.75"></a> +<span class="sourceLineNo">076</span> * </ul><a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span>public final class HtmlDocSerializerContext extends HtmlSerializerContext {<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * <b>Configuration property:</b> Page title.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * <ul><a name="line.83"></a> +<span class="sourceLineNo">084</span> * <li><b>Name:</b> <js>"HtmlSerializer.title"</js><a name="line.84"></a> +<span class="sourceLineNo">085</span> * <li><b>Data type:</b> <code>String</code><a name="line.85"></a> +<span class="sourceLineNo">086</span> * <li><b>Default:</b> <jk>null</jk><a name="line.86"></a> +<span class="sourceLineNo">087</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.87"></a> +<span class="sourceLineNo">088</span> * </ul><a name="line.88"></a> +<span class="sourceLineNo">089</span> *<a name="line.89"></a> +<span class="sourceLineNo">090</span> * <p><a name="line.90"></a> +<span class="sourceLineNo">091</span> * Specifies the text for the title that shows up in the header section of the page generated by the basic template.<a name="line.91"></a> +<span class="sourceLineNo">092</span> *<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <h5 class='section'>Example:</h5><a name="line.93"></a> +<span class="sourceLineNo">094</span> * <p><a name="line.94"></a> +<span class="sourceLineNo">095</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.95"></a> +<span class="sourceLineNo">096</span> * <p class='bcode'><a name="line.96"></a> +<span class="sourceLineNo">097</span> * <ja>@RestResource</ja>(<a name="line.97"></a> +<span class="sourceLineNo">098</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.98"></a> +<span class="sourceLineNo">099</span> * properties={<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>)<a name="line.100"></a> +<span class="sourceLineNo">101</span> * }<a name="line.101"></a> +<span class="sourceLineNo">102</span> * )<a name="line.102"></a> +<span class="sourceLineNo">103</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.103"></a> +<span class="sourceLineNo">104</span> * </p><a name="line.104"></a> +<span class="sourceLineNo">105</span> *<a name="line.105"></a> +<span class="sourceLineNo">106</span> * <p><a name="line.106"></a> +<span class="sourceLineNo">107</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.107"></a> +<span class="sourceLineNo">108</span> * <p class='bcode'><a name="line.108"></a> +<span class="sourceLineNo">109</span> * title = <js>AddressBook sample resource</js><a name="line.109"></a> +<span class="sourceLineNo">110</span> * </p><a name="line.110"></a> +<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> +<span class="sourceLineNo">112</span> * ...to produce this title on the HTML page...<a name="line.112"></a> +<span class="sourceLineNo">113</span> * <img class='bordered' src='doc-files/HTML_TITLE.png'><a name="line.113"></a> +<span class="sourceLineNo">114</span> *<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <p><a name="line.115"></a> +<span class="sourceLineNo">116</span> * Shortcuts on <ja>@RestResource</ja> are also provided for this setting:<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <p class='bcode'><a name="line.117"></a> +<span class="sourceLineNo">118</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same title.</jc><a name="line.118"></a> +<span class="sourceLineNo">119</span> * <ja>@RestResource</ja>(<a name="line.119"></a> +<span class="sourceLineNo">120</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.120"></a> +<span class="sourceLineNo">121</span> * title=<js>"My title"</js><a name="line.121"></a> +<span class="sourceLineNo">122</span> * )<a name="line.122"></a> +<span class="sourceLineNo">123</span> *<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same title.</jc><a name="line.124"></a> +<span class="sourceLineNo">125</span> * <ja>@RestResource</ja>(<a name="line.125"></a> +<span class="sourceLineNo">126</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.126"></a> +<span class="sourceLineNo">127</span> * title=<js>"My title in Swagger"</js>,<a name="line.127"></a> +<span class="sourceLineNo">128</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.128"></a> +<span class="sourceLineNo">129</span> * title=<js>"My title in HTML"</js><a name="line.129"></a> +<span class="sourceLineNo">130</span> * )<a name="line.130"></a> +<span class="sourceLineNo">131</span> * )<a name="line.131"></a> +<span class="sourceLineNo">132</span> * </p><a name="line.132"></a> +<span class="sourceLineNo">133</span> *<a name="line.133"></a> +<span class="sourceLineNo">134</span> * <p><a name="line.134"></a> +<span class="sourceLineNo">135</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.135"></a> +<span class="sourceLineNo">136</span> */<a name="line.136"></a> +<span class="sourceLineNo">137</span> public static final String HTMLDOC_title = "HtmlSerializer.title";<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> /**<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <b>Configuration property:</b> Page description.<a name="line.140"></a> +<span class="sourceLineNo">141</span> *<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <ul><a name="line.142"></a> +<span class="sourceLineNo">143</span> * <li><b>Name:</b> <js>"HtmlSerializer.description"</js><a name="line.143"></a> +<span class="sourceLineNo">144</span> * <li><b>Data type:</b> <code>String</code><a name="line.144"></a> +<span class="sourceLineNo">145</span> * <li><b>Default:</b> <jk>null</jk><a name="line.145"></a> +<span class="sourceLineNo">146</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.146"></a> +<span class="sourceLineNo">147</span> * </ul><a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <p><a name="line.149"></a> +<span class="sourceLineNo">150</span> * Specifies the text for the subtitle that shows up in the header section of the page generated by the basic<a name="line.150"></a> +<span class="sourceLineNo">151</span> * template.<a name="line.151"></a> +<span class="sourceLineNo">152</span> *<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <h5 class='section'>Example:</h5><a name="line.153"></a> +<span class="sourceLineNo">154</span> * <p><a name="line.154"></a> +<span class="sourceLineNo">155</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.155"></a> +<span class="sourceLineNo">156</span> * </p><a name="line.156"></a> +<span class="sourceLineNo">157</span> * <p class='bcode'><a name="line.157"></a> +<span class="sourceLineNo">158</span> * <ja>@RestResource</ja>(<a name="line.158"></a> +<span class="sourceLineNo">159</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.159"></a> +<span class="sourceLineNo">160</span> * properties={<a name="line.160"></a> +<span class="sourceLineNo">161</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>,<a name="line.161"></a> +<span class="sourceLineNo">162</span> alue=<js>"My description"</js>)<a name="line.162"></a> +<span class="sourceLineNo">163</span> * }<a name="line.163"></a> +<span class="sourceLineNo">164</span> * )<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.165"></a> +<span class="sourceLineNo">166</span> * </p><a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * <p><a name="line.168"></a> +<span class="sourceLineNo">169</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.169"></a> +<span class="sourceLineNo">170</span> * <p class='bcode'><a name="line.170"></a> +<span class="sourceLineNo">171</span> * description = <js>Simple address book POJO sample resource</js><a name="line.171"></a> +<span class="sourceLineNo">172</span> * </p><a name="line.172"></a> +<span class="sourceLineNo">173</span> *<a name="line.173"></a> +<span class="sourceLineNo">174</span> * <p><a name="line.174"></a> +<span class="sourceLineNo">175</span> * ...to produce this description on the HTML page...<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'><a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * Shortcuts on <ja>@RestResource</ja> are also provided for this setting:<a name="line.179"></a> +<span class="sourceLineNo">180</span> * <p class='bcode'><a name="line.180"></a> +<span class="sourceLineNo">181</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same description.</jc><a name="line.181"></a> +<span class="sourceLineNo">182</span> * <ja>@RestResource</ja>(<a name="line.182"></a> +<span class="sourceLineNo">183</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.183"></a> +<span class="sourceLineNo">184</span> * description=<js>"My description"</js><a name="line.184"></a> +<span class="sourceLineNo">185</span> * )<a name="line.185"></a> +<span class="sourceLineNo">186</span> *<a name="line.186"></a> +<span class="sourceLineNo">187</span> * <jc>// Example if you want the swagger doc and HTML doc to share the same description.</jc><a name="line.187"></a> +<span class="sourceLineNo">188</span> * <ja>@RestResource</ja>(<a name="line.188"></a> +<span class="sourceLineNo">189</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.189"></a> +<span class="sourceLineNo">190</span> * description=<js>"My description in Swagger"</js>,<a name="line.190"></a> +<span class="sourceLineNo">191</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.191"></a> +<span class="sourceLineNo">192</span> * description=<js>"My description in HTML"</js><a name="line.192"></a> +<span class="sourceLineNo">193</span> * )<a name="line.193"></a> +<span class="sourceLineNo">194</span> * )<a name="line.194"></a> +<span class="sourceLineNo">195</span> * </p><a name="line.195"></a> +<span class="sourceLineNo">196</span> *<a name="line.196"></a> +<span class="sourceLineNo">197</span> * <p><a name="line.197"></a> +<span class="sourceLineNo">198</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.198"></a> +<span class="sourceLineNo">199</span> */<a name="line.199"></a> +<span class="sourceLineNo">200</span> public static final String HTMLDOC_description = "HtmlSerializer.description";<a name="line.200"></a> +<span class="sourceLineNo">201</span><a name="line.201"></a> +<span class="sourceLineNo">202</span> /**<a name="line.202"></a> +<span class="sourceLineNo">203</span> * <b>Configuration property:</b> Page branding.<a name="line.203"></a> +<span class="sourceLineNo">204</span> *<a name="line.204"></a> +<span class="sourceLineNo">205</span> * <ul><a name="line.205"></a> +<span class="sourceLineNo">206</span> * <li><b>Name:</b> <js>"HtmlSerializer.branding"</js><a name="line.206"></a> +<span class="sourceLineNo">207</span> * <li><b>Data type:</b> <code>String</code><a name="line.207"></a> +<span class="sourceLineNo">208</span> * <li><b>Default:</b> <jk>null</jk><a name="line.208"></a> +<span class="sourceLineNo">209</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.209"></a> +<span class="sourceLineNo">210</span> * </ul><a name="line.210"></a> +<span class="sourceLineNo">211</span> *<a name="line.211"></a> +<span class="sourceLineNo">212</span> * <p><a name="line.212"></a> +<span class="sourceLineNo">213</span> * Specifies arbitrary HTML for the header that can be used for adding custom branding to the page generated by the<a name="line.213"></a> +<span class="sourceLineNo">214</span> * basic template.<a name="line.214"></a> +<span class="sourceLineNo">215</span> *<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <p><a name="line.216"></a> +<span class="sourceLineNo">217</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.217"></a> +<span class="sourceLineNo">218</span> */<a name="line.218"></a> +<span class="sourceLineNo">219</span> public static final String HTMLDOC_branding = "HtmlSerializer.branding";<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> /**<a name="line.221"></a> +<span class="sourceLineNo">222</span> * <b>Configuration property:</b> Header section contents.<a name="line.222"></a> +<span class="sourceLineNo">223</span> *<a name="line.223"></a> +<span class="sourceLineNo">224</span> * <ul><a name="line.224"></a> +<span class="sourceLineNo">225</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.header"</js><a name="line.225"></a> +<span class="sourceLineNo">226</span> * <li><b>Data type:</b> <code>String</code><a name="line.226"></a> +<span class="sourceLineNo">227</span> * <li><b>Default:</b> <jk>null</jk><a name="line.227"></a> +<span class="sourceLineNo">228</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.228"></a> +<span class="sourceLineNo">229</span> * </ul><a name="line.229"></a> +<span class="sourceLineNo">230</span> *<a name="line.230"></a> +<span class="sourceLineNo">231</span> * <p><a name="line.231"></a> +<span class="sourceLineNo">232</span> * Allows you to override the contents of the header section on the HTML page.<a name="line.232"></a> +<span class="sourceLineNo">233</span> * The header section normally contains the title and description at the top of the page.<a name="line.233"></a> +<span class="sourceLineNo">234</span> *<a name="line.234"></a> +<span class="sourceLineNo">235</span> * <h5 class='section'>Example:</h5><a name="line.235"></a> +<span class="sourceLineNo">236</span> * <p class='bcode'><a name="line.236"></a> +<span class="sourceLineNo">237</span> * <ja>@RestResource</ja>(<a name="line.237"></a> +<span class="sourceLineNo">238</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.238"></a> +<span class="sourceLineNo">239</span> * header={<a name="line.239"></a> +<span class="sourceLineNo">240</span> * <js>"&lt;h1&gt;My own header&lt;/h1&gt;"</js><a name="line.240"></a> +<span class="sourceLineNo">241</span> * }<a name="line.241"></a> +<span class="sourceLineNo">242</span> * )<a name="line.242"></a> +<span class="sourceLineNo">243</span> * )<a name="line.243"></a> +<span class="sourceLineNo">244</span> * </p><a name="line.244"></a> +<span class="sourceLineNo">245</span> *<a name="line.245"></a> +<span class="sourceLineNo">246</span> * <p><a name="line.246"></a> +<span class="sourceLineNo">247</span> * When this property is specified, the {@link #HTMLDOC_title} and {@link #HTMLDOC_description} properties are<a name="line.247"></a> +<span class="sourceLineNo">248</span> * ignored.<a name="line.248"></a> +<span class="sourceLineNo">249</span> *<a name="line.249"></a> +<span class="sourceLineNo">250</span> * <p><a name="line.250"></a> +<span class="sourceLineNo">251</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.251"></a> +<span class="sourceLineNo">252</span> */<a name="line.252"></a> +<span class="sourceLineNo">253</span> public static final String HTMLDOC_header = "HtmlDocSerializer.header";<a name="line.253"></a> +<span class="sourceLineNo">254</span><a name="line.254"></a> +<span class="sourceLineNo">255</span> /**<a name="line.255"></a> +<span class="sourceLineNo">256</span> * <b>Configuration property:</b> Page links.<a name="line.256"></a> +<span class="sourceLineNo">257</span> *<a name="line.257"></a> +<span class="sourceLineNo">258</span> * <ul><a name="line.258"></a> +<span class="sourceLineNo">259</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.links.list"</js><a name="line.259"></a> +<span class="sourceLineNo">260</span> * <li><b>Data type:</b> <code>String[]</code><a name="line.260"></a> +<span class="sourceLineNo">261</span> * <li><b>Default:</b> empty array<a name="line.261"></a> +<span class="sourceLineNo">262</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.262"></a> +<span class="sourceLineNo">263</span> * </ul><a name="line.263"></a> <span class="sourceLineNo">264</span> *<a name="line.264"></a> <span class="sourceLineNo">265</span> * <p><a name="line.265"></a> -<span class="sourceLineNo">266</span> * This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.<a name="line.266"></a> +<span class="sourceLineNo">266</span> * Adds a list of hyperlinks immediately under the title and description but above the content of the page.<a name="line.266"></a> <span class="sourceLineNo">267</span> *<a name="line.267"></a> <span class="sourceLineNo">268</span> * <p><a name="line.268"></a> -<span class="sourceLineNo">269</span> * The value is a JSON object string where the keys are anchor text and the values are URLs.<a name="line.269"></a> +<span class="sourceLineNo">269</span> * This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.<a name="line.269"></a> <span class="sourceLineNo">270</span> *<a name="line.270"></a> <span class="sourceLineNo">271</span> * <p><a name="line.271"></a> -<span class="sourceLineNo">272</span> * Relative URLs are considered relative to the servlet path.<a name="line.272"></a> -<span class="sourceLineNo">273</span> * For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the<a name="line.273"></a> -<span class="sourceLineNo">274</span> * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo"</js>.<a name="line.274"></a> -<span class="sourceLineNo">275</span> * Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs<a name="line.275"></a> -<span class="sourceLineNo">276</span> * can also be used in addition to various other protocols specified by {@link UriResolver} such as<a name="line.276"></a> -<span class="sourceLineNo">277</span> * <js>"servlet:/..."</js>.<a name="line.277"></a> +<span class="sourceLineNo">272</span> * The value is an array of strings with two possible values:<a name="line.272"></a> +<span class="sourceLineNo">273</span> * <ul><a name="line.273"></a> +<span class="sourceLineNo">274</span> * <li>A key-value pair representing a hyperlink label and href:<a name="line.274"></a> +<span class="sourceLineNo">275</span> * <br><js>"google: http://google.com"</js><a name="line.275"></a> +<span class="sourceLineNo">276</span> * <li>Arbitrary HTML.<a name="line.276"></a> +<span class="sourceLineNo">277</span> * </ul><a name="line.277"></a> <span class="sourceLineNo">278</span> *<a name="line.278"></a> -<span class="sourceLineNo">279</span> * <h5 class='section'>Example:</h5><a name="line.279"></a> -<span class="sourceLineNo">280</span> * <p><a name="line.280"></a> -<span class="sourceLineNo">281</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.281"></a> -<span class="sourceLineNo">282</span> * <p class='bcode'><a name="line.282"></a> -<span class="sourceLineNo">283</span> * <ja>@RestResource</ja>(<a name="line.283"></a> -<span class="sourceLineNo">284</span> * properties={<a name="line.284"></a> -<span class="sourceLineNo">285</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>,<a name="line.285"></a> -<span class="sourceLineNo">286</span> * value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)<a name="line.286"></a> -<span class="sourceLineNo">287</span> * }<a name="line.287"></a> -<span class="sourceLineNo">288</span> * )<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.289"></a> -<span class="sourceLineNo">290</span> * </p><a name="line.290"></a> -<span class="sourceLineNo">291</span> *<a name="line.291"></a> -<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> -<span class="sourceLineNo">293</span> * ...to produce this list of links on the HTML page...<a name="line.293"></a> -<span class="sourceLineNo">294</span> * <img class='bordered' src='doc-files/HTML_LINKS.png'><a name="line.294"></a> -<span class="sourceLineNo">295</span> *<a name="line.295"></a> -<span class="sourceLineNo">296</span> * <p><a name="line.296"></a> -<span class="sourceLineNo">297</span> * A shortcut on <ja>@RestResource</ja> is also provided for this setting:<a name="line.297"></a> -<span class="sourceLineNo">298</span> * <p class='bcode'><a name="line.298"></a> -<span class="sourceLineNo">299</span> * <ja>@RestResource</ja>(<a name="line.299"></a> -<span class="sourceLineNo">300</span> * htmldoc=@HtmlDoc(<a name="line.300"></a> -<span class="sourceLineNo">301</span> * links=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js><a name="line.301"></a> -<span class="sourceLineNo">302</span> * )<a name="line.302"></a> -<span class="sourceLineNo">303</span> * )<a name="line.303"></a> -<span class="sourceLineNo">304</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.304"></a> -<span class="sourceLineNo">305</span> * </p><a name="line.305"></a> -<span class="sourceLineNo">306</span> *<a name="line.306"></a> -<span class="sourceLineNo">307</span> * <p><a name="line.307"></a> -<span class="sourceLineNo">308</span> * Values that start with <js>'&lt;'</js> are assumed to be HTML and rendered as-is.<a name="line.308"></a> -<span class="sourceLineNo">309</span> */<a name="line.309"></a> -<span class="sourceLineNo">310</span> public static final String HTMLDOC_links = "HtmlDocSerializer.links.map";<a name="line.310"></a> -<span class="sourceLineNo">311</span><a name="line.311"></a> -<span class="sourceLineNo">312</span> /**<a name="line.312"></a> -<span class="sourceLineNo">313</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_links} property.<a name="line.313"></a> -<span class="sourceLineNo">314</span> */<a name="line.314"></a> -<span class="sourceLineNo">315</span> public static final String HTMLDOC_links_put = "HtmlDocSerializer.links.map.put";<a name="line.315"></a> -<span class="sourceLineNo">316</span><a name="line.316"></a> -<span class="sourceLineNo">317</span> /**<a name="line.317"></a> -<span class="sourceLineNo">318</span> * <b>Configuration property:</b> Nav section contents.<a name="line.318"></a> -<span class="sourceLineNo">319</span> *<a name="line.319"></a> -<span class="sourceLineNo">320</span> * <ul><a name="line.320"></a> -<span class="sourceLineNo">321</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js><a name="line.321"></a> -<span class="sourceLineNo">322</span> * <li><b>Data type:</b> <code>String</code><a name="line.322"></a> -<span class="sourceLineNo">323</span> * <li><b>Default:</b> <jk>null</jk><a name="line.323"></a> -<span class="sourceLineNo">324</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.324"></a> -<span class="sourceLineNo">325</span> * </ul><a name="line.325"></a> -<span class="sourceLineNo">326</span> *<a name="line.326"></a> -<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> -<span class="sourceLineNo">328</span> * Allows you to override the contents of the nav section on the HTML page.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * The nav section normally contains the page links at the top of the page.<a name="line.329"></a> -<span class="sourceLineNo">330</span> *<a name="line.330"></a> -<span class="sourceLineNo">331</span> * <h5 class='section'>Example:</h5><a name="line.331"></a> -<span class="sourceLineNo">332</span> * <p class='bcode'><a name="line.332"></a> -<span class="sourceLineNo">333</span> * <ja>@RestResource</ja>(<a name="line.333"></a> -<span class="sourceLineNo">334</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.334"></a> -<span class="sourceLineNo">335</span> * nav=<js>"&lt;p class='special-navigation'&gt;This is my special navigation content&lt;/p&gt;"</js><a name="line.335"></a> -<span class="sourceLineNo">336</span> * )<a name="line.336"></a> -<span class="sourceLineNo">337</span> * )<a name="line.337"></a> -<span class="sourceLineNo">338</span> * </p><a name="line.338"></a> -<span class="sourceLineNo">339</span> *<a name="line.339"></a> -<span class="sourceLineNo">340</span> * <p><a name="line.340"></a> -<span class="sourceLineNo">341</span> * When this property is specified, the {@link #HTMLDOC_links} property is ignored.<a name="line.341"></a> -<span class="sourceLineNo">342</span> *<a name="line.342"></a> -<span class="sourceLineNo">343</span> * <p><a name="line.343"></a> -<span class="sourceLineNo">344</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.344"></a> -<span class="sourceLineNo">345</span> */<a name="line.345"></a> -<span class="sourceLineNo">346</span> public static final String HTMLDOC_nav = "HtmlDocSerializer.nav";<a name="line.346"></a> -<span class="sourceLineNo">347</span><a name="line.347"></a> -<span class="sourceLineNo">348</span> /**<a name="line.348"></a> -<span class="sourceLineNo">349</span> * <b>Configuration property:</b> Aside section contents.<a name="line.349"></a> -<span class="sourceLineNo">350</span> *<a name="line.350"></a> -<span class="sourceLineNo">351</span> * <ul><a name="line.351"></a> -<span class="sourceLineNo">352</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js><a name="line.352"></a> -<span class="sourceLineNo">353</span> * <li><b>Data type:</b> <code>String</code><a name="line.353"></a> -<span class="sourceLineNo">354</span> * <li><b>Default:</b> <jk>null</jk><a name="line.354"></a> -<span class="sourceLineNo">355</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.355"></a> -<span class="sourceLineNo">356</span> * </ul><a name="line.356"></a> -<span class="sourceLineNo">357</span> *<a name="line.357"></a> -<span class="sourceLineNo">358</span> * <p><a name="line.358"></a> -<span class="sourceLineNo">359</span> * Allows you to specify the contents of the aside section on the HTML page.<a name="line.359"></a> -<span class="sourceLineNo">360</span> * The aside section floats on the right of the page for providing content supporting the serialized content of<a name="line.360"></a> -<span class="sourceLineNo">361</span> * the page.<a name="line.361"></a> -<span class="sourceLineNo">362</span> *<a name="line.362"></a> -<span class="sourceLineNo">363</span> * <p><a name="line.363"></a> -<span class="sourceLineNo">364</span> * By default, the aside section is empty.<a name="line.364"></a> -<span class="sourceLineNo">365</span> *<a name="line.365"></a> -<span class="sourceLineNo">366</span> * <h5 class='section'>Example:</h5><a name="line.366"></a> -<span class="sourceLineNo">367</span> * <p class='bcode'><a name="line.367"></a> -<span class="sourceLineNo">368</span> * <ja>@RestResource</ja>(<a name="line.368"></a> -<span class="sourceLineNo">369</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.369"></a> -<span class="sourceLineNo">370</span> * aside=<js>"&lt;ul&gt;&lt;li&gt;Item 1&lt;li&gt;Item 2&lt;li&gt;Item 3&lt;/ul&gt;"</js><a name="line.370"></a> -<span class="sourceLineNo">371</span> * )<a name="line.371"></a> -<span class="sourceLineNo">372</span> * )<a name="line.372"></a> -<span class="sourceLineNo">373</span> * </p><a name="line.373"></a> -<span class="sourceLineNo">374</span> *<a name="line.374"></a> -<span class="sourceLineNo">375</span> * <p><a name="line.375"></a> -<span class="sourceLineNo">376</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.376"></a> -<span class="sourceLineNo">377</span> */<a name="line.377"></a> -<span class="sourceLineNo">378</span> public static final String HTMLDOC_aside = "HtmlDocSerializer.aside";<a name="line.378"></a> -<span class="sourceLineNo">379</span><a name="line.379"></a> -<span class="sourceLineNo">380</span> /**<a name="line.380"></a> -<span class="sourceLineNo">381</span> * <b>Configuration property:</b> Footer section contents.<a name="line.381"></a> -<span class="sourceLineNo">382</span> *<a name="line.382"></a> -<span class="sourceLineNo">383</span> * <ul><a name="line.383"></a> -<span class="sourceLineNo">384</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js><a name="line.384"></a> -<span class="sourceLineNo">385</span> * <li><b>Data type:</b> <code>String</code><a name="line.385"></a> -<span class="sourceLineNo">386</span> * <li><b>Default:</b> <jk>null</jk><a name="line.386"></a> -<span class="sourceLineNo">387</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.387"></a> -<span class="sourceLineNo">388</span> * </ul><a name="line.388"></a> -<span class="sourceLineNo">389</span> *<a name="line.389"></a> -<span class="sourceLineNo">390</span> * <p><a name="line.390"></a> -<span class="sourceLineNo">391</span> * Allows you to specify the contents of the footer section on the HTML page.<a name="line.391"></a> -<span class="sourceLineNo">392</span> *<a name="line.392"></a> -<span class="sourceLineNo">393</span> * <p><a name="line.393"></a> -<span class="sourceLineNo">394</span> * By default, the footer section is empty.<a name="line.394"></a> -<span class="sourceLineNo">395</span> *<a name="line.395"></a> -<span class="sourceLineNo">396</span> * <h5 class='section'>Example:</h5><a name="line.396"></a> -<span class="sourceLineNo">397</span> * <p class='bcode'><a name="line.397"></a> -<span class="sourceLineNo">398</span> * <ja>@RestResource</ja>(<a name="line.398"></a> -<span class="sourceLineNo">399</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.399"></a> -<span class="sourceLineNo">400</span> * footer=<js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.400"></a> -<span class="sourceLineNo">401</span> * )<a name="line.401"></a> -<span class="sourceLineNo">402</span> * )<a name="line.402"></a> -<span class="sourceLineNo">403</span> * </p><a name="line.403"></a> -<span class="sourceLineNo">404</span> *<a name="line.404"></a> -<span class="sourceLineNo">405</span> * <p><a name="line.405"></a> -<span class="sourceLineNo">406</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.406"></a> -<span class="sourceLineNo">407</span> */<a name="line.407"></a> -<span class="sourceLineNo">408</span> public static final String HTMLDOC_footer = "HtmlDocSerializer.footer";<a name="line.408"></a> -<span class="sourceLineNo">409</span><a name="line.409"></a> -<span class="sourceLineNo">410</span> /**<a name="line.410"></a> -<span class="sourceLineNo">411</span> * <b>Configuration property:</b> No-results message.<a name="line.411"></a> -<span class="sourceLineNo">412</span> *<a name="line.412"></a> -<span class="sourceLineNo">413</span> * <ul><a name="line.413"></a> -<span class="sourceLineNo">414</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js><a name="line.414"></a> -<span class="sourceLineNo">415</span> * <li><b>Data type:</b> <code>String</code><a name="line.415"></a> -<span class="sourceLineNo">416</span> * <li><b>Default:</b> <js>"&lt;p&gt;no results&lt;/p&gt;"</js><a name="line.416"></a> -<span class="sourceLineNo">417</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.417"></a> -<span class="sourceLineNo">418</span> * </ul><a name="line.418"></a> -<span class="sourceLineNo">419</span> *<a name="line.419"></a> -<span class="sourceLineNo">420</span> * <p><a name="line.420"></a> -<span class="sourceLineNo">421</span> * Allows you to specify the string message used when trying to serialize an empty array or empty list.<a name="line.421"></a> +<span class="sourceLineNo">279</span> * <p><a name="line.279"></a> +<span class="sourceLineNo">280</span> * Relative URLs are considered relative to the servlet path.<a name="line.280"></a> +<span class="sourceLineNo">281</span> * For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the<a name="line.281"></a> +<span class="sourceLineNo">282</span> * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo"</js>.<a name="line.282"></a> +<span class="sourceLineNo">283</span> * Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs<a name="line.283"></a> +<span class="sourceLineNo">284</span> * can also be used in addition to various other protocols specified by {@link UriResolver} such as<a name="line.284"></a> +<span class="sourceLineNo">285</span> * <js>"servlet:/..."</js>.<a name="line.285"></a> +<span class="sourceLineNo">286</span> *<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <h5 class='section'>Example:</h5><a name="line.287"></a> +<span class="sourceLineNo">288</span> * <p><a name="line.288"></a> +<span class="sourceLineNo">289</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.289"></a> +<span class="sourceLineNo">290</span> * <p class='bcode'><a name="line.290"></a> +<span class="sourceLineNo">291</span> * <ja>@RestResource</ja>(<a name="line.291"></a> +<span class="sourceLineNo">292</span> * properties={<a name="line.292"></a> +<span class="sourceLineNo">293</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>,<a name="line.293"></a> +<span class="sourceLineNo">294</span> * value=<js>"['options: ?method=OPTIONS', 'doc: doc']"</js>)<a name="line.294"></a> +<span class="sourceLineNo">295</span> * }<a name="line.295"></a> +<span class="sourceLineNo">296</span> * )<a name="line.296"></a> +<span class="sourceLineNo">297</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.297"></a> +<span class="sourceLineNo">298</span> * </p><a name="line.298"></a> +<span class="sourceLineNo">299</span> *<a name="line.299"></a> +<span class="sourceLineNo">300</span> * <p><a name="line.300"></a> +<span class="sourceLineNo">301</span> * ...to produce this list of links on the HTML page...<a name="line.301"></a> +<span class="sourceLineNo">302</span> * <img class='bordered' src='doc-files/HTML_LINKS.png'><a name="line.302"></a> +<span class="sourceLineNo">303</span> *<a name="line.303"></a> +<span class="sourceLineNo">304</span> * <p><a name="line.304"></a> +<span class="sourceLineNo">305</span> * A shortcut on <ja>@RestResource</ja> is also provided for this setting:<a name="line.305"></a> +<span class="sourceLineNo">306</span> * <p class='bcode'><a name="line.306"></a> +<span class="sourceLineNo">307</span> * <ja>@RestResource</ja>(<a name="line.307"></a> +<span class="sourceLineNo">308</span> * htmldoc=@HtmlDoc(<a name="line.308"></a> +<span class="sourceLineNo">309</span> * links={<a name="line.309"></a> +<span class="sourceLineNo">310</span> * <js>"options: ?method=OPTIONS"</js>,<a name="line.310"></a> +<span class="sourceLineNo">311</span> * <js>"doc: doc"</js><a name="line.311"></a> +<span class="sourceLineNo">312</span> * }<a name="line.312"></a> +<span class="sourceLineNo">313</span> * )<a name="line.313"></a> +<span class="sourceLineNo">314</span> * )<a name="line.314"></a> +<span class="sourceLineNo">315</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.315"></a> +<span class="sourceLineNo">316</span> * </p><a name="line.316"></a> +<span class="sourceLineNo">317</span> */<a name="line.317"></a> +<span class="sourceLineNo">318</span> public static final String HTMLDOC_links = "HtmlDocSerializer.links.list";<a name="line.318"></a> +<span class="sourceLineNo">319</span><a name="line.319"></a> +<span class="sourceLineNo">320</span> /**<a name="line.320"></a> +<span class="sourceLineNo">321</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_links} property.<a name="line.321"></a> +<span class="sourceLineNo">322</span> */<a name="line.322"></a> +<span class="sourceLineNo">323</span> public static final String HTMLDOC_links_add = "HtmlDocSerializer.links.list.add";<a name="line.323"></a> +<span class="sourceLineNo">324</span><a name="line.324"></a> +<span class="sourceLineNo">325</span> /**<a name="line.325"></a> +<span class="sourceLineNo">326</span> * <b>Configuration property:</b> Nav section contents.<a name="line.326"></a> +<span class="sourceLineNo">327</span> *<a name="line.327"></a> +<span class="sourceLineNo">328</span> * <ul><a name="line.328"></a> +<span class="sourceLineNo">329</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js><a name="line.329"></a> +<span class="sourceLineNo">330</span> * <li><b>Data type:</b> <code>String</code><a name="line.330"></a> +<span class="sourceLineNo">331</span> * <li><b>Default:</b> <jk>null</jk><a name="line.331"></a> +<span class="sourceLineNo">332</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.332"></a> +<span class="sourceLineNo">333</span> * </ul><a name="line.333"></a> +<span class="sourceLineNo">334</span> *<a name="line.334"></a> +<span class="sourceLineNo">335</span> * <p><a name="line.335"></a> +<span class="sourceLineNo">336</span> * Allows you to override the contents of the nav section on the HTML page.<a name="line.336"></a> +<span class="sourceLineNo">337</span> * The nav section normally contains the page links at the top of the page.<a name="line.337"></a> +<span class="sourceLineNo">338</span> *<a name="line.338"></a> +<span class="sourceLineNo">339</span> * <h5 class='section'>Example:</h5><a name="line.339"></a> +<span class="sourceLineNo">340</span> * <p class='bcode'><a name="line.340"></a> +<span class="sourceLineNo">341</span> * <ja>@RestResource</ja>(<a name="line.341"></a> +<span class="sourceLineNo">342</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.342"></a> +<span class="sourceLineNo">343</span> * nav={<a name="line.343"></a> +<span class="sourceLineNo">344</span> * <js>"&lt;p class='special-navigation'&gt;This is my special navigation content&lt;/p&gt;"</js><a name="line.344"></a> +<span class="sourceLineNo">345</span> * }<a name="line.345"></a> +<span class="sourceLineNo">346</span> * )<a name="line.346"></a> +<span class="sourceLineNo">347</span> * )<a name="line.347"></a> +<span class="sourceLineNo">348</span> * </p><a name="line.348"></a> +<span class="sourceLineNo">349</span> *<a name="line.349"></a> +<span class="sourceLineNo">350</span> * <p><a name="line.350"></a> +<span class="sourceLineNo">351</span> * When this property is specified, the {@link #HTMLDOC_links} property is ignored.<a name="line.351"></a> +<span class="sourceLineNo">352</span> *<a name="line.352"></a> +<span class="sourceLineNo">353</span> * <p><a name="line.353"></a> +<span class="sourceLineNo">354</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.354"></a> +<span class="sourceLineNo">355</span> */<a name="line.355"></a> +<span class="sourceLineNo">356</span> public static final String HTMLDOC_nav = "HtmlDocSerializer.nav";<a name="line.356"></a> +<span class="sourceLineNo">357</span><a name="line.357"></a> +<span class="sourceLineNo">358</span> /**<a name="line.358"></a> +<span class="sourceLineNo">359</span> * <b>Configuration property:</b> Aside section contents.<a name="line.359"></a> +<span class="sourceLineNo">360</span> *<a name="line.360"></a> +<span class="sourceLineNo">361</span> * <ul><a name="line.361"></a> +<span class="sourceLineNo">362</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js><a name="line.362"></a> +<span class="sourceLineNo">363</span> * <li><b>Data type:</b> <code>String</code><a name="line.363"></a> +<span class="sourceLineNo">364</span> * <li><b>Default:</b> <jk>null</jk><a name="line.364"></a> +<span class="sourceLineNo">365</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.365"></a> +<span class="sourceLineNo">366</span> * </ul><a name="line.366"></a> +<span class="sourceLineNo">367</span> *<a name="line.367"></a> +<span class="sourceLineNo">368</span> * <p><a name="line.368"></a> +<span class="sourceLineNo">369</span> * Allows you to specify the contents of the aside section on the HTML page.<a name="line.369"></a> +<span class="sourceLineNo">370</span> * The aside section floats on the right of the page for providing content supporting the serialized content of<a name="line.370"></a> +<span class="sourceLineNo">371</span> * the page.<a name="line.371"></a> +<span class="sourceLineNo">372</span> *<a name="line.372"></a> +<span class="sourceLineNo">373</span> * <p><a name="line.373"></a> +<span class="sourceLineNo">374</span> * By default, the aside section is empty.<a name="line.374"></a> +<span class="sourceLineNo">375</span> *<a name="line.375"></a> +<span class="sourceLineNo">376</span> * <h5 class='section'>Example:</h5><a name="line.376"></a> +<span class="sourceLineNo">377</span> * <p class='bcode'><a name="line.377"></a> +<span class="sourceLineNo">378</span> * <ja>@RestResource</ja>(<a name="line.378"></a> +<span class="sourceLineNo">379</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.379"></a> +<span class="sourceLineNo">380</span> * aside={<a name="line.380"></a> +<span class="sourceLineNo">381</span> * <js>"&lt;ul&gt;"</js>,<a name="line.381"></a> +<span class="sourceLineNo">382</span> * <js>" &lt;li&gt;Item 1"</js>,<a name="line.382"></a> +<span class="sourceLineNo">383</span> * <js>" &lt;li&gt;Item 2"</js>,<a name="line.383"></a> +<span class="sourceLineNo">384</span> * <js>" &lt;li&gt;Item 3"</js>,<a name="line.384"></a> +<span class="sourceLineNo">385</span> * <js>"&lt;/ul&gt;"</js><a name="line.385"></a> +<span class="sourceLineNo">386</span> * }<a name="line.386"></a> +<span class="sourceLineNo">387</span> * )<a name="line.387"></a> +<span class="sourceLineNo">388</span> * )<a name="line.388"></a> +<span class="sourceLineNo">389</span> * </p><a name="line.389"></a> +<span class="sourceLineNo">390</span> *<a name="line.390"></a> +<span class="sourceLineNo">391</span> * <p><a name="line.391"></a> +<span class="sourceLineNo">392</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.392"></a> +<span class="sourceLineNo">393</span> */<a name="line.393"></a> +<span class="sourceLineNo">394</span> public static final String HTMLDOC_aside = "HtmlDocSerializer.aside";<a name="line.394"></a> +<span class="sourceLineNo">395</span><a name="line.395"></a> +<span class="sourceLineNo">396</span> /**<a name="line.396"></a> +<span class="sourceLineNo">397</span> * <b>Configuration property:</b> Footer section contents.<a name="line.397"></a> +<span class="sourceLineNo">398</span> *<a name="line.398"></a> +<span class="sourceLineNo">399</span> * <ul><a name="line.399"></a> +<span class="sourceLineNo">400</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js><a name="line.400"></a> +<span class="sourceLineNo">401</span> * <li><b>Data type:</b> <code>String</code><a name="line.401"></a> +<span class="sourceLineNo">402</span> * <li><b>Default:</b> <jk>null</jk><a name="line.402"></a> +<span class="sourceLineNo">403</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.403"></a> +<span class="sourceLineNo">404</span> * </ul><a name="line.404"></a> +<span class="sourceLineNo">405</span> *<a name="line.405"></a> +<span class="sourceLineNo">406</span> * <p><a name="line.406"></a> +<span class="sourceLineNo">407</span> * Allows you to specify the contents of the footer section on the HTML page.<a name="line.407"></a> +<span class="sourceLineNo">408</span> *<a name="line.408"></a> +<span class="sourceLineNo">409</span> * <p><a name="line.409"></a> +<span class="sourceLineNo">410</span> * By default, the footer section is empty.<a name="line.410"></a> +<span class="sourceLineNo">411</span> *<a name="line.411"></a> +<span class="sourceLineNo">412</span> * <h5 class='section'>Example:</h5><a name="line.412"></a> +<span class="sourceLineNo">413</span> * <p class='bcode'><a name="line.413"></a> +<span class="sourceLineNo">414</span> * <ja>@RestResource</ja>(<a name="line.414"></a> +<span class="sourceLineNo">415</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.415"></a> +<span class="sourceLineNo">416</span> * footer={<a name="line.416"></a> +<span class="sourceLineNo">417</span> * <js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.417"></a> +<span class="sourceLineNo">418</span> * }<a name="line.418"></a> +<span class="sourceLineNo">419</span> * )<a name="line.419"></a> +<span class="sourceLineNo">420</span> * )<a name="line.420"></a> +<span class="sourceLineNo">421</span> * </p><a name="line.421"></a> <span class="sourceLineNo">422</span> *<a name="line.422"></a> -<span class="sourceLineNo">423</span> * <h5 class='section'>Example:</h5><a name="line.423"></a> -<span class="sourceLineNo">424</span> * <p class='bcode'><a name="line.424"></a> -<span class="sourceLineNo">425</span> * <ja>@RestResource</ja>(<a name="line.425"></a> -<span class="sourceLineNo">426</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.426"></a> -<span class="sourceLineNo">427</span> * noResultsMessage=<js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.427"></a> -<span class="sourceLineNo">428</span> * )<a name="line.428"></a> -<span class="sourceLineNo">429</span> * )<a name="line.429"></a> -<span class="sourceLineNo">430</span> * </p><a name="line.430"></a> -<span class="sourceLineNo">431</span> *<a name="line.431"></a> -<span class="sourceLineNo">432</span> * <p><a name="line.432"></a> -<span class="sourceLineNo">433</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.433"></a> -<span class="sourceLineNo">434</span> */<a name="line.434"></a> -<span class="sourceLineNo">435</span> public static final String HTMLDOC_noResultsMessage = "HtmlDocSerializer.noResultsMessage";<a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * <b>Configuration property:</b> Prevent word wrap on page.<a name="line.438"></a> -<span class="sourceLineNo">439</span> *<a name="line.439"></a> -<span class="sourceLineNo">440</span> * <ul><a name="line.440"></a> -<span class="sourceLineNo">441</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js><a name="line.441"></a> -<span class="sourceLineNo">442</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.442"></a> -<span class="sourceLineNo">443</span> * <li><b>Default:</b> <jk>false</jk><a name="line.443"></a> -<span class="sourceLineNo">444</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.444"></a> -<span class="sourceLineNo">445</span> * </ul><a name="line.445"></a> -<span class="sourceLineNo">446</span> *<a name="line.446"></a> -<span class="sourceLineNo">447</span> * <p><a name="line.447"></a> -<span class="sourceLineNo">448</span> * Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.<a name="line.448"></a> -<span class="sourceLineNo">449</span> */<a name="line.449"></a> -<span class="sourceLineNo">450</span> public static final String HTMLDOC_nowrap = "HtmlDocSerializer.nowrap";<a name="line
<TRUNCATED>
