Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 9a1c99915 -> 5c69dfedc
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5c69dfed/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 aa55bad..874664b 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 @@ -121,348 +121,364 @@ <span class="sourceLineNo">113</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.113"></a> <span class="sourceLineNo">114</span> * <li><a name="line.114"></a> <span class="sourceLineNo">115</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.115"></a> -<span class="sourceLineNo">116</span> * parent class.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * </ul><a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> String[] header() default {};<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> /**<a name="line.121"></a> -<span class="sourceLineNo">122</span> * Sets the links in the HTML nav section.<a name="line.122"></a> -<span class="sourceLineNo">123</span> *<a name="line.123"></a> -<span class="sourceLineNo">124</span> * <p><a name="line.124"></a> -<span class="sourceLineNo">125</span> * The value is an array of strings with two possible values:<a name="line.125"></a> -<span class="sourceLineNo">126</span> * <ul><a name="line.126"></a> -<span class="sourceLineNo">127</span> * <li>A key-value pair representing a hyperlink label and href:<a name="line.127"></a> -<span class="sourceLineNo">128</span> * <br><js>"google: http://google.com"</js><a name="line.128"></a> -<span class="sourceLineNo">129</span> * <li>Arbitrary HTML.<a name="line.129"></a> -<span class="sourceLineNo">130</span> * </ul><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> * The page links are positioned immediately under the title and text.<a name="line.133"></a> -<span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * <h5 class='section'>Example:</h5><a name="line.135"></a> -<span class="sourceLineNo">136</span> * <p class='bcode'><a name="line.136"></a> -<span class="sourceLineNo">137</span> * <ja>@RestResource</ja>(<a name="line.137"></a> -<span class="sourceLineNo">138</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.138"></a> -<span class="sourceLineNo">139</span> * links={<a name="line.139"></a> -<span class="sourceLineNo">140</span> * <js>"up: request:/.."</js>,<a name="line.140"></a> -<span class="sourceLineNo">141</span> * <js>"options: servlet:/?method=OPTIONS"</js><a name="line.141"></a> -<span class="sourceLineNo">142</span> * }<a name="line.142"></a> -<span class="sourceLineNo">143</span> * )<a name="line.143"></a> -<span class="sourceLineNo">144</span> * )<a name="line.144"></a> -<span class="sourceLineNo">145</span> * </p><a name="line.145"></a> -<span class="sourceLineNo">146</span> *<a name="line.146"></a> -<span class="sourceLineNo">147</span> * <h6 class='topic'>Other Notes</h6><a name="line.147"></a> -<span class="sourceLineNo">148</span> * <ul class='spaced-list'><a name="line.148"></a> -<span class="sourceLineNo">149</span> * <li><a name="line.149"></a> -<span class="sourceLineNo">150</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.150"></a> -<span class="sourceLineNo">151</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * <li><a name="line.152"></a> -<span class="sourceLineNo">153</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.153"></a> +<span class="sourceLineNo">116</span> * parent class if not overridden.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <li><a name="line.117"></a> +<span class="sourceLineNo">118</span> * The parent value can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.118"></a> +<span class="sourceLineNo">119</span> * </ul><a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> String[] header() default {};<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> * Sets the links in the HTML nav section.<a name="line.124"></a> +<span class="sourceLineNo">125</span> *<a name="line.125"></a> +<span class="sourceLineNo">126</span> * <p><a name="line.126"></a> +<span class="sourceLineNo">127</span> * The value is an array of strings with two possible values:<a name="line.127"></a> +<span class="sourceLineNo">128</span> * <ul><a name="line.128"></a> +<span class="sourceLineNo">129</span> * <li>A key-value pair representing a hyperlink label and href:<a name="line.129"></a> +<span class="sourceLineNo">130</span> * <br><js>"google: http://google.com"</js><a name="line.130"></a> +<span class="sourceLineNo">131</span> * <li>Arbitrary HTML.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * </ul><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> * The page links are positioned immediately under the title and text.<a name="line.135"></a> +<span class="sourceLineNo">136</span> *<a name="line.136"></a> +<span class="sourceLineNo">137</span> * <h5 class='section'>Example:</h5><a name="line.137"></a> +<span class="sourceLineNo">138</span> * <p class='bcode'><a name="line.138"></a> +<span class="sourceLineNo">139</span> * <ja>@RestResource</ja>(<a name="line.139"></a> +<span class="sourceLineNo">140</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.140"></a> +<span class="sourceLineNo">141</span> * links={<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <js>"up: request:/.."</js>,<a name="line.142"></a> +<span class="sourceLineNo">143</span> * <js>"options: servlet:/?method=OPTIONS"</js><a name="line.143"></a> +<span class="sourceLineNo">144</span> * }<a name="line.144"></a> +<span class="sourceLineNo">145</span> * )<a name="line.145"></a> +<span class="sourceLineNo">146</span> * )<a name="line.146"></a> +<span class="sourceLineNo">147</span> * </p><a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <h6 class='topic'>Other Notes</h6><a name="line.149"></a> +<span class="sourceLineNo">150</span> * <ul class='spaced-list'><a name="line.150"></a> +<span class="sourceLineNo">151</span> * <li><a name="line.151"></a> +<span class="sourceLineNo">152</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.153"></a> <span class="sourceLineNo">154</span> * <li><a name="line.154"></a> -<span class="sourceLineNo">155</span> * This field can also use URIs of any support type in {@link UriResolver}.<a name="line.155"></a> +<span class="sourceLineNo">155</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.155"></a> <span class="sourceLineNo">156</span> * <li><a name="line.156"></a> -<span class="sourceLineNo">157</span> * The programmatic equivalent to this annotation are the<a name="line.157"></a> -<span class="sourceLineNo">158</span> * {@link RestConfig#setHtmlLinks(String[])} and {@link RestResponse#setHtmlLinks(String[])} methods.<a name="line.158"></a> -<span class="sourceLineNo">159</span> * <li><a name="line.159"></a> -<span class="sourceLineNo">160</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.160"></a> +<span class="sourceLineNo">157</span> * This field can also use URIs of any support type in {@link UriResolver}.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * <li><a name="line.158"></a> +<span class="sourceLineNo">159</span> * The programmatic equivalent to this annotation are the<a name="line.159"></a> +<span class="sourceLineNo">160</span> * {@link RestConfig#setHtmlLinks(String[])} and {@link RestResponse#setHtmlLinks(String[])} methods.<a name="line.160"></a> <span class="sourceLineNo">161</span> * <li><a name="line.161"></a> -<span class="sourceLineNo">162</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.162"></a> -<span class="sourceLineNo">163</span> * parent class.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * </ul><a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> String[] links() default {};<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * Sets the HTML nav section contents.<a name="line.169"></a> -<span class="sourceLineNo">170</span> *<a name="line.170"></a> -<span class="sourceLineNo">171</span> * <p><a name="line.171"></a> -<span class="sourceLineNo">172</span> * The format of this value is HTML.<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> * The nav section of the page contains the links.<a name="line.175"></a> +<span class="sourceLineNo">162</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * <li><a name="line.163"></a> +<span class="sourceLineNo">164</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.164"></a> +<span class="sourceLineNo">165</span> * parent class.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * <li><a name="line.166"></a> +<span class="sourceLineNo">167</span> * The parent links can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * <br>Use the syntax <js>"key[index]: value"</js> or <js>"[index]: value"</js> to specify an index location<a name="line.168"></a> +<span class="sourceLineNo">169</span> * to place a link inside the list of parent links.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * </ul><a name="line.170"></a> +<span class="sourceLineNo">171</span> */<a name="line.171"></a> +<span class="sourceLineNo">172</span> String[] links() default {};<a name="line.172"></a> +<span class="sourceLineNo">173</span><a name="line.173"></a> +<span class="sourceLineNo">174</span> /**<a name="line.174"></a> +<span class="sourceLineNo">175</span> * Sets the HTML nav section contents.<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> * The format of this value is HTML.<a name="line.178"></a> <span class="sourceLineNo">179</span> *<a name="line.179"></a> -<span class="sourceLineNo">180</span> * <h5 class='section'>Example:</h5><a name="line.180"></a> -<span class="sourceLineNo">181</span> * <p class='bcode'><a name="line.181"></a> -<span class="sourceLineNo">182</span> * <ja>@RestResource</ja>(<a name="line.182"></a> -<span class="sourceLineNo">183</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.183"></a> -<span class="sourceLineNo">184</span> * nav={<a name="line.184"></a> -<span class="sourceLineNo">185</span> * <js>"&lt;p&gt;Custom nav content&lt;/p&gt;"</js><a name="line.185"></a> -<span class="sourceLineNo">186</span> * }<a name="line.186"></a> -<span class="sourceLineNo">187</span> * )<a name="line.187"></a> -<span class="sourceLineNo">188</span> * )<a name="line.188"></a> -<span class="sourceLineNo">189</span> * </p><a name="line.189"></a> -<span class="sourceLineNo">190</span> *<a name="line.190"></a> -<span class="sourceLineNo">191</span> * <h6 class='topic'>Other Notes</h6><a name="line.191"></a> -<span class="sourceLineNo">192</span> * <ul class='spaced-list'><a name="line.192"></a> -<span class="sourceLineNo">193</span> * <li><a name="line.193"></a> -<span class="sourceLineNo">194</span> * When a value is specified, the {@link #links()} value will be ignored.<a name="line.194"></a> -<span class="sourceLineNo">195</span> * <li><a name="line.195"></a> -<span class="sourceLineNo">196</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.196"></a> -<span class="sourceLineNo">197</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.197"></a> -<span class="sourceLineNo">198</span> * <li><a name="line.198"></a> -<span class="sourceLineNo">199</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.199"></a> -<span class="sourceLineNo">200</span> * <li><a name="line.200"></a> -<span class="sourceLineNo">201</span> * Multiple values are combined with newlines into a single string.<a name="line.201"></a> -<span class="sourceLineNo">202</span> * <li><a name="line.202"></a> -<span class="sourceLineNo">203</span> * The programmatic equivalent to this annotation are the<a name="line.203"></a> -<span class="sourceLineNo">204</span> * {@link RestConfig#setHtmlNav(String)} and {@link RestResponse#setHtmlNav(Object)} methods.<a name="line.204"></a> -<span class="sourceLineNo">205</span> * <li><a name="line.205"></a> -<span class="sourceLineNo">206</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.206"></a> -<span class="sourceLineNo">207</span> * <li><a name="line.207"></a> -<span class="sourceLineNo">208</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.208"></a> -<span class="sourceLineNo">209</span> * parent class.<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> String[] nav() default {};<a name="line.212"></a> -<span class="sourceLineNo">213</span><a name="line.213"></a> -<span class="sourceLineNo">214</span> /**<a name="line.214"></a> -<span class="sourceLineNo">215</span> * Sets the HTML aside section contents.<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 format of this value is HTML.<a name="line.218"></a> -<span class="sourceLineNo">219</span> *<a name="line.219"></a> -<span class="sourceLineNo">220</span> * <p><a name="line.220"></a> -<span class="sourceLineNo">221</span> * The aside section typically floats on the right side of the page.<a name="line.221"></a> -<span class="sourceLineNo">222</span> *<a name="line.222"></a> -<span class="sourceLineNo">223</span> * <h5 class='section'>Example:</h5><a name="line.223"></a> -<span class="sourceLineNo">224</span> * <p class='bcode'><a name="line.224"></a> -<span class="sourceLineNo">225</span> * <ja>@RestResource</ja>(<a name="line.225"></a> -<span class="sourceLineNo">226</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.226"></a> -<span class="sourceLineNo">227</span> * aside={<a name="line.227"></a> -<span class="sourceLineNo">228</span> * <js>"&lt;p&gt;Custom aside content&lt;/p&gt;"</js><a name="line.228"></a> -<span class="sourceLineNo">229</span> * }<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> * </p><a name="line.232"></a> -<span class="sourceLineNo">233</span> *<a name="line.233"></a> -<span class="sourceLineNo">234</span> * <h6 class='topic'>Other Notes</h6><a name="line.234"></a> -<span class="sourceLineNo">235</span> * <ul class='spaced-list'><a name="line.235"></a> -<span class="sourceLineNo">236</span> * <li><a name="line.236"></a> -<span class="sourceLineNo">237</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.237"></a> -<span class="sourceLineNo">238</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.238"></a> -<span class="sourceLineNo">239</span> * <li><a name="line.239"></a> -<span class="sourceLineNo">240</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.240"></a> -<span class="sourceLineNo">241</span> * <li><a name="line.241"></a> -<span class="sourceLineNo">242</span> * Multiple values are combined with newlines into a single string.<a name="line.242"></a> -<span class="sourceLineNo">243</span> * <li><a name="line.243"></a> -<span class="sourceLineNo">244</span> * The programmatic equivalent to this annotation are the<a name="line.244"></a> -<span class="sourceLineNo">245</span> * {@link RestConfig#setHtmlAside(String)} and {@link RestResponse#setHtmlAside(Object)} methods.<a name="line.245"></a> -<span class="sourceLineNo">246</span> * <li><a name="line.246"></a> -<span class="sourceLineNo">247</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.247"></a> -<span class="sourceLineNo">248</span> * <li><a name="line.248"></a> -<span class="sourceLineNo">249</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.249"></a> -<span class="sourceLineNo">250</span> * parent class.<a name="line.250"></a> -<span class="sourceLineNo">251</span> * </ul><a name="line.251"></a> -<span class="sourceLineNo">252</span> */<a name="line.252"></a> -<span class="sourceLineNo">253</span> String[] aside() default {};<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> * Sets the HTML footer section contents.<a name="line.256"></a> -<span class="sourceLineNo">257</span> *<a name="line.257"></a> -<span class="sourceLineNo">258</span> * <p><a name="line.258"></a> -<span class="sourceLineNo">259</span> * The format of this value is HTML.<a name="line.259"></a> -<span class="sourceLineNo">260</span> *<a name="line.260"></a> -<span class="sourceLineNo">261</span> * <p><a name="line.261"></a> -<span class="sourceLineNo">262</span> * The footer section typically floats on the bottom of the page.<a name="line.262"></a> -<span class="sourceLineNo">263</span> *<a name="line.263"></a> -<span class="sourceLineNo">264</span> * <h5 class='section'>Example:</h5><a name="line.264"></a> -<span class="sourceLineNo">265</span> * <p class='bcode'><a name="line.265"></a> -<span class="sourceLineNo">266</span> * <ja>@RestResource</ja>(<a name="line.266"></a> -<span class="sourceLineNo">267</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.267"></a> -<span class="sourceLineNo">268</span> * footer={<a name="line.268"></a> -<span class="sourceLineNo">269</span> * <js>"&lt;p&gt;Custom footer content&lt;/p&gt;"</js><a name="line.269"></a> -<span class="sourceLineNo">270</span> * }<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> * </p><a name="line.273"></a> -<span class="sourceLineNo">274</span> *<a name="line.274"></a> -<span class="sourceLineNo">275</span> * <h6 class='topic'>Other Notes</h6><a name="line.275"></a> -<span class="sourceLineNo">276</span> * <ul class='spaced-list'><a name="line.276"></a> -<span class="sourceLineNo">277</span> * <li><a name="line.277"></a> -<span class="sourceLineNo">278</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.278"></a> -<span class="sourceLineNo">279</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.279"></a> -<span class="sourceLineNo">280</span> * <li><a name="line.280"></a> -<span class="sourceLineNo">281</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * <li><a name="line.282"></a> -<span class="sourceLineNo">283</span> * Multiple values are combined with newlines into a single string.<a name="line.283"></a> -<span class="sourceLineNo">284</span> * <li><a name="line.284"></a> -<span class="sourceLineNo">285</span> * The programmatic equivalent to this annotation are the<a name="line.285"></a> -<span class="sourceLineNo">286</span> * {@link RestConfig#setHtmlFooter(String)} and {@link RestResponse#setHtmlFooter(Object)} methods.<a name="line.286"></a> +<span class="sourceLineNo">180</span> * <p><a name="line.180"></a> +<span class="sourceLineNo">181</span> * The nav section of the page contains the links.<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 format of this value is HTML.<a name="line.184"></a> +<span class="sourceLineNo">185</span> *<a name="line.185"></a> +<span class="sourceLineNo">186</span> * <h5 class='section'>Example:</h5><a name="line.186"></a> +<span class="sourceLineNo">187</span> * <p class='bcode'><a name="line.187"></a> +<span class="sourceLineNo">188</span> * <ja>@RestResource</ja>(<a name="line.188"></a> +<span class="sourceLineNo">189</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.189"></a> +<span class="sourceLineNo">190</span> * nav={<a name="line.190"></a> +<span class="sourceLineNo">191</span> * <js>"&lt;p&gt;Custom nav content&lt;/p&gt;"</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> * )<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> * <h6 class='topic'>Other Notes</h6><a name="line.197"></a> +<span class="sourceLineNo">198</span> * <ul class='spaced-list'><a name="line.198"></a> +<span class="sourceLineNo">199</span> * <li><a name="line.199"></a> +<span class="sourceLineNo">200</span> * When a value is specified, the {@link #links()} value will be ignored.<a name="line.200"></a> +<span class="sourceLineNo">201</span> * <li><a name="line.201"></a> +<span class="sourceLineNo">202</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.202"></a> +<span class="sourceLineNo">203</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.203"></a> +<span class="sourceLineNo">204</span> * <li><a name="line.204"></a> +<span class="sourceLineNo">205</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.205"></a> +<span class="sourceLineNo">206</span> * <li><a name="line.206"></a> +<span class="sourceLineNo">207</span> * Multiple values are combined with newlines into a single string.<a name="line.207"></a> +<span class="sourceLineNo">208</span> * <li><a name="line.208"></a> +<span class="sourceLineNo">209</span> * The programmatic equivalent to this annotation are the<a name="line.209"></a> +<span class="sourceLineNo">210</span> * {@link RestConfig#setHtmlNav(String)} and {@link RestResponse#setHtmlNav(Object)} methods.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * <li><a name="line.211"></a> +<span class="sourceLineNo">212</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * <li><a name="line.213"></a> +<span class="sourceLineNo">214</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.214"></a> +<span class="sourceLineNo">215</span> * parent class.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <li><a name="line.216"></a> +<span class="sourceLineNo">217</span> * The parent value can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.217"></a> +<span class="sourceLineNo">218</span> * </ul><a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> String[] nav() default {};<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> /**<a name="line.222"></a> +<span class="sourceLineNo">223</span> * Sets the HTML aside section contents.<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 format of this value is HTML.<a name="line.226"></a> +<span class="sourceLineNo">227</span> *<a name="line.227"></a> +<span class="sourceLineNo">228</span> * <p><a name="line.228"></a> +<span class="sourceLineNo">229</span> * The aside section typically floats on the right side of the page.<a name="line.229"></a> +<span class="sourceLineNo">230</span> *<a name="line.230"></a> +<span class="sourceLineNo">231</span> * <h5 class='section'>Example:</h5><a name="line.231"></a> +<span class="sourceLineNo">232</span> * <p class='bcode'><a name="line.232"></a> +<span class="sourceLineNo">233</span> * <ja>@RestResource</ja>(<a name="line.233"></a> +<span class="sourceLineNo">234</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.234"></a> +<span class="sourceLineNo">235</span> * aside={<a name="line.235"></a> +<span class="sourceLineNo">236</span> * <js>"&lt;p&gt;Custom aside content&lt;/p&gt;"</js><a name="line.236"></a> +<span class="sourceLineNo">237</span> * }<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">241</span> *<a name="line.241"></a> +<span class="sourceLineNo">242</span> * <h6 class='topic'>Other Notes</h6><a name="line.242"></a> +<span class="sourceLineNo">243</span> * <ul class='spaced-list'><a name="line.243"></a> +<span class="sourceLineNo">244</span> * <li><a name="line.244"></a> +<span class="sourceLineNo">245</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.245"></a> +<span class="sourceLineNo">246</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.246"></a> +<span class="sourceLineNo">247</span> * <li><a name="line.247"></a> +<span class="sourceLineNo">248</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.248"></a> +<span class="sourceLineNo">249</span> * <li><a name="line.249"></a> +<span class="sourceLineNo">250</span> * Multiple values are combined with newlines into a single string.<a name="line.250"></a> +<span class="sourceLineNo">251</span> * <li><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#setHtmlAside(String)} and {@link RestResponse#setHtmlAside(Object)} methods.<a name="line.253"></a> +<span class="sourceLineNo">254</span> * <li><a name="line.254"></a> +<span class="sourceLineNo">255</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.255"></a> +<span class="sourceLineNo">256</span> * <li><a name="line.256"></a> +<span class="sourceLineNo">257</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.257"></a> +<span class="sourceLineNo">258</span> * parent class.<a name="line.258"></a> +<span class="sourceLineNo">259</span> * <li><a name="line.259"></a> +<span class="sourceLineNo">260</span> * The parent value can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.260"></a> +<span class="sourceLineNo">261</span> * </ul><a name="line.261"></a> +<span class="sourceLineNo">262</span> */<a name="line.262"></a> +<span class="sourceLineNo">263</span> String[] aside() default {};<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> /**<a name="line.265"></a> +<span class="sourceLineNo">266</span> * Sets the HTML footer section contents.<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 format of this value is HTML.<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> * The footer section typically floats on the bottom of the page.<a name="line.272"></a> +<span class="sourceLineNo">273</span> *<a name="line.273"></a> +<span class="sourceLineNo">274</span> * <h5 class='section'>Example:</h5><a name="line.274"></a> +<span class="sourceLineNo">275</span> * <p class='bcode'><a name="line.275"></a> +<span class="sourceLineNo">276</span> * <ja>@RestResource</ja>(<a name="line.276"></a> +<span class="sourceLineNo">277</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.277"></a> +<span class="sourceLineNo">278</span> * footer={<a name="line.278"></a> +<span class="sourceLineNo">279</span> * <js>"&lt;p&gt;Custom footer content&lt;/p&gt;"</js><a name="line.279"></a> +<span class="sourceLineNo">280</span> * }<a name="line.280"></a> +<span class="sourceLineNo">281</span> * )<a name="line.281"></a> +<span class="sourceLineNo">282</span> * )<a name="line.282"></a> +<span class="sourceLineNo">283</span> * </p><a name="line.283"></a> +<span class="sourceLineNo">284</span> *<a name="line.284"></a> +<span class="sourceLineNo">285</span> * <h6 class='topic'>Other Notes</h6><a name="line.285"></a> +<span class="sourceLineNo">286</span> * <ul class='spaced-list'><a name="line.286"></a> <span class="sourceLineNo">287</span> * <li><a name="line.287"></a> -<span class="sourceLineNo">288</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <li><a name="line.289"></a> -<span class="sourceLineNo">290</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.290"></a> -<span class="sourceLineNo">291</span> * parent class.<a name="line.291"></a> -<span class="sourceLineNo">292</span> * </ul><a name="line.292"></a> -<span class="sourceLineNo">293</span> */<a name="line.293"></a> -<span class="sourceLineNo">294</span> String[] footer() default {};<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> * Sets the HTML CSS style section contents.<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 format of this value is CSS.<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> * style={<a name="line.306"></a> -<span class="sourceLineNo">307</span> * <js>".red{color:red;}"</js>,<a name="line.307"></a> -<span class="sourceLineNo">308</span> * <js>".blue{color:blue;}"</js><a name="line.308"></a> -<span class="sourceLineNo">309</span> * }<a name="line.309"></a> -<span class="sourceLineNo">310</span> * )<a name="line.310"></a> -<span class="sourceLineNo">311</span> * )<a name="line.311"></a> -<span class="sourceLineNo">312</span> * </p><a name="line.312"></a> +<span class="sourceLineNo">288</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.288"></a> +<span class="sourceLineNo">289</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.289"></a> +<span class="sourceLineNo">290</span> * <li><a name="line.290"></a> +<span class="sourceLineNo">291</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <li><a name="line.292"></a> +<span class="sourceLineNo">293</span> * Multiple values are combined with newlines into a single string.<a name="line.293"></a> +<span class="sourceLineNo">294</span> * <li><a name="line.294"></a> +<span class="sourceLineNo">295</span> * The programmatic equivalent to this annotation are the<a name="line.295"></a> +<span class="sourceLineNo">296</span> * {@link RestConfig#setHtmlFooter(String)} and {@link RestResponse#setHtmlFooter(Object)} methods.<a name="line.296"></a> +<span class="sourceLineNo">297</span> * <li><a name="line.297"></a> +<span class="sourceLineNo">298</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.298"></a> +<span class="sourceLineNo">299</span> * <li><a name="line.299"></a> +<span class="sourceLineNo">300</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.300"></a> +<span class="sourceLineNo">301</span> * parent class.<a name="line.301"></a> +<span class="sourceLineNo">302</span> * <li><a name="line.302"></a> +<span class="sourceLineNo">303</span> * The parent value can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.303"></a> +<span class="sourceLineNo">304</span> * </ul><a name="line.304"></a> +<span class="sourceLineNo">305</span> */<a name="line.305"></a> +<span class="sourceLineNo">306</span> String[] footer() default {};<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> * Sets the HTML CSS style section contents.<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> * The format of this value is CSS.<a name="line.312"></a> <span class="sourceLineNo">313</span> *<a name="line.313"></a> -<span class="sourceLineNo">314</span> * <h6 class='topic'>Other Notes</h6><a name="line.314"></a> -<span class="sourceLineNo">315</span> * <ul class='spaced-list'><a name="line.315"></a> -<span class="sourceLineNo">316</span> * <li><a name="line.316"></a> -<span class="sourceLineNo">317</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.317"></a> -<span class="sourceLineNo">318</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.318"></a> -<span class="sourceLineNo">319</span> * <li><a name="line.319"></a> -<span class="sourceLineNo">320</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.320"></a> -<span class="sourceLineNo">321</span> * <li><a name="line.321"></a> -<span class="sourceLineNo">322</span> * Multiple values are combined with newlines into a single string.<a name="line.322"></a> -<span class="sourceLineNo">323</span> * <li><a name="line.323"></a> -<span class="sourceLineNo">324</span> * The programmatic equivalent to this annotation are the<a name="line.324"></a> -<span class="sourceLineNo">325</span> * {@link RestConfig#setHtmlStyle(String)} and {@link RestResponse#setHtmlStyle(Object)} methods.<a name="line.325"></a> -<span class="sourceLineNo">326</span> * <li><a name="line.326"></a> -<span class="sourceLineNo">327</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.327"></a> +<span class="sourceLineNo">314</span> * <h5 class='section'>Example:</h5><a name="line.314"></a> +<span class="sourceLineNo">315</span> * <p class='bcode'><a name="line.315"></a> +<span class="sourceLineNo">316</span> * <ja>@RestResource</ja>(<a name="line.316"></a> +<span class="sourceLineNo">317</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.317"></a> +<span class="sourceLineNo">318</span> * style={<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <js>".red{color:red;}"</js>,<a name="line.319"></a> +<span class="sourceLineNo">320</span> * <js>".blue{color:blue;}"</js><a name="line.320"></a> +<span class="sourceLineNo">321</span> * }<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> * </p><a name="line.324"></a> +<span class="sourceLineNo">325</span> *<a name="line.325"></a> +<span class="sourceLineNo">326</span> * <h6 class='topic'>Other Notes</h6><a name="line.326"></a> +<span class="sourceLineNo">327</span> * <ul class='spaced-list'><a name="line.327"></a> <span class="sourceLineNo">328</span> * <li><a name="line.328"></a> -<span class="sourceLineNo">329</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.329"></a> -<span class="sourceLineNo">330</span> * parent class.<a name="line.330"></a> -<span class="sourceLineNo">331</span> * </ul><a name="line.331"></a> -<span class="sourceLineNo">332</span> */<a name="line.332"></a> -<span class="sourceLineNo">333</span> String[] style() default {};<a name="line.333"></a> -<span class="sourceLineNo">334</span><a name="line.334"></a> -<span class="sourceLineNo">335</span> /**<a name="line.335"></a> -<span class="sourceLineNo">336</span> * Sets the CSS URL in the HTML CSS style section.<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> * The format of this value is a URL.<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> * Specifies the URL to the stylesheet to add as a link in the style tag in the header.<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> * The format of this value is CSS.<a name="line.345"></a> -<span class="sourceLineNo">346</span> *<a name="line.346"></a> -<span class="sourceLineNo">347</span> * <h5 class='section'>Example:</h5><a name="line.347"></a> -<span class="sourceLineNo">348</span> * <p class='bcode'><a name="line.348"></a> -<span class="sourceLineNo">349</span> * <ja>@RestResource</ja>(<a name="line.349"></a> -<span class="sourceLineNo">350</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.350"></a> -<span class="sourceLineNo">351</span> * stylesheet=<js>"http://someOtherHost/stealTheir.css"</js><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> * </p><a name="line.354"></a> -<span class="sourceLineNo">355</span> *<a name="line.355"></a> -<span class="sourceLineNo">356</span> * <h6 class='topic'>Other Notes</h6><a name="line.356"></a> -<span class="sourceLineNo">357</span> * <ul class='spaced-list'><a name="line.357"></a> -<span class="sourceLineNo">358</span> * <li><a name="line.358"></a> -<span class="sourceLineNo">359</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols<a name="line.359"></a> -<span class="sourceLineNo">360</span> * defined by {@link UriResolver}.<a name="line.360"></a> -<span class="sourceLineNo">361</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.361"></a> -<span class="sourceLineNo">362</span> * <li><a name="line.362"></a> -<span class="sourceLineNo">363</span> * The programmatic equivalent to this annotation are the<a name="line.363"></a> -<span class="sourceLineNo">364</span> * {@link RestConfig#setHtmlStylesheet(String)}/{@link RestResponse#setHtmlStylesheet(Object)} methods.<a name="line.364"></a> -<span class="sourceLineNo">365</span> * <li><a name="line.365"></a> -<span class="sourceLineNo">366</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.366"></a> -<span class="sourceLineNo">367</span> * <li><a name="line.367"></a> -<span class="sourceLineNo">368</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.368"></a> -<span class="sourceLineNo">369</span> * parent class.<a name="line.369"></a> -<span class="sourceLineNo">370</span> * </ul><a name="line.370"></a> -<span class="sourceLineNo">371</span> */<a name="line.371"></a> -<span class="sourceLineNo">372</span> String stylesheet() default "";<a name="line.372"></a> -<span class="sourceLineNo">373</span><a name="line.373"></a> -<span class="sourceLineNo">374</span> /**<a name="line.374"></a> -<span class="sourceLineNo">375</span> * Sets the HTML script section contents.<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 format of this value is Javascript.<a name="line.378"></a> -<span class="sourceLineNo">379</span> *<a name="line.379"></a> -<span class="sourceLineNo">380</span> * <h5 class='section'>Example:</h5><a name="line.380"></a> -<span class="sourceLineNo">381</span> * <p class='bcode'><a name="line.381"></a> -<span class="sourceLineNo">382</span> * <ja>@RestResource</ja>(<a name="line.382"></a> -<span class="sourceLineNo">383</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.383"></a> -<span class="sourceLineNo">384</span> * script={<a name="line.384"></a> -<span class="sourceLineNo">385</span> * <js>"alert('Hello!')"</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">329</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.329"></a> +<span class="sourceLineNo">330</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <li><a name="line.331"></a> +<span class="sourceLineNo">332</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.332"></a> +<span class="sourceLineNo">333</span> * <li><a name="line.333"></a> +<span class="sourceLineNo">334</span> * Multiple values are combined with newlines into a single string.<a name="line.334"></a> +<span class="sourceLineNo">335</span> * <li><a name="line.335"></a> +<span class="sourceLineNo">336</span> * The programmatic equivalent to this annotation are the<a name="line.336"></a> +<span class="sourceLineNo">337</span> * {@link RestConfig#setHtmlStyle(String)} and {@link RestResponse#setHtmlStyle(Object)} methods.<a name="line.337"></a> +<span class="sourceLineNo">338</span> * <li><a name="line.338"></a> +<span class="sourceLineNo">339</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.339"></a> +<span class="sourceLineNo">340</span> * <li><a name="line.340"></a> +<span class="sourceLineNo">341</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.341"></a> +<span class="sourceLineNo">342</span> * parent class.<a name="line.342"></a> +<span class="sourceLineNo">343</span> * <li><a name="line.343"></a> +<span class="sourceLineNo">344</span> * The parent value can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.344"></a> +<span class="sourceLineNo">345</span> * </ul><a name="line.345"></a> +<span class="sourceLineNo">346</span> */<a name="line.346"></a> +<span class="sourceLineNo">347</span> String[] style() default {};<a name="line.347"></a> +<span class="sourceLineNo">348</span><a name="line.348"></a> +<span class="sourceLineNo">349</span> /**<a name="line.349"></a> +<span class="sourceLineNo">350</span> * Sets the CSS URL in the HTML CSS style section.<a name="line.350"></a> +<span class="sourceLineNo">351</span> *<a name="line.351"></a> +<span class="sourceLineNo">352</span> * <p><a name="line.352"></a> +<span class="sourceLineNo">353</span> * The format of this value is a URL.<a name="line.353"></a> +<span class="sourceLineNo">354</span> *<a name="line.354"></a> +<span class="sourceLineNo">355</span> * <p><a name="line.355"></a> +<span class="sourceLineNo">356</span> * Specifies the URL to the stylesheet to add as a link in the style tag in the header.<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> * The format of this value is CSS.<a name="line.359"></a> +<span class="sourceLineNo">360</span> *<a name="line.360"></a> +<span class="sourceLineNo">361</span> * <h5 class='section'>Example:</h5><a name="line.361"></a> +<span class="sourceLineNo">362</span> * <p class='bcode'><a name="line.362"></a> +<span class="sourceLineNo">363</span> * <ja>@RestResource</ja>(<a name="line.363"></a> +<span class="sourceLineNo">364</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.364"></a> +<span class="sourceLineNo">365</span> * stylesheet=<js>"http://someOtherHost/stealTheir.css"</js><a name="line.365"></a> +<span class="sourceLineNo">366</span> * )<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> *<a name="line.369"></a> +<span class="sourceLineNo">370</span> * <h6 class='topic'>Other Notes</h6><a name="line.370"></a> +<span class="sourceLineNo">371</span> * <ul class='spaced-list'><a name="line.371"></a> +<span class="sourceLineNo">372</span> * <li><a name="line.372"></a> +<span class="sourceLineNo">373</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols<a name="line.373"></a> +<span class="sourceLineNo">374</span> * defined by {@link UriResolver}.<a name="line.374"></a> +<span class="sourceLineNo">375</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.375"></a> +<span class="sourceLineNo">376</span> * <li><a name="line.376"></a> +<span class="sourceLineNo">377</span> * The programmatic equivalent to this annotation are the<a name="line.377"></a> +<span class="sourceLineNo">378</span> * {@link RestConfig#setHtmlStylesheet(String)}/{@link RestResponse#setHtmlStylesheet(Object)} methods.<a name="line.378"></a> +<span class="sourceLineNo">379</span> * <li><a name="line.379"></a> +<span class="sourceLineNo">380</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.380"></a> +<span class="sourceLineNo">381</span> * <li><a name="line.381"></a> +<span class="sourceLineNo">382</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.382"></a> +<span class="sourceLineNo">383</span> * parent class.<a name="line.383"></a> +<span class="sourceLineNo">384</span> * </ul><a name="line.384"></a> +<span class="sourceLineNo">385</span> */<a name="line.385"></a> +<span class="sourceLineNo">386</span> String stylesheet() default "";<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> * Sets the HTML script section contents.<a name="line.389"></a> <span class="sourceLineNo">390</span> *<a name="line.390"></a> -<span class="sourceLineNo">391</span> * <h6 class='topic'>Other Notes</h6><a name="line.391"></a> -<span class="sourceLineNo">392</span> * <ul class='spaced-list'><a name="line.392"></a> -<span class="sourceLineNo">393</span> * <li><a name="line.393"></a> -<span class="sourceLineNo">394</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.394"></a> -<span class="sourceLineNo">395</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.395"></a> -<span class="sourceLineNo">396</span> * <li><a name="line.396"></a> -<span class="sourceLineNo">397</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.397"></a> -<span class="sourceLineNo">398</span> * <li><a name="line.398"></a> -<span class="sourceLineNo">399</span> * Multiple values are combined with newlines into a single string.<a name="line.399"></a> -<span class="sourceLineNo">400</span> * <li><a name="line.400"></a> -<span class="sourceLineNo">401</span> * The programmatic equivalent to this annotation are the<a name="line.401"></a> -<span class="sourceLineNo">402</span> * {@link RestConfig#setHtmlScript(String)} and {@link RestResponse#setHtmlScript(Object)} methods.<a name="line.402"></a> -<span class="sourceLineNo">403</span> * <li><a name="line.403"></a> -<span class="sourceLineNo">404</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.404"></a> -<span class="sourceLineNo">405</span> * <li><a name="line.405"></a> -<span class="sourceLineNo">406</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.406"></a> -<span class="sourceLineNo">407</span> * parent class.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * </ul><a name="line.408"></a> -<span class="sourceLineNo">409</span> */<a name="line.409"></a> -<span class="sourceLineNo">410</span> String[] script() default {};<a name="line.410"></a> -<span class="sourceLineNo">411</span><a name="line.411"></a> -<span class="sourceLineNo">412</span> /**<a name="line.412"></a> -<span class="sourceLineNo">413</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.413"></a> -<span class="sourceLineNo">414</span> *<a name="line.414"></a> -<span class="sourceLineNo">415</span> * <p><a name="line.415"></a> -<span class="sourceLineNo">416</span> * This only applies to the rendered data portion of the page.<a name="line.416"></a> -<span class="sourceLineNo">417</span> */<a name="line.417"></a> -<span class="sourceLineNo">418</span> boolean nowrap() default false;<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> * Specifies the text to display when serializing an empty array or collection.<a name="line.421"></a> -<span class="sourceLineNo">422</span> */<a name="line.422"></a> -<span class="sourceLineNo">423</span> String noResultsMessage() default "no results";<a name="line.423"></a> -<span class="sourceLineNo">424</span><a name="line.424"></a> -<span class="sourceLineNo">425</span> /**<a name="line.425"></a> -<span class="sourceLineNo">426</span> * Specifies the template class to use for rendering the HTML page.<a name="line.426"></a> -<span class="sourceLineNo">427</span> *<a name="line.427"></a> -<span class="sourceLineNo">428</span> * <p><a name="line.428"></a> -<span class="sourceLineNo">429</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.429"></a> -<span class="sourceLineNo">430</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.430"></a> -<span class="sourceLineNo">431</span> *<a name="line.431"></a> -<span class="sourceLineNo">432</span> * <h6 class='topic'>Other Notes</h6><a name="line.432"></a> -<span class="sourceLineNo">433</span> * <ul class='spaced-list'><a name="line.433"></a> -<span class="sourceLineNo">434</span> * <li><a name="line.434"></a> -<span class="sourceLineNo">435</span> * The programmatic equivalent to this annotation are the<a name="line.435"></a> -<span class="sourceLineNo">436</span> * {@link RestConfig#setHtmlTemplate(Class)} and {@link RestResponse#setHtmlTemplate(Class)} methods.<a name="line.436"></a> -<span class="sourceLineNo">437</span> * <li><a name="line.437"></a> -<span class="sourceLineNo">438</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.438"></a> -<span class="sourceLineNo">439</span> * <li><a name="line.439"></a> -<span class="sourceLineNo">440</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.440"></a> -<span class="sourceLineNo">441</span> * parent class.<a name="line.441"></a> -<span class="sourceLineNo">442</span> * </ul><a name="line.442"></a> -<span class="sourceLineNo">443</span> */<a name="line.443"></a> -<span class="sourceLineNo">444</span> Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;<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> * Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly<a name="line.447"></a> -<span class="sourceLineNo">448</span> * generate arbitrary replacement HTML.<a name="line.448"></a> -<span class="sourceLineNo">449</span> *<a name="line.449"></a> -<span class="sourceLineNo">450</span> * <h6 class='topic'>Other Notes</h6><a name="line.450"></a> -<span class="sourceLineNo">451</span> * <ul class='spaced-list'><a name="line.451"></a> -<span class="sourceLineNo">452</span> * <li><a name="line.452"></a> -<span class="sourceLineNo">453</span> * Widgets are inherited from parent to child, but can be overridden by reusing the widget name.<a name="line.453"></a> -<span class="sourceLineNo">454</span> * </ul><a name="line.454"></a> -<span class="sourceLineNo">455</span> */<a name="line.455"></a> -<span class="sourceLineNo">456</span> Class<? extends Widget>[] widgets() default {};<a name="line.456"></a> -<span class="sourceLineNo">457</span>}<a name="line.457"></a> +<span class="sourceLineNo">391</span> * <p><a name="line.391"></a> +<span class="sourceLineNo">392</span> * The format of this value is Javascript.<a name="line.392"></a> +<span class="sourceLineNo">393</span> *<a name="line.393"></a> +<span class="sourceLineNo">394</span> * <h5 class='section'>Example:</h5><a name="line.394"></a> +<span class="sourceLineNo">395</span> * <p class='bcode'><a name="line.395"></a> +<span class="sourceLineNo">396</span> * <ja>@RestResource</ja>(<a name="line.396"></a> +<span class="sourceLineNo">397</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.397"></a> +<span class="sourceLineNo">398</span> * script={<a name="line.398"></a> +<span class="sourceLineNo">399</span> * <js>"alert('Hello!')"</js><a name="line.399"></a> +<span class="sourceLineNo">400</span> * }<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> * <h6 class='topic'>Other Notes</h6><a name="line.405"></a> +<span class="sourceLineNo">406</span> * <ul class='spaced-list'><a name="line.406"></a> +<span class="sourceLineNo">407</span> * <li><a name="line.407"></a> +<span class="sourceLineNo">408</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.408"></a> +<span class="sourceLineNo">409</span> * <br>See {@link RestContext#getVarResolver()} for the list of supported variables.<a name="line.409"></a> +<span class="sourceLineNo">410</span> * <li><a name="line.410"></a> +<span class="sourceLineNo">411</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.411"></a> +<span class="sourceLineNo">412</span> * <li><a name="line.412"></a> +<span class="sourceLineNo">413</span> * Multiple values are combined with newlines into a single string.<a name="line.413"></a> +<span class="sourceLineNo">414</span> * <li><a name="line.414"></a> +<span class="sourceLineNo">415</span> * The programmatic equivalent to this annotation are the<a name="line.415"></a> +<span class="sourceLineNo">416</span> * {@link RestConfig#setHtmlScript(String)} and {@link RestResponse#setHtmlScript(Object)} methods.<a name="line.416"></a> +<span class="sourceLineNo">417</span> * <li><a name="line.417"></a> +<span class="sourceLineNo">418</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.418"></a> +<span class="sourceLineNo">419</span> * <li><a name="line.419"></a> +<span class="sourceLineNo">420</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.420"></a> +<span class="sourceLineNo">421</span> * parent class.<a name="line.421"></a> +<span class="sourceLineNo">422</span> * <li><a name="line.422"></a> +<span class="sourceLineNo">423</span> * The parent value can be included by adding the literal <js>"INHERIT"</js> as a value.<a name="line.423"></a> +<span class="sourceLineNo">424</span> * </ul><a name="line.424"></a> +<span class="sourceLineNo">425</span> */<a name="line.425"></a> +<span class="sourceLineNo">426</span> String[] script() default {};<a name="line.426"></a> +<span class="sourceLineNo">427</span><a name="line.427"></a> +<span class="sourceLineNo">428</span> /**<a name="line.428"></a> +<span class="sourceLineNo">429</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.429"></a> +<span class="sourceLineNo">430</span> *<a name="line.430"></a> +<span class="sourceLineNo">431</span> * <p><a name="line.431"></a> +<span class="sourceLineNo">432</span> * This only applies to the rendered data portion of the page.<a name="line.432"></a> +<span class="sourceLineNo">433</span> */<a name="line.433"></a> +<span class="sourceLineNo">434</span> boolean nowrap() default false;<a name="line.434"></a> +<span class="sourceLineNo">435</span><a name="line.435"></a> +<span class="sourceLineNo">436</span> /**<a name="line.436"></a> +<span class="sourceLineNo">437</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.437"></a> +<span class="sourceLineNo">438</span> */<a name="line.438"></a> +<span class="sourceLineNo">439</span> String noResultsMessage() default "no results";<a name="line.439"></a> +<span class="sourceLineNo">440</span><a name="line.440"></a> +<span class="sourceLineNo">441</span> /**<a name="line.441"></a> +<span class="sourceLineNo">442</span> * Specifies the template class to use for rendering the HTML page.<a name="line.442"></a> +<span class="sourceLineNo">443</span> *<a name="line.443"></a> +<span class="sourceLineNo">444</span> * <p><a name="line.444"></a> +<span class="sourceLineNo">445</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.445"></a> +<span class="sourceLineNo">446</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.446"></a> +<span class="sourceLineNo">447</span> *<a name="line.447"></a> +<span class="sourceLineNo">448</span> * <h6 class='topic'>Other Notes</h6><a name="line.448"></a> +<span class="sourceLineNo">449</span> * <ul class='spaced-list'><a name="line.449"></a> +<span class="sourceLineNo">450</span> * <li><a name="line.450"></a> +<span class="sourceLineNo">451</span> * The programmatic equivalent to this annotation are the<a name="line.451"></a> +<span class="sourceLineNo">452</span> * {@link RestConfig#setHtmlTemplate(Class)} and {@link RestResponse#setHtmlTemplate(Class)} methods.<a name="line.452"></a> +<span class="sourceLineNo">453</span> * <li><a name="line.453"></a> +<span class="sourceLineNo">454</span> * On methods, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the servlet/resource class.<a name="line.454"></a> +<span class="sourceLineNo">455</span> * <li><a name="line.455"></a> +<span class="sourceLineNo">456</span> * On servlet/resource classes, this value is inherited from the <ja>@HtmlDoc</ja> annotation on the<a name="line.456"></a> +<span class="sourceLineNo">457</span> * parent class.<a name="line.457"></a> +<span class="sourceLineNo">458</span> * </ul><a name="line.458"></a> +<span class="sourceLineNo">459</span> */<a name="line.459"></a> +<span class="sourceLineNo">460</span> Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;<a name="line.460"></a> +<span class="sourceLineNo">461</span><a name="line.461"></a> +<span class="sourceLineNo">462</span> /**<a name="line.462"></a> +<span class="sourceLineNo">463</span> * Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly<a name="line.463"></a> +<span class="sourceLineNo">464</span> * generate arbitrary replacement HTML.<a name="line.464"></a> +<span class="sourceLineNo">465</span> *<a name="line.465"></a> +<span class="sourceLineNo">466</span> * <h6 class='topic'>Other Notes</h6><a name="line.466"></a> +<span class="sourceLineNo">467</span> * <ul class='spaced-list'><a name="line.467"></a> +<span class="sourceLineNo">468</span> * <li><a name="line.468"></a> +<span class="sourceLineNo">469</span> * Widgets are inherited from parent to child, but can be overridden by reusing the widget name.<a name="line.469"></a> +<span class="sourceLineNo">470</span> * </ul><a name="line.470"></a> +<span class="sourceLineNo">471</span> */<a name="line.471"></a> +<span class="sourceLineNo">472</span> Class<? extends Widget>[] widgets() default {};<a name="line.472"></a> +<span class="sourceLineNo">473</span>}<a name="line.473"></a>
