http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializer.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializer.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializer.html index c4ba251..4b7b896 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializer.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializer.html @@ -120,7 +120,7 @@ <span class="sourceLineNo">112</span> String title = s.getTitle();<a name="line.112"></a> <span class="sourceLineNo">113</span> if (title == null && isOptionsPage)<a name="line.113"></a> <span class="sourceLineNo">114</span> title = "Options";<a name="line.114"></a> -<span class="sourceLineNo">115</span> String description = s.getDescription();<a name="line.115"></a> +<span class="sourceLineNo">115</span> String description = s.getText();<a name="line.115"></a> <span class="sourceLineNo">116</span> if (title != null)<a name="line.116"></a> <span class="sourceLineNo">117</span> w.oTag(1, "h3").attr("class", "title").append('>').text(title).eTag("h3").nl();<a name="line.117"></a> <span class="sourceLineNo">118</span> if (description != null)<a name="line.118"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/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 2269437..4fda3a2 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 @@ -43,229 +43,268 @@ <span class="sourceLineNo">035</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.35"></a> <span class="sourceLineNo">036</span> * </p><a name="line.36"></a> <span class="sourceLineNo">037</span> * <p><a name="line.37"></a> -<span class="sourceLineNo">038</span> * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * These variables are replaced at runtime based on the HTTP request locale.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.<a name="line.40"></a> -<span class="sourceLineNo">041</span> *<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <h5 class='section'>Inherited configurable properties:</h5><a name="line.42"></a> -<span class="sourceLineNo">043</span> * <ul class='javahierarchy'><a name="line.43"></a> -<span class="sourceLineNo">044</span> * <li class='c'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <ul><a name="line.45"></a> -<span class="sourceLineNo">046</span> * <li class='c'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - Configurable properties common to all serializers.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * <ul><a name="line.47"></a> -<span class="sourceLineNo">048</span> * <li class='c'><a class="doclink" href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a> - Configurable properties on the HTML serializer.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * </ul><a name="line.49"></a> -<span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> -<span class="sourceLineNo">051</span> * </ul><a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span>public final class HtmlDocSerializerContext extends HtmlSerializerContext {<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> /**<a name="line.55"></a> -<span class="sourceLineNo">056</span> * <b>Configuration property:</b> Page title.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * <p><a name="line.57"></a> -<span class="sourceLineNo">058</span> * <ul><a name="line.58"></a> -<span class="sourceLineNo">059</span> * <li><b>Name:</b> <js>"HtmlSerializer.title"</js><a name="line.59"></a> -<span class="sourceLineNo">060</span> * <li><b>Data type:</b> <code>String</code><a name="line.60"></a> -<span class="sourceLineNo">061</span> * <li><b>Default:</b> <jk>null</jk><a name="line.61"></a> -<span class="sourceLineNo">062</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.62"></a> -<span class="sourceLineNo">063</span> * </ul><a name="line.63"></a> -<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> -<span class="sourceLineNo">065</span> *<a name="line.65"></a> -<span class="sourceLineNo">066</span> * <h5 class='section'>Example:</h5><a name="line.66"></a> -<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> -<span class="sourceLineNo">068</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.68"></a> -<span class="sourceLineNo">069</span> * </p><a name="line.69"></a> -<span class="sourceLineNo">070</span> * <p class='bcode'><a name="line.70"></a> -<span class="sourceLineNo">071</span> * <ja>@RestResource</ja>(<a name="line.71"></a> -<span class="sourceLineNo">072</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.72"></a> -<span class="sourceLineNo">073</span> * properties={<a name="line.73"></a> -<span class="sourceLineNo">074</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>)<a name="line.74"></a> -<span class="sourceLineNo">075</span> * }<a name="line.75"></a> -<span class="sourceLineNo">076</span> * )<a name="line.76"></a> -<span class="sourceLineNo">077</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.77"></a> -<span class="sourceLineNo">078</span> * </p><a name="line.78"></a> +<span class="sourceLineNo">038</span> * Note that shortcut annotations are also provided for these particular settings:<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p class='bcode'><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <ja>@RestResource</ja>(<a name="line.40"></a> +<span class="sourceLineNo">041</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.41"></a> +<span class="sourceLineNo">042</span> * title=<js>"$L{title}"</js>, <jc>// or pageTitle</jc><a name="line.42"></a> +<span class="sourceLineNo">043</span> * description=<js>"$L{description}"</js>, <jc>// or pageText</jc><a name="line.43"></a> +<span class="sourceLineNo">044</span> * pageLinks=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js><a name="line.44"></a> +<span class="sourceLineNo">045</span> * )<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.46"></a> +<span class="sourceLineNo">047</span> * </p><a name="line.47"></a> +<span class="sourceLineNo">048</span> *<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * These variables are replaced at runtime based on the HTTP request locale.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.<a name="line.52"></a> +<span class="sourceLineNo">053</span> *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <h5 class='section'>Inherited configurable properties:</h5><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <ul class='javahierarchy'><a name="line.55"></a> +<span class="sourceLineNo">056</span> * <li class='c'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <ul><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <li class='c'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - Configurable properties common to all serializers.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <ul><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <li class='c'><a class="doclink" href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a> - Configurable properties on the HTML serializer.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * </ul><a name="line.61"></a> +<span class="sourceLineNo">062</span> * </ul><a name="line.62"></a> +<span class="sourceLineNo">063</span> * </ul><a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span>public final class HtmlDocSerializerContext extends HtmlSerializerContext {<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <b>Configuration property:</b> Page title.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <p><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <ul><a name="line.70"></a> +<span class="sourceLineNo">071</span> * <li><b>Name:</b> <js>"HtmlSerializer.title"</js><a name="line.71"></a> +<span class="sourceLineNo">072</span> * <li><b>Data type:</b> <code>String</code><a name="line.72"></a> +<span class="sourceLineNo">073</span> * <li><b>Default:</b> <jk>null</jk><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.74"></a> +<span class="sourceLineNo">075</span> * </ul><a name="line.75"></a> +<span class="sourceLineNo">076</span> * <p><a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * <h5 class='section'>Example:</h5><a name="line.78"></a> <span class="sourceLineNo">079</span> * <p><a name="line.79"></a> -<span class="sourceLineNo">080</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.80"></a> +<span class="sourceLineNo">080</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.80"></a> <span class="sourceLineNo">081</span> * </p><a name="line.81"></a> <span class="sourceLineNo">082</span> * <p class='bcode'><a name="line.82"></a> -<span class="sourceLineNo">083</span> * title = <js>AddressBook sample resource</js><a name="line.83"></a> -<span class="sourceLineNo">084</span> * </p><a name="line.84"></a> -<span class="sourceLineNo">085</span> * <p><a name="line.85"></a> -<span class="sourceLineNo">086</span> * ...to produce this title on the HTML page...<a name="line.86"></a> -<span class="sourceLineNo">087</span> * </p><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <img class='bordered' src='doc-files/HTML_TITLE.png'><a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> public static final String HTMLDOC_title = "HtmlSerializer.title";<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * <b>Configuration property:</b> Page description.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * <p><a name="line.94"></a> -<span class="sourceLineNo">095</span> * <ul><a name="line.95"></a> -<span class="sourceLineNo">096</span> * <li><b>Name:</b> <js>"HtmlSerializer.description"</js><a name="line.96"></a> -<span class="sourceLineNo">097</span> * <li><b>Data type:</b> <code>String</code><a name="line.97"></a> -<span class="sourceLineNo">098</span> * <li><b>Default:</b> <jk>null</jk><a name="line.98"></a> -<span class="sourceLineNo">099</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.99"></a> -<span class="sourceLineNo">100</span> * </ul><a name="line.100"></a> +<span class="sourceLineNo">083</span> * <ja>@RestResource</ja>(<a name="line.83"></a> +<span class="sourceLineNo">084</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.84"></a> +<span class="sourceLineNo">085</span> * properties={<a name="line.85"></a> +<span class="sourceLineNo">086</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_title</jsf>, value=<js>"$L{title}"</js>)<a name="line.86"></a> +<span class="sourceLineNo">087</span> * }<a name="line.87"></a> +<span class="sourceLineNo">088</span> * )<a name="line.88"></a> +<span class="sourceLineNo">089</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.89"></a> +<span class="sourceLineNo">090</span> * </p><a name="line.90"></a> +<span class="sourceLineNo">091</span> * <p><a name="line.91"></a> +<span class="sourceLineNo">092</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.92"></a> +<span class="sourceLineNo">093</span> * </p><a name="line.93"></a> +<span class="sourceLineNo">094</span> * <p class='bcode'><a name="line.94"></a> +<span class="sourceLineNo">095</span> * title = <js>AddressBook sample resource</js><a name="line.95"></a> +<span class="sourceLineNo">096</span> * </p><a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p><a name="line.97"></a> +<span class="sourceLineNo">098</span> * ...to produce this title on the HTML page...<a name="line.98"></a> +<span class="sourceLineNo">099</span> * </p><a name="line.99"></a> +<span class="sourceLineNo">100</span> * <img class='bordered' src='doc-files/HTML_TITLE.png'><a name="line.100"></a> <span class="sourceLineNo">101</span> * <p><a name="line.101"></a> -<span class="sourceLineNo">102</span> *<a name="line.102"></a> -<span class="sourceLineNo">103</span> * <h5 class='section'>Example:</h5><a name="line.103"></a> -<span class="sourceLineNo">104</span> * <p><a name="line.104"></a> -<span class="sourceLineNo">105</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.105"></a> -<span class="sourceLineNo">106</span> * </p><a name="line.106"></a> -<span class="sourceLineNo">107</span> * <p class='bcode'><a name="line.107"></a> -<span class="sourceLineNo">108</span> * <ja>@RestResource</ja>(<a name="line.108"></a> -<span class="sourceLineNo">109</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.109"></a> -<span class="sourceLineNo">110</span> * properties={<a name="line.110"></a> -<span class="sourceLineNo">111</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>, value=<js>"description"</js>, type=<jsf>NLS</jsf>)<a name="line.111"></a> -<span class="sourceLineNo">112</span> * }<a name="line.112"></a> -<span class="sourceLineNo">113</span> * )<a name="line.113"></a> -<span class="sourceLineNo">114</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.114"></a> -<span class="sourceLineNo">115</span> * </p><a name="line.115"></a> -<span class="sourceLineNo">116</span> * <p><a name="line.116"></a> -<span class="sourceLineNo">117</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.117"></a> -<span class="sourceLineNo">118</span> * </p><a name="line.118"></a> -<span class="sourceLineNo">119</span> * <p class='bcode'><a name="line.119"></a> -<span class="sourceLineNo">120</span> * description = <js>Simple address book POJO sample resource</js><a name="line.120"></a> -<span class="sourceLineNo">121</span> * </p><a name="line.121"></a> +<span class="sourceLineNo">102</span> * Shortcuts on <ja>@RestResource</ja> are also provided for this setting:<a name="line.102"></a> +<span class="sourceLineNo">103</span> * <p class='bcode'><a name="line.103"></a> +<span class="sourceLineNo">104</span> * <ja>@RestResource</ja>(<a name="line.104"></a> +<span class="sourceLineNo">105</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.105"></a> +<span class="sourceLineNo">106</span> * title=<js>"My title"</js>, <jc>// or pageTitle</jc><a name="line.106"></a> +<span class="sourceLineNo">107</span> * )<a name="line.107"></a> +<span class="sourceLineNo">108</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.108"></a> +<span class="sourceLineNo">109</span> * </p><a name="line.109"></a> +<span class="sourceLineNo">110</span> */<a name="line.110"></a> +<span class="sourceLineNo">111</span> public static final String HTMLDOC_title = "HtmlSerializer.title";<a name="line.111"></a> +<span class="sourceLineNo">112</span><a name="line.112"></a> +<span class="sourceLineNo">113</span> /**<a name="line.113"></a> +<span class="sourceLineNo">114</span> * <b>Configuration property:</b> Page description.<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <p><a name="line.115"></a> +<span class="sourceLineNo">116</span> * <ul><a name="line.116"></a> +<span class="sourceLineNo">117</span> * <li><b>Name:</b> <js>"HtmlSerializer.description"</js><a name="line.117"></a> +<span class="sourceLineNo">118</span> * <li><b>Data type:</b> <code>String</code><a name="line.118"></a> +<span class="sourceLineNo">119</span> * <li><b>Default:</b> <jk>null</jk><a name="line.119"></a> +<span class="sourceLineNo">120</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.120"></a> +<span class="sourceLineNo">121</span> * </ul><a name="line.121"></a> <span class="sourceLineNo">122</span> * <p><a name="line.122"></a> -<span class="sourceLineNo">123</span> * ...to produce this description on the HTML page...<a name="line.123"></a> -<span class="sourceLineNo">124</span> * </p><a name="line.124"></a> -<span class="sourceLineNo">125</span> * <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'><a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> public static final String HTMLDOC_description = "HtmlSerializer.description";<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> * <b>Configuration property:</b> Page links.<a name="line.130"></a> -<span class="sourceLineNo">131</span> * <p><a name="line.131"></a> -<span class="sourceLineNo">132</span> * <ul><a name="line.132"></a> -<span class="sourceLineNo">133</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.links.map"</js><a name="line.133"></a> -<span class="sourceLineNo">134</span> * <li><b>Data type:</b> <code>Map&lt;String,String&gt;</code><a name="line.134"></a> -<span class="sourceLineNo">135</span> * <li><b>Default:</b> empty map<a name="line.135"></a> -<span class="sourceLineNo">136</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.136"></a> -<span class="sourceLineNo">137</span> * </ul><a name="line.137"></a> -<span class="sourceLineNo">138</span> * <p><a name="line.138"></a> -<span class="sourceLineNo">139</span> * Adds a list of hyperlinks immediately under the title and description but above the content of the page.<a name="line.139"></a> -<span class="sourceLineNo">140</span> * <p><a name="line.140"></a> -<span class="sourceLineNo">141</span> * This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * <p><a name="line.142"></a> -<span class="sourceLineNo">143</span> * The value is a JSON object string where the keys are anchor text and the values are URLs.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * <p><a name="line.144"></a> -<span class="sourceLineNo">145</span> * Relative URLs are considered relative to the servlet path.<a name="line.145"></a> -<span class="sourceLineNo">146</span> * For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the<a name="line.146"></a> -<span class="sourceLineNo">147</span> * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo"</js>.<a name="line.147"></a> -<span class="sourceLineNo">148</span> * Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs<a name="line.148"></a> -<span class="sourceLineNo">149</span> * can also be used.<a name="line.149"></a> -<span class="sourceLineNo">150</span> *<a name="line.150"></a> -<span class="sourceLineNo">151</span> * <h5 class='section'>Example:</h5><a name="line.151"></a> -<span class="sourceLineNo">152</span> * <p><a name="line.152"></a> -<span class="sourceLineNo">153</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.153"></a> -<span class="sourceLineNo">154</span> * </p><a name="line.154"></a> -<span class="sourceLineNo">155</span> * <p class='bcode'><a name="line.155"></a> -<span class="sourceLineNo">156</span> * <ja>@RestResource</ja>(<a name="line.156"></a> -<span class="sourceLineNo">157</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.157"></a> -<span class="sourceLineNo">158</span> * properties={<a name="line.158"></a> -<span class="sourceLineNo">159</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)<a name="line.159"></a> -<span class="sourceLineNo">160</span> * }<a name="line.160"></a> -<span class="sourceLineNo">161</span> * )<a name="line.161"></a> -<span class="sourceLineNo">162</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.162"></a> -<span class="sourceLineNo">163</span> * </p><a name="line.163"></a> -<span class="sourceLineNo">164</span> * <p><a name="line.164"></a> -<span class="sourceLineNo">165</span> * ...to produce this list of links on the HTML page...<a name="line.165"></a> -<span class="sourceLineNo">166</span> * </p><a name="line.166"></a> -<span class="sourceLineNo">167</span> * <img class='bordered' src='doc-files/HTML_LINKS.png'><a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> public static final String HTMLDOC_links = "HtmlDocSerializer.links.map";<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> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_links} property.<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> public static final String HTMLDOC_links_put = "HtmlDocSerializer.links.map.put";<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> * <b>Configuration property:</b> Stylesheet URL.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> -<span class="sourceLineNo">179</span> * <ul><a name="line.179"></a> -<span class="sourceLineNo">180</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js><a name="line.180"></a> -<span class="sourceLineNo">181</span> * <li><b>Data type:</b> <code>String</code><a name="line.181"></a> -<span class="sourceLineNo">182</span> * <li><b>Default:</b> <js>"style.css"</js><a name="line.182"></a> -<span class="sourceLineNo">183</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.183"></a> -<span class="sourceLineNo">184</span> * </ul><a name="line.184"></a> -<span class="sourceLineNo">185</span> * <p><a name="line.185"></a> -<span class="sourceLineNo">186</span> * Adds a link to the specified stylesheet URL.<a name="line.186"></a> -<span class="sourceLineNo">187</span> * <p><a name="line.187"></a> -<span class="sourceLineNo">188</span> * If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>.<a name="line.188"></a> -<span class="sourceLineNo">189</span> * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> public static final String HTMLDOC_cssUrl = "HtmlDocSerializer.cssUrl";<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> * <b>Configuration property:</b> CSS imports.<a name="line.194"></a> -<span class="sourceLineNo">195</span> * <p><a name="line.195"></a> -<span class="sourceLineNo">196</span> * <ul><a name="line.196"></a> -<span class="sourceLineNo">197</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.cssImports.list"</js><a name="line.197"></a> -<span class="sourceLineNo">198</span> * <li><b>Data type:</b> <code>List&lt;String&gt;</code><a name="line.198"></a> -<span class="sourceLineNo">199</span> * <li><b>Default:</b> empty list<a name="line.199"></a> -<span class="sourceLineNo">200</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.200"></a> -<span class="sourceLineNo">201</span> * </ul><a name="line.201"></a> -<span class="sourceLineNo">202</span> * <p><a name="line.202"></a> -<span class="sourceLineNo">203</span> * Imports the specified CSS page URLs into the page.<a name="line.203"></a> -<span class="sourceLineNo">204</span> */<a name="line.204"></a> -<span class="sourceLineNo">205</span> public static final String HTMLDOC_cssImports = "HtmlDocSerializer.cssImports.list";<a name="line.205"></a> -<span class="sourceLineNo">206</span><a name="line.206"></a> -<span class="sourceLineNo">207</span> /**<a name="line.207"></a> -<span class="sourceLineNo">208</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_cssImports} property.<a name="line.208"></a> -<span class="sourceLineNo">209</span> */<a name="line.209"></a> -<span class="sourceLineNo">210</span> public static final String HTMLDOC_cssImports_add = "HtmlDocSerializer.cssImports.list.add";<a name="line.210"></a> -<span class="sourceLineNo">211</span><a name="line.211"></a> -<span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * <b>Configuration property:</b> Prevent word wrap on page.<a name="line.213"></a> -<span class="sourceLineNo">214</span> * <p><a name="line.214"></a> -<span class="sourceLineNo">215</span> * <ul><a name="line.215"></a> -<span class="sourceLineNo">216</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js><a name="line.216"></a> -<span class="sourceLineNo">217</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.217"></a> -<span class="sourceLineNo">218</span> * <li><b>Default:</b> <jk>false</jk><a name="line.218"></a> -<span class="sourceLineNo">219</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.219"></a> -<span class="sourceLineNo">220</span> * </ul><a name="line.220"></a> -<span class="sourceLineNo">221</span> * <p><a name="line.221"></a> -<span class="sourceLineNo">222</span> * Adds <js>"* {white-space:nowrap}"</js> to the style header to prevent word wrapping.<a name="line.222"></a> -<span class="sourceLineNo">223</span> */<a name="line.223"></a> -<span class="sourceLineNo">224</span> public static final String HTMLDOC_nowrap = "HtmlDocSerializer.nowrap";<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> final String[] cssImports;<a name="line.226"></a> -<span class="sourceLineNo">227</span> final Map<String,String> links;<a name="line.227"></a> -<span class="sourceLineNo">228</span> final String title, description, cssUrl;<a name="line.228"></a> -<span class="sourceLineNo">229</span> final boolean nowrap;<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> * Constructor.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * <p><a name="line.233"></a> -<span class="sourceLineNo">234</span> * Typically only called from {@link PropertyStore#getContext(Class)}.<a name="line.234"></a> -<span class="sourceLineNo">235</span> *<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @param ps The property store that created this context.<a name="line.236"></a> -<span class="sourceLineNo">237</span> */<a name="line.237"></a> -<span class="sourceLineNo">238</span> public HtmlDocSerializerContext(PropertyStore ps) {<a name="line.238"></a> -<span class="sourceLineNo">239</span> super(ps);<a name="line.239"></a> -<span class="sourceLineNo">240</span> cssImports = ps.getProperty(HTMLDOC_cssImports, String[].class, new String[0]);<a name="line.240"></a> -<span class="sourceLineNo">241</span> title = ps.getProperty(HTMLDOC_title, String.class, null);<a name="line.241"></a> -<span class="sourceLineNo">242</span> description = ps.getProperty(HTMLDOC_description, String.class, null);<a name="line.242"></a> -<span class="sourceLineNo">243</span> cssUrl = ps.getProperty(HTMLDOC_cssUrl, String.class, null);<a name="line.243"></a> -<span class="sourceLineNo">244</span> nowrap = ps.getProperty(HTMLDOC_nowrap, boolean.class, false);<a name="line.244"></a> -<span class="sourceLineNo">245</span> links = ps.getMap(HTMLDOC_links, String.class, String.class, Collections.<String,String>emptyMap());<a name="line.245"></a> -<span class="sourceLineNo">246</span> }<a name="line.246"></a> -<span class="sourceLineNo">247</span><a name="line.247"></a> -<span class="sourceLineNo">248</span> @Override /* Context */<a name="line.248"></a> -<span class="sourceLineNo">249</span> public ObjectMap asMap() {<a name="line.249"></a> -<span class="sourceLineNo">250</span> return super.asMap()<a name="line.250"></a> -<span class="sourceLineNo">251</span> .append("HtmlDocSerializerContext", new ObjectMap()<a name="line.251"></a> -<span class="sourceLineNo">252</span> .append("cssImports", cssImports)<a name="line.252"></a> -<span class="sourceLineNo">253</span> .append("title", title)<a name="line.253"></a> -<span class="sourceLineNo">254</span> .append("description", description)<a name="line.254"></a> -<span class="sourceLineNo">255</span> .append("cssUrl", cssUrl)<a name="line.255"></a> -<span class="sourceLineNo">256</span> .append("nowrap", nowrap)<a name="line.256"></a> -<span class="sourceLineNo">257</span> .append("links", links)<a name="line.257"></a> -<span class="sourceLineNo">258</span> );<a name="line.258"></a> -<span class="sourceLineNo">259</span> }<a name="line.259"></a> -<span class="sourceLineNo">260</span>}<a name="line.260"></a> +<span class="sourceLineNo">123</span> *<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <h5 class='section'>Example:</h5><a name="line.124"></a> +<span class="sourceLineNo">125</span> * <p><a name="line.125"></a> +<span class="sourceLineNo">126</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.126"></a> +<span class="sourceLineNo">127</span> * </p><a name="line.127"></a> +<span class="sourceLineNo">128</span> * <p class='bcode'><a name="line.128"></a> +<span class="sourceLineNo">129</span> * <ja>@RestResource</ja>(<a name="line.129"></a> +<span class="sourceLineNo">130</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.130"></a> +<span class="sourceLineNo">131</span> * properties={<a name="line.131"></a> +<span class="sourceLineNo">132</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_description</jsf>, value=<js>"My description"</js>)<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> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.135"></a> +<span class="sourceLineNo">136</span> * </p><a name="line.136"></a> +<span class="sourceLineNo">137</span> * <p><a name="line.137"></a> +<span class="sourceLineNo">138</span> * ...with this property in <code>AddressBookResource.properties</code>...<a name="line.138"></a> +<span class="sourceLineNo">139</span> * </p><a name="line.139"></a> +<span class="sourceLineNo">140</span> * <p class='bcode'><a name="line.140"></a> +<span class="sourceLineNo">141</span> * description = <js>Simple address book POJO sample resource</js><a name="line.141"></a> +<span class="sourceLineNo">142</span> * </p><a name="line.142"></a> +<span class="sourceLineNo">143</span> * <p><a name="line.143"></a> +<span class="sourceLineNo">144</span> * ...to produce this description on the HTML page...<a name="line.144"></a> +<span class="sourceLineNo">145</span> * </p><a name="line.145"></a> +<span class="sourceLineNo">146</span> * <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'><a name="line.146"></a> +<span class="sourceLineNo">147</span> * <p><a name="line.147"></a> +<span class="sourceLineNo">148</span> * Shortcuts on <ja>@RestResource</ja> are also provided for this setting:<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <p class='bcode'><a name="line.149"></a> +<span class="sourceLineNo">150</span> * <ja>@RestResource</ja>(<a name="line.150"></a> +<span class="sourceLineNo">151</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.151"></a> +<span class="sourceLineNo">152</span> * description=<js>"My description"</js>, <jc>// or pageText</jc><a name="line.152"></a> +<span class="sourceLineNo">153</span> * )<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.154"></a> +<span class="sourceLineNo">155</span> * </p><a name="line.155"></a> +<span class="sourceLineNo">156</span> */<a name="line.156"></a> +<span class="sourceLineNo">157</span> public static final String HTMLDOC_text = "HtmlSerializer.description";<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> * <b>Configuration property:</b> Page links.<a name="line.160"></a> +<span class="sourceLineNo">161</span> * <p><a name="line.161"></a> +<span class="sourceLineNo">162</span> * <ul><a name="line.162"></a> +<span class="sourceLineNo">163</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.links.map"</js><a name="line.163"></a> +<span class="sourceLineNo">164</span> * <li><b>Data type:</b> <code>Map&lt;String,String&gt;</code><a name="line.164"></a> +<span class="sourceLineNo">165</span> * <li><b>Default:</b> empty map<a name="line.165"></a> +<span class="sourceLineNo">166</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.166"></a> +<span class="sourceLineNo">167</span> * </ul><a name="line.167"></a> +<span class="sourceLineNo">168</span> * <p><a name="line.168"></a> +<span class="sourceLineNo">169</span> * Adds a list of hyperlinks immediately under the title and description but above the content of the page.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * <p><a name="line.170"></a> +<span class="sourceLineNo">171</span> * This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * <p><a name="line.172"></a> +<span class="sourceLineNo">173</span> * The value is a JSON object string where the keys are anchor text and the values are URLs.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * <p><a name="line.174"></a> +<span class="sourceLineNo">175</span> * Relative URLs are considered relative to the servlet path.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the<a name="line.176"></a> +<span class="sourceLineNo">177</span> * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo"</js>.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs<a name="line.178"></a> +<span class="sourceLineNo">179</span> * can also be used.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * <h5 class='section'>Example:</h5><a name="line.181"></a> +<span class="sourceLineNo">182</span> * <p><a name="line.182"></a> +<span class="sourceLineNo">183</span> * The <code>AddressBookResource</code> sample class uses this property...<a name="line.183"></a> +<span class="sourceLineNo">184</span> * </p><a name="line.184"></a> +<span class="sourceLineNo">185</span> * <p class='bcode'><a name="line.185"></a> +<span class="sourceLineNo">186</span> * <ja>@RestResource</ja>(<a name="line.186"></a> +<span class="sourceLineNo">187</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.187"></a> +<span class="sourceLineNo">188</span> * properties={<a name="line.188"></a> +<span class="sourceLineNo">189</span> * <ja>@Property</ja>(name=HtmlDocSerializerContext.<jsf>HTMLDOC_links</jsf>, value=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js>)<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">192</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.192"></a> +<span class="sourceLineNo">193</span> * </p><a name="line.193"></a> +<span class="sourceLineNo">194</span> * <p><a name="line.194"></a> +<span class="sourceLineNo">195</span> * ...to produce this list of links on the HTML page...<a name="line.195"></a> +<span class="sourceLineNo">196</span> * </p><a name="line.196"></a> +<span class="sourceLineNo">197</span> * <img class='bordered' src='doc-files/HTML_LINKS.png'><a name="line.197"></a> +<span class="sourceLineNo">198</span> * <p><a name="line.198"></a> +<span class="sourceLineNo">199</span> * A shortcut on <ja>@RestResource</ja> is also provided for this setting:<a name="line.199"></a> +<span class="sourceLineNo">200</span> * <p class='bcode'><a name="line.200"></a> +<span class="sourceLineNo">201</span> * <ja>@RestResource</ja>(<a name="line.201"></a> +<span class="sourceLineNo">202</span> * messages=<js>"nls/AddressBookResource"</js>,<a name="line.202"></a> +<span class="sourceLineNo">203</span> * pageLinks=<js>"{options:'?method=OPTIONS',doc:'doc'}"</js><a name="line.203"></a> +<span class="sourceLineNo">204</span> * )<a name="line.204"></a> +<span class="sourceLineNo">205</span> * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {<a name="line.205"></a> +<span class="sourceLineNo">206</span> * </p><a name="line.206"></a> +<span class="sourceLineNo">207</span> */<a name="line.207"></a> +<span class="sourceLineNo">208</span> public static final String HTMLDOC_links = "HtmlDocSerializer.links.map";<a name="line.208"></a> +<span class="sourceLineNo">209</span><a name="line.209"></a> +<span class="sourceLineNo">210</span> /**<a name="line.210"></a> +<span class="sourceLineNo">211</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_links} property.<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> public static final String HTMLDOC_links_put = "HtmlDocSerializer.links.map.put";<a name="line.213"></a> +<span class="sourceLineNo">214</span><a name="line.214"></a> +<span class="sourceLineNo">215</span> /**<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <b>Configuration property:</b> Stylesheet URL.<a name="line.216"></a> +<span class="sourceLineNo">217</span> * <p><a name="line.217"></a> +<span class="sourceLineNo">218</span> * <ul><a name="line.218"></a> +<span class="sourceLineNo">219</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js><a name="line.219"></a> +<span class="sourceLineNo">220</span> * <li><b>Data type:</b> <code>String</code><a name="line.220"></a> +<span class="sourceLineNo">221</span> * <li><b>Default:</b> <js>"style.css"</js><a name="line.221"></a> +<span class="sourceLineNo">222</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.222"></a> +<span class="sourceLineNo">223</span> * </ul><a name="line.223"></a> +<span class="sourceLineNo">224</span> * <p><a name="line.224"></a> +<span class="sourceLineNo">225</span> * Adds a link to the specified stylesheet URL.<a name="line.225"></a> +<span class="sourceLineNo">226</span> * <p><a name="line.226"></a> +<span class="sourceLineNo">227</span> * If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>.<a name="line.227"></a> +<span class="sourceLineNo">228</span> * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.<a name="line.228"></a> +<span class="sourceLineNo">229</span> */<a name="line.229"></a> +<span class="sourceLineNo">230</span> public static final String HTMLDOC_cssUrl = "HtmlDocSerializer.cssUrl";<a name="line.230"></a> +<span class="sourceLineNo">231</span><a name="line.231"></a> +<span class="sourceLineNo">232</span> /**<a name="line.232"></a> +<span class="sourceLineNo">233</span> * <b>Configuration property:</b> CSS imports.<a name="line.233"></a> +<span class="sourceLineNo">234</span> * <p><a name="line.234"></a> +<span class="sourceLineNo">235</span> * <ul><a name="line.235"></a> +<span class="sourceLineNo">236</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.cssImports.list"</js><a name="line.236"></a> +<span class="sourceLineNo">237</span> * <li><b>Data type:</b> <code>List&lt;String&gt;</code><a name="line.237"></a> +<span class="sourceLineNo">238</span> * <li><b>Default:</b> empty list<a name="line.238"></a> +<span class="sourceLineNo">239</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.239"></a> +<span class="sourceLineNo">240</span> * </ul><a name="line.240"></a> +<span class="sourceLineNo">241</span> * <p><a name="line.241"></a> +<span class="sourceLineNo">242</span> * Imports the specified CSS page URLs into the page.<a name="line.242"></a> +<span class="sourceLineNo">243</span> */<a name="line.243"></a> +<span class="sourceLineNo">244</span> public static final String HTMLDOC_cssImports = "HtmlDocSerializer.cssImports.list";<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> /**<a name="line.246"></a> +<span class="sourceLineNo">247</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_cssImports} property.<a name="line.247"></a> +<span class="sourceLineNo">248</span> */<a name="line.248"></a> +<span class="sourceLineNo">249</span> public static final String HTMLDOC_cssImports_add = "HtmlDocSerializer.cssImports.list.add";<a name="line.249"></a> +<span class="sourceLineNo">250</span><a name="line.250"></a> +<span class="sourceLineNo">251</span> /**<a name="line.251"></a> +<span class="sourceLineNo">252</span> * <b>Configuration property:</b> Prevent word wrap on page.<a name="line.252"></a> +<span class="sourceLineNo">253</span> * <p><a name="line.253"></a> +<span class="sourceLineNo">254</span> * <ul><a name="line.254"></a> +<span class="sourceLineNo">255</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js><a name="line.255"></a> +<span class="sourceLineNo">256</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.256"></a> +<span class="sourceLineNo">257</span> * <li><b>Default:</b> <jk>false</jk><a name="line.257"></a> +<span class="sourceLineNo">258</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.258"></a> +<span class="sourceLineNo">259</span> * </ul><a name="line.259"></a> +<span class="sourceLineNo">260</span> * <p><a name="line.260"></a> +<span class="sourceLineNo">261</span> * Adds <js>"* {white-space:nowrap}"</js> to the style header to prevent word wrapping.<a name="line.261"></a> +<span class="sourceLineNo">262</span> */<a name="line.262"></a> +<span class="sourceLineNo">263</span> public static final String HTMLDOC_nowrap = "HtmlDocSerializer.nowrap";<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> final String[] cssImports;<a name="line.265"></a> +<span class="sourceLineNo">266</span> final Map<String,String> links;<a name="line.266"></a> +<span class="sourceLineNo">267</span> final String title, text, cssUrl;<a name="line.267"></a> +<span class="sourceLineNo">268</span> final boolean nowrap;<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Constructor.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * <p><a name="line.272"></a> +<span class="sourceLineNo">273</span> * Typically only called from {@link PropertyStore#getContext(Class)}.<a name="line.273"></a> +<span class="sourceLineNo">274</span> *<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @param ps The property store that created this context.<a name="line.275"></a> +<span class="sourceLineNo">276</span> */<a name="line.276"></a> +<span class="sourceLineNo">277</span> public HtmlDocSerializerContext(PropertyStore ps) {<a name="line.277"></a> +<span class="sourceLineNo">278</span> super(ps);<a name="line.278"></a> +<span class="sourceLineNo">279</span> cssImports = ps.getProperty(HTMLDOC_cssImports, String[].class, new String[0]);<a name="line.279"></a> +<span class="sourceLineNo">280</span> title = ps.getProperty(HTMLDOC_title, String.class, null);<a name="line.280"></a> +<span class="sourceLineNo">281</span> text = ps.getProperty(HTMLDOC_text, String.class, null);<a name="line.281"></a> +<span class="sourceLineNo">282</span> cssUrl = ps.getProperty(HTMLDOC_cssUrl, String.class, null);<a name="line.282"></a> +<span class="sourceLineNo">283</span> nowrap = ps.getProperty(HTMLDOC_nowrap, boolean.class, false);<a name="line.283"></a> +<span class="sourceLineNo">284</span> links = ps.getMap(HTMLDOC_links, String.class, String.class, Collections.<String,String>emptyMap());<a name="line.284"></a> +<span class="sourceLineNo">285</span> }<a name="line.285"></a> +<span class="sourceLineNo">286</span><a name="line.286"></a> +<span class="sourceLineNo">287</span> @Override /* Context */<a name="line.287"></a> +<span class="sourceLineNo">288</span> public ObjectMap asMap() {<a name="line.288"></a> +<span class="sourceLineNo">289</span> return super.asMap()<a name="line.289"></a> +<span class="sourceLineNo">290</span> .append("HtmlDocSerializerContext", new ObjectMap()<a name="line.290"></a> +<span class="sourceLineNo">291</span> .append("cssImports", cssImports)<a name="line.291"></a> +<span class="sourceLineNo">292</span> .append("title", title)<a name="line.292"></a> +<span class="sourceLineNo">293</span> .append("text", text)<a name="line.293"></a> +<span class="sourceLineNo">294</span> .append("cssUrl", cssUrl)<a name="line.294"></a> +<span class="sourceLineNo">295</span> .append("nowrap", nowrap)<a name="line.295"></a> +<span class="sourceLineNo">296</span> .append("links", links)<a name="line.296"></a> +<span class="sourceLineNo">297</span> );<a name="line.297"></a> +<span class="sourceLineNo">298</span> }<a name="line.298"></a> +<span class="sourceLineNo">299</span>}<a name="line.299"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/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 54bd1fa..8470367 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 @@ -39,7 +39,7 @@ <span class="sourceLineNo">031</span> */<a name="line.31"></a> <span class="sourceLineNo">032</span>public final class HtmlDocSerializerSession extends HtmlSerializerSession {<a name="line.32"></a> <span class="sourceLineNo">033</span><a name="line.33"></a> -<span class="sourceLineNo">034</span> private final String title, description, cssUrl;<a name="line.34"></a> +<span class="sourceLineNo">034</span> private final String title, text, cssUrl;<a name="line.34"></a> <span class="sourceLineNo">035</span> private final String[] cssImports;<a name="line.35"></a> <span class="sourceLineNo">036</span> private final Map<String,String> links;<a name="line.36"></a> <span class="sourceLineNo">037</span> private final boolean nowrap;<a name="line.37"></a> @@ -64,14 +64,14 @@ <span class="sourceLineNo">056</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.56"></a> <span class="sourceLineNo">057</span> if (op == null || op.isEmpty()) {<a name="line.57"></a> <span class="sourceLineNo">058</span> title = ctx.title;<a name="line.58"></a> -<span class="sourceLineNo">059</span> description = ctx.description;<a name="line.59"></a> +<span class="sourceLineNo">059</span> text = ctx.text;<a name="line.59"></a> <span class="sourceLineNo">060</span> links = ctx.links;<a name="line.60"></a> <span class="sourceLineNo">061</span> cssUrl = ctx.cssUrl;<a name="line.61"></a> <span class="sourceLineNo">062</span> cssImports = ctx.cssImports;<a name="line.62"></a> <span class="sourceLineNo">063</span> nowrap = ctx.nowrap;<a name="line.63"></a> <span class="sourceLineNo">064</span> } else {<a name="line.64"></a> <span class="sourceLineNo">065</span> title = op.getString(HTMLDOC_title, ctx.title);<a name="line.65"></a> -<span class="sourceLineNo">066</span> description = op.getString(HTMLDOC_description, ctx.description);<a name="line.66"></a> +<span class="sourceLineNo">066</span> text = op.getString(HTMLDOC_text, ctx.text);<a name="line.66"></a> <span class="sourceLineNo">067</span> links = new LinkedHashMap(op.getMap(HTMLDOC_links, ctx.links));<a name="line.67"></a> <span class="sourceLineNo">068</span> cssUrl = op.getString(HTMLDOC_cssUrl, ctx.cssUrl);<a name="line.68"></a> <span class="sourceLineNo">069</span> cssImports = StringUtils.split(op.getString(HTMLDOC_cssImports, null), ',');<a name="line.69"></a> @@ -89,12 +89,12 @@ <span class="sourceLineNo">081</span> }<a name="line.81"></a> <span class="sourceLineNo">082</span><a name="line.82"></a> <span class="sourceLineNo">083</span> /**<a name="line.83"></a> -<span class="sourceLineNo">084</span> * Returns the {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.<a name="line.84"></a> +<span class="sourceLineNo">084</span> * Returns the {@link HtmlDocSerializerContext#HTMLDOC_text} setting value in this context.<a name="line.84"></a> <span class="sourceLineNo">085</span> *<a name="line.85"></a> -<span class="sourceLineNo">086</span> * @return The {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.<a name="line.86"></a> +<span class="sourceLineNo">086</span> * @return The {@link HtmlDocSerializerContext#HTMLDOC_text} setting value in this context.<a name="line.86"></a> <span class="sourceLineNo">087</span> */<a name="line.87"></a> -<span class="sourceLineNo">088</span> public final String getDescription() {<a name="line.88"></a> -<span class="sourceLineNo">089</span> return description;<a name="line.89"></a> +<span class="sourceLineNo">088</span> public final String getText() {<a name="line.88"></a> +<span class="sourceLineNo">089</span> return text;<a name="line.89"></a> <span class="sourceLineNo">090</span> }<a name="line.90"></a> <span class="sourceLineNo">091</span><a name="line.91"></a> <span class="sourceLineNo">092</span> /**<a name="line.92"></a>
