http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html index b53b05f..f36294e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -63,8 +63,8 @@ <span class="sourceLineNo">055</span> * &lt;/head&gt;<a name="line.55"></a> <span class="sourceLineNo">056</span> * &lt;body&gt;<a name="line.56"></a> <span class="sourceLineNo">057</span> * &lt;header&gt;<a name="line.57"></a> -<span class="sourceLineNo">058</span> * &lt;h3 <xa>class</xa>=<xs>'title'</xs>&gt;<xv>Page title</xv>&lt;/h3&gt;<a name="line.58"></a> -<span class="sourceLineNo">059</span> * &lt;h5 <xa>class</xa>=<xs>'description'</xs>&gt;<xv>Page description</xv>&lt;/h5&gt;<a name="line.59"></a> +<span class="sourceLineNo">058</span> * &lt;h1&gt;<xv>Page title</xv>&lt;/h1&gt;<a name="line.58"></a> +<span class="sourceLineNo">059</span> * &lt;h2&gt;<xv>Page description</xv>&lt;/h2&gt;<a name="line.59"></a> <span class="sourceLineNo">060</span> * <xv>Arbitrary page branding</xv><a name="line.60"></a> <span class="sourceLineNo">061</span> * &lt;/header&gt;<a name="line.61"></a> <span class="sourceLineNo">062</span> * &lt;nav&gt;<a name="line.62"></a> @@ -92,7 +92,7 @@ <span class="sourceLineNo">084</span> * The format of this value is HTML (phrasing content only).<a name="line.84"></a> <span class="sourceLineNo">085</span> *<a name="line.85"></a> <span class="sourceLineNo">086</span> * <p><a name="line.86"></a> -<span class="sourceLineNo">087</span> * It gets wrapped in a <code><xt>&lt;h3&gt; <xa>class</xa>=<xs>'title'</xs>&gt;</xt></code> element and then added<a name="line.87"></a> +<span class="sourceLineNo">087</span> * It gets wrapped in a <code><xt>&lt;h1&gt;</xt></code> element and then added<a name="line.87"></a> <span class="sourceLineNo">088</span> * to the <code><xt>&lt;header&gt;</code> section on the page.<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> @@ -135,7 +135,7 @@ <span class="sourceLineNo">127</span> * The format of this value is HTML (phrasing content only).<a name="line.127"></a> <span class="sourceLineNo">128</span> *<a name="line.128"></a> <span class="sourceLineNo">129</span> * <p><a name="line.129"></a> -<span class="sourceLineNo">130</span> * It gets wrapped in a <code><xt>&lt;h5&gt; <xa>class</xa>=<xs>'description'</xs>&gt;</xt></code> element and then<a name="line.130"></a> +<span class="sourceLineNo">130</span> * It gets wrapped in a <code><xt>&lt;h2&gt;</xt></code> element and then<a name="line.130"></a> <span class="sourceLineNo">131</span> * added to the <code><xt>&lt;header&gt;</code> section on the page.<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> @@ -189,186 +189,186 @@ <span class="sourceLineNo">181</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.181"></a> <span class="sourceLineNo">182</span> *<a name="line.182"></a> <span class="sourceLineNo">183</span> * <p><a name="line.183"></a> -<span class="sourceLineNo">184</span> * The programmatic equivalent to this annotation are the<a name="line.184"></a> -<span class="sourceLineNo">185</span> * {@link RestConfig#setHtmlBranding(String)}/{@link RestResponse#setHtmlBranding(Object)} methods.<a name="line.185"></a> -<span class="sourceLineNo">186</span> */<a name="line.186"></a> -<span class="sourceLineNo">187</span> String branding() default "";<a name="line.187"></a> -<span class="sourceLineNo">188</span><a name="line.188"></a> -<span class="sourceLineNo">189</span> /**<a name="line.189"></a> -<span class="sourceLineNo">190</span> * Sets the HTML header section contents.<a name="line.190"></a> -<span class="sourceLineNo">191</span> *<a name="line.191"></a> -<span class="sourceLineNo">192</span> * <p><a name="line.192"></a> -<span class="sourceLineNo">193</span> * The format of this value is HTML.<a name="line.193"></a> +<span class="sourceLineNo">184</span> * Multiple values are combined with newlines into a single string.<a name="line.184"></a> +<span class="sourceLineNo">185</span> *<a name="line.185"></a> +<span class="sourceLineNo">186</span> * <p><a name="line.186"></a> +<span class="sourceLineNo">187</span> * The programmatic equivalent to this annotation are the<a name="line.187"></a> +<span class="sourceLineNo">188</span> * {@link RestConfig#setHtmlBranding(String)}/{@link RestResponse#setHtmlBranding(Object)} methods.<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> String[] branding() default {};<a name="line.190"></a> +<span class="sourceLineNo">191</span><a name="line.191"></a> +<span class="sourceLineNo">192</span> /**<a name="line.192"></a> +<span class="sourceLineNo">193</span> * Sets the HTML header section contents.<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> * The page header normally contains the title and description, but this value can be used to override the contents<a name="line.196"></a> -<span class="sourceLineNo">197</span> * to be whatever you want.<a name="line.197"></a> -<span class="sourceLineNo">198</span> *<a name="line.198"></a> -<span class="sourceLineNo">199</span> * <h5 class='section'>Example:</h5><a name="line.199"></a> -<span class="sourceLineNo">200</span> * <p class='bcode'><a name="line.200"></a> -<span class="sourceLineNo">201</span> * <ja>@RestResource</ja>(<a name="line.201"></a> -<span class="sourceLineNo">202</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.202"></a> -<span class="sourceLineNo">203</span> * header=<js>"&lt;p&gt;This is my REST interface&lt;/p&gt;"</js><a name="line.203"></a> -<span class="sourceLineNo">204</span> * )<a name="line.204"></a> -<span class="sourceLineNo">205</span> * )<a name="line.205"></a> -<span class="sourceLineNo">206</span> * </p><a name="line.206"></a> -<span class="sourceLineNo">207</span> *<a name="line.207"></a> -<span class="sourceLineNo">208</span> * <p><a name="line.208"></a> -<span class="sourceLineNo">209</span> * When a value is specified, the {@link #title()} and {@link #description()} values will be ignored.<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> * A value of <js>"NONE"</js> can be used to force no header.<a name="line.212"></a> -<span class="sourceLineNo">213</span> *<a name="line.213"></a> -<span class="sourceLineNo">214</span> * <p><a name="line.214"></a> -<span class="sourceLineNo">215</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.215"></a> -<span class="sourceLineNo">216</span> *<a name="line.216"></a> -<span class="sourceLineNo">217</span> * <p><a name="line.217"></a> -<span class="sourceLineNo">218</span> * The programmatic equivalent to this annotation are the<a name="line.218"></a> -<span class="sourceLineNo">219</span> * {@link RestConfig#setHtmlHeader(String)}/{@link RestResponse#setHtmlHeader(Object)} methods.<a name="line.219"></a> -<span class="sourceLineNo">220</span> */<a name="line.220"></a> -<span class="sourceLineNo">221</span> String header() default "";<a name="line.221"></a> -<span class="sourceLineNo">222</span><a name="line.222"></a> -<span class="sourceLineNo">223</span> /**<a name="line.223"></a> -<span class="sourceLineNo">224</span> * Sets the links in the HTML nav section.<a name="line.224"></a> -<span class="sourceLineNo">225</span> *<a name="line.225"></a> -<span class="sourceLineNo">226</span> * <p><a name="line.226"></a> -<span class="sourceLineNo">227</span> * The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are<a name="line.227"></a> -<span class="sourceLineNo">228</span> * relative (to the servlet) or absolute URLs.<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> * The page links are positioned immediately under the title and text.<a name="line.231"></a> -<span class="sourceLineNo">232</span> *<a name="line.232"></a> -<span class="sourceLineNo">233</span> * <h5 class='section'>Example:</h5><a name="line.233"></a> -<span class="sourceLineNo">234</span> * <p class='bcode'><a name="line.234"></a> -<span class="sourceLineNo">235</span> * <ja>@RestResource</ja>(<a name="line.235"></a> -<span class="sourceLineNo">236</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.236"></a> -<span class="sourceLineNo">237</span> * links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS'}"</js><a name="line.237"></a> -<span class="sourceLineNo">238</span> * )<a name="line.238"></a> -<span class="sourceLineNo">239</span> * )<a name="line.239"></a> -<span class="sourceLineNo">240</span> * </p><a name="line.240"></a> +<span class="sourceLineNo">196</span> * The format of this value is HTML.<a name="line.196"></a> +<span class="sourceLineNo">197</span> *<a name="line.197"></a> +<span class="sourceLineNo">198</span> * <p><a name="line.198"></a> +<span class="sourceLineNo">199</span> * The page header normally contains the title and description, but this value can be used to override the contents<a name="line.199"></a> +<span class="sourceLineNo">200</span> * to be whatever you want.<a name="line.200"></a> +<span class="sourceLineNo">201</span> *<a name="line.201"></a> +<span class="sourceLineNo">202</span> * <h5 class='section'>Example:</h5><a name="line.202"></a> +<span class="sourceLineNo">203</span> * <p class='bcode'><a name="line.203"></a> +<span class="sourceLineNo">204</span> * <ja>@RestResource</ja>(<a name="line.204"></a> +<span class="sourceLineNo">205</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.205"></a> +<span class="sourceLineNo">206</span> * header={<a name="line.206"></a> +<span class="sourceLineNo">207</span> * <js>"&lt;p&gt;This is my REST interface&lt;/p&gt;"</js><a name="line.207"></a> +<span class="sourceLineNo">208</span> * }<a name="line.208"></a> +<span class="sourceLineNo">209</span> * )<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> *<a name="line.212"></a> +<span class="sourceLineNo">213</span> * <p><a name="line.213"></a> +<span class="sourceLineNo">214</span> * When a value is specified, the {@link #title()} and {@link #description()} values will be ignored.<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 force no header.<a name="line.217"></a> +<span class="sourceLineNo">218</span> *<a name="line.218"></a> +<span class="sourceLineNo">219</span> * <p><a name="line.219"></a> +<span class="sourceLineNo">220</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.220"></a> +<span class="sourceLineNo">221</span> *<a name="line.221"></a> +<span class="sourceLineNo">222</span> * <p><a name="line.222"></a> +<span class="sourceLineNo">223</span> * Multiple values are combined with newlines into a single string.<a name="line.223"></a> +<span class="sourceLineNo">224</span> *<a name="line.224"></a> +<span class="sourceLineNo">225</span> * <p><a name="line.225"></a> +<span class="sourceLineNo">226</span> * The programmatic equivalent to this annotation are the<a name="line.226"></a> +<span class="sourceLineNo">227</span> * {@link RestConfig#setHtmlHeader(String)}/{@link RestResponse#setHtmlHeader(Object)} methods.<a name="line.227"></a> +<span class="sourceLineNo">228</span> */<a name="line.228"></a> +<span class="sourceLineNo">229</span> String[] header() default {};<a name="line.229"></a> +<span class="sourceLineNo">230</span><a name="line.230"></a> +<span class="sourceLineNo">231</span> /**<a name="line.231"></a> +<span class="sourceLineNo">232</span> * Sets the links in the HTML nav section.<a name="line.232"></a> +<span class="sourceLineNo">233</span> *<a name="line.233"></a> +<span class="sourceLineNo">234</span> * <p><a name="line.234"></a> +<span class="sourceLineNo">235</span> * The value is an array of strings with two possible values:<a name="line.235"></a> +<span class="sourceLineNo">236</span> * <ul><a name="line.236"></a> +<span class="sourceLineNo">237</span> * <li>A key-value pair representing a hyperlink label and href:<a name="line.237"></a> +<span class="sourceLineNo">238</span> * <br><js>"google: http://google.com"</js><a name="line.238"></a> +<span class="sourceLineNo">239</span> * <li>Arbitrary HTML.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * </ul><a name="line.240"></a> <span class="sourceLineNo">241</span> *<a name="line.241"></a> <span class="sourceLineNo">242</span> * <p><a name="line.242"></a> -<span class="sourceLineNo">243</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.243"></a> +<span class="sourceLineNo">243</span> * The page links are positioned immediately under the title and text.<a name="line.243"></a> <span class="sourceLineNo">244</span> *<a name="line.244"></a> -<span class="sourceLineNo">245</span> * <p><a name="line.245"></a> -<span class="sourceLineNo">246</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.246"></a> -<span class="sourceLineNo">247</span> *<a name="line.247"></a> -<span class="sourceLineNo">248</span> * <p><a name="line.248"></a> -<span class="sourceLineNo">249</span> * This field can also use URIs of any support type in {@link UriResolver}.<a name="line.249"></a> -<span class="sourceLineNo">250</span> *<a name="line.250"></a> -<span class="sourceLineNo">251</span> * <p><a name="line.251"></a> -<span class="sourceLineNo">252</span> * The programmatic equivalent to this annotation are the<a name="line.252"></a> -<span class="sourceLineNo">253</span> * {@link RestConfig#setHtmlLinks(String)}/{@link RestResponse#setHtmlLinks(Object)} methods.<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> String links() default "";<a name="line.255"></a> -<span class="sourceLineNo">256</span><a name="line.256"></a> -<span class="sourceLineNo">257</span> /**<a name="line.257"></a> -<span class="sourceLineNo">258</span> * Sets the HTML nav section contents.<a name="line.258"></a> +<span class="sourceLineNo">245</span> * <h5 class='section'>Example:</h5><a name="line.245"></a> +<span class="sourceLineNo">246</span> * <p class='bcode'><a name="line.246"></a> +<span class="sourceLineNo">247</span> * <ja>@RestResource</ja>(<a name="line.247"></a> +<span class="sourceLineNo">248</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.248"></a> +<span class="sourceLineNo">249</span> * links={<a name="line.249"></a> +<span class="sourceLineNo">250</span> * <js>"up: request:/.."</js>,<a name="line.250"></a> +<span class="sourceLineNo">251</span> * <js>"options: servlet:/?method=OPTIONS"</js><a name="line.251"></a> +<span class="sourceLineNo">252</span> * }<a name="line.252"></a> +<span class="sourceLineNo">253</span> * )<a name="line.253"></a> +<span class="sourceLineNo">254</span> * )<a name="line.254"></a> +<span class="sourceLineNo">255</span> * </p><a name="line.255"></a> +<span class="sourceLineNo">256</span> *<a name="line.256"></a> +<span class="sourceLineNo">257</span> * <p><a name="line.257"></a> +<span class="sourceLineNo">258</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.258"></a> <span class="sourceLineNo">259</span> *<a name="line.259"></a> <span class="sourceLineNo">260</span> * <p><a name="line.260"></a> -<span class="sourceLineNo">261</span> * The format of this value is HTML.<a name="line.261"></a> +<span class="sourceLineNo">261</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.261"></a> <span class="sourceLineNo">262</span> *<a name="line.262"></a> <span class="sourceLineNo">263</span> * <p><a name="line.263"></a> -<span class="sourceLineNo">264</span> * The nav section of the page contains the links.<a name="line.264"></a> +<span class="sourceLineNo">264</span> * This field can also use URIs of any support type in {@link UriResolver}.<a name="line.264"></a> <span class="sourceLineNo">265</span> *<a name="line.265"></a> <span class="sourceLineNo">266</span> * <p><a name="line.266"></a> -<span class="sourceLineNo">267</span> * The format of this value is HTML.<a name="line.267"></a> -<span class="sourceLineNo">268</span> *<a name="line.268"></a> -<span class="sourceLineNo">269</span> * <h5 class='section'>Example:</h5><a name="line.269"></a> -<span class="sourceLineNo">270</span> * <p class='bcode'><a name="line.270"></a> -<span class="sourceLineNo">271</span> * <ja>@RestResource</ja>(<a name="line.271"></a> -<span class="sourceLineNo">272</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.272"></a> -<span class="sourceLineNo">273</span> * nav=<js>"&lt;p&gt;Custom nav content&lt;/p&gt;"</js><a name="line.273"></a> -<span class="sourceLineNo">274</span> * )<a name="line.274"></a> -<span class="sourceLineNo">275</span> * )<a name="line.275"></a> -<span class="sourceLineNo">276</span> * </p><a name="line.276"></a> +<span class="sourceLineNo">267</span> * The programmatic equivalent to this annotation are the<a name="line.267"></a> +<span class="sourceLineNo">268</span> * {@link RestConfig#setHtmlLinks(String[])}/{@link RestResponse#setHtmlLinks(String[])} methods.<a name="line.268"></a> +<span class="sourceLineNo">269</span> */<a name="line.269"></a> +<span class="sourceLineNo">270</span> String[] links() default {};<a name="line.270"></a> +<span class="sourceLineNo">271</span><a name="line.271"></a> +<span class="sourceLineNo">272</span> /**<a name="line.272"></a> +<span class="sourceLineNo">273</span> * Sets the HTML nav section contents.<a name="line.273"></a> +<span class="sourceLineNo">274</span> *<a name="line.274"></a> +<span class="sourceLineNo">275</span> * <p><a name="line.275"></a> +<span class="sourceLineNo">276</span> * The format of this value is HTML.<a name="line.276"></a> <span class="sourceLineNo">277</span> *<a name="line.277"></a> <span class="sourceLineNo">278</span> * <p><a name="line.278"></a> -<span class="sourceLineNo">279</span> * When a value is specified, the {@link #links()} value will be ignored.<a name="line.279"></a> +<span class="sourceLineNo">279</span> * The nav section of the page contains the links.<a name="line.279"></a> <span class="sourceLineNo">280</span> *<a name="line.280"></a> <span class="sourceLineNo">281</span> * <p><a name="line.281"></a> -<span class="sourceLineNo">282</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.282"></a> +<span class="sourceLineNo">282</span> * The format of this value is HTML.<a name="line.282"></a> <span class="sourceLineNo">283</span> *<a name="line.283"></a> -<span class="sourceLineNo">284</span> * <p><a name="line.284"></a> -<span class="sourceLineNo">285</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.285"></a> -<span class="sourceLineNo">286</span> *<a name="line.286"></a> -<span class="sourceLineNo">287</span> * <p><a name="line.287"></a> -<span class="sourceLineNo">288</span> * The programmatic equivalent to this annotation are the<a name="line.288"></a> -<span class="sourceLineNo">289</span> * {@link RestConfig#setHtmlNav(String)}/{@link RestResponse#setHtmlNav(Object)} methods.<a name="line.289"></a> -<span class="sourceLineNo">290</span> */<a name="line.290"></a> -<span class="sourceLineNo">291</span> String nav() default "";<a name="line.291"></a> -<span class="sourceLineNo">292</span><a name="line.292"></a> -<span class="sourceLineNo">293</span> /**<a name="line.293"></a> -<span class="sourceLineNo">294</span> * Sets the HTML aside section contents.<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> * The format of this value is HTML.<a name="line.297"></a> -<span class="sourceLineNo">298</span> *<a name="line.298"></a> -<span class="sourceLineNo">299</span> * <p><a name="line.299"></a> -<span class="sourceLineNo">300</span> * The aside section typically floats on the right side of the page.<a name="line.300"></a> -<span class="sourceLineNo">301</span> *<a name="line.301"></a> -<span class="sourceLineNo">302</span> * <h5 class='section'>Example:</h5><a name="line.302"></a> -<span class="sourceLineNo">303</span> * <p class='bcode'><a name="line.303"></a> -<span class="sourceLineNo">304</span> * <ja>@RestResource</ja>(<a name="line.304"></a> -<span class="sourceLineNo">305</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.305"></a> -<span class="sourceLineNo">306</span> * aside=<js>"&lt;p&gt;Custom aside content&lt;/p&gt;"</js><a name="line.306"></a> -<span class="sourceLineNo">307</span> * )<a name="line.307"></a> -<span class="sourceLineNo">308</span> * )<a name="line.308"></a> -<span class="sourceLineNo">309</span> * </p><a name="line.309"></a> -<span class="sourceLineNo">310</span> *<a name="line.310"></a> -<span class="sourceLineNo">311</span> * <p><a name="line.311"></a> -<span class="sourceLineNo">312</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.312"></a> -<span class="sourceLineNo">313</span> *<a name="line.313"></a> -<span class="sourceLineNo">314</span> * <p><a name="line.314"></a> -<span class="sourceLineNo">315</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.315"></a> -<span class="sourceLineNo">316</span> *<a name="line.316"></a> -<span class="sourceLineNo">317</span> * <p><a name="line.317"></a> -<span class="sourceLineNo">318</span> * The programmatic equivalent to this annotation are the<a name="line.318"></a> -<span class="sourceLineNo">319</span> * {@link RestConfig#setHtmlAside(String)}/{@link RestResponse#setHtmlAside(Object)} methods.<a name="line.319"></a> -<span class="sourceLineNo">320</span> */<a name="line.320"></a> -<span class="sourceLineNo">321</span> String aside() default "";<a name="line.321"></a> -<span class="sourceLineNo">322</span><a name="line.322"></a> -<span class="sourceLineNo">323</span> /**<a name="line.323"></a> -<span class="sourceLineNo">324</span> * Sets the HTML footer section contents.<a name="line.324"></a> -<span class="sourceLineNo">325</span> *<a name="line.325"></a> -<span class="sourceLineNo">326</span> * <p><a name="line.326"></a> -<span class="sourceLineNo">327</span> * The format of this value is HTML.<a name="line.327"></a> -<span class="sourceLineNo">328</span> *<a name="line.328"></a> -<span class="sourceLineNo">329</span> * <p><a name="line.329"></a> -<span class="sourceLineNo">330</span> * The footer section typically floats on the bottom of the page.<a name="line.330"></a> -<span class="sourceLineNo">331</span> *<a name="line.331"></a> -<span class="sourceLineNo">332</span> * <h5 class='section'>Example:</h5><a name="line.332"></a> -<span class="sourceLineNo">333</span> * <p class='bcode'><a name="line.333"></a> -<span class="sourceLineNo">334</span> * <ja>@RestResource</ja>(<a name="line.334"></a> -<span class="sourceLineNo">335</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.335"></a> -<span class="sourceLineNo">336</span> * footer=<js>"&lt;p&gt;Custom footer content&lt;/p&gt;"</js><a name="line.336"></a> -<span class="sourceLineNo">337</span> * )<a name="line.337"></a> -<span class="sourceLineNo">338</span> * )<a name="line.338"></a> -<span class="sourceLineNo">339</span> * </p><a name="line.339"></a> -<span class="sourceLineNo">340</span> *<a name="line.340"></a> -<span class="sourceLineNo">341</span> * <p><a name="line.341"></a> -<span class="sourceLineNo">342</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.342"></a> -<span class="sourceLineNo">343</span> *<a name="line.343"></a> -<span class="sourceLineNo">344</span> * <p><a name="line.344"></a> -<span class="sourceLineNo">345</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.345"></a> -<span class="sourceLineNo">346</span> *<a name="line.346"></a> -<span class="sourceLineNo">347</span> * <p><a name="line.347"></a> -<span class="sourceLineNo">348</span> * The programmatic equivalent to this annotation are the<a name="line.348"></a> -<span class="sourceLineNo">349</span> * {@link RestConfig#setHtmlFooter(String)}/{@link RestResponse#setHtmlFooter(Object)} methods.<a name="line.349"></a> -<span class="sourceLineNo">350</span> */<a name="line.350"></a> -<span class="sourceLineNo">351</span> String footer() default "";<a name="line.351"></a> -<span class="sourceLineNo">352</span><a name="line.352"></a> -<span class="sourceLineNo">353</span> /**<a name="line.353"></a> -<span class="sourceLineNo">354</span> * Sets the HTML CSS style section contents.<a name="line.354"></a> -<span class="sourceLineNo">355</span> *<a name="line.355"></a> -<span class="sourceLineNo">356</span> * <p><a name="line.356"></a> -<span class="sourceLineNo">357</span> * The format of this value is CSS.<a name="line.357"></a> -<span class="sourceLineNo">358</span> *<a name="line.358"></a> -<span class="sourceLineNo">359</span> * <h5 class='section'>Example:</h5><a name="line.359"></a> -<span class="sourceLineNo">360</span> * <p class='bcode'><a name="line.360"></a> -<span class="sourceLineNo">361</span> * <ja>@RestResource</ja>(<a name="line.361"></a> -<span class="sourceLineNo">362</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.362"></a> -<span class="sourceLineNo">363</span> * style=<js>".red{color:red;}\n.blue{color:blue}"</js><a name="line.363"></a> +<span class="sourceLineNo">284</span> * <h5 class='section'>Example:</h5><a name="line.284"></a> +<span class="sourceLineNo">285</span> * <p class='bcode'><a name="line.285"></a> +<span class="sourceLineNo">286</span> * <ja>@RestResource</ja>(<a name="line.286"></a> +<span class="sourceLineNo">287</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.287"></a> +<span class="sourceLineNo">288</span> * nav={<a name="line.288"></a> +<span class="sourceLineNo">289</span> * <js>"&lt;p&gt;Custom nav content&lt;/p&gt;"</js><a name="line.289"></a> +<span class="sourceLineNo">290</span> * }<a name="line.290"></a> +<span class="sourceLineNo">291</span> * )<a name="line.291"></a> +<span class="sourceLineNo">292</span> * )<a name="line.292"></a> +<span class="sourceLineNo">293</span> * </p><a name="line.293"></a> +<span class="sourceLineNo">294</span> *<a name="line.294"></a> +<span class="sourceLineNo">295</span> * <p><a name="line.295"></a> +<span class="sourceLineNo">296</span> * When a value is specified, the {@link #links()} value will be ignored.<a name="line.296"></a> +<span class="sourceLineNo">297</span> *<a name="line.297"></a> +<span class="sourceLineNo">298</span> * <p><a name="line.298"></a> +<span class="sourceLineNo">299</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.299"></a> +<span class="sourceLineNo">300</span> *<a name="line.300"></a> +<span class="sourceLineNo">301</span> * <p><a name="line.301"></a> +<span class="sourceLineNo">302</span> * A value of <js>"NONE"</js> can be used to force no value.<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> * Multiple values are combined with newlines into a single string.<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> * The programmatic equivalent to this annotation are the<a name="line.308"></a> +<span class="sourceLineNo">309</span> * {@link RestConfig#setHtmlNav(String)}/{@link RestResponse#setHtmlNav(Object)} methods.<a name="line.309"></a> +<span class="sourceLineNo">310</span> */<a name="line.310"></a> +<span class="sourceLineNo">311</span> String[] nav() default {};<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> * Sets the HTML aside section contents.<a name="line.314"></a> +<span class="sourceLineNo">315</span> *<a name="line.315"></a> +<span class="sourceLineNo">316</span> * <p><a name="line.316"></a> +<span class="sourceLineNo">317</span> * The format of this value is HTML.<a name="line.317"></a> +<span class="sourceLineNo">318</span> *<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <p><a name="line.319"></a> +<span class="sourceLineNo">320</span> * The aside section typically floats on the right side of the page.<a name="line.320"></a> +<span class="sourceLineNo">321</span> *<a name="line.321"></a> +<span class="sourceLineNo">322</span> * <h5 class='section'>Example:</h5><a name="line.322"></a> +<span class="sourceLineNo">323</span> * <p class='bcode'><a name="line.323"></a> +<span class="sourceLineNo">324</span> * <ja>@RestResource</ja>(<a name="line.324"></a> +<span class="sourceLineNo">325</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.325"></a> +<span class="sourceLineNo">326</span> * aside={<a name="line.326"></a> +<span class="sourceLineNo">327</span> * <js>"&lt;p&gt;Custom aside content&lt;/p&gt;"</js><a name="line.327"></a> +<span class="sourceLineNo">328</span> * }<a name="line.328"></a> +<span class="sourceLineNo">329</span> * )<a name="line.329"></a> +<span class="sourceLineNo">330</span> * )<a name="line.330"></a> +<span class="sourceLineNo">331</span> * </p><a name="line.331"></a> +<span class="sourceLineNo">332</span> *<a name="line.332"></a> +<span class="sourceLineNo">333</span> * <p><a name="line.333"></a> +<span class="sourceLineNo">334</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.334"></a> +<span class="sourceLineNo">335</span> *<a name="line.335"></a> +<span class="sourceLineNo">336</span> * <p><a name="line.336"></a> +<span class="sourceLineNo">337</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.337"></a> +<span class="sourceLineNo">338</span> *<a name="line.338"></a> +<span class="sourceLineNo">339</span> * <p><a name="line.339"></a> +<span class="sourceLineNo">340</span> * Multiple values are combined with newlines into a single string.<a name="line.340"></a> +<span class="sourceLineNo">341</span> *<a name="line.341"></a> +<span class="sourceLineNo">342</span> * <p><a name="line.342"></a> +<span class="sourceLineNo">343</span> * The programmatic equivalent to this annotation are the<a name="line.343"></a> +<span class="sourceLineNo">344</span> * {@link RestConfig#setHtmlAside(String)}/{@link RestResponse#setHtmlAside(Object)} methods.<a name="line.344"></a> +<span class="sourceLineNo">345</span> */<a name="line.345"></a> +<span class="sourceLineNo">346</span> String[] aside() default {};<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> * Sets the HTML footer section contents.<a name="line.349"></a> +<span class="sourceLineNo">350</span> *<a name="line.350"></a> +<span class="sourceLineNo">351</span> * <p><a name="line.351"></a> +<span class="sourceLineNo">352</span> * The format of this value is HTML.<a name="line.352"></a> +<span class="sourceLineNo">353</span> *<a name="line.353"></a> +<span class="sourceLineNo">354</span> * <p><a name="line.354"></a> +<span class="sourceLineNo">355</span> * The footer section typically floats on the bottom of the page.<a name="line.355"></a> +<span class="sourceLineNo">356</span> *<a name="line.356"></a> +<span class="sourceLineNo">357</span> * <h5 class='section'>Example:</h5><a name="line.357"></a> +<span class="sourceLineNo">358</span> * <p class='bcode'><a name="line.358"></a> +<span class="sourceLineNo">359</span> * <ja>@RestResource</ja>(<a name="line.359"></a> +<span class="sourceLineNo">360</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.360"></a> +<span class="sourceLineNo">361</span> * footer={<a name="line.361"></a> +<span class="sourceLineNo">362</span> * <js>"&lt;p&gt;Custom footer content&lt;/p&gt;"</js><a name="line.362"></a> +<span class="sourceLineNo">363</span> * }<a name="line.363"></a> <span class="sourceLineNo">364</span> * )<a name="line.364"></a> <span class="sourceLineNo">365</span> * )<a name="line.365"></a> <span class="sourceLineNo">366</span> * </p><a name="line.366"></a> @@ -380,95 +380,136 @@ <span class="sourceLineNo">372</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.372"></a> <span class="sourceLineNo">373</span> *<a name="line.373"></a> <span class="sourceLineNo">374</span> * <p><a name="line.374"></a> -<span class="sourceLineNo">375</span> * The programmatic equivalent to this annotation are the<a name="line.375"></a> -<span class="sourceLineNo">376</span> * {@link RestConfig#setHtmlStyle(String)}/{@link RestResponse#setHtmlStyle(Object)} methods.<a name="line.376"></a> -<span class="sourceLineNo">377</span> */<a name="line.377"></a> -<span class="sourceLineNo">378</span> String style() default "";<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> * Sets the CSS URL in the HTML CSS style section.<a name="line.381"></a> -<span class="sourceLineNo">382</span> *<a name="line.382"></a> -<span class="sourceLineNo">383</span> * <p><a name="line.383"></a> -<span class="sourceLineNo">384</span> * The format of this value is a URL.<a name="line.384"></a> +<span class="sourceLineNo">375</span> * Multiple values are combined with newlines into a single string.<a name="line.375"></a> +<span class="sourceLineNo">376</span> *<a name="line.376"></a> +<span class="sourceLineNo">377</span> * <p><a name="line.377"></a> +<span class="sourceLineNo">378</span> * The programmatic equivalent to this annotation are the<a name="line.378"></a> +<span class="sourceLineNo">379</span> * {@link RestConfig#setHtmlFooter(String)}/{@link RestResponse#setHtmlFooter(Object)} methods.<a name="line.379"></a> +<span class="sourceLineNo">380</span> */<a name="line.380"></a> +<span class="sourceLineNo">381</span> String[] footer() default {};<a name="line.381"></a> +<span class="sourceLineNo">382</span><a name="line.382"></a> +<span class="sourceLineNo">383</span> /**<a name="line.383"></a> +<span class="sourceLineNo">384</span> * Sets the HTML CSS style section contents.<a name="line.384"></a> <span class="sourceLineNo">385</span> *<a name="line.385"></a> <span class="sourceLineNo">386</span> * <p><a name="line.386"></a> -<span class="sourceLineNo">387</span> * Specifies the URL to the stylesheet to add as a link in the style tag in the header.<a name="line.387"></a> +<span class="sourceLineNo">387</span> * The format of this value is CSS.<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> * The format of this value is CSS.<a name="line.390"></a> -<span class="sourceLineNo">391</span> *<a name="line.391"></a> -<span class="sourceLineNo">392</span> * <h5 class='section'>Example:</h5><a name="line.392"></a> -<span class="sourceLineNo">393</span> * <p class='bcode'><a name="line.393"></a> -<span class="sourceLineNo">394</span> * <ja>@RestResource</ja>(<a name="line.394"></a> -<span class="sourceLineNo">395</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.395"></a> -<span class="sourceLineNo">396</span> * stylesheet=<js>"http://someOtherHost/stealTheir.css"</js><a name="line.396"></a> +<span class="sourceLineNo">389</span> * <h5 class='section'>Example:</h5><a name="line.389"></a> +<span class="sourceLineNo">390</span> * <p class='bcode'><a name="line.390"></a> +<span class="sourceLineNo">391</span> * <ja>@RestResource</ja>(<a name="line.391"></a> +<span class="sourceLineNo">392</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.392"></a> +<span class="sourceLineNo">393</span> * style={<a name="line.393"></a> +<span class="sourceLineNo">394</span> * <js>".red{color:red;}"</js>,<a name="line.394"></a> +<span class="sourceLineNo">395</span> * <js>".blue{color:blue;}"</js><a name="line.395"></a> +<span class="sourceLineNo">396</span> * }<a name="line.396"></a> <span class="sourceLineNo">397</span> * )<a name="line.397"></a> <span class="sourceLineNo">398</span> * )<a name="line.398"></a> <span class="sourceLineNo">399</span> * </p><a name="line.399"></a> <span class="sourceLineNo">400</span> *<a name="line.400"></a> <span class="sourceLineNo">401</span> * <p><a name="line.401"></a> -<span class="sourceLineNo">402</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined<a name="line.402"></a> -<span class="sourceLineNo">403</span> * by {@link UriResolver}.<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> * The programmatic equivalent to this annotation are the<a name="line.406"></a> -<span class="sourceLineNo">407</span> * {@link RestConfig#setHtmlStylesheet(String)}/{@link RestResponse#setHtmlStylesheet(Object)} methods.<a name="line.407"></a> -<span class="sourceLineNo">408</span> */<a name="line.408"></a> -<span class="sourceLineNo">409</span> String stylesheet() default "";<a name="line.409"></a> -<span class="sourceLineNo">410</span><a name="line.410"></a> -<span class="sourceLineNo">411</span> /**<a name="line.411"></a> -<span class="sourceLineNo">412</span> * Sets the HTML script section contents.<a name="line.412"></a> -<span class="sourceLineNo">413</span> *<a name="line.413"></a> -<span class="sourceLineNo">414</span> * <p><a name="line.414"></a> -<span class="sourceLineNo">415</span> * The format of this value is Javascript.<a name="line.415"></a> -<span class="sourceLineNo">416</span> *<a name="line.416"></a> -<span class="sourceLineNo">417</span> * <h5 class='section'>Example:</h5><a name="line.417"></a> -<span class="sourceLineNo">418</span> * <p class='bcode'><a name="line.418"></a> -<span class="sourceLineNo">419</span> * <ja>@RestResource</ja>(<a name="line.419"></a> -<span class="sourceLineNo">420</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.420"></a> -<span class="sourceLineNo">421</span> * script=<js>"alert('Hello!')"</js><a name="line.421"></a> -<span class="sourceLineNo">422</span> * )<a name="line.422"></a> -<span class="sourceLineNo">423</span> * )<a name="line.423"></a> -<span class="sourceLineNo">424</span> * </p><a name="line.424"></a> -<span class="sourceLineNo">425</span> *<a name="line.425"></a> -<span class="sourceLineNo">426</span> * <p><a name="line.426"></a> -<span class="sourceLineNo">427</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.427"></a> -<span class="sourceLineNo">428</span> *<a name="line.428"></a> -<span class="sourceLineNo">429</span> * <p><a name="line.429"></a> -<span class="sourceLineNo">430</span> * A value of <js>"NONE"</js> can be used to force no value.<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> * The programmatic equivalent to this annotation are the<a name="line.433"></a> -<span class="sourceLineNo">434</span> * {@link RestConfig#setHtmlScript(String)}/{@link RestResponse#setHtmlScript(Object)} methods.<a name="line.434"></a> -<span class="sourceLineNo">435</span> */<a name="line.435"></a> -<span class="sourceLineNo">436</span> String script() default "";<a name="line.436"></a> -<span class="sourceLineNo">437</span><a name="line.437"></a> -<span class="sourceLineNo">438</span> /**<a name="line.438"></a> -<span class="sourceLineNo">439</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.439"></a> +<span class="sourceLineNo">402</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.402"></a> +<span class="sourceLineNo">403</span> *<a name="line.403"></a> +<span class="sourceLineNo">404</span> * <p><a name="line.404"></a> +<span class="sourceLineNo">405</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.405"></a> +<span class="sourceLineNo">406</span> *<a name="line.406"></a> +<span class="sourceLineNo">407</span> * <p><a name="line.407"></a> +<span class="sourceLineNo">408</span> * Multiple values are combined with newlines into a single string.<a name="line.408"></a> +<span class="sourceLineNo">409</span> *<a name="line.409"></a> +<span class="sourceLineNo">410</span> * <p><a name="line.410"></a> +<span class="sourceLineNo">411</span> * The programmatic equivalent to this annotation are the<a name="line.411"></a> +<span class="sourceLineNo">412</span> * {@link RestConfig#setHtmlStyle(String)}/{@link RestResponse#setHtmlStyle(Object)} methods.<a name="line.412"></a> +<span class="sourceLineNo">413</span> */<a name="line.413"></a> +<span class="sourceLineNo">414</span> String[] style() default {};<a name="line.414"></a> +<span class="sourceLineNo">415</span><a name="line.415"></a> +<span class="sourceLineNo">416</span> /**<a name="line.416"></a> +<span class="sourceLineNo">417</span> * Sets the CSS URL in the HTML CSS style section.<a name="line.417"></a> +<span class="sourceLineNo">418</span> *<a name="line.418"></a> +<span class="sourceLineNo">419</span> * <p><a name="line.419"></a> +<span class="sourceLineNo">420</span> * The format of this value is a URL.<a name="line.420"></a> +<span class="sourceLineNo">421</span> *<a name="line.421"></a> +<span class="sourceLineNo">422</span> * <p><a name="line.422"></a> +<span class="sourceLineNo">423</span> * Specifies the URL to the stylesheet to add as a link in the style tag in the header.<a name="line.423"></a> +<span class="sourceLineNo">424</span> *<a name="line.424"></a> +<span class="sourceLineNo">425</span> * <p><a name="line.425"></a> +<span class="sourceLineNo">426</span> * The format of this value is CSS.<a name="line.426"></a> +<span class="sourceLineNo">427</span> *<a name="line.427"></a> +<span class="sourceLineNo">428</span> * <h5 class='section'>Example:</h5><a name="line.428"></a> +<span class="sourceLineNo">429</span> * <p class='bcode'><a name="line.429"></a> +<span class="sourceLineNo">430</span> * <ja>@RestResource</ja>(<a name="line.430"></a> +<span class="sourceLineNo">431</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.431"></a> +<span class="sourceLineNo">432</span> * stylesheet=<js>"http://someOtherHost/stealTheir.css"</js><a name="line.432"></a> +<span class="sourceLineNo">433</span> * )<a name="line.433"></a> +<span class="sourceLineNo">434</span> * )<a name="line.434"></a> +<span class="sourceLineNo">435</span> * </p><a name="line.435"></a> +<span class="sourceLineNo">436</span> *<a name="line.436"></a> +<span class="sourceLineNo">437</span> * <p><a name="line.437"></a> +<span class="sourceLineNo">438</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined<a name="line.438"></a> +<span class="sourceLineNo">439</span> * by {@link UriResolver}.<a name="line.439"></a> <span class="sourceLineNo">440</span> *<a name="line.440"></a> <span class="sourceLineNo">441</span> * <p><a name="line.441"></a> -<span class="sourceLineNo">442</span> * This only applies to the rendered data portion of the page.<a name="line.442"></a> -<span class="sourceLineNo">443</span> */<a name="line.443"></a> -<span class="sourceLineNo">444</span> boolean nowrap() default false;<a name="line.444"></a> -<span class="sourceLineNo">445</span><a name="line.445"></a> -<span class="sourceLineNo">446</span> /**<a name="line.446"></a> -<span class="sourceLineNo">447</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.447"></a> -<span class="sourceLineNo">448</span> */<a name="line.448"></a> -<span class="sourceLineNo">449</span> String noResultsMessage() default "no results";<a name="line.449"></a> -<span class="sourceLineNo">450</span><a name="line.450"></a> -<span class="sourceLineNo">451</span> /**<a name="line.451"></a> -<span class="sourceLineNo">452</span> * Specifies the template class to use for rendering the HTML page.<a name="line.452"></a> -<span class="sourceLineNo">453</span> *<a name="line.453"></a> -<span class="sourceLineNo">454</span> * <p><a name="line.454"></a> -<span class="sourceLineNo">455</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.455"></a> -<span class="sourceLineNo">456</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.456"></a> -<span class="sourceLineNo">457</span> *<a name="line.457"></a> -<span class="sourceLineNo">458</span> * <p><a name="line.458"></a> -<span class="sourceLineNo">459</span> * The programmatic equivalent to this annotation are the<a name="line.459"></a> -<span class="sourceLineNo">460</span> * {@link RestConfig#setHtmlTemplate(Class)}/{@link RestResponse#setHtmlTemplate(Class)} methods.<a name="line.460"></a> -<span class="sourceLineNo">461</span> */<a name="line.461"></a> -<span class="sourceLineNo">462</span> Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;<a name="line.462"></a> -<span class="sourceLineNo">463</span>}<a name="line.463"></a> +<span class="sourceLineNo">442</span> * The programmatic equivalent to this annotation are the<a name="line.442"></a> +<span class="sourceLineNo">443</span> * {@link RestConfig#setHtmlStylesheet(String)}/{@link RestResponse#setHtmlStylesheet(Object)} methods.<a name="line.443"></a> +<span class="sourceLineNo">444</span> */<a name="line.444"></a> +<span class="sourceLineNo">445</span> String stylesheet() default "";<a name="line.445"></a> +<span class="sourceLineNo">446</span><a name="line.446"></a> +<span class="sourceLineNo">447</span> /**<a name="line.447"></a> +<span class="sourceLineNo">448</span> * Sets the HTML script section contents.<a name="line.448"></a> +<span class="sourceLineNo">449</span> *<a name="line.449"></a> +<span class="sourceLineNo">450</span> * <p><a name="line.450"></a> +<span class="sourceLineNo">451</span> * The format of this value is Javascript.<a name="line.451"></a> +<span class="sourceLineNo">452</span> *<a name="line.452"></a> +<span class="sourceLineNo">453</span> * <h5 class='section'>Example:</h5><a name="line.453"></a> +<span class="sourceLineNo">454</span> * <p class='bcode'><a name="line.454"></a> +<span class="sourceLineNo">455</span> * <ja>@RestResource</ja>(<a name="line.455"></a> +<span class="sourceLineNo">456</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.456"></a> +<span class="sourceLineNo">457</span> * script={<a name="line.457"></a> +<span class="sourceLineNo">458</span> * <js>"alert('Hello!')"</js><a name="line.458"></a> +<span class="sourceLineNo">459</span> * }<a name="line.459"></a> +<span class="sourceLineNo">460</span> * )<a name="line.460"></a> +<span class="sourceLineNo">461</span> * )<a name="line.461"></a> +<span class="sourceLineNo">462</span> * </p><a name="line.462"></a> +<span class="sourceLineNo">463</span> *<a name="line.463"></a> +<span class="sourceLineNo">464</span> * <p><a name="line.464"></a> +<span class="sourceLineNo">465</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.465"></a> +<span class="sourceLineNo">466</span> *<a name="line.466"></a> +<span class="sourceLineNo">467</span> * <p><a name="line.467"></a> +<span class="sourceLineNo">468</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.468"></a> +<span class="sourceLineNo">469</span> *<a name="line.469"></a> +<span class="sourceLineNo">470</span> * <p><a name="line.470"></a> +<span class="sourceLineNo">471</span> * Multiple values are combined with newlines into a single string.<a name="line.471"></a> +<span class="sourceLineNo">472</span> *<a name="line.472"></a> +<span class="sourceLineNo">473</span> * <p><a name="line.473"></a> +<span class="sourceLineNo">474</span> * The programmatic equivalent to this annotation are the<a name="line.474"></a> +<span class="sourceLineNo">475</span> * {@link RestConfig#setHtmlScript(String)}/{@link RestResponse#setHtmlScript(Object)} methods.<a name="line.475"></a> +<span class="sourceLineNo">476</span> */<a name="line.476"></a> +<span class="sourceLineNo">477</span> String[] script() default {};<a name="line.477"></a> +<span class="sourceLineNo">478</span><a name="line.478"></a> +<span class="sourceLineNo">479</span> /**<a name="line.479"></a> +<span class="sourceLineNo">480</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.480"></a> +<span class="sourceLineNo">481</span> *<a name="line.481"></a> +<span class="sourceLineNo">482</span> * <p><a name="line.482"></a> +<span class="sourceLineNo">483</span> * This only applies to the rendered data portion of the page.<a name="line.483"></a> +<span class="sourceLineNo">484</span> */<a name="line.484"></a> +<span class="sourceLineNo">485</span> boolean nowrap() default false;<a name="line.485"></a> +<span class="sourceLineNo">486</span><a name="line.486"></a> +<span class="sourceLineNo">487</span> /**<a name="line.487"></a> +<span class="sourceLineNo">488</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.488"></a> +<span class="sourceLineNo">489</span> */<a name="line.489"></a> +<span class="sourceLineNo">490</span> String noResultsMessage() default "no results";<a name="line.490"></a> +<span class="sourceLineNo">491</span><a name="line.491"></a> +<span class="sourceLineNo">492</span> /**<a name="line.492"></a> +<span class="sourceLineNo">493</span> * Specifies the template class to use for rendering the HTML page.<a name="line.493"></a> +<span class="sourceLineNo">494</span> *<a name="line.494"></a> +<span class="sourceLineNo">495</span> * <p><a name="line.495"></a> +<span class="sourceLineNo">496</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.496"></a> +<span class="sourceLineNo">497</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.497"></a> +<span class="sourceLineNo">498</span> *<a name="line.498"></a> +<span class="sourceLineNo">499</span> * <p><a name="line.499"></a> +<span class="sourceLineNo">500</span> * The programmatic equivalent to this annotation are the<a name="line.500"></a> +<span class="sourceLineNo">501</span> * {@link RestConfig#setHtmlTemplate(Class)}/{@link RestResponse#setHtmlTemplate(Class)} methods.<a name="line.501"></a> +<span class="sourceLineNo">502</span> */<a name="line.502"></a> +<span class="sourceLineNo">503</span> Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;<a name="line.503"></a> +<span class="sourceLineNo">504</span>}<a name="line.504"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html index 3cf79a8..7ec992b 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html @@ -708,32 +708,37 @@ <span class="sourceLineNo">700</span> * // "servlet:/..." URIs are relative to the servlet URI.<a name="line.700"></a> <span class="sourceLineNo">701</span> * // "$C{...}" variables are pulled from the config file.</jc><a name="line.701"></a> <span class="sourceLineNo">702</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.702"></a> -<span class="sourceLineNo">703</span> * links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS',source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js>,<a name="line.703"></a> -<span class="sourceLineNo">704</span> * aside=<js>""</js><a name="line.704"></a> -<span class="sourceLineNo">705</span> * + <js>"&lt;div style='max-width:400px;min-width:200px'&gt;"</js><a name="line.705"></a> -<span class="sourceLineNo">706</span> * + <js>" &lt;p&gt;Proof-of-concept resource that shows off the capabilities of working with POJO resources.&lt;/p&gt;"</js><a name="line.706"></a> -<span class="sourceLineNo">707</span> * + <js>" &lt;p&gt;Provides examples of: &lt;/p&gt;"</js><a name="line.707"></a> -<span class="sourceLineNo">708</span> * + <js>" &lt;ul&gt;"</js><a name="line.708"></a> -<span class="sourceLineNo">709</span> * + <js>" &lt;li&gt;XML and RDF namespaces"</js><a name="line.709"></a> -<span class="sourceLineNo">710</span> * + <js>" &lt;li&gt;Swagger documentation"</js><a name="line.710"></a> -<span class="sourceLineNo">711</span> * + <js>" &lt;li&gt;Widgets"</js><a name="line.711"></a> -<span class="sourceLineNo">712</span> * + <js>" &lt;/ul&gt;"</js><a name="line.712"></a> -<span class="sourceLineNo">713</span> * + <js>" &lt;p style='text-weight:bold;text-decoration:underline;'&gt;Available Content Types&lt;/p&gt;"</js><a name="line.713"></a> -<span class="sourceLineNo">714</span> * + <js>" $W{contentTypeLinks}"</js><a name="line.714"></a> -<span class="sourceLineNo">715</span> * + <js>"&lt;/div&gt;"</js>,<a name="line.715"></a> -<span class="sourceLineNo">716</span> * footer=<js>"$W{poweredByJuneau}"</js><a name="line.716"></a> -<span class="sourceLineNo">717</span> * ),<a name="line.717"></a> -<span class="sourceLineNo">718</span> *<a name="line.718"></a> -<span class="sourceLineNo">719</span> * <jc>// Widgets for $W variables above.</jc><a name="line.719"></a> -<span class="sourceLineNo">720</span> * widgets={<a name="line.720"></a> -<span class="sourceLineNo">721</span> * PoweredByJuneauWidget.<jk>class</jk>,<a name="line.721"></a> -<span class="sourceLineNo">722</span> * ContentTypeLinksWidget.<jk>class</jk><a name="line.722"></a> -<span class="sourceLineNo">723</span> * }<a name="line.723"></a> -<span class="sourceLineNo">724</span> * )<a name="line.724"></a> -<span class="sourceLineNo">725</span> * </p><a name="line.725"></a> -<span class="sourceLineNo">726</span> */<a name="line.726"></a> -<span class="sourceLineNo">727</span> HtmlDoc htmldoc() default @HtmlDoc;<a name="line.727"></a> -<span class="sourceLineNo">728</span>}<a name="line.728"></a> +<span class="sourceLineNo">703</span> * links={<a name="line.703"></a> +<span class="sourceLineNo">704</span> * <js>"up: request:/.."</js>,<a name="line.704"></a> +<span class="sourceLineNo">705</span> * <js>"options: servlet:/?method=OPTIONS"</js>,<a name="line.705"></a> +<span class="sourceLineNo">706</span> * <js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java"</js>,<a name="line.706"></a> +<span class="sourceLineNo">707</span> * },<a name="line.707"></a> +<span class="sourceLineNo">708</span> * aside={<a name="line.708"></a> +<span class="sourceLineNo">709</span> * <js>"&lt;div style='max-width:400px;min-width:200px'&gt;"</js>,<a name="line.709"></a> +<span class="sourceLineNo">710</span> * <js>" &lt;p&gt;Proof-of-concept resource that shows off the capabilities of working with POJO resources.&lt;/p&gt;"</js>,<a name="line.710"></a> +<span class="sourceLineNo">711</span> * <js>" &lt;p&gt;Provides examples of: &lt;/p&gt;"</js>,<a name="line.711"></a> +<span class="sourceLineNo">712</span> * <js>" &lt;ul&gt;"</js>,<a name="line.712"></a> +<span class="sourceLineNo">713</span> * <js>" &lt;li&gt;XML and RDF namespaces"</js>,<a name="line.713"></a> +<span class="sourceLineNo">714</span> * <js>" &lt;li&gt;Swagger documentation"</js>,<a name="line.714"></a> +<span class="sourceLineNo">715</span> * <js>" &lt;li&gt;Widgets"</js>,<a name="line.715"></a> +<span class="sourceLineNo">716</span> * <js>" &lt;/ul&gt;"</js>,<a name="line.716"></a> +<span class="sourceLineNo">717</span> * <js>" &lt;p style='text-weight:bold;text-decoration:underline;'&gt;Available Content Types&lt;/p&gt;"</js>,<a name="line.717"></a> +<span class="sourceLineNo">718</span> * <js>" $W{contentTypeLinks}"</js>,<a name="line.718"></a> +<span class="sourceLineNo">719</span> * <js>"&lt;/div&gt;"</js><a name="line.719"></a> +<span class="sourceLineNo">720</span> * },<a name="line.720"></a> +<span class="sourceLineNo">721</span> * footer=<js>"$W{poweredByJuneau}"</js><a name="line.721"></a> +<span class="sourceLineNo">722</span> * ),<a name="line.722"></a> +<span class="sourceLineNo">723</span> *<a name="line.723"></a> +<span class="sourceLineNo">724</span> * <jc>// Widgets for $W variables above.</jc><a name="line.724"></a> +<span class="sourceLineNo">725</span> * widgets={<a name="line.725"></a> +<span class="sourceLineNo">726</span> * PoweredByJuneauWidget.<jk>class</jk>,<a name="line.726"></a> +<span class="sourceLineNo">727</span> * ContentTypeLinksWidget.<jk>class</jk><a name="line.727"></a> +<span class="sourceLineNo">728</span> * }<a name="line.728"></a> +<span class="sourceLineNo">729</span> * )<a name="line.729"></a> +<span class="sourceLineNo">730</span> * </p><a name="line.730"></a> +<span class="sourceLineNo">731</span> */<a name="line.731"></a> +<span class="sourceLineNo">732</span> HtmlDoc htmldoc() default @HtmlDoc;<a name="line.732"></a> +<span class="sourceLineNo">733</span>}<a name="line.733"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html b/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html index 5930055..051bfc2 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html @@ -269,16 +269,21 @@ <span class="sourceLineNo">261</span> * @return The bean containing the contents of the OPTIONS page.<a name="line.261"></a> <span class="sourceLineNo">262</span> */<a name="line.262"></a> <span class="sourceLineNo">263</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.263"></a> -<span class="sourceLineNo">264</span> summary="Resource options",<a name="line.264"></a> -<span class="sourceLineNo">265</span> description="Resource options",<a name="line.265"></a> -<span class="sourceLineNo">266</span> htmldoc=@HtmlDoc(<a name="line.266"></a> -<span class="sourceLineNo">267</span> links="{back:'$R{servletURI}'}"<a name="line.267"></a> -<span class="sourceLineNo">268</span> )<a name="line.268"></a> -<span class="sourceLineNo">269</span> )<a name="line.269"></a> -<span class="sourceLineNo">270</span> public Swagger getOptions(RestRequest req) {<a name="line.270"></a> -<span class="sourceLineNo">271</span> return req.getSwagger();<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span>}<a name="line.273"></a> +<span class="sourceLineNo">264</span> htmldoc=@HtmlDoc(<a name="line.264"></a> +<span class="sourceLineNo">265</span> links={<a name="line.265"></a> +<span class="sourceLineNo">266</span> "back: servlet:/",<a name="line.266"></a> +<span class="sourceLineNo">267</span> "json: servlet:/?method=OPTIONS&Accept=text/json&plainText=true"<a name="line.267"></a> +<span class="sourceLineNo">268</span> },<a name="line.268"></a> +<span class="sourceLineNo">269</span> description="Swagger documentation",<a name="line.269"></a> +<span class="sourceLineNo">270</span> aside="NONE"<a name="line.270"></a> +<span class="sourceLineNo">271</span> ),<a name="line.271"></a> +<span class="sourceLineNo">272</span> summary="Resource options",<a name="line.272"></a> +<span class="sourceLineNo">273</span> description="Swagger documentation"<a name="line.273"></a> +<span class="sourceLineNo">274</span> )<a name="line.274"></a> +<span class="sourceLineNo">275</span> public Swagger getOptions(RestRequest req) {<a name="line.275"></a> +<span class="sourceLineNo">276</span> return req.getSwagger();<a name="line.276"></a> +<span class="sourceLineNo">277</span> }<a name="line.277"></a> +<span class="sourceLineNo">278</span>}<a name="line.278"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html index d7735da..fde7cb8 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html @@ -20,74 +20,82 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<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">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import org.apache.juneau.*;<a name="line.17"></a> +<span class="sourceLineNo">015</span>import java.net.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> <span class="sourceLineNo">018</span>import org.apache.juneau.http.*;<a name="line.18"></a> <span class="sourceLineNo">019</span>import org.apache.juneau.rest.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>/**<a name="line.21"></a> -<span class="sourceLineNo">022</span> * Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types.<a name="line.22"></a> -<span class="sourceLineNo">023</span> *<a name="line.23"></a> -<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> -<span class="sourceLineNo">025</span> * The variable it resolves is <js>"$W{contentTypeMenuItem}"</js>.<a name="line.25"></a> -<span class="sourceLineNo">026</span> *<a name="line.26"></a> -<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> -<span class="sourceLineNo">028</span> * An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides<a name="line.28"></a> -<span class="sourceLineNo">029</span> * a drop-down menu item for rendering all other supported content types in plain text:<a name="line.29"></a> -<span class="sourceLineNo">030</span> * <p class='bcode'><a name="line.30"></a> -<span class="sourceLineNo">031</span> * <ja>@RestMethod</ja>(<a name="line.31"></a> -<span class="sourceLineNo">032</span> * name=<js>"GET"</js>,<a name="line.32"></a> -<span class="sourceLineNo">033</span> * path=<js>"/"</js>,<a name="line.33"></a> -<span class="sourceLineNo">034</span> * widgets={<a name="line.34"></a> -<span class="sourceLineNo">035</span> * ContentTypeMenuItem.<jk>class</jk>,<a name="line.35"></a> -<span class="sourceLineNo">036</span> * },<a name="line.36"></a> -<span class="sourceLineNo">037</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.37"></a> -<span class="sourceLineNo">038</span> * links=<js>"{up:'...',options:'...',query:'...',contentTypes:'$W{contentTypeMenuItem}',source:'...'}"</js><a name="line.38"></a> -<span class="sourceLineNo">039</span> * )<a name="line.39"></a> -<span class="sourceLineNo">040</span> * )<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <jk>public</jk> Collection&lt;Pet&gt; getPets() {<a name="line.41"></a> -<span class="sourceLineNo">042</span> * </p><a name="line.42"></a> -<span class="sourceLineNo">043</span> *<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> -<span class="sourceLineNo">045</span> * It renders the following popup-box:<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <br><img class='bordered' src='doc-files/ContentTypeMenuItem.png'><a name="line.46"></a> -<span class="sourceLineNo">047</span> */<a name="line.47"></a> -<span class="sourceLineNo">048</span>public class ContentTypeMenuItem extends MenuItemWidget {<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> * Returns <js>"contentTypeMenuItem"</js>.<a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span> @Override /* Widget */<a name="line.53"></a> -<span class="sourceLineNo">054</span> public String getName() {<a name="line.54"></a> -<span class="sourceLineNo">055</span> return "contentTypeMenuItem";<a name="line.55"></a> -<span class="sourceLineNo">056</span> }<a name="line.56"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.utils.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types.<a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * The variable it resolves is <js>"$W{contentTypeMenuItem}"</js>.<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides<a name="line.29"></a> +<span class="sourceLineNo">030</span> * a drop-down menu item for rendering all other supported content types in plain text:<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <p class='bcode'><a name="line.31"></a> +<span class="sourceLineNo">032</span> * <ja>@RestMethod</ja>(<a name="line.32"></a> +<span class="sourceLineNo">033</span> * name=<js>"GET"</js>,<a name="line.33"></a> +<span class="sourceLineNo">034</span> * path=<js>"/"</js>,<a name="line.34"></a> +<span class="sourceLineNo">035</span> * widgets={<a name="line.35"></a> +<span class="sourceLineNo">036</span> * ContentTypeMenuItem.<jk>class</jk>,<a name="line.36"></a> +<span class="sourceLineNo">037</span> * },<a name="line.37"></a> +<span class="sourceLineNo">038</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.38"></a> +<span class="sourceLineNo">039</span> * links={<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <js>"up: ..."</js>,<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <js>"options: ..."</js>,<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <js>"$W{queryMenuItem}"</js>,<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <js>"$W{contentTypeMenuItem}"</js>,<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <js>"$W{styleMenuItem}"</js>,<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <js>"source: ..."</js><a name="line.45"></a> +<span class="sourceLineNo">046</span> * }<a name="line.46"></a> +<span class="sourceLineNo">047</span> * )<a name="line.47"></a> +<span class="sourceLineNo">048</span> * )<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <jk>public</jk> Collection&lt;Pet&gt; getPets() {<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> * It renders the following popup-box:<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <br><img class='bordered' src='doc-files/ContentTypeMenuItem.png'><a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span>public class ContentTypeMenuItem extends MenuItemWidget {<a name="line.56"></a> <span class="sourceLineNo">057</span><a name="line.57"></a> <span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Looks at the supported media types from the request and constructs a list of hyperlinks to render the data<a name="line.59"></a> -<span class="sourceLineNo">060</span> * as plain-text.<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> @Override /* Widget */<a name="line.62"></a> -<span class="sourceLineNo">063</span> public String getHtml(RestRequest req) throws Exception {<a name="line.63"></a> -<span class="sourceLineNo">064</span> UriResolver r = req.getUriResolver();<a name="line.64"></a> -<span class="sourceLineNo">065</span> StringBuilder sb = new StringBuilder();<a name="line.65"></a> -<span class="sourceLineNo">066</span> sb.append(""<a name="line.66"></a> -<span class="sourceLineNo">067</span> + "<div class='menu-item'>"<a name="line.67"></a> -<span class="sourceLineNo">068</span> + "\n\t<a class='link' onclick='menuClick(this)'>content-types</a>"<a name="line.68"></a> -<span class="sourceLineNo">069</span> + "\n\t<div class='popup-content'>"<a name="line.69"></a> -<span class="sourceLineNo">070</span> );<a name="line.70"></a> -<span class="sourceLineNo">071</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.71"></a> -<span class="sourceLineNo">072</span> Collections.sort(l);<a name="line.72"></a> -<span class="sourceLineNo">073</span> for (MediaType mt : l)<a name="line.73"></a> -<span class="sourceLineNo">074</span> sb.append("\n\t\t<a class='link' href='").append(r.resolve("request:/?plainText=true&Accept="+mt))<a name="line.74"></a> -<span class="sourceLineNo">075</span> .append("'>").append(mt).append("</a><br>");<a name="line.75"></a> -<span class="sourceLineNo">076</span> sb.append(""<a name="line.76"></a> -<span class="sourceLineNo">077</span> + "\n\t</div>"<a name="line.77"></a> -<span class="sourceLineNo">078</span> + "\n</div>"<a name="line.78"></a> -<span class="sourceLineNo">079</span> );<a name="line.79"></a> -<span class="sourceLineNo">080</span> return sb.toString();<a name="line.80"></a> -<span class="sourceLineNo">081</span> }<a name="line.81"></a> -<span class="sourceLineNo">082</span>}<a name="line.82"></a> +<span class="sourceLineNo">059</span> * Returns <js>"contentTypeMenuItem"</js>.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> @Override /* Widget */<a name="line.61"></a> +<span class="sourceLineNo">062</span> public String getName() {<a name="line.62"></a> +<span class="sourceLineNo">063</span> return "contentTypeMenuItem";<a name="line.63"></a> +<span class="sourceLineNo">064</span> }<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> /**<a name="line.66"></a> +<span class="sourceLineNo">067</span> * Looks at the supported media types from the request and constructs a list of hyperlinks to render the data<a name="line.67"></a> +<span class="sourceLineNo">068</span> * as plain-text.<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> @Override /* Widget */<a name="line.70"></a> +<span class="sourceLineNo">071</span> public String getHtml(RestRequest req) throws Exception {<a name="line.71"></a> +<span class="sourceLineNo">072</span> StringBuilder sb = new StringBuilder();<a name="line.72"></a> +<span class="sourceLineNo">073</span> sb.append(""<a name="line.73"></a> +<span class="sourceLineNo">074</span> + "<div class='menu-item'>"<a name="line.74"></a> +<span class="sourceLineNo">075</span> + "\n\t<a class='link' onclick='menuClick(this)'>content-types</a>"<a name="line.75"></a> +<span class="sourceLineNo">076</span> + "\n\t<div class='popup-content'>"<a name="line.76"></a> +<span class="sourceLineNo">077</span> );<a name="line.77"></a> +<span class="sourceLineNo">078</span> List<MediaType> l = new ArrayList<MediaType>(req.getSerializerGroup().getSupportedMediaTypes());<a name="line.78"></a> +<span class="sourceLineNo">079</span> Collections.sort(l);<a name="line.79"></a> +<span class="sourceLineNo">080</span> for (MediaType mt : l) {<a name="line.80"></a> +<span class="sourceLineNo">081</span> URI uri = req.getUri(true, new AMap<String,String>().append("plainText","true").append("Accept",mt.toString()));<a name="line.81"></a> +<span class="sourceLineNo">082</span> sb.append("\n\t\t<a class='link' href='").append(uri).append("'>").append(mt).append("</a><br>");<a name="line.82"></a> +<span class="sourceLineNo">083</span> }<a name="line.83"></a> +<span class="sourceLineNo">084</span> sb.append(""<a name="line.84"></a> +<span class="sourceLineNo">085</span> + "\n\t</div>"<a name="line.85"></a> +<span class="sourceLineNo">086</span> + "\n</div>"<a name="line.86"></a> +<span class="sourceLineNo">087</span> );<a name="line.87"></a> +<span class="sourceLineNo">088</span> return sb.toString();<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span>}<a name="line.90"></a>
