http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplate.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplate.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplate.html index 841c9c5..9b24947 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplate.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplate.html @@ -29,171 +29,191 @@ <span class="sourceLineNo">021</span> * <p class='bcode'><a name="line.21"></a> <span class="sourceLineNo">022</span> * <xt>&lt;html&gt;<a name="line.22"></a> <span class="sourceLineNo">023</span> * &lt;head&gt;<a name="line.23"></a> -<span class="sourceLineNo">024</span> * &lt;style <xa>type</xa>=<xs>'text/css'</xs>&gt;<a name="line.24"></a> +<span class="sourceLineNo">024</span> * &lt;style&gt;<a name="line.24"></a> <span class="sourceLineNo">025</span> * <xv>CSS styles and links to stylesheets</xv><a name="line.25"></a> <span class="sourceLineNo">026</span> * &lt;/style&gt;<a name="line.26"></a> -<span class="sourceLineNo">027</span> * &lt;/head&gt;<a name="line.27"></a> -<span class="sourceLineNo">028</span> * &lt;body&gt;<a name="line.28"></a> -<span class="sourceLineNo">029</span> * &lt;header&gt;<a name="line.29"></a> -<span class="sourceLineNo">030</span> * &lt;h3 <xa>class</xa>=<xs>'title'</xs>&gt;<xv>Page title</xv>&lt;/h3&gt;<a name="line.30"></a> -<span class="sourceLineNo">031</span> * &lt;h5 <xa>class</xa>=<xs>'description'</xs>&gt;<xv>Page description</xv>&lt;/h5&gt;<a name="line.31"></a> -<span class="sourceLineNo">032</span> * <xv>Arbitrary page branding</xv><a name="line.32"></a> -<span class="sourceLineNo">033</span> * &lt;/header&gt;<a name="line.33"></a> -<span class="sourceLineNo">034</span> * &lt;nav&gt;<a name="line.34"></a> -<span class="sourceLineNo">035</span> * <xv>Page links</xv><a name="line.35"></a> -<span class="sourceLineNo">036</span> * &lt;/nav&gt;<a name="line.36"></a> -<span class="sourceLineNo">037</span> * &lt;aside&gt;<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <xv>Side-bar page links</xv><a name="line.38"></a> -<span class="sourceLineNo">039</span> * &lt;/aside&gt;<a name="line.39"></a> -<span class="sourceLineNo">040</span> * &lt;article&gt;<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <xv>Contents of serialized object</xv><a name="line.41"></a> -<span class="sourceLineNo">042</span> * &lt;/article&gt;<a name="line.42"></a> -<span class="sourceLineNo">043</span> * &lt;footer&gt;<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <xv>Footer message</xv><a name="line.44"></a> -<span class="sourceLineNo">045</span> * &lt;/footer&gt;<a name="line.45"></a> -<span class="sourceLineNo">046</span> * &lt;/body&gt;<a name="line.46"></a> -<span class="sourceLineNo">047</span> * &lt;/html&gt;</xt><a name="line.47"></a> -<span class="sourceLineNo">048</span> * </p><a name="line.48"></a> -<span class="sourceLineNo">049</span> *<a name="line.49"></a> -<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> -<span class="sourceLineNo">051</span> * This interface allows you to control how these sections get rendered.<a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span>public interface HtmlDocTemplate {<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> * Renders the contents of the <code><xt>&lt;head&gt;</xt></code> element.<a name="line.56"></a> -<span class="sourceLineNo">057</span> *<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param session The current serializer session.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param w The writer being written to.<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @param s The serializer calling this method.<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @param o The object being serialized.<a name="line.61"></a> -<span class="sourceLineNo">062</span> * @throws Exception Any exception can be thrown.<a name="line.62"></a> -<span class="sourceLineNo">063</span> */<a name="line.63"></a> -<span class="sourceLineNo">064</span> public void head(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * Renders the contents of the <code><xt>&lt;head&gt;</xt>/<xt>&lt;style</xt><a name="line.67"></a> -<span class="sourceLineNo">068</span> * <xa>type</xa>=<xs>"text/css"</xs><xt>&gt;</xt></code> element.<a name="line.68"></a> -<span class="sourceLineNo">069</span> *<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @param session The current serializer session.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * @param w The writer being written to.<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @param s The serializer calling this method.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * @param o The object being serialized.<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @throws Exception Any exception can be thrown.<a name="line.74"></a> -<span class="sourceLineNo">075</span> */<a name="line.75"></a> -<span class="sourceLineNo">076</span> public void css(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.76"></a> -<span class="sourceLineNo">077</span><a name="line.77"></a> -<span class="sourceLineNo">078</span> /**<a name="line.78"></a> -<span class="sourceLineNo">079</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt></code> element.<a name="line.79"></a> -<span class="sourceLineNo">080</span> *<a name="line.80"></a> -<span class="sourceLineNo">081</span> * @param session The current serializer session.<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param w The writer being written to.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param s The serializer calling this method.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @param o The object being serialized.<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @throws Exception Any exception can be thrown.<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> public void body(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;header&gt;</xt></code> element.<a name="line.90"></a> -<span class="sourceLineNo">091</span> *<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @param session The current serializer session.<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param w The writer being written to.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param s The serializer calling this method.<a name="line.94"></a> -<span class="sourceLineNo">095</span> * @param o The object being serialized.<a name="line.95"></a> -<span class="sourceLineNo">096</span> * @throws Exception Any exception can be thrown.<a name="line.96"></a> -<span class="sourceLineNo">097</span> */<a name="line.97"></a> -<span class="sourceLineNo">098</span> public void header(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.98"></a> -<span class="sourceLineNo">099</span><a name="line.99"></a> -<span class="sourceLineNo">100</span> /**<a name="line.100"></a> -<span class="sourceLineNo">101</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;nav&gt;</xt></code> element.<a name="line.101"></a> -<span class="sourceLineNo">102</span> *<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @param session The current serializer session.<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @param w The writer being written to.<a name="line.104"></a> -<span class="sourceLineNo">105</span> * @param s The serializer calling this method.<a name="line.105"></a> -<span class="sourceLineNo">106</span> * @param o The object being serialized.<a name="line.106"></a> -<span class="sourceLineNo">107</span> * @throws Exception Any exception can be thrown.<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> public void nav(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.109"></a> -<span class="sourceLineNo">110</span><a name="line.110"></a> -<span class="sourceLineNo">111</span> /**<a name="line.111"></a> -<span class="sourceLineNo">112</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;article&gt;</xt></code> element.<a name="line.112"></a> -<span class="sourceLineNo">113</span> *<a name="line.113"></a> -<span class="sourceLineNo">114</span> * @param session The current serializer session.<a name="line.114"></a> -<span class="sourceLineNo">115</span> * @param w The writer being written to.<a name="line.115"></a> -<span class="sourceLineNo">116</span> * @param s The serializer calling this method.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param o The object being serialized.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @throws Exception Any exception can be thrown.<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> public void article(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> /**<a name="line.122"></a> -<span class="sourceLineNo">123</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;aside&gt;</xt></code> element.<a name="line.123"></a> -<span class="sourceLineNo">124</span> *<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @param session The current serializer session.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param w The writer being written to.<a name="line.126"></a> -<span class="sourceLineNo">127</span> * @param s The serializer calling this method.<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @param o The object being serialized.<a name="line.128"></a> -<span class="sourceLineNo">129</span> * @throws Exception Any exception can be thrown.<a name="line.129"></a> -<span class="sourceLineNo">130</span> */<a name="line.130"></a> -<span class="sourceLineNo">131</span> public void aside(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> /**<a name="line.133"></a> -<span class="sourceLineNo">134</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;footer&gt;</xt></code> element.<a name="line.134"></a> -<span class="sourceLineNo">135</span> *<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @param session The current serializer session.<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @param w The writer being written to.<a name="line.137"></a> -<span class="sourceLineNo">138</span> * @param s The serializer calling this method.<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param o The object being serialized.<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @throws Exception Any exception can be thrown.<a name="line.140"></a> -<span class="sourceLineNo">141</span> */<a name="line.141"></a> -<span class="sourceLineNo">142</span> public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> /**<a name="line.144"></a> -<span class="sourceLineNo">145</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;head&gt;</xt>/<xt>&lt;style</xt><a name="line.145"></a> -<span class="sourceLineNo">146</span> * <xa>type</xa>=<xs>"text/css"</xs><xt>&gt;</xt></code> element.<a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * @param session The current serializer session.<a name="line.148"></a> -<span class="sourceLineNo">149</span> * @return A boolean flag.<a name="line.149"></a> -<span class="sourceLineNo">150</span> */<a name="line.150"></a> -<span class="sourceLineNo">151</span> public boolean hasCss(HtmlDocSerializerSession session);<a name="line.151"></a> -<span class="sourceLineNo">152</span><a name="line.152"></a> -<span class="sourceLineNo">153</span> /**<a name="line.153"></a> -<span class="sourceLineNo">154</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;header&gt;</xt></code><a name="line.154"></a> -<span class="sourceLineNo">155</span> * element.<a name="line.155"></a> -<span class="sourceLineNo">156</span> *<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param session The current serializer session.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @return A boolean flag.<a name="line.158"></a> -<span class="sourceLineNo">159</span> */<a name="line.159"></a> -<span class="sourceLineNo">160</span> public boolean hasHeader(HtmlDocSerializerSession session);<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> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;nav&gt;</xt></code><a name="line.163"></a> -<span class="sourceLineNo">164</span> * element.<a name="line.164"></a> -<span class="sourceLineNo">165</span> *<a name="line.165"></a> -<span class="sourceLineNo">166</span> * @param session The current serializer session.<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @return A boolean flag.<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> public boolean hasNav(HtmlDocSerializerSession session);<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> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;aside&gt;</xt></code><a name="line.172"></a> -<span class="sourceLineNo">173</span> * element.<a name="line.173"></a> -<span class="sourceLineNo">174</span> *<a name="line.174"></a> -<span class="sourceLineNo">175</span> * @param session The current serializer session.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * @return A boolean flag.<a name="line.176"></a> -<span class="sourceLineNo">177</span> */<a name="line.177"></a> -<span class="sourceLineNo">178</span> public boolean hasAside(HtmlDocSerializerSession session);<a name="line.178"></a> -<span class="sourceLineNo">179</span><a name="line.179"></a> -<span class="sourceLineNo">180</span> /**<a name="line.180"></a> -<span class="sourceLineNo">181</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;footer&gt;</xt></code><a name="line.181"></a> -<span class="sourceLineNo">182</span> * element.<a name="line.182"></a> -<span class="sourceLineNo">183</span> *<a name="line.183"></a> -<span class="sourceLineNo">184</span> * @param session The current serializer session.<a name="line.184"></a> -<span class="sourceLineNo">185</span> * @return A boolean flag.<a name="line.185"></a> -<span class="sourceLineNo">186</span> */<a name="line.186"></a> -<span class="sourceLineNo">187</span> public boolean hasFooter(HtmlDocSerializerSession session);<a name="line.187"></a> -<span class="sourceLineNo">188</span>}<a name="line.188"></a> +<span class="sourceLineNo">027</span> * &lt;script&gt;<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <xv>Javascript</xv><a name="line.28"></a> +<span class="sourceLineNo">029</span> * &lt;/script&gt;<a name="line.29"></a> +<span class="sourceLineNo">030</span> * &lt;/head&gt;<a name="line.30"></a> +<span class="sourceLineNo">031</span> * &lt;body&gt;<a name="line.31"></a> +<span class="sourceLineNo">032</span> * &lt;header&gt;<a name="line.32"></a> +<span class="sourceLineNo">033</span> * &lt;h3 <xa>class</xa>=<xs>'title'</xs>&gt;<xv>Page title</xv>&lt;/h3&gt;<a name="line.33"></a> +<span class="sourceLineNo">034</span> * &lt;h5 <xa>class</xa>=<xs>'description'</xs>&gt;<xv>Page description</xv>&lt;/h5&gt;<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <xv>Arbitrary page branding</xv><a name="line.35"></a> +<span class="sourceLineNo">036</span> * &lt;/header&gt;<a name="line.36"></a> +<span class="sourceLineNo">037</span> * &lt;nav&gt;<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <xv>Page links</xv><a name="line.38"></a> +<span class="sourceLineNo">039</span> * &lt;/nav&gt;<a name="line.39"></a> +<span class="sourceLineNo">040</span> * &lt;aside&gt;<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <xv>Side-bar page links</xv><a name="line.41"></a> +<span class="sourceLineNo">042</span> * &lt;/aside&gt;<a name="line.42"></a> +<span class="sourceLineNo">043</span> * &lt;article&gt;<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <xv>Contents of serialized object</xv><a name="line.44"></a> +<span class="sourceLineNo">045</span> * &lt;/article&gt;<a name="line.45"></a> +<span class="sourceLineNo">046</span> * &lt;footer&gt;<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <xv>Footer message</xv><a name="line.47"></a> +<span class="sourceLineNo">048</span> * &lt;/footer&gt;<a name="line.48"></a> +<span class="sourceLineNo">049</span> * &lt;/body&gt;<a name="line.49"></a> +<span class="sourceLineNo">050</span> * &lt;/html&gt;</xt><a name="line.50"></a> +<span class="sourceLineNo">051</span> * </p><a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * This interface allows you to control how these sections get rendered.<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span>public interface HtmlDocTemplate {<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * Renders the contents of the <code><xt>&lt;head&gt;</xt></code> element.<a name="line.59"></a> +<span class="sourceLineNo">060</span> *<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param session The current serializer session.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param w The writer being written to.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @param s The serializer calling this method.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param o The object being serialized.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @throws Exception Any exception can be thrown.<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public void head(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.67"></a> +<span class="sourceLineNo">068</span><a name="line.68"></a> +<span class="sourceLineNo">069</span> /**<a name="line.69"></a> +<span class="sourceLineNo">070</span> * Renders the contents of the <code><xt>&lt;head&gt;</xt>/<xt>&lt;style&gt;</xt></code> element.<a name="line.70"></a> +<span class="sourceLineNo">071</span> *<a name="line.71"></a> +<span class="sourceLineNo">072</span> * @param session The current serializer session.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param w The writer being written to.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @param s The serializer calling this method.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param o The object being serialized.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @throws Exception Any exception can be thrown.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> public void style(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Renders the contents of the <code><xt>&lt;head&gt;</xt>/<xt>&lt;script&gt;</xt></code> element.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param session The current serializer session.<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @param w The writer being written to.<a name="line.84"></a> +<span class="sourceLineNo">085</span> * @param s The serializer calling this method.<a name="line.85"></a> +<span class="sourceLineNo">086</span> * @param o The object being serialized.<a name="line.86"></a> +<span class="sourceLineNo">087</span> * @throws Exception Any exception can be thrown.<a name="line.87"></a> +<span class="sourceLineNo">088</span> */<a name="line.88"></a> +<span class="sourceLineNo">089</span> public void script(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<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> * Renders the contents of the <code><xt>&lt;body&gt;</xt></code> element.<a name="line.92"></a> +<span class="sourceLineNo">093</span> *<a name="line.93"></a> +<span class="sourceLineNo">094</span> * @param session The current serializer session.<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @param w The writer being written to.<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @param s The serializer calling this method.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @param o The object being serialized.<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @throws Exception Any exception can be thrown.<a name="line.98"></a> +<span class="sourceLineNo">099</span> */<a name="line.99"></a> +<span class="sourceLineNo">100</span> public void body(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.100"></a> +<span class="sourceLineNo">101</span><a name="line.101"></a> +<span class="sourceLineNo">102</span> /**<a name="line.102"></a> +<span class="sourceLineNo">103</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;header&gt;</xt></code> element.<a name="line.103"></a> +<span class="sourceLineNo">104</span> *<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @param session The current serializer session.<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @param w The writer being written to.<a name="line.106"></a> +<span class="sourceLineNo">107</span> * @param s The serializer calling this method.<a name="line.107"></a> +<span class="sourceLineNo">108</span> * @param o The object being serialized.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @throws Exception Any exception can be thrown.<a name="line.109"></a> +<span class="sourceLineNo">110</span> */<a name="line.110"></a> +<span class="sourceLineNo">111</span> public void header(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<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> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;nav&gt;</xt></code> element.<a name="line.114"></a> +<span class="sourceLineNo">115</span> *<a name="line.115"></a> +<span class="sourceLineNo">116</span> * @param session The current serializer session.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * @param w The writer being written to.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @param s The serializer calling this method.<a name="line.118"></a> +<span class="sourceLineNo">119</span> * @param o The object being serialized.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @throws Exception Any exception can be thrown.<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> public void nav(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<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> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;article&gt;</xt></code> element.<a name="line.125"></a> +<span class="sourceLineNo">126</span> *<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @param session The current serializer session.<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @param w The writer being written to.<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @param s The serializer calling this method.<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @param o The object being serialized.<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @throws Exception Any exception can be thrown.<a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span> public void article(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;aside&gt;</xt></code> element.<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @param session The current serializer session.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param w The writer being written to.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * @param s The serializer calling this method.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * @param o The object being serialized.<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @throws Exception Any exception can be thrown.<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> public void aside(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> /**<a name="line.146"></a> +<span class="sourceLineNo">147</span> * Renders the contents of the <code><xt>&lt;body&gt;</xt>/<xt>&lt;footer&gt;</xt></code> element.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @param session The current serializer session.<a name="line.149"></a> +<span class="sourceLineNo">150</span> * @param w The writer being written to.<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param s The serializer calling this method.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param o The object being serialized.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @throws Exception Any exception can be thrown.<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception;<a name="line.155"></a> +<span class="sourceLineNo">156</span><a name="line.156"></a> +<span class="sourceLineNo">157</span> /**<a name="line.157"></a> +<span class="sourceLineNo">158</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;head&gt;</xt>/<xt>&lt;style&gt;</xt></code> element.<a name="line.158"></a> +<span class="sourceLineNo">159</span> *<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param session The current serializer session.<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @return A boolean flag.<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> public boolean hasStyle(HtmlDocSerializerSession session);<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;head&gt;</xt>/<xt>&lt;script&gt;</xt></code> element.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param session The current serializer session.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @return A boolean flag.<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> public boolean hasScript(HtmlDocSerializerSession session);<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;header&gt;</xt></code><a name="line.174"></a> +<span class="sourceLineNo">175</span> * element.<a name="line.175"></a> +<span class="sourceLineNo">176</span> *<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @param session The current serializer session.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @return A boolean flag.<a name="line.178"></a> +<span class="sourceLineNo">179</span> */<a name="line.179"></a> +<span class="sourceLineNo">180</span> public boolean hasHeader(HtmlDocSerializerSession session);<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> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;nav&gt;</xt></code><a name="line.183"></a> +<span class="sourceLineNo">184</span> * element.<a name="line.184"></a> +<span class="sourceLineNo">185</span> *<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param session The current serializer session.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @return A boolean flag.<a name="line.187"></a> +<span class="sourceLineNo">188</span> */<a name="line.188"></a> +<span class="sourceLineNo">189</span> public boolean hasNav(HtmlDocSerializerSession session);<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> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;aside&gt;</xt></code><a name="line.192"></a> +<span class="sourceLineNo">193</span> * element.<a name="line.193"></a> +<span class="sourceLineNo">194</span> *<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @param session The current serializer session.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @return A boolean flag.<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> public boolean hasAside(HtmlDocSerializerSession session);<a name="line.198"></a> +<span class="sourceLineNo">199</span><a name="line.199"></a> +<span class="sourceLineNo">200</span> /**<a name="line.200"></a> +<span class="sourceLineNo">201</span> * Returns <jk>true</jk> if this page should render a <code><xt>&lt;body&gt;</xt>/<xt>&lt;footer&gt;</xt></code><a name="line.201"></a> +<span class="sourceLineNo">202</span> * element.<a name="line.202"></a> +<span class="sourceLineNo">203</span> *<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @param session The current serializer session.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @return A boolean flag.<a name="line.205"></a> +<span class="sourceLineNo">206</span> */<a name="line.206"></a> +<span class="sourceLineNo">207</span> public boolean hasFooter(HtmlDocSerializerSession session);<a name="line.207"></a> +<span class="sourceLineNo">208</span>}<a name="line.208"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 7253791..2d4a524 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 @@ -34,175 +34,193 @@ <span class="sourceLineNo">026</span><a name="line.26"></a> <span class="sourceLineNo">027</span> @Override /* HtmlDocTemplate */<a name="line.27"></a> <span class="sourceLineNo">028</span> public void head(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.28"></a> -<span class="sourceLineNo">029</span> if (hasCss(session)) {<a name="line.29"></a> -<span class="sourceLineNo">030</span> w.oTag(1, "style").attr("type", "text/css").appendln(">").nl(1);<a name="line.30"></a> -<span class="sourceLineNo">031</span> css(session, w, s, o);<a name="line.31"></a> +<span class="sourceLineNo">029</span> if (hasStyle(session)) {<a name="line.29"></a> +<span class="sourceLineNo">030</span> w.sTag(1, "style").nl(1);<a name="line.30"></a> +<span class="sourceLineNo">031</span> style(session, w, s, o);<a name="line.31"></a> <span class="sourceLineNo">032</span> w.ie(1).eTag("style").nl(1);<a name="line.32"></a> <span class="sourceLineNo">033</span> }<a name="line.33"></a> -<span class="sourceLineNo">034</span> }<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> @Override /* HtmlDocTemplate */<a name="line.36"></a> -<span class="sourceLineNo">037</span> public void css(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span> String cssUrl = session.getCssUrl();<a name="line.39"></a> -<span class="sourceLineNo">040</span> if (cssUrl == null)<a name="line.40"></a> -<span class="sourceLineNo">041</span> cssUrl = "servlet:/style.css";<a name="line.41"></a> -<span class="sourceLineNo">042</span> cssUrl = session.resolveUri(cssUrl);<a name="line.42"></a> +<span class="sourceLineNo">034</span> if (hasScript(session)) {<a name="line.34"></a> +<span class="sourceLineNo">035</span> w.sTag(1, "script").nl(1);<a name="line.35"></a> +<span class="sourceLineNo">036</span> script(session, w, s, o);<a name="line.36"></a> +<span class="sourceLineNo">037</span> w.ie(1).eTag("script").nl(1);<a name="line.37"></a> +<span class="sourceLineNo">038</span> }<a name="line.38"></a> +<span class="sourceLineNo">039</span> }<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> @Override /* HtmlDocTemplate */<a name="line.41"></a> +<span class="sourceLineNo">042</span> public void style(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.42"></a> <span class="sourceLineNo">043</span><a name="line.43"></a> -<span class="sourceLineNo">044</span> w.append(2, "@import ").q().append(cssUrl).q().appendln(";");<a name="line.44"></a> -<span class="sourceLineNo">045</span> if (session.isNoWrap())<a name="line.45"></a> -<span class="sourceLineNo">046</span> w.appendln("\ndiv.data * {white-space:nowrap;}");<a name="line.46"></a> -<span class="sourceLineNo">047</span> if (session.getCss() != null)<a name="line.47"></a> -<span class="sourceLineNo">048</span> for (String css : session.getCss())<a name="line.48"></a> -<span class="sourceLineNo">049</span> w.appendln(css);<a name="line.49"></a> -<span class="sourceLineNo">050</span> }<a name="line.50"></a> +<span class="sourceLineNo">044</span> String[] styleImport = session.getStyleImport();<a name="line.44"></a> +<span class="sourceLineNo">045</span> if (! ArrayUtils.contains("NONE", styleImport)) <a name="line.45"></a> +<span class="sourceLineNo">046</span> for (String si : styleImport)<a name="line.46"></a> +<span class="sourceLineNo">047</span> w.append(2, "@import ").q().append(session.resolveUri(si)).q().appendln(";");<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span> if (session.isNoWrap())<a name="line.49"></a> +<span class="sourceLineNo">050</span> w.appendln("\ndiv.data * {white-space:nowrap;}");<a name="line.50"></a> <span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> @Override /* HtmlDocTemplate */<a name="line.52"></a> -<span class="sourceLineNo">053</span> public void body(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> if (hasHeader(session)) {<a name="line.55"></a> -<span class="sourceLineNo">056</span> w.sTag(1, "header").nl(1);<a name="line.56"></a> -<span class="sourceLineNo">057</span> header(session, w, s, o);<a name="line.57"></a> -<span class="sourceLineNo">058</span> w.ie(1).eTag("header").nl(1);<a name="line.58"></a> -<span class="sourceLineNo">059</span> }<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> if (hasNav(session)) {<a name="line.61"></a> -<span class="sourceLineNo">062</span> w.sTag(1, "nav").nl(1);<a name="line.62"></a> -<span class="sourceLineNo">063</span> nav(session, w, s, o);<a name="line.63"></a> -<span class="sourceLineNo">064</span> w.ie(1).eTag("nav").nl(1);<a name="line.64"></a> -<span class="sourceLineNo">065</span> }<a name="line.65"></a> -<span class="sourceLineNo">066</span><a name="line.66"></a> -<span class="sourceLineNo">067</span> w.sTag(1, "section").nl(1);<a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> w.sTag(2, "article").nl(2);<a name="line.69"></a> -<span class="sourceLineNo">070</span> article(session, w, s, o);<a name="line.70"></a> -<span class="sourceLineNo">071</span> w.ie(2).eTag("article").nl(2);<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> if (hasAside(session)) {<a name="line.73"></a> -<span class="sourceLineNo">074</span> w.sTag(2, "aside").nl(2);<a name="line.74"></a> -<span class="sourceLineNo">075</span> aside(session, w, s, o);<a name="line.75"></a> -<span class="sourceLineNo">076</span> w.ie(2).eTag("aside").nl(2);<a name="line.76"></a> -<span class="sourceLineNo">077</span> }<a name="line.77"></a> -<span class="sourceLineNo">078</span><a name="line.78"></a> -<span class="sourceLineNo">079</span> w.ie(1).eTag("section").nl(1);<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> if (hasFooter(session)) {<a name="line.81"></a> -<span class="sourceLineNo">082</span> w.sTag(1, "footer").nl(1);<a name="line.82"></a> -<span class="sourceLineNo">083</span> footer(session, w, s, o);<a name="line.83"></a> -<span class="sourceLineNo">084</span> w.ie(1).eTag("footer").nl(1);<a name="line.84"></a> -<span class="sourceLineNo">085</span> }<a name="line.85"></a> -<span class="sourceLineNo">086</span> }<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> @Override /* HtmlDocTemplate */<a name="line.88"></a> -<span class="sourceLineNo">089</span> public void header(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.89"></a> -<span class="sourceLineNo">090</span> // Write the title of the page.<a name="line.90"></a> -<span class="sourceLineNo">091</span> String header = session.getHeader();<a name="line.91"></a> -<span class="sourceLineNo">092</span> if (header != null) {<a name="line.92"></a> -<span class="sourceLineNo">093</span> if (exists(header))<a name="line.93"></a> -<span class="sourceLineNo">094</span> w.append(2, header).nl(2);<a name="line.94"></a> -<span class="sourceLineNo">095</span> } else {<a name="line.95"></a> -<span class="sourceLineNo">096</span> String title = session.getTitle();<a name="line.96"></a> -<span class="sourceLineNo">097</span> String description = session.getDescription();<a name="line.97"></a> -<span class="sourceLineNo">098</span> String branding = session.getBranding();<a name="line.98"></a> -<span class="sourceLineNo">099</span> if (exists(title))<a name="line.99"></a> -<span class="sourceLineNo">100</span> w.oTag(3, "h3").attr("class", "title").append('>').append(title).eTag("h3").nl(3);<a name="line.100"></a> -<span class="sourceLineNo">101</span> if (exists(description))<a name="line.101"></a> -<span class="sourceLineNo">102</span> w.oTag(3, "h5").attr("class", "description").append('>').append(description).eTag("h5").nl(3);<a name="line.102"></a> -<span class="sourceLineNo">103</span> if (exists(branding))<a name="line.103"></a> -<span class="sourceLineNo">104</span> w.append(3, branding).nl(3);<a name="line.104"></a> -<span class="sourceLineNo">105</span> }<a name="line.105"></a> -<span class="sourceLineNo">106</span> }<a name="line.106"></a> -<span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span><a name="line.108"></a> -<span class="sourceLineNo">109</span> @Override /* HtmlDocTemplate */<a name="line.109"></a> -<span class="sourceLineNo">110</span> public void nav(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.110"></a> -<span class="sourceLineNo">111</span> String nav = session.getNav();<a name="line.111"></a> -<span class="sourceLineNo">112</span> if (nav != null) {<a name="line.112"></a> -<span class="sourceLineNo">113</span> if (exists(nav))<a name="line.113"></a> -<span class="sourceLineNo">114</span> w.append(2, nav).nl(2);<a name="line.114"></a> -<span class="sourceLineNo">115</span> } else {<a name="line.115"></a> -<span class="sourceLineNo">116</span> Map<String,Object> htmlLinks = session.getLinks();<a name="line.116"></a> -<span class="sourceLineNo">117</span> boolean first = true;<a name="line.117"></a> -<span class="sourceLineNo">118</span> if (htmlLinks != null) {<a name="line.118"></a> -<span class="sourceLineNo">119</span> for (Map.Entry<String,Object> e : htmlLinks.entrySet()) {<a name="line.119"></a> -<span class="sourceLineNo">120</span> String v = e.getValue().toString();<a name="line.120"></a> -<span class="sourceLineNo">121</span> if (! first)<a name="line.121"></a> -<span class="sourceLineNo">122</span> w.append(3, " - ").nl(3);<a name="line.122"></a> -<span class="sourceLineNo">123</span> first = false;<a name="line.123"></a> -<span class="sourceLineNo">124</span> if (v.startsWith("<"))<a name="line.124"></a> -<span class="sourceLineNo">125</span> w.append(v);<a name="line.125"></a> -<span class="sourceLineNo">126</span> else<a name="line.126"></a> -<span class="sourceLineNo">127</span> w.oTag("a").attr("class", "link").attr("href", session.resolveUri(v), true).cTag()<a name="line.127"></a> -<span class="sourceLineNo">128</span> .text(e.getKey(), true).eTag("a");<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> }<a name="line.132"></a> -<span class="sourceLineNo">133</span><a name="line.133"></a> -<span class="sourceLineNo">134</span> @Override /* HtmlDocTemplate */<a name="line.134"></a> -<span class="sourceLineNo">135</span> public void aside(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.135"></a> -<span class="sourceLineNo">136</span> String aside = session.getAside();<a name="line.136"></a> -<span class="sourceLineNo">137</span> if (exists(aside))<a name="line.137"></a> -<span class="sourceLineNo">138</span> w.append(aside);<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span> @Override /* HtmlDocTemplate */<a name="line.141"></a> -<span class="sourceLineNo">142</span> public void article(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.142"></a> -<span class="sourceLineNo">143</span> // To allow for page formatting using CSS, we encapsulate the data inside two div tags:<a name="line.143"></a> -<span class="sourceLineNo">144</span> // <div class='outerdata'><div class='data' id='data'>...</div></div><a name="line.144"></a> -<span class="sourceLineNo">145</span> w.oTag(3, "div").attr("class","outerdata").append('>').nl(3);<a name="line.145"></a> -<span class="sourceLineNo">146</span> w.oTag(4, "div").attr("class","data").attr("id", "data").append('>').nl(4);<a name="line.146"></a> -<span class="sourceLineNo">147</span><a name="line.147"></a> -<span class="sourceLineNo">148</span> if (o == null) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> w.append(5, "<null/>").nl(5);<a name="line.149"></a> -<span class="sourceLineNo">150</span> } else if (ObjectUtils.isEmpty(o)){<a name="line.150"></a> -<span class="sourceLineNo">151</span> String m = session.getNoResultsMessage();<a name="line.151"></a> -<span class="sourceLineNo">152</span> if (exists(m))<a name="line.152"></a> -<span class="sourceLineNo">153</span> w.append(5, m).nl(5);<a name="line.153"></a> -<span class="sourceLineNo">154</span> } else {<a name="line.154"></a> -<span class="sourceLineNo">155</span> s.parentSerialize(session, o);<a name="line.155"></a> -<span class="sourceLineNo">156</span> }<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> w.ie(4).eTag("div").nl(4);<a name="line.158"></a> -<span class="sourceLineNo">159</span> w.ie(4).eTag("div").nl(3);<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> @Override /* HtmlDocTemplate */<a name="line.162"></a> -<span class="sourceLineNo">163</span> public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.163"></a> -<span class="sourceLineNo">164</span> String footer = session.getFooter();<a name="line.164"></a> -<span class="sourceLineNo">165</span> if (exists(footer))<a name="line.165"></a> -<span class="sourceLineNo">166</span> w.append(footer);<a name="line.166"></a> -<span class="sourceLineNo">167</span> }<a name="line.167"></a> -<span class="sourceLineNo">168</span><a name="line.168"></a> -<span class="sourceLineNo">169</span> @Override /* HtmlDocTemplate */<a name="line.169"></a> -<span class="sourceLineNo">170</span> public boolean hasCss(HtmlDocSerializerSession session) {<a name="line.170"></a> -<span class="sourceLineNo">171</span> return true;<a name="line.171"></a> -<span class="sourceLineNo">172</span> }<a name="line.172"></a> -<span class="sourceLineNo">173</span><a name="line.173"></a> -<span class="sourceLineNo">174</span> @Override /* HtmlDocTemplate */<a name="line.174"></a> -<span class="sourceLineNo">175</span> public boolean hasHeader(HtmlDocSerializerSession session) {<a name="line.175"></a> -<span class="sourceLineNo">176</span> return exists(session.getHeader()) || exists(session.getTitle()) || exists(session.getDescription());<a name="line.176"></a> -<span class="sourceLineNo">177</span> }<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> @Override /* HtmlDocTemplate */<a name="line.179"></a> -<span class="sourceLineNo">180</span> public boolean hasNav(HtmlDocSerializerSession session) {<a name="line.180"></a> -<span class="sourceLineNo">181</span> return exists(session.getNav()) || session.getLinks() != null;<a name="line.181"></a> -<span class="sourceLineNo">182</span> }<a name="line.182"></a> -<span class="sourceLineNo">183</span><a name="line.183"></a> -<span class="sourceLineNo">184</span> @Override /* HtmlDocTemplate */<a name="line.184"></a> -<span class="sourceLineNo">185</span> public boolean hasAside(HtmlDocSerializerSession session) {<a name="line.185"></a> -<span class="sourceLineNo">186</span> return exists(session.getAside());<a name="line.186"></a> -<span class="sourceLineNo">187</span> }<a name="line.187"></a> -<span class="sourceLineNo">188</span><a name="line.188"></a> -<span class="sourceLineNo">189</span> @Override /* HtmlDocTemplate */<a name="line.189"></a> -<span class="sourceLineNo">190</span> public boolean hasFooter(HtmlDocSerializerSession session) {<a name="line.190"></a> -<span class="sourceLineNo">191</span> return exists(session.getFooter());<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> private static boolean exists(String s) {<a name="line.194"></a> -<span class="sourceLineNo">195</span> return s != null && ! "NONE".equals(s);<a name="line.195"></a> -<span class="sourceLineNo">196</span> }<a name="line.196"></a> -<span class="sourceLineNo">197</span>}<a name="line.197"></a> +<span class="sourceLineNo">052</span> if (session.getStyle() != null)<a name="line.52"></a> +<span class="sourceLineNo">053</span> for (String style : session.getStyle())<a name="line.53"></a> +<span class="sourceLineNo">054</span> w.appendln(style);<a name="line.54"></a> +<span class="sourceLineNo">055</span> }<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> @Override /* HtmlDocTemplate */<a name="line.57"></a> +<span class="sourceLineNo">058</span> public void script(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> if (session.getScript() != null)<a name="line.60"></a> +<span class="sourceLineNo">061</span> for (String script : session.getScript())<a name="line.61"></a> +<span class="sourceLineNo">062</span> w.appendln(script);<a name="line.62"></a> +<span class="sourceLineNo">063</span> }<a name="line.63"></a> +<span class="sourceLineNo">064</span><a name="line.64"></a> +<span class="sourceLineNo">065</span> @Override /* HtmlDocTemplate */<a name="line.65"></a> +<span class="sourceLineNo">066</span> public void body(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.66"></a> +<span class="sourceLineNo">067</span><a name="line.67"></a> +<span class="sourceLineNo">068</span> if (hasHeader(session)) {<a name="line.68"></a> +<span class="sourceLineNo">069</span> w.sTag(1, "header").nl(1);<a name="line.69"></a> +<span class="sourceLineNo">070</span> header(session, w, s, o);<a name="line.70"></a> +<span class="sourceLineNo">071</span> w.ie(1).eTag("header").nl(1);<a name="line.71"></a> +<span class="sourceLineNo">072</span> }<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> if (hasNav(session)) {<a name="line.74"></a> +<span class="sourceLineNo">075</span> w.sTag(1, "nav").nl(1);<a name="line.75"></a> +<span class="sourceLineNo">076</span> nav(session, w, s, o);<a name="line.76"></a> +<span class="sourceLineNo">077</span> w.ie(1).eTag("nav").nl(1);<a name="line.77"></a> +<span class="sourceLineNo">078</span> }<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> w.sTag(1, "section").nl(1);<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> w.sTag(2, "article").nl(2);<a name="line.82"></a> +<span class="sourceLineNo">083</span> article(session, w, s, o);<a name="line.83"></a> +<span class="sourceLineNo">084</span> w.ie(2).eTag("article").nl(2);<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> if (hasAside(session)) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> w.sTag(2, "aside").nl(2);<a name="line.87"></a> +<span class="sourceLineNo">088</span> aside(session, w, s, o);<a name="line.88"></a> +<span class="sourceLineNo">089</span> w.ie(2).eTag("aside").nl(2);<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> w.ie(1).eTag("section").nl(1);<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> if (hasFooter(session)) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> w.sTag(1, "footer").nl(1);<a name="line.95"></a> +<span class="sourceLineNo">096</span> footer(session, w, s, o);<a name="line.96"></a> +<span class="sourceLineNo">097</span> w.ie(1).eTag("footer").nl(1);<a name="line.97"></a> +<span class="sourceLineNo">098</span> }<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> @Override /* HtmlDocTemplate */<a name="line.101"></a> +<span class="sourceLineNo">102</span> public void header(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.102"></a> +<span class="sourceLineNo">103</span> // Write the title of the page.<a name="line.103"></a> +<span class="sourceLineNo">104</span> String header = session.getHeader();<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (header != null) {<a name="line.105"></a> +<span class="sourceLineNo">106</span> if (exists(header))<a name="line.106"></a> +<span class="sourceLineNo">107</span> w.append(2, header).nl(2);<a name="line.107"></a> +<span class="sourceLineNo">108</span> } else {<a name="line.108"></a> +<span class="sourceLineNo">109</span> String title = session.getTitle();<a name="line.109"></a> +<span class="sourceLineNo">110</span> String description = session.getDescription();<a name="line.110"></a> +<span class="sourceLineNo">111</span> String branding = session.getBranding();<a name="line.111"></a> +<span class="sourceLineNo">112</span> if (exists(title))<a name="line.112"></a> +<span class="sourceLineNo">113</span> w.oTag(3, "h3").attr("class", "title").append('>').append(title).eTag("h3").nl(3);<a name="line.113"></a> +<span class="sourceLineNo">114</span> if (exists(description))<a name="line.114"></a> +<span class="sourceLineNo">115</span> w.oTag(3, "h5").attr("class", "description").append('>').append(description).eTag("h5").nl(3);<a name="line.115"></a> +<span class="sourceLineNo">116</span> if (exists(branding))<a name="line.116"></a> +<span class="sourceLineNo">117</span> w.append(3, branding).nl(3);<a name="line.117"></a> +<span class="sourceLineNo">118</span> }<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> @Override /* HtmlDocTemplate */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public void nav(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.123"></a> +<span class="sourceLineNo">124</span> String nav = session.getNav();<a name="line.124"></a> +<span class="sourceLineNo">125</span> if (nav != null) {<a name="line.125"></a> +<span class="sourceLineNo">126</span> if (exists(nav))<a name="line.126"></a> +<span class="sourceLineNo">127</span> w.append(2, nav).nl(2);<a name="line.127"></a> +<span class="sourceLineNo">128</span> } else {<a name="line.128"></a> +<span class="sourceLineNo">129</span> Map<String,Object> htmlLinks = session.getLinks();<a name="line.129"></a> +<span class="sourceLineNo">130</span> boolean first = true;<a name="line.130"></a> +<span class="sourceLineNo">131</span> if (htmlLinks != null) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> for (Map.Entry<String,Object> e : htmlLinks.entrySet()) {<a name="line.132"></a> +<span class="sourceLineNo">133</span> String v = e.getValue().toString();<a name="line.133"></a> +<span class="sourceLineNo">134</span> if (! first)<a name="line.134"></a> +<span class="sourceLineNo">135</span> w.append(3, " - ").nl(3);<a name="line.135"></a> +<span class="sourceLineNo">136</span> first = false;<a name="line.136"></a> +<span class="sourceLineNo">137</span> if (v.startsWith("<"))<a name="line.137"></a> +<span class="sourceLineNo">138</span> w.append(v);<a name="line.138"></a> +<span class="sourceLineNo">139</span> else<a name="line.139"></a> +<span class="sourceLineNo">140</span> w.oTag("a").attr("class", "link").attr("href", session.resolveUri(v), true).cTag()<a name="line.140"></a> +<span class="sourceLineNo">141</span> .text(e.getKey(), true).eTag("a");<a name="line.141"></a> +<span class="sourceLineNo">142</span> }<a name="line.142"></a> +<span class="sourceLineNo">143</span> }<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span> }<a name="line.145"></a> +<span class="sourceLineNo">146</span><a name="line.146"></a> +<span class="sourceLineNo">147</span> @Override /* HtmlDocTemplate */<a name="line.147"></a> +<span class="sourceLineNo">148</span> public void aside(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.148"></a> +<span class="sourceLineNo">149</span> String aside = session.getAside();<a name="line.149"></a> +<span class="sourceLineNo">150</span> if (exists(aside))<a name="line.150"></a> +<span class="sourceLineNo">151</span> w.append(aside);<a name="line.151"></a> +<span class="sourceLineNo">152</span> }<a name="line.152"></a> +<span class="sourceLineNo">153</span><a name="line.153"></a> +<span class="sourceLineNo">154</span> @Override /* HtmlDocTemplate */<a name="line.154"></a> +<span class="sourceLineNo">155</span> public void article(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.155"></a> +<span class="sourceLineNo">156</span> // To allow for page formatting using CSS, we encapsulate the data inside two div tags:<a name="line.156"></a> +<span class="sourceLineNo">157</span> // <div class='outerdata'><div class='data' id='data'>...</div></div><a name="line.157"></a> +<span class="sourceLineNo">158</span> w.oTag(3, "div").attr("class","outerdata").append('>').nl(3);<a name="line.158"></a> +<span class="sourceLineNo">159</span> w.oTag(4, "div").attr("class","data").attr("id", "data").append('>').nl(4);<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> if (o == null) {<a name="line.161"></a> +<span class="sourceLineNo">162</span> w.append(5, "<null/>").nl(5);<a name="line.162"></a> +<span class="sourceLineNo">163</span> } else if (ObjectUtils.isEmpty(o)){<a name="line.163"></a> +<span class="sourceLineNo">164</span> String m = session.getNoResultsMessage();<a name="line.164"></a> +<span class="sourceLineNo">165</span> if (exists(m))<a name="line.165"></a> +<span class="sourceLineNo">166</span> w.append(5, m).nl(5);<a name="line.166"></a> +<span class="sourceLineNo">167</span> } else {<a name="line.167"></a> +<span class="sourceLineNo">168</span> s.parentSerialize(session, o);<a name="line.168"></a> +<span class="sourceLineNo">169</span> }<a name="line.169"></a> +<span class="sourceLineNo">170</span><a name="line.170"></a> +<span class="sourceLineNo">171</span> w.ie(4).eTag("div").nl(4);<a name="line.171"></a> +<span class="sourceLineNo">172</span> w.ie(4).eTag("div").nl(3);<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span><a name="line.174"></a> +<span class="sourceLineNo">175</span> @Override /* HtmlDocTemplate */<a name="line.175"></a> +<span class="sourceLineNo">176</span> public void footer(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.176"></a> +<span class="sourceLineNo">177</span> String footer = session.getFooter();<a name="line.177"></a> +<span class="sourceLineNo">178</span> if (exists(footer))<a name="line.178"></a> +<span class="sourceLineNo">179</span> w.append(footer);<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 hasStyle(HtmlDocSerializerSession session) {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return true;<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 hasScript(HtmlDocSerializerSession session) {<a name="line.188"></a> +<span class="sourceLineNo">189</span> return true;<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> @Override /* HtmlDocTemplate */<a name="line.192"></a> +<span class="sourceLineNo">193</span> public boolean hasHeader(HtmlDocSerializerSession session) {<a name="line.193"></a> +<span class="sourceLineNo">194</span> return exists(session.getHeader()) || exists(session.getTitle()) || exists(session.getDescription());<a name="line.194"></a> +<span class="sourceLineNo">195</span> }<a name="line.195"></a> +<span class="sourceLineNo">196</span><a name="line.196"></a> +<span class="sourceLineNo">197</span> @Override /* HtmlDocTemplate */<a name="line.197"></a> +<span class="sourceLineNo">198</span> public boolean hasNav(HtmlDocSerializerSession session) {<a name="line.198"></a> +<span class="sourceLineNo">199</span> return exists(session.getNav()) || session.getLinks() != null;<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span><a name="line.201"></a> +<span class="sourceLineNo">202</span> @Override /* HtmlDocTemplate */<a name="line.202"></a> +<span class="sourceLineNo">203</span> public boolean hasAside(HtmlDocSerializerSession session) {<a name="line.203"></a> +<span class="sourceLineNo">204</span> return exists(session.getAside());<a name="line.204"></a> +<span class="sourceLineNo">205</span> }<a name="line.205"></a> +<span class="sourceLineNo">206</span><a name="line.206"></a> +<span class="sourceLineNo">207</span> @Override /* HtmlDocTemplate */<a name="line.207"></a> +<span class="sourceLineNo">208</span> public boolean hasFooter(HtmlDocSerializerSession session) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> return exists(session.getFooter());<a name="line.209"></a> +<span class="sourceLineNo">210</span> }<a name="line.210"></a> +<span class="sourceLineNo">211</span><a name="line.211"></a> +<span class="sourceLineNo">212</span> private static boolean exists(String s) {<a name="line.212"></a> +<span class="sourceLineNo">213</span> return s != null && ! "NONE".equals(s);<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/internal/ArrayUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/internal/ArrayUtils.html b/content/site/apidocs/src-html/org/apache/juneau/internal/ArrayUtils.html index 75eeba7..0bf3cd2 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/internal/ArrayUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/internal/ArrayUtils.html @@ -406,7 +406,25 @@ <span class="sourceLineNo">398</span> }<a name="line.398"></a> <span class="sourceLineNo">399</span> return null;<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">401</span><a name="line.401"></a> +<span class="sourceLineNo">402</span> /**<a name="line.402"></a> +<span class="sourceLineNo">403</span> * Converts the specified collection to an array of strings.<a name="line.403"></a> +<span class="sourceLineNo">404</span> *<a name="line.404"></a> +<span class="sourceLineNo">405</span> * <p><a name="line.405"></a> +<span class="sourceLineNo">406</span> * Entries are converted to strings using {@link #toString()}.<a name="line.406"></a> +<span class="sourceLineNo">407</span> * <jk>null</jk> values remain <jk>null</jk>.<a name="line.407"></a> +<span class="sourceLineNo">408</span> *<a name="line.408"></a> +<span class="sourceLineNo">409</span> * @param c The collection to convert.<a name="line.409"></a> +<span class="sourceLineNo">410</span> * @return The collection as a string array.<a name="line.410"></a> +<span class="sourceLineNo">411</span> */<a name="line.411"></a> +<span class="sourceLineNo">412</span> public static String[] toStringArray(Collection<?> c) {<a name="line.412"></a> +<span class="sourceLineNo">413</span> String[] r = new String[c.size()];<a name="line.413"></a> +<span class="sourceLineNo">414</span> int i = 0;<a name="line.414"></a> +<span class="sourceLineNo">415</span> for (Object o : c)<a name="line.415"></a> +<span class="sourceLineNo">416</span> r[i++] = StringUtils.toString(o);<a name="line.416"></a> +<span class="sourceLineNo">417</span> return r;<a name="line.417"></a> +<span class="sourceLineNo">418</span> }<a name="line.418"></a> +<span class="sourceLineNo">419</span>}<a name="line.419"></a>
