http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html index 524d210..f4b3ea9 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html @@ -285,274 +285,276 @@ <span class="sourceLineNo">277</span> * )<a name="line.277"></a> <span class="sourceLineNo">278</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.278"></a> <span class="sourceLineNo">279</span> * </p><a name="line.279"></a> -<span class="sourceLineNo">280</span> */<a name="line.280"></a> -<span class="sourceLineNo">281</span> public static final String HTMLDOC_links = "HtmlDocSerializer.links.map";<a name="line.281"></a> -<span class="sourceLineNo">282</span><a name="line.282"></a> -<span class="sourceLineNo">283</span> /**<a name="line.283"></a> -<span class="sourceLineNo">284</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_links} property.<a name="line.284"></a> -<span class="sourceLineNo">285</span> */<a name="line.285"></a> -<span class="sourceLineNo">286</span> public static final String HTMLDOC_links_put = "HtmlDocSerializer.links.map.put";<a name="line.286"></a> -<span class="sourceLineNo">287</span><a name="line.287"></a> -<span class="sourceLineNo">288</span> /**<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <b>Configuration property:</b> Nav section contents.<a name="line.289"></a> -<span class="sourceLineNo">290</span> * <p><a name="line.290"></a> -<span class="sourceLineNo">291</span> * <ul><a name="line.291"></a> -<span class="sourceLineNo">292</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js><a name="line.292"></a> -<span class="sourceLineNo">293</span> * <li><b>Data type:</b> <code>String</code><a name="line.293"></a> -<span class="sourceLineNo">294</span> * <li><b>Default:</b> <jk>null</jk><a name="line.294"></a> -<span class="sourceLineNo">295</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.295"></a> -<span class="sourceLineNo">296</span> * </ul><a name="line.296"></a> -<span class="sourceLineNo">297</span> * <p><a name="line.297"></a> -<span class="sourceLineNo">298</span> * Allows you to override the contents of the nav section on the HTML page.<a name="line.298"></a> -<span class="sourceLineNo">299</span> * The nav section normally contains the page links at the top of the page.<a name="line.299"></a> -<span class="sourceLineNo">300</span> * <p><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> * nav=<js>"&lt;p class='special-navigation'&gt;This is my special navigation 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> * <p><a name="line.310"></a> -<span class="sourceLineNo">311</span> * When this property is specified, the {@link #HTMLDOC_links} property is ignored.<a name="line.311"></a> +<span class="sourceLineNo">280</span> * <p><a name="line.280"></a> +<span class="sourceLineNo">281</span> * Values that start with <js>'&lt;'</js> are assumed to be HTML and rendered as-is. <a name="line.281"></a> +<span class="sourceLineNo">282</span> */<a name="line.282"></a> +<span class="sourceLineNo">283</span> public static final String HTMLDOC_links = "HtmlDocSerializer.links.map";<a name="line.283"></a> +<span class="sourceLineNo">284</span><a name="line.284"></a> +<span class="sourceLineNo">285</span> /**<a name="line.285"></a> +<span class="sourceLineNo">286</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_links} property.<a name="line.286"></a> +<span class="sourceLineNo">287</span> */<a name="line.287"></a> +<span class="sourceLineNo">288</span> public static final String HTMLDOC_links_put = "HtmlDocSerializer.links.map.put";<a name="line.288"></a> +<span class="sourceLineNo">289</span><a name="line.289"></a> +<span class="sourceLineNo">290</span> /**<a name="line.290"></a> +<span class="sourceLineNo">291</span> * <b>Configuration property:</b> Nav section contents.<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> +<span class="sourceLineNo">293</span> * <ul><a name="line.293"></a> +<span class="sourceLineNo">294</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js><a name="line.294"></a> +<span class="sourceLineNo">295</span> * <li><b>Data type:</b> <code>String</code><a name="line.295"></a> +<span class="sourceLineNo">296</span> * <li><b>Default:</b> <jk>null</jk><a name="line.296"></a> +<span class="sourceLineNo">297</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.297"></a> +<span class="sourceLineNo">298</span> * </ul><a name="line.298"></a> +<span class="sourceLineNo">299</span> * <p><a name="line.299"></a> +<span class="sourceLineNo">300</span> * Allows you to override the contents of the nav section on the HTML page.<a name="line.300"></a> +<span class="sourceLineNo">301</span> * The nav section normally contains the page links at the top of the page.<a name="line.301"></a> +<span class="sourceLineNo">302</span> * <p><a name="line.302"></a> +<span class="sourceLineNo">303</span> *<a name="line.303"></a> +<span class="sourceLineNo">304</span> * <h5 class='section'>Example:</h5><a name="line.304"></a> +<span class="sourceLineNo">305</span> * <p class='bcode'><a name="line.305"></a> +<span class="sourceLineNo">306</span> * <ja>@RestResource</ja>(<a name="line.306"></a> +<span class="sourceLineNo">307</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.307"></a> +<span class="sourceLineNo">308</span> * nav=<js>"&lt;p class='special-navigation'&gt;This is my special navigation content&lt;/p&gt;"</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> * </p><a name="line.311"></a> <span class="sourceLineNo">312</span> * <p><a name="line.312"></a> -<span class="sourceLineNo">313</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.313"></a> -<span class="sourceLineNo">314</span> */<a name="line.314"></a> -<span class="sourceLineNo">315</span> public static final String HTMLDOC_nav = "HtmlDocSerializer.nav";<a name="line.315"></a> -<span class="sourceLineNo">316</span><a name="line.316"></a> -<span class="sourceLineNo">317</span> /**<a name="line.317"></a> -<span class="sourceLineNo">318</span> * <b>Configuration property:</b> Aside section contents.<a name="line.318"></a> -<span class="sourceLineNo">319</span> * <p><a name="line.319"></a> -<span class="sourceLineNo">320</span> * <ul><a name="line.320"></a> -<span class="sourceLineNo">321</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js><a name="line.321"></a> -<span class="sourceLineNo">322</span> * <li><b>Data type:</b> <code>String</code><a name="line.322"></a> -<span class="sourceLineNo">323</span> * <li><b>Default:</b> <jk>null</jk><a name="line.323"></a> -<span class="sourceLineNo">324</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.324"></a> -<span class="sourceLineNo">325</span> * </ul><a name="line.325"></a> -<span class="sourceLineNo">326</span> * <p><a name="line.326"></a> -<span class="sourceLineNo">327</span> * Allows you to specifigy the contents of the aside section on the HTML page.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * The aside section floats on the right of the page for providing content supporting the serialized content of<a name="line.328"></a> -<span class="sourceLineNo">329</span> * the page.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * <p><a name="line.330"></a> -<span class="sourceLineNo">331</span> * By default, the aside section is empty.<a name="line.331"></a> +<span class="sourceLineNo">313</span> * When this property is specified, the {@link #HTMLDOC_links} property is ignored.<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 represent no value to differentiate it from an empty string.<a name="line.315"></a> +<span class="sourceLineNo">316</span> */<a name="line.316"></a> +<span class="sourceLineNo">317</span> public static final String HTMLDOC_nav = "HtmlDocSerializer.nav";<a name="line.317"></a> +<span class="sourceLineNo">318</span><a name="line.318"></a> +<span class="sourceLineNo">319</span> /**<a name="line.319"></a> +<span class="sourceLineNo">320</span> * <b>Configuration property:</b> Aside section contents.<a name="line.320"></a> +<span class="sourceLineNo">321</span> * <p><a name="line.321"></a> +<span class="sourceLineNo">322</span> * <ul><a name="line.322"></a> +<span class="sourceLineNo">323</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js><a name="line.323"></a> +<span class="sourceLineNo">324</span> * <li><b>Data type:</b> <code>String</code><a name="line.324"></a> +<span class="sourceLineNo">325</span> * <li><b>Default:</b> <jk>null</jk><a name="line.325"></a> +<span class="sourceLineNo">326</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.326"></a> +<span class="sourceLineNo">327</span> * </ul><a name="line.327"></a> +<span class="sourceLineNo">328</span> * <p><a name="line.328"></a> +<span class="sourceLineNo">329</span> * Allows you to specifigy the contents of the aside section on the HTML page.<a name="line.329"></a> +<span class="sourceLineNo">330</span> * The aside section floats on the right of the page for providing content supporting the serialized content of<a name="line.330"></a> +<span class="sourceLineNo">331</span> * the page.<a name="line.331"></a> <span class="sourceLineNo">332</span> * <p><a name="line.332"></a> -<span class="sourceLineNo">333</span> *<a name="line.333"></a> -<span class="sourceLineNo">334</span> * <h5 class='section'>Example:</h5><a name="line.334"></a> -<span class="sourceLineNo">335</span> * <p class='bcode'><a name="line.335"></a> -<span class="sourceLineNo">336</span> * <ja>@RestResource</ja>(<a name="line.336"></a> -<span class="sourceLineNo">337</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.337"></a> -<span class="sourceLineNo">338</span> * aside=<js>"&lt;ul&gt;&lt;li&gt;Item 1&lt;li&gt;Item 2&lt;li&gt;Item 3&lt;/ul&gt;"</js><a name="line.338"></a> -<span class="sourceLineNo">339</span> * )<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> * <p><a name="line.342"></a> -<span class="sourceLineNo">343</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.343"></a> -<span class="sourceLineNo">344</span> */<a name="line.344"></a> -<span class="sourceLineNo">345</span> public static final String HTMLDOC_aside = "HtmlDocSerializer.aside";<a name="line.345"></a> -<span class="sourceLineNo">346</span><a name="line.346"></a> -<span class="sourceLineNo">347</span> /**<a name="line.347"></a> -<span class="sourceLineNo">348</span> * <b>Configuration property:</b> Footer section contents.<a name="line.348"></a> -<span class="sourceLineNo">349</span> * <p><a name="line.349"></a> -<span class="sourceLineNo">350</span> * <ul><a name="line.350"></a> -<span class="sourceLineNo">351</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js><a name="line.351"></a> -<span class="sourceLineNo">352</span> * <li><b>Data type:</b> <code>String</code><a name="line.352"></a> -<span class="sourceLineNo">353</span> * <li><b>Default:</b> <jk>null</jk><a name="line.353"></a> -<span class="sourceLineNo">354</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.354"></a> -<span class="sourceLineNo">355</span> * </ul><a name="line.355"></a> -<span class="sourceLineNo">356</span> * <p><a name="line.356"></a> -<span class="sourceLineNo">357</span> * Allows you to specify the contents of the footer section on the HTML page.<a name="line.357"></a> +<span class="sourceLineNo">333</span> * By default, the aside section is empty.<a name="line.333"></a> +<span class="sourceLineNo">334</span> * <p><a name="line.334"></a> +<span class="sourceLineNo">335</span> *<a name="line.335"></a> +<span class="sourceLineNo">336</span> * <h5 class='section'>Example:</h5><a name="line.336"></a> +<span class="sourceLineNo">337</span> * <p class='bcode'><a name="line.337"></a> +<span class="sourceLineNo">338</span> * <ja>@RestResource</ja>(<a name="line.338"></a> +<span class="sourceLineNo">339</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.339"></a> +<span class="sourceLineNo">340</span> * aside=<js>"&lt;ul&gt;&lt;li&gt;Item 1&lt;li&gt;Item 2&lt;li&gt;Item 3&lt;/ul&gt;"</js><a name="line.340"></a> +<span class="sourceLineNo">341</span> * )<a name="line.341"></a> +<span class="sourceLineNo">342</span> * )<a name="line.342"></a> +<span class="sourceLineNo">343</span> * </p><a name="line.343"></a> +<span class="sourceLineNo">344</span> * <p><a name="line.344"></a> +<span class="sourceLineNo">345</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.345"></a> +<span class="sourceLineNo">346</span> */<a name="line.346"></a> +<span class="sourceLineNo">347</span> public static final String HTMLDOC_aside = "HtmlDocSerializer.aside";<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> * <b>Configuration property:</b> Footer section contents.<a name="line.350"></a> +<span class="sourceLineNo">351</span> * <p><a name="line.351"></a> +<span class="sourceLineNo">352</span> * <ul><a name="line.352"></a> +<span class="sourceLineNo">353</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js><a name="line.353"></a> +<span class="sourceLineNo">354</span> * <li><b>Data type:</b> <code>String</code><a name="line.354"></a> +<span class="sourceLineNo">355</span> * <li><b>Default:</b> <jk>null</jk><a name="line.355"></a> +<span class="sourceLineNo">356</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.356"></a> +<span class="sourceLineNo">357</span> * </ul><a name="line.357"></a> <span class="sourceLineNo">358</span> * <p><a name="line.358"></a> -<span class="sourceLineNo">359</span> * By default, the footer section is empty.<a name="line.359"></a> +<span class="sourceLineNo">359</span> * Allows you to specify the contents of the footer section on the HTML page.<a name="line.359"></a> <span class="sourceLineNo">360</span> * <p><a name="line.360"></a> -<span class="sourceLineNo">361</span> *<a name="line.361"></a> -<span class="sourceLineNo">362</span> * <h5 class='section'>Example:</h5><a name="line.362"></a> -<span class="sourceLineNo">363</span> * <p class='bcode'><a name="line.363"></a> -<span class="sourceLineNo">364</span> * <ja>@RestResource</ja>(<a name="line.364"></a> -<span class="sourceLineNo">365</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.365"></a> -<span class="sourceLineNo">366</span> * footer=<js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.366"></a> -<span class="sourceLineNo">367</span> * )<a name="line.367"></a> -<span class="sourceLineNo">368</span> * )<a name="line.368"></a> -<span class="sourceLineNo">369</span> * </p><a name="line.369"></a> -<span class="sourceLineNo">370</span> * <p><a name="line.370"></a> -<span class="sourceLineNo">371</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.371"></a> -<span class="sourceLineNo">372</span> */<a name="line.372"></a> -<span class="sourceLineNo">373</span> public static final String HTMLDOC_footer = "HtmlDocSerializer.footer";<a name="line.373"></a> -<span class="sourceLineNo">374</span><a name="line.374"></a> -<span class="sourceLineNo">375</span> /**<a name="line.375"></a> -<span class="sourceLineNo">376</span> * <b>Configuration property:</b> No-results message.<a name="line.376"></a> -<span class="sourceLineNo">377</span> * <p><a name="line.377"></a> -<span class="sourceLineNo">378</span> * <ul><a name="line.378"></a> -<span class="sourceLineNo">379</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js><a name="line.379"></a> -<span class="sourceLineNo">380</span> * <li><b>Data type:</b> <code>String</code><a name="line.380"></a> -<span class="sourceLineNo">381</span> * <li><b>Default:</b> <js>"&lt;p&gt;no results&lt;/p&gt;"</js><a name="line.381"></a> -<span class="sourceLineNo">382</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.382"></a> -<span class="sourceLineNo">383</span> * </ul><a name="line.383"></a> -<span class="sourceLineNo">384</span> * <p><a name="line.384"></a> -<span class="sourceLineNo">385</span> * Allows you to specify the string message used when trying to serialize an empty array or empty list.<a name="line.385"></a> +<span class="sourceLineNo">361</span> * By default, the footer section is empty.<a name="line.361"></a> +<span class="sourceLineNo">362</span> * <p><a name="line.362"></a> +<span class="sourceLineNo">363</span> *<a name="line.363"></a> +<span class="sourceLineNo">364</span> * <h5 class='section'>Example:</h5><a name="line.364"></a> +<span class="sourceLineNo">365</span> * <p class='bcode'><a name="line.365"></a> +<span class="sourceLineNo">366</span> * <ja>@RestResource</ja>(<a name="line.366"></a> +<span class="sourceLineNo">367</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.367"></a> +<span class="sourceLineNo">368</span> * footer=<js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.368"></a> +<span class="sourceLineNo">369</span> * )<a name="line.369"></a> +<span class="sourceLineNo">370</span> * )<a name="line.370"></a> +<span class="sourceLineNo">371</span> * </p><a name="line.371"></a> +<span class="sourceLineNo">372</span> * <p><a name="line.372"></a> +<span class="sourceLineNo">373</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.373"></a> +<span class="sourceLineNo">374</span> */<a name="line.374"></a> +<span class="sourceLineNo">375</span> public static final String HTMLDOC_footer = "HtmlDocSerializer.footer";<a name="line.375"></a> +<span class="sourceLineNo">376</span><a name="line.376"></a> +<span class="sourceLineNo">377</span> /**<a name="line.377"></a> +<span class="sourceLineNo">378</span> * <b>Configuration property:</b> No-results message.<a name="line.378"></a> +<span class="sourceLineNo">379</span> * <p><a name="line.379"></a> +<span class="sourceLineNo">380</span> * <ul><a name="line.380"></a> +<span class="sourceLineNo">381</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js><a name="line.381"></a> +<span class="sourceLineNo">382</span> * <li><b>Data type:</b> <code>String</code><a name="line.382"></a> +<span class="sourceLineNo">383</span> * <li><b>Default:</b> <js>"&lt;p&gt;no results&lt;/p&gt;"</js><a name="line.383"></a> +<span class="sourceLineNo">384</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.384"></a> +<span class="sourceLineNo">385</span> * </ul><a name="line.385"></a> <span class="sourceLineNo">386</span> * <p><a name="line.386"></a> -<span class="sourceLineNo">387</span> *<a name="line.387"></a> -<span class="sourceLineNo">388</span> * <h5 class='section'>Example:</h5><a name="line.388"></a> -<span class="sourceLineNo">389</span> * <p class='bcode'><a name="line.389"></a> -<span class="sourceLineNo">390</span> * <ja>@RestResource</ja>(<a name="line.390"></a> -<span class="sourceLineNo">391</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.391"></a> -<span class="sourceLineNo">392</span> * =<js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.392"></a> -<span class="sourceLineNo">393</span> * )<a name="line.393"></a> -<span class="sourceLineNo">394</span> * )<a name="line.394"></a> -<span class="sourceLineNo">395</span> * </p><a name="line.395"></a> -<span class="sourceLineNo">396</span> * <p><a name="line.396"></a> -<span class="sourceLineNo">397</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.397"></a> -<span class="sourceLineNo">398</span> */<a name="line.398"></a> -<span class="sourceLineNo">399</span> public static final String HTMLDOC_noResultsMessage = "HtmlDocSerializer.noResultsMessage";<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> * <b>Configuration property:</b> Prevent word wrap on page.<a name="line.402"></a> -<span class="sourceLineNo">403</span> * <p><a name="line.403"></a> -<span class="sourceLineNo">404</span> * <ul><a name="line.404"></a> -<span class="sourceLineNo">405</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js><a name="line.405"></a> -<span class="sourceLineNo">406</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.406"></a> -<span class="sourceLineNo">407</span> * <li><b>Default:</b> <jk>false</jk><a name="line.407"></a> -<span class="sourceLineNo">408</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.408"></a> -<span class="sourceLineNo">409</span> * </ul><a name="line.409"></a> -<span class="sourceLineNo">410</span> * <p><a name="line.410"></a> -<span class="sourceLineNo">411</span> * Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.<a name="line.411"></a> -<span class="sourceLineNo">412</span> */<a name="line.412"></a> -<span class="sourceLineNo">413</span> public static final String HTMLDOC_nowrap = "HtmlDocSerializer.nowrap";<a name="line.413"></a> -<span class="sourceLineNo">414</span><a name="line.414"></a> -<span class="sourceLineNo">415</span> /**<a name="line.415"></a> -<span class="sourceLineNo">416</span> * <b>Configuration property:</b> Stylesheet URL.<a name="line.416"></a> -<span class="sourceLineNo">417</span> * <p><a name="line.417"></a> -<span class="sourceLineNo">418</span> * <ul><a name="line.418"></a> -<span class="sourceLineNo">419</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js><a name="line.419"></a> -<span class="sourceLineNo">420</span> * <li><b>Data type:</b> <code>String</code><a name="line.420"></a> -<span class="sourceLineNo">421</span> * <li><b>Default:</b> <js>"style.css"</js><a name="line.421"></a> -<span class="sourceLineNo">422</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.422"></a> -<span class="sourceLineNo">423</span> * </ul><a name="line.423"></a> -<span class="sourceLineNo">424</span> * <p><a name="line.424"></a> -<span class="sourceLineNo">425</span> * Adds a link to the specified stylesheet URL.<a name="line.425"></a> +<span class="sourceLineNo">387</span> * Allows you to specify the string message used when trying to serialize an empty array or empty list.<a name="line.387"></a> +<span class="sourceLineNo">388</span> * <p><a name="line.388"></a> +<span class="sourceLineNo">389</span> *<a name="line.389"></a> +<span class="sourceLineNo">390</span> * <h5 class='section'>Example:</h5><a name="line.390"></a> +<span class="sourceLineNo">391</span> * <p class='bcode'><a name="line.391"></a> +<span class="sourceLineNo">392</span> * <ja>@RestResource</ja>(<a name="line.392"></a> +<span class="sourceLineNo">393</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.393"></a> +<span class="sourceLineNo">394</span> * =<js>"&lt;b&gt;This interface is great!&lt;/b&gt;"</js><a name="line.394"></a> +<span class="sourceLineNo">395</span> * )<a name="line.395"></a> +<span class="sourceLineNo">396</span> * )<a name="line.396"></a> +<span class="sourceLineNo">397</span> * </p><a name="line.397"></a> +<span class="sourceLineNo">398</span> * <p><a name="line.398"></a> +<span class="sourceLineNo">399</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.399"></a> +<span class="sourceLineNo">400</span> */<a name="line.400"></a> +<span class="sourceLineNo">401</span> public static final String HTMLDOC_noResultsMessage = "HtmlDocSerializer.noResultsMessage";<a name="line.401"></a> +<span class="sourceLineNo">402</span><a name="line.402"></a> +<span class="sourceLineNo">403</span> /**<a name="line.403"></a> +<span class="sourceLineNo">404</span> * <b>Configuration property:</b> Prevent word wrap on page.<a name="line.404"></a> +<span class="sourceLineNo">405</span> * <p><a name="line.405"></a> +<span class="sourceLineNo">406</span> * <ul><a name="line.406"></a> +<span class="sourceLineNo">407</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js><a name="line.407"></a> +<span class="sourceLineNo">408</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.408"></a> +<span class="sourceLineNo">409</span> * <li><b>Default:</b> <jk>false</jk><a name="line.409"></a> +<span class="sourceLineNo">410</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.410"></a> +<span class="sourceLineNo">411</span> * </ul><a name="line.411"></a> +<span class="sourceLineNo">412</span> * <p><a name="line.412"></a> +<span class="sourceLineNo">413</span> * Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.<a name="line.413"></a> +<span class="sourceLineNo">414</span> */<a name="line.414"></a> +<span class="sourceLineNo">415</span> public static final String HTMLDOC_nowrap = "HtmlDocSerializer.nowrap";<a name="line.415"></a> +<span class="sourceLineNo">416</span><a name="line.416"></a> +<span class="sourceLineNo">417</span> /**<a name="line.417"></a> +<span class="sourceLineNo">418</span> * <b>Configuration property:</b> Stylesheet URL.<a name="line.418"></a> +<span class="sourceLineNo">419</span> * <p><a name="line.419"></a> +<span class="sourceLineNo">420</span> * <ul><a name="line.420"></a> +<span class="sourceLineNo">421</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js><a name="line.421"></a> +<span class="sourceLineNo">422</span> * <li><b>Data type:</b> <code>String</code><a name="line.422"></a> +<span class="sourceLineNo">423</span> * <li><b>Default:</b> <js>"style.css"</js><a name="line.423"></a> +<span class="sourceLineNo">424</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.424"></a> +<span class="sourceLineNo">425</span> * </ul><a name="line.425"></a> <span class="sourceLineNo">426</span> * <p><a name="line.426"></a> -<span class="sourceLineNo">427</span> * If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>.<a name="line.427"></a> -<span class="sourceLineNo">428</span> * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.<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 represent no value to differentiate it from an empty string.<a name="line.430"></a> -<span class="sourceLineNo">431</span> */<a name="line.431"></a> -<span class="sourceLineNo">432</span> public static final String HTMLDOC_cssUrl = "HtmlDocSerializer.cssUrl";<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> * <b>Configuration property:</b> CSS code.<a name="line.435"></a> -<span class="sourceLineNo">436</span> * <p><a name="line.436"></a> -<span class="sourceLineNo">437</span> * <ul><a name="line.437"></a> -<span class="sourceLineNo">438</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.css.list"</js><a name="line.438"></a> -<span class="sourceLineNo">439</span> * <li><b>Data type:</b> <code>List&lt;String&gt;</code><a name="line.439"></a> -<span class="sourceLineNo">440</span> * <li><b>Default:</b> empty list<a name="line.440"></a> -<span class="sourceLineNo">441</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.441"></a> -<span class="sourceLineNo">442</span> * </ul><a name="line.442"></a> -<span class="sourceLineNo">443</span> * <p><a name="line.443"></a> -<span class="sourceLineNo">444</span> * Adds the specified CSS instructions to the HTML page.<a name="line.444"></a> -<span class="sourceLineNo">445</span> *<a name="line.445"></a> -<span class="sourceLineNo">446</span> * <h5 class='section'>Example:</h5><a name="line.446"></a> -<span class="sourceLineNo">447</span> * </p><a name="line.447"></a> -<span class="sourceLineNo">448</span> * <p class='bcode'><a name="line.448"></a> -<span class="sourceLineNo">449</span> * <ja>@RestResource</ja>(<a name="line.449"></a> -<span class="sourceLineNo">450</span> * properties={<a name="line.450"></a> -<span class="sourceLineNo">451</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_css</jsf>, value=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js>)<a name="line.451"></a> -<span class="sourceLineNo">452</span> * }<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> * A shortcut on <ja>@RestResource</ja> is also provided for this setting:<a name="line.455"></a> -<span class="sourceLineNo">456</span> * <p class='bcode'><a name="line.456"></a> -<span class="sourceLineNo">457</span> * <ja>@RestResource</ja>(<a name="line.457"></a> -<span class="sourceLineNo">458</span> * htmldoc=@HtmlDoc(<a name="line.458"></a> -<span class="sourceLineNo">459</span> * css=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js><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> public static final String HTMLDOC_css = "HtmlDocSerializer.css.list";<a name="line.464"></a> -<span class="sourceLineNo">465</span><a name="line.465"></a> -<span class="sourceLineNo">466</span> /**<a name="line.466"></a> -<span class="sourceLineNo">467</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_css} property.<a name="line.467"></a> -<span class="sourceLineNo">468</span> */<a name="line.468"></a> -<span class="sourceLineNo">469</span> public static final String HTMLDOC_css_add = "HtmlDocSerializer.css.list.add";<a name="line.469"></a> -<span class="sourceLineNo">470</span><a name="line.470"></a> -<span class="sourceLineNo">471</span> /**<a name="line.471"></a> -<span class="sourceLineNo">472</span> * <b>Configuration property:</b> HTML document template.<a name="line.472"></a> -<span class="sourceLineNo">473</span> * <p><a name="line.473"></a> -<span class="sourceLineNo">474</span> * <ul><a name="line.474"></a> -<span class="sourceLineNo">475</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.template"</js><a name="line.475"></a> -<span class="sourceLineNo">476</span> * <li><b>Data type:</b> <code>Class&lt;? <jk>extends</jk> HtmlDocTemplate&gt;</code> or {@link HtmlDocTemplate}<a name="line.476"></a> -<span class="sourceLineNo">477</span> * <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code><a name="line.477"></a> -<span class="sourceLineNo">478</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.478"></a> -<span class="sourceLineNo">479</span> * </ul><a name="line.479"></a> -<span class="sourceLineNo">480</span> * <p><a name="line.480"></a> -<span class="sourceLineNo">481</span> * Specifies the template to use for serializing the page.<a name="line.481"></a> +<span class="sourceLineNo">427</span> * Adds a link to the specified stylesheet URL.<a name="line.427"></a> +<span class="sourceLineNo">428</span> * <p><a name="line.428"></a> +<span class="sourceLineNo">429</span> * If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>.<a name="line.429"></a> +<span class="sourceLineNo">430</span> * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.<a name="line.430"></a> +<span class="sourceLineNo">431</span> * <p><a name="line.431"></a> +<span class="sourceLineNo">432</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.432"></a> +<span class="sourceLineNo">433</span> */<a name="line.433"></a> +<span class="sourceLineNo">434</span> public static final String HTMLDOC_cssUrl = "HtmlDocSerializer.cssUrl";<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> * <b>Configuration property:</b> CSS code.<a name="line.437"></a> +<span class="sourceLineNo">438</span> * <p><a name="line.438"></a> +<span class="sourceLineNo">439</span> * <ul><a name="line.439"></a> +<span class="sourceLineNo">440</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.css.list"</js><a name="line.440"></a> +<span class="sourceLineNo">441</span> * <li><b>Data type:</b> <code>List&lt;String&gt;</code><a name="line.441"></a> +<span class="sourceLineNo">442</span> * <li><b>Default:</b> empty list<a name="line.442"></a> +<span class="sourceLineNo">443</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.443"></a> +<span class="sourceLineNo">444</span> * </ul><a name="line.444"></a> +<span class="sourceLineNo">445</span> * <p><a name="line.445"></a> +<span class="sourceLineNo">446</span> * Adds the specified CSS instructions to the HTML page.<a name="line.446"></a> +<span class="sourceLineNo">447</span> *<a name="line.447"></a> +<span class="sourceLineNo">448</span> * <h5 class='section'>Example:</h5><a name="line.448"></a> +<span class="sourceLineNo">449</span> * </p><a name="line.449"></a> +<span class="sourceLineNo">450</span> * <p class='bcode'><a name="line.450"></a> +<span class="sourceLineNo">451</span> * <ja>@RestResource</ja>(<a name="line.451"></a> +<span class="sourceLineNo">452</span> * properties={<a name="line.452"></a> +<span class="sourceLineNo">453</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_css</jsf>, value=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js>)<a name="line.453"></a> +<span class="sourceLineNo">454</span> * }<a name="line.454"></a> +<span class="sourceLineNo">455</span> * )<a name="line.455"></a> +<span class="sourceLineNo">456</span> * </p><a name="line.456"></a> +<span class="sourceLineNo">457</span> * A shortcut on <ja>@RestResource</ja> is also provided for this setting:<a name="line.457"></a> +<span class="sourceLineNo">458</span> * <p class='bcode'><a name="line.458"></a> +<span class="sourceLineNo">459</span> * <ja>@RestResource</ja>(<a name="line.459"></a> +<span class="sourceLineNo">460</span> * htmldoc=@HtmlDoc(<a name="line.460"></a> +<span class="sourceLineNo">461</span> * css=<js>"h3 { color: red; }\nh5 { font-weight: bold; }"</js><a name="line.461"></a> +<span class="sourceLineNo">462</span> * )<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> */<a name="line.465"></a> +<span class="sourceLineNo">466</span> public static final String HTMLDOC_css = "HtmlDocSerializer.css.list";<a name="line.466"></a> +<span class="sourceLineNo">467</span><a name="line.467"></a> +<span class="sourceLineNo">468</span> /**<a name="line.468"></a> +<span class="sourceLineNo">469</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_css} property.<a name="line.469"></a> +<span class="sourceLineNo">470</span> */<a name="line.470"></a> +<span class="sourceLineNo">471</span> public static final String HTMLDOC_css_add = "HtmlDocSerializer.css.list.add";<a name="line.471"></a> +<span class="sourceLineNo">472</span><a name="line.472"></a> +<span class="sourceLineNo">473</span> /**<a name="line.473"></a> +<span class="sourceLineNo">474</span> * <b>Configuration property:</b> HTML document template.<a name="line.474"></a> +<span class="sourceLineNo">475</span> * <p><a name="line.475"></a> +<span class="sourceLineNo">476</span> * <ul><a name="line.476"></a> +<span class="sourceLineNo">477</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.template"</js><a name="line.477"></a> +<span class="sourceLineNo">478</span> * <li><b>Data type:</b> <code>Class&lt;? <jk>extends</jk> HtmlDocTemplate&gt;</code> or {@link HtmlDocTemplate}<a name="line.478"></a> +<span class="sourceLineNo">479</span> * <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code><a name="line.479"></a> +<span class="sourceLineNo">480</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.480"></a> +<span class="sourceLineNo">481</span> * </ul><a name="line.481"></a> <span class="sourceLineNo">482</span> * <p><a name="line.482"></a> -<span class="sourceLineNo">483</span> * By default, the {@link HtmlDocTemplateBasic} class is used to construct the contents of the HTML page, but<a name="line.483"></a> -<span class="sourceLineNo">484</span> * can be overridden with your own custom implementation class.<a name="line.484"></a> -<span class="sourceLineNo">485</span> *<a name="line.485"></a> -<span class="sourceLineNo">486</span> * <h5 class='section'>Example:</h5><a name="line.486"></a> -<span class="sourceLineNo">487</span> * <p class='bcode'><a name="line.487"></a> -<span class="sourceLineNo">488</span> * <ja>@RestResource</ja>(<a name="line.488"></a> -<span class="sourceLineNo">489</span> * htmldoc=@HtmlDoc(<a name="line.489"></a> -<span class="sourceLineNo">490</span> * template=MySpecialDocTemplate.<jk>class</jk><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> * </p><a name="line.493"></a> -<span class="sourceLineNo">494</span> */<a name="line.494"></a> -<span class="sourceLineNo">495</span> public static final String HTMLDOC_template = "HtmlDocSerializer.template";<a name="line.495"></a> -<span class="sourceLineNo">496</span><a name="line.496"></a> -<span class="sourceLineNo">497</span><a name="line.497"></a> -<span class="sourceLineNo">498</span> final String[] css;<a name="line.498"></a> -<span class="sourceLineNo">499</span> final Map<String,String> links;<a name="line.499"></a> -<span class="sourceLineNo">500</span> final String title, description, branding, header, nav, aside, footer, cssUrl, noResultsMessage;<a name="line.500"></a> -<span class="sourceLineNo">501</span> final boolean nowrap;<a name="line.501"></a> -<span class="sourceLineNo">502</span> final HtmlDocTemplate template;<a name="line.502"></a> -<span class="sourceLineNo">503</span><a name="line.503"></a> -<span class="sourceLineNo">504</span> /**<a name="line.504"></a> -<span class="sourceLineNo">505</span> * Constructor.<a name="line.505"></a> -<span class="sourceLineNo">506</span> * <p><a name="line.506"></a> -<span class="sourceLineNo">507</span> * Typically only called from {@link PropertyStore#getContext(Class)}.<a name="line.507"></a> -<span class="sourceLineNo">508</span> *<a name="line.508"></a> -<span class="sourceLineNo">509</span> * @param ps The property store that created this context.<a name="line.509"></a> -<span class="sourceLineNo">510</span> */<a name="line.510"></a> -<span class="sourceLineNo">511</span> public HtmlDocSerializerContext(PropertyStore ps) {<a name="line.511"></a> -<span class="sourceLineNo">512</span> super(ps);<a name="line.512"></a> -<span class="sourceLineNo">513</span> css = ps.getProperty(HTMLDOC_css, String[].class, new String[0]);<a name="line.513"></a> -<span class="sourceLineNo">514</span> title = ps.getProperty(HTMLDOC_title, String.class, null);<a name="line.514"></a> -<span class="sourceLineNo">515</span> description = ps.getProperty(HTMLDOC_description, String.class, null);<a name="line.515"></a> -<span class="sourceLineNo">516</span> branding = ps.getProperty(HTMLDOC_branding, String.class, null);<a name="line.516"></a> -<span class="sourceLineNo">517</span> header = ps.getProperty(HTMLDOC_header, String.class, null);<a name="line.517"></a> -<span class="sourceLineNo">518</span> nav = ps.getProperty(HTMLDOC_nav, String.class, null);<a name="line.518"></a> -<span class="sourceLineNo">519</span> aside = ps.getProperty(HTMLDOC_aside, String.class, null);<a name="line.519"></a> -<span class="sourceLineNo">520</span> footer = ps.getProperty(HTMLDOC_footer, String.class, null);<a name="line.520"></a> -<span class="sourceLineNo">521</span> cssUrl = ps.getProperty(HTMLDOC_cssUrl, String.class, null);<a name="line.521"></a> -<span class="sourceLineNo">522</span> nowrap = ps.getProperty(HTMLDOC_nowrap, boolean.class, false);<a name="line.522"></a> -<span class="sourceLineNo">523</span> links = ps.getMap(HTMLDOC_links, String.class, String.class, null);<a name="line.523"></a> -<span class="sourceLineNo">524</span> noResultsMessage = ps.getProperty(HTMLDOC_noResultsMessage, String.class, "<p>no results</p>");<a name="line.524"></a> -<span class="sourceLineNo">525</span> template = ps.getTypedProperty(HTMLDOC_template, HtmlDocTemplate.class, HtmlDocTemplateBasic.class);<a name="line.525"></a> -<span class="sourceLineNo">526</span> }<a name="line.526"></a> -<span class="sourceLineNo">527</span><a name="line.527"></a> -<span class="sourceLineNo">528</span> @Override /* Context */<a name="line.528"></a> -<span class="sourceLineNo">529</span> public ObjectMap asMap() {<a name="line.529"></a> -<span class="sourceLineNo">530</span> return super.asMap()<a name="line.530"></a> -<span class="sourceLineNo">531</span> .append("HtmlDocSerializerContext", new ObjectMap()<a name="line.531"></a> -<span class="sourceLineNo">532</span> .append("cssImports", css)<a name="line.532"></a> -<span class="sourceLineNo">533</span> .append("title", title)<a name="line.533"></a> -<span class="sourceLineNo">534</span> .append("text", description)<a name="line.534"></a> -<span class="sourceLineNo">535</span> .append("branding", branding)<a name="line.535"></a> -<span class="sourceLineNo">536</span> .append("header", header)<a name="line.536"></a> -<span class="sourceLineNo">537</span> .append("nav", nav)<a name="line.537"></a> -<span class="sourceLineNo">538</span> .append("links", links)<a name="line.538"></a> -<span class="sourceLineNo">539</span> .append("aside", aside)<a name="line.539"></a> -<span class="sourceLineNo">540</span> .append("footer", footer)<a name="line.540"></a> -<span class="sourceLineNo">541</span> .append("cssUrl", cssUrl)<a name="line.541"></a> -<span class="sourceLineNo">542</span> .append("nowrap", nowrap)<a name="line.542"></a> -<span class="sourceLineNo">543</span> .append("template", template)<a name="line.543"></a> -<span class="sourceLineNo">544</span> .append("noResultsMessage", noResultsMessage)<a name="line.544"></a> -<span class="sourceLineNo">545</span> );<a name="line.545"></a> -<span class="sourceLineNo">546</span> }<a name="line.546"></a> -<span class="sourceLineNo">547</span>}<a name="line.547"></a> +<span class="sourceLineNo">483</span> * Specifies the template to use for serializing the page.<a name="line.483"></a> +<span class="sourceLineNo">484</span> * <p><a name="line.484"></a> +<span class="sourceLineNo">485</span> * By default, the {@link HtmlDocTemplateBasic} class is used to construct the contents of the HTML page, but<a name="line.485"></a> +<span class="sourceLineNo">486</span> * can be overridden with your own custom implementation class.<a name="line.486"></a> +<span class="sourceLineNo">487</span> *<a name="line.487"></a> +<span class="sourceLineNo">488</span> * <h5 class='section'>Example:</h5><a name="line.488"></a> +<span class="sourceLineNo">489</span> * <p class='bcode'><a name="line.489"></a> +<span class="sourceLineNo">490</span> * <ja>@RestResource</ja>(<a name="line.490"></a> +<span class="sourceLineNo">491</span> * htmldoc=@HtmlDoc(<a name="line.491"></a> +<span class="sourceLineNo">492</span> * template=MySpecialDocTemplate.<jk>class</jk><a name="line.492"></a> +<span class="sourceLineNo">493</span> * )<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> */<a name="line.496"></a> +<span class="sourceLineNo">497</span> public static final String HTMLDOC_template = "HtmlDocSerializer.template";<a name="line.497"></a> +<span class="sourceLineNo">498</span><a name="line.498"></a> +<span class="sourceLineNo">499</span><a name="line.499"></a> +<span class="sourceLineNo">500</span> final String[] css;<a name="line.500"></a> +<span class="sourceLineNo">501</span> final Map<String,Object> links;<a name="line.501"></a> +<span class="sourceLineNo">502</span> final String title, description, branding, header, nav, aside, footer, cssUrl, noResultsMessage;<a name="line.502"></a> +<span class="sourceLineNo">503</span> final boolean nowrap;<a name="line.503"></a> +<span class="sourceLineNo">504</span> final HtmlDocTemplate template;<a name="line.504"></a> +<span class="sourceLineNo">505</span><a name="line.505"></a> +<span class="sourceLineNo">506</span> /**<a name="line.506"></a> +<span class="sourceLineNo">507</span> * Constructor.<a name="line.507"></a> +<span class="sourceLineNo">508</span> * <p><a name="line.508"></a> +<span class="sourceLineNo">509</span> * Typically only called from {@link PropertyStore#getContext(Class)}.<a name="line.509"></a> +<span class="sourceLineNo">510</span> *<a name="line.510"></a> +<span class="sourceLineNo">511</span> * @param ps The property store that created this context.<a name="line.511"></a> +<span class="sourceLineNo">512</span> */<a name="line.512"></a> +<span class="sourceLineNo">513</span> public HtmlDocSerializerContext(PropertyStore ps) {<a name="line.513"></a> +<span class="sourceLineNo">514</span> super(ps);<a name="line.514"></a> +<span class="sourceLineNo">515</span> css = ps.getProperty(HTMLDOC_css, String[].class, new String[0]);<a name="line.515"></a> +<span class="sourceLineNo">516</span> title = ps.getProperty(HTMLDOC_title, String.class, null);<a name="line.516"></a> +<span class="sourceLineNo">517</span> description = ps.getProperty(HTMLDOC_description, String.class, null);<a name="line.517"></a> +<span class="sourceLineNo">518</span> branding = ps.getProperty(HTMLDOC_branding, String.class, null);<a name="line.518"></a> +<span class="sourceLineNo">519</span> header = ps.getProperty(HTMLDOC_header, String.class, null);<a name="line.519"></a> +<span class="sourceLineNo">520</span> nav = ps.getProperty(HTMLDOC_nav, String.class, null);<a name="line.520"></a> +<span class="sourceLineNo">521</span> aside = ps.getProperty(HTMLDOC_aside, String.class, null);<a name="line.521"></a> +<span class="sourceLineNo">522</span> footer = ps.getProperty(HTMLDOC_footer, String.class, null);<a name="line.522"></a> +<span class="sourceLineNo">523</span> cssUrl = ps.getProperty(HTMLDOC_cssUrl, String.class, null);<a name="line.523"></a> +<span class="sourceLineNo">524</span> nowrap = ps.getProperty(HTMLDOC_nowrap, boolean.class, false);<a name="line.524"></a> +<span class="sourceLineNo">525</span> links = ps.getMap(HTMLDOC_links, String.class, Object.class, null);<a name="line.525"></a> +<span class="sourceLineNo">526</span> noResultsMessage = ps.getProperty(HTMLDOC_noResultsMessage, String.class, "<p>no results</p>");<a name="line.526"></a> +<span class="sourceLineNo">527</span> template = ps.getTypedProperty(HTMLDOC_template, HtmlDocTemplate.class, HtmlDocTemplateBasic.class);<a name="line.527"></a> +<span class="sourceLineNo">528</span> }<a name="line.528"></a> +<span class="sourceLineNo">529</span><a name="line.529"></a> +<span class="sourceLineNo">530</span> @Override /* Context */<a name="line.530"></a> +<span class="sourceLineNo">531</span> public ObjectMap asMap() {<a name="line.531"></a> +<span class="sourceLineNo">532</span> return super.asMap()<a name="line.532"></a> +<span class="sourceLineNo">533</span> .append("HtmlDocSerializerContext", new ObjectMap()<a name="line.533"></a> +<span class="sourceLineNo">534</span> .append("cssImports", css)<a name="line.534"></a> +<span class="sourceLineNo">535</span> .append("title", title)<a name="line.535"></a> +<span class="sourceLineNo">536</span> .append("text", description)<a name="line.536"></a> +<span class="sourceLineNo">537</span> .append("branding", branding)<a name="line.537"></a> +<span class="sourceLineNo">538</span> .append("header", header)<a name="line.538"></a> +<span class="sourceLineNo">539</span> .append("nav", nav)<a name="line.539"></a> +<span class="sourceLineNo">540</span> .append("links", links)<a name="line.540"></a> +<span class="sourceLineNo">541</span> .append("aside", aside)<a name="line.541"></a> +<span class="sourceLineNo">542</span> .append("footer", footer)<a name="line.542"></a> +<span class="sourceLineNo">543</span> .append("cssUrl", cssUrl)<a name="line.543"></a> +<span class="sourceLineNo">544</span> .append("nowrap", nowrap)<a name="line.544"></a> +<span class="sourceLineNo">545</span> .append("template", template)<a name="line.545"></a> +<span class="sourceLineNo">546</span> .append("noResultsMessage", noResultsMessage)<a name="line.546"></a> +<span class="sourceLineNo">547</span> );<a name="line.547"></a> +<span class="sourceLineNo">548</span> }<a name="line.548"></a> +<span class="sourceLineNo">549</span>}<a name="line.549"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html index f1ae30c..7b0bb8d 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html @@ -43,7 +43,7 @@ <span class="sourceLineNo">035</span><a name="line.35"></a> <span class="sourceLineNo">036</span> private final String title, description, branding, header, nav, aside, footer, cssUrl, noResultsMessage;<a name="line.36"></a> <span class="sourceLineNo">037</span> private final String[] css;<a name="line.37"></a> -<span class="sourceLineNo">038</span> private final Map<String,String> links;<a name="line.38"></a> +<span class="sourceLineNo">038</span> private final Map<String,Object> links;<a name="line.38"></a> <span class="sourceLineNo">039</span> private final boolean nowrap;<a name="line.39"></a> <span class="sourceLineNo">040</span> private final HtmlDocTemplate template;<a name="line.40"></a> <span class="sourceLineNo">041</span><a name="line.41"></a> @@ -166,7 +166,7 @@ <span class="sourceLineNo">158</span> * @return The {@link HtmlDocSerializerContext#HTMLDOC_links} setting value in this context.<a name="line.158"></a> <span class="sourceLineNo">159</span> * <jk>null</jk> if not specified. Never an empty map.<a name="line.159"></a> <span class="sourceLineNo">160</span> */<a name="line.160"></a> -<span class="sourceLineNo">161</span> public final Map<String,String> getLinks() {<a name="line.161"></a> +<span class="sourceLineNo">161</span> public final Map<String,Object> getLinks() {<a name="line.161"></a> <span class="sourceLineNo">162</span> return links;<a name="line.162"></a> <span class="sourceLineNo">163</span> }<a name="line.163"></a> <span class="sourceLineNo">164</span><a name="line.164"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2871fb5d/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html index d91dd63..494bb98 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html @@ -120,83 +120,87 @@ <span class="sourceLineNo">112</span> if (exists(nav))<a name="line.112"></a> <span class="sourceLineNo">113</span> w.append(2, nav).nl(2);<a name="line.113"></a> <span class="sourceLineNo">114</span> } else {<a name="line.114"></a> -<span class="sourceLineNo">115</span> Map<String,String> htmlLinks = session.getLinks();<a name="line.115"></a> +<span class="sourceLineNo">115</span> Map<String,Object> htmlLinks = session.getLinks();<a name="line.115"></a> <span class="sourceLineNo">116</span> boolean first = true;<a name="line.116"></a> <span class="sourceLineNo">117</span> if (htmlLinks != null) {<a name="line.117"></a> -<span class="sourceLineNo">118</span> for (Map.Entry<String,String> e : htmlLinks.entrySet()) {<a name="line.118"></a> -<span class="sourceLineNo">119</span> if (! first)<a name="line.119"></a> -<span class="sourceLineNo">120</span> w.append(3, " - ").nl(3);<a name="line.120"></a> -<span class="sourceLineNo">121</span> first = false;<a name="line.121"></a> -<span class="sourceLineNo">122</span> w.oTag("a").attr("class", "link").attr("href", session.resolveUri(e.getValue()), true).cTag().text(e.getKey(), true).eTag("a");<a name="line.122"></a> -<span class="sourceLineNo">123</span> }<a name="line.123"></a> -<span class="sourceLineNo">124</span> }<a name="line.124"></a> -<span class="sourceLineNo">125</span> }<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span><a name="line.127"></a> -<span class="sourceLineNo">128</span> @Override /* HtmlDocTemplate */<a name="line.128"></a> -<span class="sourceLineNo">129</span> public void aside(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.129"></a> -<span class="sourceLineNo">130</span> String aside = session.getAside();<a name="line.130"></a> -<span class="sourceLineNo">131</span> if (exists(aside))<a name="line.131"></a> -<span class="sourceLineNo">132</span> w.append(aside);<a name="line.132"></a> -<span class="sourceLineNo">133</span> }<a name="line.133"></a> -<span class="sourceLineNo">134</span><a name="line.134"></a> -<span class="sourceLineNo">135</span> @Override /* HtmlDocTemplate */<a name="line.135"></a> -<span class="sourceLineNo">136</span> public void article(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.136"></a> -<span class="sourceLineNo">137</span> // To allow for page formatting using CSS, we encapsulate the data inside two div tags:<a name="line.137"></a> -<span class="sourceLineNo">138</span> // <div class='outerdata'><div class='data' id='data'>...</div></div><a name="line.138"></a> -<span class="sourceLineNo">139</span> w.oTag(3, "div").attr("class","outerdata").append('>').nl(3);<a name="line.139"></a> -<span class="sourceLineNo">140</span> w.oTag(4, "div").attr("class","data").attr("id", "data").append('>').nl(4);<a name="line.140"></a> -<span class="sourceLineNo">141</span><a name="line.141"></a> -<span class="sourceLineNo">142</span> if (o == null) {<a name="line.142"></a> -<span class="sourceLineNo">143</span> w.append(5, "<null/>").nl(5);<a name="line.143"></a> -<span class="sourceLineNo">144</span> } else if (ObjectUtils.isEmpty(o)){<a name="line.144"></a> -<span class="sourceLineNo">145</span> String m = session.getNoResultsMessage();<a name="line.145"></a> -<span class="sourceLineNo">146</span> if (exists(m))<a name="line.146"></a> -<span class="sourceLineNo">147</span> w.append(5, m).nl(5);<a name="line.147"></a> -<span class="sourceLineNo">148</span> } else {<a name="line.148"></a> -<span class="sourceLineNo">149</span> s.parentSerialize(session, o);<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span><a name="line.151"></a> -<span class="sourceLineNo">152</span> w.ie(4).eTag("div").nl(4);<a name="line.152"></a> -<span class="sourceLineNo">153</span> w.ie(4).eTag("div").nl(3);<a name="line.153"></a> -<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">118</span> for (Map.Entry<String,Object> e : htmlLinks.entrySet()) {<a name="line.118"></a> +<span class="sourceLineNo">119</span> String v = e.getValue().toString();<a name="line.119"></a> +<span class="sourceLineNo">120</span> if (! first)<a name="line.120"></a> +<span class="sourceLineNo">121</span> w.append(3, " - ").nl(3);<a name="line.121"></a> +<span class="sourceLineNo">122</span> first = false;<a name="line.122"></a> +<span class="sourceLineNo">123</span> if (v.startsWith("<"))<a name="line.123"></a> +<span class="sourceLineNo">124</span> w.append(v);<a name="line.124"></a> +<span class="sourceLineNo">125</span> else<a name="line.125"></a> +<span class="sourceLineNo">126</span> w.oTag("a").attr("class", "link").attr("href", session.resolveUri(v), true).cTag().text(e.getKey(), true).eTag("a");<a name="line.126"></a> +<span class="sourceLineNo">127</span> }<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span> }<a name="line.129"></a> +<span class="sourceLineNo">130</span> }<a name="line.130"></a> +<span class="sourceLineNo">131</span><a name="line.131"></a> +<span class="sourceLineNo">132</span> @Override /* HtmlDocTemplate */<a name="line.132"></a> +<span class="sourceLineNo">133</span> public void aside(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.133"></a> +<span class="sourceLineNo">134</span> String aside = session.getAside();<a name="line.134"></a> +<span class="sourceLineNo">135</span> if (exists(aside))<a name="line.135"></a> +<span class="sourceLineNo">136</span> w.append(aside);<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> @Override /* HtmlDocTemplate */<a name="line.139"></a> +<span class="sourceLineNo">140</span> public void article(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.140"></a> +<span class="sourceLineNo">141</span> // To allow for page formatting using CSS, we encapsulate the data inside two div tags:<a name="line.141"></a> +<span class="sourceLineNo">142</span> // <div class='outerdata'><div class='data' id='data'>...</div></div><a name="line.142"></a> +<span class="sourceLineNo">143</span> w.oTag(3, "div").attr("class","outerdata").append('>').nl(3);<a name="line.143"></a> +<span class="sourceLineNo">144</span> w.oTag(4, "div").attr("class","data").attr("id", "data").append('>').nl(4);<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> if (o == null) {<a name="line.146"></a> +<span class="sourceLineNo">147</span> w.append(5, "<null/>").nl(5);<a name="line.147"></a> +<span class="sourceLineNo">148</span> } else if (ObjectUtils.isEmpty(o)){<a name="line.148"></a> +<span class="sourceLineNo">149</span> String m = session.getNoResultsMessage();<a name="line.149"></a> +<span class="sourceLineNo">150</span> if (exists(m))<a name="line.150"></a> +<span class="sourceLineNo">151</span> w.append(5, m).nl(5);<a name="line.151"></a> +<span class="sourceLineNo">152</span> } else {<a name="line.152"></a> +<span class="sourceLineNo">153</span> s.parentSerialize(session, o);<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> <span class="sourceLineNo">155</span><a name="line.155"></a> -<span class="sourceLineNo">156</span> @Override /* HtmlDocTemplate */<a name="line.156"></a> -<span class="sourceLineNo">157</span> public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.157"></a> -<span class="sourceLineNo">158</span> String footer = session.getFooter();<a name="line.158"></a> -<span class="sourceLineNo">159</span> if (exists(footer))<a name="line.159"></a> -<span class="sourceLineNo">160</span> w.append(footer);<a name="line.160"></a> -<span class="sourceLineNo">161</span> }<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> @Override /* HtmlDocTemplate */<a name="line.163"></a> -<span class="sourceLineNo">164</span> public boolean hasCss(HtmlDocSerializerSession session) {<a name="line.164"></a> -<span class="sourceLineNo">165</span> return true;<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> @Override /* HtmlDocTemplate */<a name="line.168"></a> -<span class="sourceLineNo">169</span> public boolean hasHeader(HtmlDocSerializerSession session) {<a name="line.169"></a> -<span class="sourceLineNo">170</span> return exists(session.getHeader()) || exists(session.getTitle()) || exists(session.getDescription());<a name="line.170"></a> -<span class="sourceLineNo">171</span> }<a name="line.171"></a> -<span class="sourceLineNo">172</span><a name="line.172"></a> -<span class="sourceLineNo">173</span> @Override /* HtmlDocTemplate */<a name="line.173"></a> -<span class="sourceLineNo">174</span> public boolean hasNav(HtmlDocSerializerSession session) {<a name="line.174"></a> -<span class="sourceLineNo">175</span> return exists(session.getNav()) || session.getLinks() != null;<a name="line.175"></a> -<span class="sourceLineNo">176</span> }<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> @Override /* HtmlDocTemplate */<a name="line.178"></a> -<span class="sourceLineNo">179</span> public boolean hasAside(HtmlDocSerializerSession session) {<a name="line.179"></a> -<span class="sourceLineNo">180</span> return exists(session.getAside());<a name="line.180"></a> -<span class="sourceLineNo">181</span> }<a name="line.181"></a> -<span class="sourceLineNo">182</span><a name="line.182"></a> -<span class="sourceLineNo">183</span> @Override /* HtmlDocTemplate */<a name="line.183"></a> -<span class="sourceLineNo">184</span> public boolean hasFooter(HtmlDocSerializerSession session) {<a name="line.184"></a> -<span class="sourceLineNo">185</span> return exists(session.getFooter());<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> private static boolean exists(String s) {<a name="line.188"></a> -<span class="sourceLineNo">189</span> return s != null && ! "NONE".equals(s);<a name="line.189"></a> +<span class="sourceLineNo">156</span> w.ie(4).eTag("div").nl(4);<a name="line.156"></a> +<span class="sourceLineNo">157</span> w.ie(4).eTag("div").nl(3);<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span><a name="line.159"></a> +<span class="sourceLineNo">160</span> @Override /* HtmlDocTemplate */<a name="line.160"></a> +<span class="sourceLineNo">161</span> public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.161"></a> +<span class="sourceLineNo">162</span> String footer = session.getFooter();<a name="line.162"></a> +<span class="sourceLineNo">163</span> if (exists(footer))<a name="line.163"></a> +<span class="sourceLineNo">164</span> w.append(footer);<a name="line.164"></a> +<span class="sourceLineNo">165</span> }<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> @Override /* HtmlDocTemplate */<a name="line.167"></a> +<span class="sourceLineNo">168</span> public boolean hasCss(HtmlDocSerializerSession session) {<a name="line.168"></a> +<span class="sourceLineNo">169</span> return true;<a name="line.169"></a> +<span class="sourceLineNo">170</span> }<a name="line.170"></a> +<span class="sourceLineNo">171</span><a name="line.171"></a> +<span class="sourceLineNo">172</span> @Override /* HtmlDocTemplate */<a name="line.172"></a> +<span class="sourceLineNo">173</span> public boolean hasHeader(HtmlDocSerializerSession session) {<a name="line.173"></a> +<span class="sourceLineNo">174</span> return exists(session.getHeader()) || exists(session.getTitle()) || exists(session.getDescription());<a name="line.174"></a> +<span class="sourceLineNo">175</span> }<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> @Override /* HtmlDocTemplate */<a name="line.177"></a> +<span class="sourceLineNo">178</span> public boolean hasNav(HtmlDocSerializerSession session) {<a name="line.178"></a> +<span class="sourceLineNo">179</span> return exists(session.getNav()) || session.getLinks() != null;<a name="line.179"></a> +<span class="sourceLineNo">180</span> }<a name="line.180"></a> +<span class="sourceLineNo">181</span><a name="line.181"></a> +<span class="sourceLineNo">182</span> @Override /* HtmlDocTemplate */<a name="line.182"></a> +<span class="sourceLineNo">183</span> public boolean hasAside(HtmlDocSerializerSession session) {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return exists(session.getAside());<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span><a name="line.186"></a> +<span class="sourceLineNo">187</span> @Override /* HtmlDocTemplate */<a name="line.187"></a> +<span class="sourceLineNo">188</span> public boolean hasFooter(HtmlDocSerializerSession session) {<a name="line.188"></a> +<span class="sourceLineNo">189</span> return exists(session.getFooter());<a name="line.189"></a> <span class="sourceLineNo">190</span> }<a name="line.190"></a> -<span class="sourceLineNo">191</span>}<a name="line.191"></a> +<span class="sourceLineNo">191</span><a name="line.191"></a> +<span class="sourceLineNo">192</span> private static boolean exists(String s) {<a name="line.192"></a> +<span class="sourceLineNo">193</span> return s != null && ! "NONE".equals(s);<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span>}<a name="line.195"></a>
