http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApacheWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApacheWidget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApacheWidget.html deleted file mode 100644 index 043a3ab..0000000 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByApacheWidget.html +++ /dev/null @@ -1,137 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> -<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> -<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> -<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> -<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> -<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> -<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> -<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> -<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> -<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> -<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> -<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> -<span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<a name="line.13"></a> -<span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import org.apache.juneau.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import org.apache.juneau.rest.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>/**<a name="line.18"></a> -<span class="sourceLineNo">019</span> * Widget that places a powered-by-Apache message on the page.<a name="line.19"></a> -<span class="sourceLineNo">020</span> *<a name="line.20"></a> -<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> -<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{poweredByApache}"</js>.<a name="line.22"></a> -<span class="sourceLineNo">023</span> *<a name="line.23"></a> -<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> -<span class="sourceLineNo">025</span> * It produces a simple Apache icon floating on the right.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * Typically it's used in the footer of the page, as shown below in the <code>RootResources</code> from the examples:<a name="line.26"></a> -<span class="sourceLineNo">027</span> *<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> -<span class="sourceLineNo">029</span> * <ja>@RestResource</ja>(<a name="line.29"></a> -<span class="sourceLineNo">030</span> * path=<js>"/"</js>,<a name="line.30"></a> -<span class="sourceLineNo">031</span> * title=<js>"Root resources"</js>,<a name="line.31"></a> -<span class="sourceLineNo">032</span> * description=<js>"Example of a router resource page."</js>,<a name="line.32"></a> -<span class="sourceLineNo">033</span> * widgets={<a name="line.33"></a> -<span class="sourceLineNo">034</span> * PoweredByApacheWidget.<jk>class</jk><a name="line.34"></a> -<span class="sourceLineNo">035</span> * },<a name="line.35"></a> -<span class="sourceLineNo">036</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.36"></a> -<span class="sourceLineNo">037</span> * footer=<js>"$W{poweredByApache}"</js><a name="line.37"></a> -<span class="sourceLineNo">038</span> * )<a name="line.38"></a> -<span class="sourceLineNo">039</span> * </p><a name="line.39"></a> -<span class="sourceLineNo">040</span> *<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * It renders the following image:<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <img class='bordered' src='doc-files/PoweredByApacheWidget.png'><a name="line.43"></a> -<span class="sourceLineNo">044</span> */<a name="line.44"></a> -<span class="sourceLineNo">045</span>public class PoweredByApacheWidget extends Widget {<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span> /**<a name="line.47"></a> -<span class="sourceLineNo">048</span> * Returns <js>"poweredByApache"</js>.<a name="line.48"></a> -<span class="sourceLineNo">049</span> */<a name="line.49"></a> -<span class="sourceLineNo">050</span> @Override /* Widget */<a name="line.50"></a> -<span class="sourceLineNo">051</span> public String getName() {<a name="line.51"></a> -<span class="sourceLineNo">052</span> return "poweredByApache";<a name="line.52"></a> -<span class="sourceLineNo">053</span> }<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> * Returns an Apache image tag hyperlinked to <js>"http://apache.org"</js><a name="line.56"></a> -<span class="sourceLineNo">057</span> */<a name="line.57"></a> -<span class="sourceLineNo">058</span> @Override /* Widget */<a name="line.58"></a> -<span class="sourceLineNo">059</span> public String getHtml(RestRequest req) throws Exception {<a name="line.59"></a> -<span class="sourceLineNo">060</span> UriResolver r = req.getUriResolver();<a name="line.60"></a> -<span class="sourceLineNo">061</span> return "<a href='http://apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+r.resolve("servlet:/htdocs/asf.png")+"'>";<a name="line.61"></a> -<span class="sourceLineNo">062</span> }<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><a name="line.65"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneau.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneau.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneau.html new file mode 100644 index 0000000..469d240 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneau.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import org.apache.juneau.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import org.apache.juneau.rest.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>/**<a name="line.18"></a> +<span class="sourceLineNo">019</span> * Widget that places a powered-by-Juneau message on the page.<a name="line.19"></a> +<span class="sourceLineNo">020</span> *<a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> +<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{PoweredByJuneau}"</js>.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * It produces a simple Apache Juneau icon floating on the right.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * Typically it's used in the footer of the page, as shown below in the <code>AddressBookResource</code> from the examples:<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@RestResource</ja>(<a name="line.29"></a> +<span class="sourceLineNo">030</span> * path=<js>"/addressBook"</js>,<a name="line.30"></a> +<span class="sourceLineNo">031</span> * widgets={<a name="line.31"></a> +<span class="sourceLineNo">032</span> * PoweredByJuneau.<jk>class</jk><a name="line.32"></a> +<span class="sourceLineNo">033</span> * },<a name="line.33"></a> +<span class="sourceLineNo">034</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.34"></a> +<span class="sourceLineNo">035</span> * footer=<js>"$W{PoweredByJuneau}"</js><a name="line.35"></a> +<span class="sourceLineNo">036</span> * )<a name="line.36"></a> +<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> +<span class="sourceLineNo">038</span> *<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * It renders the following image:<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <img class='bordered' src='doc-files/PoweredByJuneauWidget.png'><a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span>public class PoweredByJuneau extends Widget {<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span><a name="line.45"></a> +<span class="sourceLineNo">046</span> /**<a name="line.46"></a> +<span class="sourceLineNo">047</span> * Returns an Apache Juneau image tag hyperlinked to <js>"http://juneau.apache.org"</js><a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span> @Override /* Widget */<a name="line.49"></a> +<span class="sourceLineNo">050</span> public String getHtml(RestRequest req) throws Exception {<a name="line.50"></a> +<span class="sourceLineNo">051</span> UriResolver r = req.getUriResolver();<a name="line.51"></a> +<span class="sourceLineNo">052</span> return "<a href='http://juneau.apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+r.resolve("servlet:/htdocs/juneau.png")+"'>";<a name="line.52"></a> +<span class="sourceLineNo">053</span> }<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><a name="line.56"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneauWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneauWidget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneauWidget.html deleted file mode 100644 index 3a78c3a..0000000 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/PoweredByJuneauWidget.html +++ /dev/null @@ -1,135 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> -<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> -<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> -<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> -<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> -<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> -<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> -<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> -<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> -<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> -<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> -<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> -<span class="sourceLineNo">013</span>package org.apache.juneau.rest.widget;<a name="line.13"></a> -<span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import org.apache.juneau.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import org.apache.juneau.rest.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>/**<a name="line.18"></a> -<span class="sourceLineNo">019</span> * Widget that places a powered-by-Juneau message on the page.<a name="line.19"></a> -<span class="sourceLineNo">020</span> *<a name="line.20"></a> -<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> -<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{poweredByJuneau}"</js>.<a name="line.22"></a> -<span class="sourceLineNo">023</span> *<a name="line.23"></a> -<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> -<span class="sourceLineNo">025</span> * It produces a simple Apache Juneau icon floating on the right.<a name="line.25"></a> -<span class="sourceLineNo">026</span> * Typically it's used in the footer of the page, as shown below in the <code>AddressBookResource</code> from the examples:<a name="line.26"></a> -<span class="sourceLineNo">027</span> *<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> -<span class="sourceLineNo">029</span> * <ja>@RestResource</ja>(<a name="line.29"></a> -<span class="sourceLineNo">030</span> * path=<js>"/addressBook"</js>,<a name="line.30"></a> -<span class="sourceLineNo">031</span> * widgets={<a name="line.31"></a> -<span class="sourceLineNo">032</span> * PoweredByJuneauWidget.<jk>class</jk><a name="line.32"></a> -<span class="sourceLineNo">033</span> * },<a name="line.33"></a> -<span class="sourceLineNo">034</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.34"></a> -<span class="sourceLineNo">035</span> * footer=<js>"$W{poweredByJuneau}"</js><a name="line.35"></a> -<span class="sourceLineNo">036</span> * )<a name="line.36"></a> -<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> -<span class="sourceLineNo">038</span> *<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> -<span class="sourceLineNo">040</span> * It renders the following image:<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <img class='bordered' src='doc-files/PoweredByJuneauWidget.png'><a name="line.41"></a> -<span class="sourceLineNo">042</span> */<a name="line.42"></a> -<span class="sourceLineNo">043</span>public class PoweredByJuneauWidget extends Widget {<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Returns <js>"poweredByJuneau"</js>.<a name="line.46"></a> -<span class="sourceLineNo">047</span> */<a name="line.47"></a> -<span class="sourceLineNo">048</span> @Override /* Widget */<a name="line.48"></a> -<span class="sourceLineNo">049</span> public String getName() {<a name="line.49"></a> -<span class="sourceLineNo">050</span> return "poweredByJuneau";<a name="line.50"></a> -<span class="sourceLineNo">051</span> }<a name="line.51"></a> -<span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> /**<a name="line.53"></a> -<span class="sourceLineNo">054</span> * Returns an Apache Juneau image tag hyperlinked to <js>"http://juneau.apache.org"</js><a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> @Override /* Widget */<a name="line.56"></a> -<span class="sourceLineNo">057</span> public String getHtml(RestRequest req) throws Exception {<a name="line.57"></a> -<span class="sourceLineNo">058</span> UriResolver r = req.getUriResolver();<a name="line.58"></a> -<span class="sourceLineNo">059</span> return "<a href='http://juneau.apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+r.resolve("servlet:/htdocs/juneau.png")+"'>";<a name="line.59"></a> -<span class="sourceLineNo">060</span> }<a name="line.60"></a> -<span class="sourceLineNo">061</span>}<a name="line.61"></a> -<span class="sourceLineNo">062</span><a name="line.62"></a> -<span class="sourceLineNo">063</span><a name="line.63"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryMenuItem.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryMenuItem.html index 7f75e8f..d99c729 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryMenuItem.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryMenuItem.html @@ -27,7 +27,7 @@ <span class="sourceLineNo">019</span> * Widget that returns a menu-item drop-down form for entering search/view/sort arguments.<a name="line.19"></a> <span class="sourceLineNo">020</span> *<a name="line.20"></a> <span class="sourceLineNo">021</span> * <p><a name="line.21"></a> -<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{queryMenuItem}"</js>.<a name="line.22"></a> +<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{QueryMenuItem}"</js>.<a name="line.22"></a> <span class="sourceLineNo">023</span> *<a name="line.23"></a> <span class="sourceLineNo">024</span> * <p><a name="line.24"></a> <span class="sourceLineNo">025</span> * This widget is designed to be used in conjunction with the {@link Queryable} converter, although implementations<a name="line.25"></a> @@ -48,9 +48,9 @@ <span class="sourceLineNo">040</span> * links={<a name="line.40"></a> <span class="sourceLineNo">041</span> * <js>"up: ..."</js>,<a name="line.41"></a> <span class="sourceLineNo">042</span> * <js>"options: ..."</js>,<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <js>"$W{queryMenuItem}"</js>,<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <js>"$W{contentTypeMenuItem}"</js>,<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <js>"$W{styleMenuItem}"</js>,<a name="line.45"></a> +<span class="sourceLineNo">043</span> * <js>"$W{QueryMenuItem}"</js>,<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <js>"$W{ContentTypeMenuItem}"</js>,<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <js>"$W{StyleMenuItem}"</js>,<a name="line.45"></a> <span class="sourceLineNo">046</span> * <js>"source: ..."</js><a name="line.46"></a> <span class="sourceLineNo">047</span> * }<a name="line.47"></a> <span class="sourceLineNo">048</span> * ),<a name="line.48"></a> @@ -75,31 +75,23 @@ <span class="sourceLineNo">067</span>public class QueryMenuItem extends MenuItemWidget {<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> * Returns <js>"queryMenuItem"</js>.<a name="line.70"></a> +<span class="sourceLineNo">070</span> * Returns CSS for the tooltips.<a name="line.70"></a> <span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> @Override /* Widget */<a name="line.72"></a> -<span class="sourceLineNo">073</span> public String getName() {<a name="line.73"></a> -<span class="sourceLineNo">074</span> return "queryMenuItem";<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> /**<a name="line.77"></a> -<span class="sourceLineNo">078</span> * Returns CSS for the tooltips.<a name="line.78"></a> -<span class="sourceLineNo">079</span> */<a name="line.79"></a> -<span class="sourceLineNo">080</span> @Override<a name="line.80"></a> -<span class="sourceLineNo">081</span> public String getStyle(RestRequest req) throws Exception {<a name="line.81"></a> -<span class="sourceLineNo">082</span> return super.getStyle(req)<a name="line.82"></a> -<span class="sourceLineNo">083</span> + "\n"<a name="line.83"></a> -<span class="sourceLineNo">084</span> + loadStyle("QueryMenuItem.css");<a name="line.84"></a> +<span class="sourceLineNo">072</span> @Override<a name="line.72"></a> +<span class="sourceLineNo">073</span> public String getStyle(RestRequest req) throws Exception {<a name="line.73"></a> +<span class="sourceLineNo">074</span> return super.getStyle(req)<a name="line.74"></a> +<span class="sourceLineNo">075</span> + "\n"<a name="line.75"></a> +<span class="sourceLineNo">076</span> + loadStyle("QueryMenuItem.css");<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> /**<a name="line.79"></a> +<span class="sourceLineNo">080</span> * Returns the HTML for rendering the query form and tooltips.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> @Override /* Widget */<a name="line.82"></a> +<span class="sourceLineNo">083</span> public String getHtml(RestRequest req) throws Exception {<a name="line.83"></a> +<span class="sourceLineNo">084</span> return loadHtml("QueryMenuItem.html");<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> * Returns the HTML for rendering the query form and tooltips.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> @Override /* Widget */<a name="line.90"></a> -<span class="sourceLineNo">091</span> public String getHtml(RestRequest req) throws Exception {<a name="line.91"></a> -<span class="sourceLineNo">092</span> return loadHtml("QueryMenuItem.html");<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span>}<a name="line.94"></a> +<span class="sourceLineNo">086</span>}<a name="line.86"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html index d3f8fa5..ae2af8a 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html @@ -27,7 +27,7 @@ <span class="sourceLineNo">019</span> * Widget that returns back a list of hyperlinks for rendering the contents of a page in the various default styles.<a name="line.19"></a> <span class="sourceLineNo">020</span> *<a name="line.20"></a> <span class="sourceLineNo">021</span> * <p><a name="line.21"></a> -<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{styleMenuItem}"</js>.<a name="line.22"></a> +<span class="sourceLineNo">022</span> * The variable it resolves is <js>"$W{StyleMenuItem}"</js>.<a name="line.22"></a> <span class="sourceLineNo">023</span> *<a name="line.23"></a> <span class="sourceLineNo">024</span> * <p><a name="line.24"></a> <span class="sourceLineNo">025</span> * An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides<a name="line.25"></a> @@ -43,9 +43,9 @@ <span class="sourceLineNo">035</span> * links={<a name="line.35"></a> <span class="sourceLineNo">036</span> * <js>"up: ..."</js>,<a name="line.36"></a> <span class="sourceLineNo">037</span> * <js>"options: ..."</js>,<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <js>"$W{queryMenuItem}"</js>,<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <js>"$W{contentTypeMenuItem}"</js>,<a name="line.39"></a> -<span class="sourceLineNo">040</span> * <js>"$W{styleMenuItem}"</js>,<a name="line.40"></a> +<span class="sourceLineNo">038</span> * <js>"$W{QueryMenuItem}"</js>,<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <js>"$W{ContentTypeMenuItem}"</js>,<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <js>"$W{StyleMenuItem}"</js>,<a name="line.40"></a> <span class="sourceLineNo">041</span> * <js>"source: ..."</js><a name="line.41"></a> <span class="sourceLineNo">042</span> * }<a name="line.42"></a> <span class="sourceLineNo">043</span> * )<a name="line.43"></a> @@ -58,36 +58,28 @@ <span class="sourceLineNo">050</span> private static final String[] BUILT_IN_STYLES = {"devops", "light", "original"};<a name="line.50"></a> <span class="sourceLineNo">051</span><a name="line.51"></a> <span class="sourceLineNo">052</span> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * Returns <js>"styleMenuItem"</js>.<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> @Override /* Widget */<a name="line.55"></a> -<span class="sourceLineNo">056</span> public String getName() {<a name="line.56"></a> -<span class="sourceLineNo">057</span> return "styleMenuItem";<a name="line.57"></a> -<span class="sourceLineNo">058</span> }<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> * Looks at the supported media types from the request and constructs a list of hyperlinks to render the data<a name="line.61"></a> -<span class="sourceLineNo">062</span> * as plain-text.<a name="line.62"></a> -<span class="sourceLineNo">063</span> */<a name="line.63"></a> -<span class="sourceLineNo">064</span> @Override /* Widget */<a name="line.64"></a> -<span class="sourceLineNo">065</span> public String getHtml(RestRequest req) throws Exception {<a name="line.65"></a> -<span class="sourceLineNo">066</span> StringBuilder sb = new StringBuilder();<a name="line.66"></a> -<span class="sourceLineNo">067</span> sb.append(""<a name="line.67"></a> -<span class="sourceLineNo">068</span> + "<div class='menu-item'>"<a name="line.68"></a> -<span class="sourceLineNo">069</span> + "\n\t<a class='link' onclick='menuClick(this)'>styles</a>"<a name="line.69"></a> -<span class="sourceLineNo">070</span> + "\n\t<div class='popup-content'>"<a name="line.70"></a> +<span class="sourceLineNo">053</span> * Looks at the supported media types from the request and constructs a list of hyperlinks to render the data<a name="line.53"></a> +<span class="sourceLineNo">054</span> * as plain-text.<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> @Override /* Widget */<a name="line.56"></a> +<span class="sourceLineNo">057</span> public String getHtml(RestRequest req) throws Exception {<a name="line.57"></a> +<span class="sourceLineNo">058</span> StringBuilder sb = new StringBuilder();<a name="line.58"></a> +<span class="sourceLineNo">059</span> sb.append(""<a name="line.59"></a> +<span class="sourceLineNo">060</span> + "<div class='menu-item'>"<a name="line.60"></a> +<span class="sourceLineNo">061</span> + "\n\t<a class='link' onclick='menuClick(this)'>styles</a>"<a name="line.61"></a> +<span class="sourceLineNo">062</span> + "\n\t<div class='popup-content'>"<a name="line.62"></a> +<span class="sourceLineNo">063</span> );<a name="line.63"></a> +<span class="sourceLineNo">064</span> for (String s : BUILT_IN_STYLES) {<a name="line.64"></a> +<span class="sourceLineNo">065</span> java.net.URI uri = req.getUri(true, new AMap<String,String>().append("stylesheet", "styles/"+s+".css"));<a name="line.65"></a> +<span class="sourceLineNo">066</span> sb.append("\n\t\t<a class='link' href='").append(uri).append("'>").append(s).append("</a><br>");<a name="line.66"></a> +<span class="sourceLineNo">067</span> }<a name="line.67"></a> +<span class="sourceLineNo">068</span> sb.append(""<a name="line.68"></a> +<span class="sourceLineNo">069</span> + "\n\t</div>"<a name="line.69"></a> +<span class="sourceLineNo">070</span> + "\n</div>"<a name="line.70"></a> <span class="sourceLineNo">071</span> );<a name="line.71"></a> -<span class="sourceLineNo">072</span> for (String s : BUILT_IN_STYLES) {<a name="line.72"></a> -<span class="sourceLineNo">073</span> java.net.URI uri = req.getUri(true, new AMap<String,String>().append("stylesheet", "styles/"+s+".css"));<a name="line.73"></a> -<span class="sourceLineNo">074</span> sb.append("\n\t\t<a class='link' href='").append(uri).append("'>").append(s).append("</a><br>");<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span> sb.append(""<a name="line.76"></a> -<span class="sourceLineNo">077</span> + "\n\t</div>"<a name="line.77"></a> -<span class="sourceLineNo">078</span> + "\n</div>"<a name="line.78"></a> -<span class="sourceLineNo">079</span> );<a name="line.79"></a> -<span class="sourceLineNo">080</span> return sb.toString();<a name="line.80"></a> -<span class="sourceLineNo">081</span> }<a name="line.81"></a> -<span class="sourceLineNo">082</span>}<a name="line.82"></a> +<span class="sourceLineNo">072</span> return sb.toString();<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span>}<a name="line.74"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/widget/Widget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/Widget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/Widget.html index 0127ab4..acd4fbc 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/Widget.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/Widget.html @@ -33,253 +33,252 @@ <span class="sourceLineNo">025</span> * <p><a name="line.25"></a> <span class="sourceLineNo">026</span> * Widgets are associated with resources through the following<a name="line.26"></a> <span class="sourceLineNo">027</span> * <ul><a name="line.27"></a> -<span class="sourceLineNo">028</span> * <li>{@link RestResource#widgets() @RestResource.widgets}<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <li>{@link RestMethod#widgets() @RestMethod.widgets}<a name="line.29"></a> -<span class="sourceLineNo">030</span> * <li>{@link RestConfig#addWidget(Class)}<a name="line.30"></a> -<span class="sourceLineNo">031</span> * </ul><a name="line.31"></a> -<span class="sourceLineNo">032</span> *<a name="line.32"></a> -<span class="sourceLineNo">033</span> * <p><a name="line.33"></a> -<span class="sourceLineNo">034</span> * Widgets allow you to add arbitrary HTML, CSS, and Javascript to the page.<a name="line.34"></a> -<span class="sourceLineNo">035</span> *<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> -<span class="sourceLineNo">037</span> * The HTML content returned by the {@link #getHtml(RestRequest)} method is added where the <js>"$W{...}"</js> is<a name="line.37"></a> -<span class="sourceLineNo">038</span> * referenced in the page.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * The Javascript and stylesheet content is added to the header of the page.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * They allow you to control the look and behavior of your widgets.<a name="line.40"></a> -<span class="sourceLineNo">041</span> *<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> -<span class="sourceLineNo">043</span> * The following examples shows how to associate a widget with a REST method and then have it rendered in the links<a name="line.43"></a> -<span class="sourceLineNo">044</span> * and aside section of the page:<a name="line.44"></a> -<span class="sourceLineNo">045</span> *<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <p class='bcode'><a name="line.46"></a> -<span class="sourceLineNo">047</span> * <ja>@RestMethod</ja>(<a name="line.47"></a> -<span class="sourceLineNo">048</span> * widgets={<a name="line.48"></a> -<span class="sourceLineNo">049</span> * MyWidget.<jk>class</jk><a name="line.49"></a> -<span class="sourceLineNo">050</span> * }<a name="line.50"></a> -<span class="sourceLineNo">051</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.51"></a> -<span class="sourceLineNo">052</span> * links={<a name="line.52"></a> -<span class="sourceLineNo">053</span> * <js>"$W{myWidget}"</js><a name="line.53"></a> -<span class="sourceLineNo">054</span> * },<a name="line.54"></a> -<span class="sourceLineNo">055</span> * aside={<a name="line.55"></a> -<span class="sourceLineNo">056</span> * <js>"Check out this widget: $W{myWidget}"</js><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> * )<a name="line.59"></a> -<span class="sourceLineNo">060</span> * </p><a name="line.60"></a> -<span class="sourceLineNo">061</span> *<a name="line.61"></a> -<span class="sourceLineNo">062</span> * <p><a name="line.62"></a> -<span class="sourceLineNo">063</span> * The following shows an example of a widget that renders an image located in the <code>htdocs</code> static files<a name="line.63"></a> -<span class="sourceLineNo">064</span> * directory in your classpath (see {@link RestResource#staticFiles()}):<a name="line.64"></a> -<span class="sourceLineNo">065</span> * <p class='bcode'><a name="line.65"></a> -<span class="sourceLineNo">066</span> * <jk>public class</jk> MyWidget <jk>extends</jk> Widget {<a name="line.66"></a> -<span class="sourceLineNo">067</span> *<a name="line.67"></a> -<span class="sourceLineNo">068</span> * <ja>@Override</ja><a name="line.68"></a> -<span class="sourceLineNo">069</span> * <jk>public</jk> String getName(RestRequest req) {<a name="line.69"></a> -<span class="sourceLineNo">070</span> * return <js>"myWidget"</js>;<a name="line.70"></a> +<span class="sourceLineNo">028</span> * <li>{@link HtmlDoc#widgets() @HtmlDoc.widgets}<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <li>{@link RestConfig#addHtmlWidget(Class)}<a name="line.29"></a> +<span class="sourceLineNo">030</span> * </ul><a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> +<span class="sourceLineNo">033</span> * Widgets allow you to add arbitrary HTML, CSS, and Javascript to the page.<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * The HTML content returned by the {@link #getHtml(RestRequest)} method is added where the <js>"$W{...}"</js> is<a name="line.36"></a> +<span class="sourceLineNo">037</span> * referenced in the page.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * The Javascript and stylesheet content is added to the header of the page.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * They allow you to control the look and behavior of your widgets.<a name="line.39"></a> +<span class="sourceLineNo">040</span> *<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * The following examples shows how to associate a widget with a REST method and then have it rendered in the links<a name="line.42"></a> +<span class="sourceLineNo">043</span> * and aside section of the page:<a name="line.43"></a> +<span class="sourceLineNo">044</span> *<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <p class='bcode'><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <ja>@RestMethod</ja>(<a name="line.46"></a> +<span class="sourceLineNo">047</span> * widgets={<a name="line.47"></a> +<span class="sourceLineNo">048</span> * MyWidget.<jk>class</jk><a name="line.48"></a> +<span class="sourceLineNo">049</span> * }<a name="line.49"></a> +<span class="sourceLineNo">050</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.50"></a> +<span class="sourceLineNo">051</span> * links={<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <js>"$W{MyWidget}"</js><a name="line.52"></a> +<span class="sourceLineNo">053</span> * },<a name="line.53"></a> +<span class="sourceLineNo">054</span> * aside={<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <js>"Check out this widget: $W{MyWidget}"</js><a name="line.55"></a> +<span class="sourceLineNo">056</span> * }<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> * </p><a name="line.59"></a> +<span class="sourceLineNo">060</span> *<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> +<span class="sourceLineNo">062</span> * The following shows an example of a widget that renders an image located in the <code>htdocs</code> static files<a name="line.62"></a> +<span class="sourceLineNo">063</span> * directory in your classpath (see {@link RestResource#staticFiles()}):<a name="line.63"></a> +<span class="sourceLineNo">064</span> * <p class='bcode'><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <jk>public class</jk> MyWidget <jk>extends</jk> Widget {<a name="line.65"></a> +<span class="sourceLineNo">066</span> *<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <ja>@Override</ja><a name="line.67"></a> +<span class="sourceLineNo">068</span> * <jk>public</jk> String getHtml(RestRequest req) <jk>throws</jk> Exception {<a name="line.68"></a> +<span class="sourceLineNo">069</span> * UriResolver r = req.getUriResolver();<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <jk>return</jk> <js>"&lt;img class='myimage' onclick='myalert(this)' src='"</js>+r.resolve(<js>"servlet:/htdocs/myimage.png"</js>)+<js>"'&gt;"</js>;<a name="line.70"></a> <span class="sourceLineNo">071</span> * }<a name="line.71"></a> <span class="sourceLineNo">072</span> *<a name="line.72"></a> <span class="sourceLineNo">073</span> * <ja>@Override</ja><a name="line.73"></a> -<span class="sourceLineNo">074</span> * <jk>public</jk> String getHtml(RestRequest req) <jk>throws</jk> Exception {<a name="line.74"></a> -<span class="sourceLineNo">075</span> * UriResolver r = req.getUriResolver();<a name="line.75"></a> -<span class="sourceLineNo">076</span> * <jk>return</jk> <js>"&lt;img class='myimage' onclick='myalert(this)' src='"</js>+r.resolve(<js>"servlet:/htdocs/myimage.png"</js>)+<js>"'&gt;"</js>;<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> * <ja>@Override</ja><a name="line.79"></a> -<span class="sourceLineNo">080</span> * <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {<a name="line.80"></a> -<span class="sourceLineNo">081</span> * <jk>return</jk> <js>""</js><a name="line.81"></a> -<span class="sourceLineNo">082</span> * + <js>"\n function myalert(imageElement) {"</js><a name="line.82"></a> -<span class="sourceLineNo">083</span> * + <js>"\n alert('cool!');"</js><a name="line.83"></a> -<span class="sourceLineNo">084</span> * + <js>"\n }"</js>;<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> * <ja>@Override</ja><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {<a name="line.88"></a> -<span class="sourceLineNo">089</span> * <jk>return</jk> <js>""</js><a name="line.89"></a> -<span class="sourceLineNo">090</span> * + <js>"\n .myimage {"</js><a name="line.90"></a> -<span class="sourceLineNo">091</span> * + <js>"\n border: 10px solid red;"</js><a name="line.91"></a> -<span class="sourceLineNo">092</span> * + <js>"\n }"</js>;<a name="line.92"></a> -<span class="sourceLineNo">093</span> * }<a name="line.93"></a> -<span class="sourceLineNo">094</span> * }<a name="line.94"></a> -<span class="sourceLineNo">095</span> * </p><a name="line.95"></a> -<span class="sourceLineNo">096</span> *<a name="line.96"></a> -<span class="sourceLineNo">097</span> * <p><a name="line.97"></a> -<span class="sourceLineNo">098</span> * Note the {@link #getResourceAsString(String)} and {@link #getResourceAsString(String, Locale)} convenience methods<a name="line.98"></a> -<span class="sourceLineNo">099</span> * provided for quickly loading javascript and css files from the classpath or file system.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * These are useful if your script or styles are complex and you want them loaded from files.<a name="line.100"></a> +<span class="sourceLineNo">074</span> * <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {<a name="line.74"></a> +<span class="sourceLineNo">075</span> * <jk>return</jk> <js>""</js><a name="line.75"></a> +<span class="sourceLineNo">076</span> * + <js>"\n function myalert(imageElement) {"</js><a name="line.76"></a> +<span class="sourceLineNo">077</span> * + <js>"\n alert('cool!');"</js><a name="line.77"></a> +<span class="sourceLineNo">078</span> * + <js>"\n }"</js>;<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> * <ja>@Override</ja><a name="line.81"></a> +<span class="sourceLineNo">082</span> * <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {<a name="line.82"></a> +<span class="sourceLineNo">083</span> * <jk>return</jk> <js>""</js><a name="line.83"></a> +<span class="sourceLineNo">084</span> * + <js>"\n .myimage {"</js><a name="line.84"></a> +<span class="sourceLineNo">085</span> * + <js>"\n border: 10px solid red;"</js><a name="line.85"></a> +<span class="sourceLineNo">086</span> * + <js>"\n }"</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> * </p><a name="line.89"></a> +<span class="sourceLineNo">090</span> *<a name="line.90"></a> +<span class="sourceLineNo">091</span> * <p><a name="line.91"></a> +<span class="sourceLineNo">092</span> * Note the {@link #getResourceAsString(String)} and {@link #getResourceAsString(String, Locale)} convenience methods<a name="line.92"></a> +<span class="sourceLineNo">093</span> * provided for quickly loading javascript and css files from the classpath or file system.<a name="line.93"></a> +<span class="sourceLineNo">094</span> * These are useful if your script or styles are complex and you want them loaded from files.<a name="line.94"></a> +<span class="sourceLineNo">095</span> *<a name="line.95"></a> +<span class="sourceLineNo">096</span> * <p><a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p class='bcode'><a name="line.97"></a> +<span class="sourceLineNo">098</span> * <jk>public class</jk> MyWidget <jk>extends</jk> Widget {<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> *<a name="line.101"></a> -<span class="sourceLineNo">102</span> * <p><a name="line.102"></a> -<span class="sourceLineNo">103</span> * <p class='bcode'><a name="line.103"></a> -<span class="sourceLineNo">104</span> * <jk>public class</jk> MyWidget <jk>extends</jk> Widget {<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> * <ja>@Override</ja><a name="line.108"></a> -<span class="sourceLineNo">109</span> * <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {<a name="line.109"></a> -<span class="sourceLineNo">110</span> * <jk>return</jk> getResourceAsString(<js>"MyWidget.js"</js>);<a name="line.110"></a> -<span class="sourceLineNo">111</span> * }<a name="line.111"></a> -<span class="sourceLineNo">112</span> *<a name="line.112"></a> -<span class="sourceLineNo">113</span> * <ja>@Override</ja><a name="line.113"></a> -<span class="sourceLineNo">114</span> * <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {<a name="line.114"></a> -<span class="sourceLineNo">115</span> * <jk>return</jk> getResourceAsString(<js>"MyWidget.css"</js>);<a name="line.115"></a> -<span class="sourceLineNo">116</span> * }<a name="line.116"></a> -<span class="sourceLineNo">117</span> * }<a name="line.117"></a> -<span class="sourceLineNo">118</span> * </p><a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span>public abstract class Widget {<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> private final ResourceFinder resourceFinder = new ResourceFinder(getClass());<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> * The widget key.<a name="line.125"></a> +<span class="sourceLineNo">102</span> * <ja>@Override</ja><a name="line.102"></a> +<span class="sourceLineNo">103</span> * <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <jk>return</jk> getResourceAsString(<js>"MyWidget.js"</js>);<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> * <ja>@Override</ja><a name="line.107"></a> +<span class="sourceLineNo">108</span> * <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {<a name="line.108"></a> +<span class="sourceLineNo">109</span> * <jk>return</jk> getResourceAsString(<js>"MyWidget.css"</js>);<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> * </p><a name="line.112"></a> +<span class="sourceLineNo">113</span> */<a name="line.113"></a> +<span class="sourceLineNo">114</span>public abstract class Widget {<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> private final ResourceFinder resourceFinder = new ResourceFinder(getClass());<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * The widget key.<a name="line.119"></a> +<span class="sourceLineNo">120</span> *<a name="line.120"></a> +<span class="sourceLineNo">121</span> * <p><a name="line.121"></a> +<span class="sourceLineNo">122</span> * (i.e. The variable name inside the <js>"$W{...}"</js> variable).<a name="line.122"></a> +<span class="sourceLineNo">123</span> *<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <p><a name="line.124"></a> +<span class="sourceLineNo">125</span> * The returned value must not be <jk>null</jk>.<a name="line.125"></a> <span class="sourceLineNo">126</span> *<a name="line.126"></a> <span class="sourceLineNo">127</span> * <p><a name="line.127"></a> -<span class="sourceLineNo">128</span> * (i.e. The contents of the <js>"$W{...}"</js> variable).<a name="line.128"></a> +<span class="sourceLineNo">128</span> * If not overridden, the default value is the class simple name.<a name="line.128"></a> <span class="sourceLineNo">129</span> *<a name="line.129"></a> -<span class="sourceLineNo">130</span> * <p><a name="line.130"></a> -<span class="sourceLineNo">131</span> * The returned value must not be <jk>null</jk>.<a name="line.131"></a> -<span class="sourceLineNo">132</span> *<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @return The widget key.<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> public abstract String getName();<a name="line.135"></a> -<span class="sourceLineNo">136</span><a name="line.136"></a> -<span class="sourceLineNo">137</span> /**<a name="line.137"></a> -<span class="sourceLineNo">138</span> * Resolves the HTML content for this widget.<a name="line.138"></a> -<span class="sourceLineNo">139</span> *<a name="line.139"></a> -<span class="sourceLineNo">140</span> * <p><a name="line.140"></a> -<span class="sourceLineNo">141</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.141"></a> -<span class="sourceLineNo">142</span> *<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @param req The HTTP request object.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @return The HTML content of this widget.<a name="line.144"></a> -<span class="sourceLineNo">145</span> * @throws Exception<a name="line.145"></a> -<span class="sourceLineNo">146</span> */<a name="line.146"></a> -<span class="sourceLineNo">147</span> public String getHtml(RestRequest req) throws Exception {<a name="line.147"></a> -<span class="sourceLineNo">148</span> return null;<a name="line.148"></a> -<span class="sourceLineNo">149</span> }<a name="line.149"></a> -<span class="sourceLineNo">150</span><a name="line.150"></a> -<span class="sourceLineNo">151</span> /**<a name="line.151"></a> -<span class="sourceLineNo">152</span> * Resolves any Javascript that should be added to the <xt>&lt;head&gt;/&lt;script&gt;</xt> element.<a name="line.152"></a> -<span class="sourceLineNo">153</span> *<a name="line.153"></a> -<span class="sourceLineNo">154</span> * <p><a name="line.154"></a> -<span class="sourceLineNo">155</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.155"></a> -<span class="sourceLineNo">156</span> *<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param req The HTTP request object.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @return The Javascript needed by this widget.<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @throws Exception<a name="line.159"></a> -<span class="sourceLineNo">160</span> */<a name="line.160"></a> -<span class="sourceLineNo">161</span> public String getScript(RestRequest req) throws Exception {<a name="line.161"></a> -<span class="sourceLineNo">162</span> return null;<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> /**<a name="line.165"></a> -<span class="sourceLineNo">166</span> * Resolves any CSS styles that should be added to the <xt>&lt;head&gt;/&lt;style&gt;</xt> element.<a name="line.166"></a> -<span class="sourceLineNo">167</span> *<a name="line.167"></a> -<span class="sourceLineNo">168</span> * <p><a name="line.168"></a> -<span class="sourceLineNo">169</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.169"></a> -<span class="sourceLineNo">170</span> *<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @param req The HTTP request object.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @return The CSS styles needed by this widget.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * @throws Exception<a name="line.173"></a> -<span class="sourceLineNo">174</span> */<a name="line.174"></a> -<span class="sourceLineNo">175</span> public String getStyle(RestRequest req) throws Exception {<a name="line.175"></a> -<span class="sourceLineNo">176</span> return null;<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> /**<a name="line.179"></a> -<span class="sourceLineNo">180</span> * Retrieves the specified classpath resource and returns the contents as a string.<a name="line.180"></a> -<span class="sourceLineNo">181</span> *<a name="line.181"></a> -<span class="sourceLineNo">182</span> * <p><a name="line.182"></a> -<span class="sourceLineNo">183</span> * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches<a name="line.183"></a> -<span class="sourceLineNo">184</span> * up the parent hierarchy chain.<a name="line.184"></a> -<span class="sourceLineNo">185</span> *<a name="line.185"></a> -<span class="sourceLineNo">186</span> * <p><a name="line.186"></a> -<span class="sourceLineNo">187</span> * If the resource cannot be found in the classpath, then an attempt is made to look relative to the JVM working directory.<a name="line.187"></a> -<span class="sourceLineNo">188</span> * <br>Path traversals outside the working directory are not allowed for security reasons.<a name="line.188"></a> -<span class="sourceLineNo">189</span> *<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @param name Name of the desired resource.<a name="line.190"></a> -<span class="sourceLineNo">191</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @throws IOException<a name="line.192"></a> -<span class="sourceLineNo">193</span> */<a name="line.193"></a> -<span class="sourceLineNo">194</span> protected String getResourceAsString(String name) throws IOException {<a name="line.194"></a> -<span class="sourceLineNo">195</span> return resourceFinder.getResourceAsString(name);<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">198</span> /**<a name="line.198"></a> -<span class="sourceLineNo">199</span> * Same as {@link #getResourceAsString(String)} except also looks for localized-versions of the file.<a name="line.199"></a> -<span class="sourceLineNo">200</span> *<a name="line.200"></a> -<span class="sourceLineNo">201</span> * <p><a name="line.201"></a> -<span class="sourceLineNo">202</span> * If the <code>locale</code> is specified, then we look for resources whose name matches that locale.<a name="line.202"></a> -<span class="sourceLineNo">203</span> * <br>For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.203"></a> -<span class="sourceLineNo">204</span> * files in the following order:<a name="line.204"></a> -<span class="sourceLineNo">205</span> * <ol><a name="line.205"></a> -<span class="sourceLineNo">206</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.206"></a> -<span class="sourceLineNo">207</span> * <li><js>"MyResource_ja.txt"</js><a name="line.207"></a> -<span class="sourceLineNo">208</span> * <li><js>"MyResource.txt"</js><a name="line.208"></a> -<span class="sourceLineNo">209</span> * </ol><a name="line.209"></a> +<span class="sourceLineNo">130</span> * @return The widget key.<a name="line.130"></a> +<span class="sourceLineNo">131</span> */<a name="line.131"></a> +<span class="sourceLineNo">132</span> public String getName() {<a name="line.132"></a> +<span class="sourceLineNo">133</span> return getClass().getSimpleName();<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> /**<a name="line.136"></a> +<span class="sourceLineNo">137</span> * Resolves the HTML content for this widget.<a name="line.137"></a> +<span class="sourceLineNo">138</span> *<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <p><a name="line.139"></a> +<span class="sourceLineNo">140</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.140"></a> +<span class="sourceLineNo">141</span> *<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @param req The HTTP request object.<a name="line.142"></a> +<span class="sourceLineNo">143</span> * @return The HTML content of this widget.<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @throws Exception<a name="line.144"></a> +<span class="sourceLineNo">145</span> */<a name="line.145"></a> +<span class="sourceLineNo">146</span> public String getHtml(RestRequest req) throws Exception {<a name="line.146"></a> +<span class="sourceLineNo">147</span> return null;<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> /**<a name="line.150"></a> +<span class="sourceLineNo">151</span> * Resolves any Javascript that should be added to the <xt>&lt;head&gt;/&lt;script&gt;</xt> element.<a name="line.151"></a> +<span class="sourceLineNo">152</span> *<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> +<span class="sourceLineNo">154</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.154"></a> +<span class="sourceLineNo">155</span> *<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @param req The HTTP request object.<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @return The Javascript needed by this widget.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @throws Exception<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> public String getScript(RestRequest req) throws Exception {<a name="line.160"></a> +<span class="sourceLineNo">161</span> return null;<a name="line.161"></a> +<span class="sourceLineNo">162</span> }<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * Resolves any CSS styles that should be added to the <xt>&lt;head&gt;/&lt;style&gt;</xt> element.<a name="line.165"></a> +<span class="sourceLineNo">166</span> *<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> +<span class="sourceLineNo">168</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.168"></a> +<span class="sourceLineNo">169</span> *<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @param req The HTTP request object.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @return The CSS styles needed by this widget.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @throws Exception<a name="line.172"></a> +<span class="sourceLineNo">173</span> */<a name="line.173"></a> +<span class="sourceLineNo">174</span> public String getStyle(RestRequest req) throws Exception {<a name="line.174"></a> +<span class="sourceLineNo">175</span> return null;<a name="line.175"></a> +<span class="sourceLineNo">176</span> }<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> /**<a name="line.178"></a> +<span class="sourceLineNo">179</span> * Retrieves the specified classpath resource and returns the contents as a string.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * <p><a name="line.181"></a> +<span class="sourceLineNo">182</span> * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches<a name="line.182"></a> +<span class="sourceLineNo">183</span> * up the parent hierarchy chain.<a name="line.183"></a> +<span class="sourceLineNo">184</span> *<a name="line.184"></a> +<span class="sourceLineNo">185</span> * <p><a name="line.185"></a> +<span class="sourceLineNo">186</span> * If the resource cannot be found in the classpath, then an attempt is made to look relative to the JVM working directory.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * <br>Path traversals outside the working directory are not allowed for security reasons.<a name="line.187"></a> +<span class="sourceLineNo">188</span> *<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @param name Name of the desired resource.<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @throws IOException<a name="line.191"></a> +<span class="sourceLineNo">192</span> */<a name="line.192"></a> +<span class="sourceLineNo">193</span> protected String getResourceAsString(String name) throws IOException {<a name="line.193"></a> +<span class="sourceLineNo">194</span> return resourceFinder.getResourceAsString(name);<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> /**<a name="line.197"></a> +<span class="sourceLineNo">198</span> * Same as {@link #getResourceAsString(String)} except also looks for localized-versions of the file.<a name="line.198"></a> +<span class="sourceLineNo">199</span> *<a name="line.199"></a> +<span class="sourceLineNo">200</span> * <p><a name="line.200"></a> +<span class="sourceLineNo">201</span> * If the <code>locale</code> is specified, then we look for resources whose name matches that locale.<a name="line.201"></a> +<span class="sourceLineNo">202</span> * <br>For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.202"></a> +<span class="sourceLineNo">203</span> * files in the following order:<a name="line.203"></a> +<span class="sourceLineNo">204</span> * <ol><a name="line.204"></a> +<span class="sourceLineNo">205</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.205"></a> +<span class="sourceLineNo">206</span> * <li><js>"MyResource_ja.txt"</js><a name="line.206"></a> +<span class="sourceLineNo">207</span> * <li><js>"MyResource.txt"</js><a name="line.207"></a> +<span class="sourceLineNo">208</span> * </ol><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> *<a name="line.211"></a> -<span class="sourceLineNo">212</span> * @param name Name of the desired resource.<a name="line.212"></a> -<span class="sourceLineNo">213</span> * @param locale The locale. Can be <jk>null</jk>.<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.214"></a> -<span class="sourceLineNo">215</span> * @throws IOException<a name="line.215"></a> -<span class="sourceLineNo">216</span> */<a name="line.216"></a> -<span class="sourceLineNo">217</span> protected String getResourceAsString(String name, Locale locale) throws IOException {<a name="line.217"></a> -<span class="sourceLineNo">218</span> return resourceFinder.getResourceAsString(name, locale);<a name="line.218"></a> -<span class="sourceLineNo">219</span> }<a name="line.219"></a> -<span class="sourceLineNo">220</span><a name="line.220"></a> -<span class="sourceLineNo">221</span> /**<a name="line.221"></a> -<span class="sourceLineNo">222</span> * Convenience method for calling {@link #getResourceAsString(String)} except also strips Javascript comments from<a name="line.222"></a> -<span class="sourceLineNo">223</span> * the file.<a name="line.223"></a> -<span class="sourceLineNo">224</span> *<a name="line.224"></a> -<span class="sourceLineNo">225</span> * <p><a name="line.225"></a> -<span class="sourceLineNo">226</span> * Comments are assumed to be Java-style block comments: <js>"/*"</js>.<a name="line.226"></a> -<span class="sourceLineNo">227</span> *<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @param name Name of the desired resource.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @throws IOException<a name="line.230"></a> -<span class="sourceLineNo">231</span> */<a name="line.231"></a> -<span class="sourceLineNo">232</span> protected String loadScript(String name) throws IOException {<a name="line.232"></a> -<span class="sourceLineNo">233</span> String s = getResourceAsString(name);<a name="line.233"></a> -<span class="sourceLineNo">234</span> if (s != null)<a name="line.234"></a> -<span class="sourceLineNo">235</span> s = s.replaceAll("(?s)\\/\\*(.*?)\\*\\/\\s*", "");<a name="line.235"></a> -<span class="sourceLineNo">236</span> return s;<a name="line.236"></a> -<span class="sourceLineNo">237</span> }<a name="line.237"></a> -<span class="sourceLineNo">238</span><a name="line.238"></a> -<span class="sourceLineNo">239</span> /**<a name="line.239"></a> -<span class="sourceLineNo">240</span> * Convenience method for calling {@link #getResourceAsString(String)} except also strips CSS comments from<a name="line.240"></a> -<span class="sourceLineNo">241</span> * the file.<a name="line.241"></a> -<span class="sourceLineNo">242</span> *<a name="line.242"></a> -<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> -<span class="sourceLineNo">244</span> * Comments are assumed to be Java-style block comments: <js>"/*"</js>.<a name="line.244"></a> -<span class="sourceLineNo">245</span> *<a name="line.245"></a> -<span class="sourceLineNo">246</span> * @param name Name of the desired resource.<a name="line.246"></a> -<span class="sourceLineNo">247</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.247"></a> -<span class="sourceLineNo">248</span> * @throws IOException<a name="line.248"></a> -<span class="sourceLineNo">249</span> */<a name="line.249"></a> -<span class="sourceLineNo">250</span> protected String loadStyle(String name) throws IOException {<a name="line.250"></a> -<span class="sourceLineNo">251</span> String s = getResourceAsString(name);<a name="line.251"></a> -<span class="sourceLineNo">252</span> if (s != null)<a name="line.252"></a> -<span class="sourceLineNo">253</span> s = s.replaceAll("(?s)\\/\\*(.*?)\\*\\/\\s*", "");<a name="line.253"></a> -<span class="sourceLineNo">254</span> return s;<a name="line.254"></a> -<span class="sourceLineNo">255</span> }<a name="line.255"></a> -<span class="sourceLineNo">256</span><a name="line.256"></a> -<span class="sourceLineNo">257</span> /**<a name="line.257"></a> -<span class="sourceLineNo">258</span> * Convenience method for calling {@link #getResourceAsString(String)} except also strips HTML comments from the<a name="line.258"></a> -<span class="sourceLineNo">259</span> * file.<a name="line.259"></a> -<span class="sourceLineNo">260</span> *<a name="line.260"></a> -<span class="sourceLineNo">261</span> * <p><a name="line.261"></a> -<span class="sourceLineNo">262</span> * Comment are assumed to be <js>"<!-- -->"</js> code blocks.<a name="line.262"></a> -<span class="sourceLineNo">263</span> *<a name="line.263"></a> -<span class="sourceLineNo">264</span> * @param name Name of the desired resource.<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @throws IOException<a name="line.266"></a> -<span class="sourceLineNo">267</span> */<a name="line.267"></a> -<span class="sourceLineNo">268</span> protected String loadHtml(String name) throws IOException {<a name="line.268"></a> -<span class="sourceLineNo">269</span> String s = getResourceAsString(name);<a name="line.269"></a> -<span class="sourceLineNo">270</span> if (s != null)<a name="line.270"></a> -<span class="sourceLineNo">271</span> s = s.replaceAll("(?s)<!--(.*?)-->\\s*", "");<a name="line.271"></a> -<span class="sourceLineNo">272</span> return s;<a name="line.272"></a> -<span class="sourceLineNo">273</span> }<a name="line.273"></a> -<span class="sourceLineNo">274</span>}<a name="line.274"></a> +<span class="sourceLineNo">211</span> * @param name Name of the desired resource.<a name="line.211"></a> +<span class="sourceLineNo">212</span> * @param locale The locale. Can be <jk>null</jk>.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @throws IOException<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> protected String getResourceAsString(String name, Locale locale) throws IOException {<a name="line.216"></a> +<span class="sourceLineNo">217</span> return resourceFinder.getResourceAsString(name, locale);<a name="line.217"></a> +<span class="sourceLineNo">218</span> }<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * Convenience method for calling {@link #getResourceAsString(String)} except also strips Javascript comments from<a name="line.221"></a> +<span class="sourceLineNo">222</span> * the file.<a name="line.222"></a> +<span class="sourceLineNo">223</span> *<a name="line.223"></a> +<span class="sourceLineNo">224</span> * <p><a name="line.224"></a> +<span class="sourceLineNo">225</span> * Comments are assumed to be Java-style block comments: <js>"/*"</js>.<a name="line.225"></a> +<span class="sourceLineNo">226</span> *<a name="line.226"></a> +<span class="sourceLineNo">227</span> * @param name Name of the desired resource.<a name="line.227"></a> +<span class="sourceLineNo">228</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @throws IOException<a name="line.229"></a> +<span class="sourceLineNo">230</span> */<a name="line.230"></a> +<span class="sourceLineNo">231</span> protected String loadScript(String name) throws IOException {<a name="line.231"></a> +<span class="sourceLineNo">232</span> String s = getResourceAsString(name);<a name="line.232"></a> +<span class="sourceLineNo">233</span> if (s != null)<a name="line.233"></a> +<span class="sourceLineNo">234</span> s = s.replaceAll("(?s)\\/\\*(.*?)\\*\\/\\s*", "");<a name="line.234"></a> +<span class="sourceLineNo">235</span> return s;<a name="line.235"></a> +<span class="sourceLineNo">236</span> }<a name="line.236"></a> +<span class="sourceLineNo">237</span><a name="line.237"></a> +<span class="sourceLineNo">238</span> /**<a name="line.238"></a> +<span class="sourceLineNo">239</span> * Convenience method for calling {@link #getResourceAsString(String)} except also strips CSS comments from<a name="line.239"></a> +<span class="sourceLineNo">240</span> * the file.<a name="line.240"></a> +<span class="sourceLineNo">241</span> *<a name="line.241"></a> +<span class="sourceLineNo">242</span> * <p><a name="line.242"></a> +<span class="sourceLineNo">243</span> * Comments are assumed to be Java-style block comments: <js>"/*"</js>.<a name="line.243"></a> +<span class="sourceLineNo">244</span> *<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @param name Name of the desired resource.<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.246"></a> +<span class="sourceLineNo">247</span> * @throws IOException<a name="line.247"></a> +<span class="sourceLineNo">248</span> */<a name="line.248"></a> +<span class="sourceLineNo">249</span> protected String loadStyle(String name) throws IOException {<a name="line.249"></a> +<span class="sourceLineNo">250</span> String s = getResourceAsString(name);<a name="line.250"></a> +<span class="sourceLineNo">251</span> if (s != null)<a name="line.251"></a> +<span class="sourceLineNo">252</span> s = s.replaceAll("(?s)\\/\\*(.*?)\\*\\/\\s*", "");<a name="line.252"></a> +<span class="sourceLineNo">253</span> return s;<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> /**<a name="line.256"></a> +<span class="sourceLineNo">257</span> * Convenience method for calling {@link #getResourceAsString(String)} except also strips HTML comments from the<a name="line.257"></a> +<span class="sourceLineNo">258</span> * file.<a name="line.258"></a> +<span class="sourceLineNo">259</span> *<a name="line.259"></a> +<span class="sourceLineNo">260</span> * <p><a name="line.260"></a> +<span class="sourceLineNo">261</span> * Comment are assumed to be <js>"<!-- -->"</js> code blocks.<a name="line.261"></a> +<span class="sourceLineNo">262</span> *<a name="line.262"></a> +<span class="sourceLineNo">263</span> * @param name Name of the desired resource.<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @throws IOException<a name="line.265"></a> +<span class="sourceLineNo">266</span> */<a name="line.266"></a> +<span class="sourceLineNo">267</span> protected String loadHtml(String name) throws IOException {<a name="line.267"></a> +<span class="sourceLineNo">268</span> String s = getResourceAsString(name);<a name="line.268"></a> +<span class="sourceLineNo">269</span> if (s != null)<a name="line.269"></a> +<span class="sourceLineNo">270</span> s = s.replaceAll("(?s)<!--(.*?)-->\\s*", "");<a name="line.270"></a> +<span class="sourceLineNo">271</span> return s;<a name="line.271"></a> +<span class="sourceLineNo">272</span> }<a name="line.272"></a> +<span class="sourceLineNo">273</span>}<a name="line.273"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/svl/DefaultingVar.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/svl/DefaultingVar.html b/content/site/apidocs/src-html/org/apache/juneau/svl/DefaultingVar.html index 464db57..947e599 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/svl/DefaultingVar.html +++ b/content/site/apidocs/src-html/org/apache/juneau/svl/DefaultingVar.html @@ -46,7 +46,7 @@ <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> @Override /* Var*/<a name="line.40"></a> -<span class="sourceLineNo">041</span> public String doResolve(VarResolverSession session, String s) {<a name="line.41"></a> +<span class="sourceLineNo">041</span> public String doResolve(VarResolverSession session, String s) throws Exception {<a name="line.41"></a> <span class="sourceLineNo">042</span> int i = s.indexOf(',');<a name="line.42"></a> <span class="sourceLineNo">043</span> if (i == -1)<a name="line.43"></a> <span class="sourceLineNo">044</span> return resolve(session, s.trim());<a name="line.44"></a>
