http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/widget/MenuItemWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/MenuItemWidget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/MenuItemWidget.html new file mode 100644 index 0000000..769be50 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/MenuItemWidget.html @@ -0,0 +1,144 @@ +<!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.rest.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>/**<a name="line.17"></a> +<span class="sourceLineNo">018</span> * A subclass of widgets for rendering menu items with drop-down windows.<a name="line.18"></a> +<span class="sourceLineNo">019</span> *<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <p><a name="line.20"></a> +<span class="sourceLineNo">021</span> * Defines some simple CSS and Javascript for enabling drop-down menus in the nav section of the page (although<a name="line.21"></a> +<span class="sourceLineNo">022</span> * nothing keeps you from using it in an arbirary location in the page).<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> * The script specifies a <js>"menuClick(element)"</js> function that toggles the visibility of the next sibling of the<a name="line.25"></a> +<span class="sourceLineNo">026</span> * element.<a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> +<span class="sourceLineNo">029</span> * Subclasses should implement a {@link #getHtml(RestRequest)} that returns the following content:<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p class='bcode'><a name="line.30"></a> +<span class="sourceLineNo">031</span> * <xt>&lt;div</xt> <xa>class</xa>=<xs>'menu-item'</xs><xt>&gt;</xt><a name="line.31"></a> +<span class="sourceLineNo">032</span> * <xc>&lt;!-- Normally visible content with onclick='menuClick(this)' --&gt;</xc><a name="line.32"></a> +<span class="sourceLineNo">033</span> * <xt>&lt;div</xt> <xa>class</xa>=<xs>'popup-content'</xs><xt>&gt;</xt><a name="line.33"></a> +<span class="sourceLineNo">034</span> * <xc>&lt;!-- Normally hidden popup-content --&gt;</xc><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <xt>&lt;/div&gt;</xt><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <xt>&lt;/div&gt;</xt><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> * For example, to render a link that brings up a simple dialog:<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p class='bcode'><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <xt>&lt;div</xt> <xa>class</xa>=<xs>'menu-item'</xs><xt>&gt;</xt><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <xt>&lt;a</xt> <xa>class</xa>=<xs>'link'</xs> <xa>onclick</xa>=<xs>'menuClick(this)'</xs><xt>&gt;</xt>my-menu-item<xt>&lt;/a&gt;</xt><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <xt>&lt;div</xt> <xa>class</xa>=<xs>'popup-content'</xs><xt>&gt;</xt><a name="line.44"></a> +<span class="sourceLineNo">045</span> * Surprise!<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <xt>&lt;/div&gt;</xt><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <xt>&lt;/div&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> * The HTML content returned by the {@link #getHtml(RestRequest)} method is added where the <js>"$W{...}"</js> is<a name="line.51"></a> +<span class="sourceLineNo">052</span> * referenced in the page.<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span>public abstract class MenuItemWidget extends Widget {<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> * Returns the Javascript needed for the show and hide actions of the menu item.<a name="line.57"></a> +<span class="sourceLineNo">058</span> */<a name="line.58"></a> +<span class="sourceLineNo">059</span> @Override<a name="line.59"></a> +<span class="sourceLineNo">060</span> public String getScript(RestRequest req) throws Exception {<a name="line.60"></a> +<span class="sourceLineNo">061</span> return getResourceAsString("MenuItemWidget.js").replaceAll("(?s)\\/\\*{2}(.*?)\\/\\*\\s*", "");<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> * Defines a <js>"menu-item"</js> class that needs to be used on the outer element of the HTML returned by the<a name="line.65"></a> +<span class="sourceLineNo">066</span> * {@link #getHtml(RestRequest)} method.<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> @Override<a name="line.68"></a> +<span class="sourceLineNo">069</span> public String getStyle(RestRequest req) throws Exception {<a name="line.69"></a> +<span class="sourceLineNo">070</span> return getResourceAsString("MenuItemWidget.css").replaceAll("(?s)\\/\\*{2}(.*?)\\/\\*\\s*", "");<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 index 41d1219..043a3ab 100644 --- 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 @@ -20,28 +20,57 @@ <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.rest.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>/**<a name="line.17"></a> -<span class="sourceLineNo">018</span> * Widget that places a powered-by-Apache message on the page.<a name="line.18"></a> -<span class="sourceLineNo">019</span> *<a name="line.19"></a> -<span class="sourceLineNo">020</span> * <p><a name="line.20"></a> -<span class="sourceLineNo">021</span> * The variable it resolves is <js>"$W{poweredByApache}"</js>.<a name="line.21"></a> -<span class="sourceLineNo">022</span> */<a name="line.22"></a> -<span class="sourceLineNo">023</span>public class PoweredByApacheWidget extends Widget {<a name="line.23"></a> -<span class="sourceLineNo">024</span><a name="line.24"></a> -<span class="sourceLineNo">025</span> @Override /* Widget */<a name="line.25"></a> -<span class="sourceLineNo">026</span> public String getName() {<a name="line.26"></a> -<span class="sourceLineNo">027</span> return "poweredByApache";<a name="line.27"></a> -<span class="sourceLineNo">028</span> }<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span> @Override /* Widget */<a name="line.30"></a> -<span class="sourceLineNo">031</span> public String resolve(RestRequest req) throws Exception {<a name="line.31"></a> -<span class="sourceLineNo">032</span> return "<a href='http://apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+req.getUriResolver().resolve("servlet:/htdocs/asf.png")+"'>";<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><a name="line.36"></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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 index 2a52c04..3a78c3a 100644 --- 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 @@ -20,28 +20,55 @@ <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.rest.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>/**<a name="line.17"></a> -<span class="sourceLineNo">018</span> * Widget that places a powered-by-Juneau message on the page.<a name="line.18"></a> -<span class="sourceLineNo">019</span> *<a name="line.19"></a> -<span class="sourceLineNo">020</span> * <p><a name="line.20"></a> -<span class="sourceLineNo">021</span> * The variable it resolves is <js>"$W{poweredByJuneau}"</js>.<a name="line.21"></a> -<span class="sourceLineNo">022</span> */<a name="line.22"></a> -<span class="sourceLineNo">023</span>public class PoweredByJuneauWidget extends Widget {<a name="line.23"></a> -<span class="sourceLineNo">024</span><a name="line.24"></a> -<span class="sourceLineNo">025</span> @Override /* Widget */<a name="line.25"></a> -<span class="sourceLineNo">026</span> public String getName() {<a name="line.26"></a> -<span class="sourceLineNo">027</span> return "poweredByJuneau";<a name="line.27"></a> -<span class="sourceLineNo">028</span> }<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span> @Override /* Widget */<a name="line.30"></a> -<span class="sourceLineNo">031</span> public String resolve(RestRequest req) throws Exception {<a name="line.31"></a> -<span class="sourceLineNo">032</span> return "<a href='http://apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+req.getUriResolver().resolve("servlet:/htdocs/juneau.png")+"'>";<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><a name="line.36"></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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 new file mode 100644 index 0000000..a740a6b --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryMenuItem.html @@ -0,0 +1,159 @@ +<!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.rest.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import org.apache.juneau.rest.converters.*;<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 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">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> +<span class="sourceLineNo">026</span> * can process the query parameters themselves if they wish to do so by using the {@link RequestQuery#getSearchArgs()}<a name="line.26"></a> +<span class="sourceLineNo">027</span> * method to retrieve the arguments and process the data themselves.<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><a name="line.29"></a> +<span class="sourceLineNo">030</span> * An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides<a name="line.30"></a> +<span class="sourceLineNo">031</span> * search/view/sort capabilities against the collection of POJOs:<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p class='bcode'><a name="line.32"></a> +<span class="sourceLineNo">033</span> * <ja>@RestMethod</ja>(<a name="line.33"></a> +<span class="sourceLineNo">034</span> * name=<js>"GET"</js>,<a name="line.34"></a> +<span class="sourceLineNo">035</span> * path=<js>"/"</js>,<a name="line.35"></a> +<span class="sourceLineNo">036</span> * widgets={<a name="line.36"></a> +<span class="sourceLineNo">037</span> * QueryMenuItem.<jk>class</jk>,<a name="line.37"></a> +<span class="sourceLineNo">038</span> * },<a name="line.38"></a> +<span class="sourceLineNo">039</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.39"></a> +<span class="sourceLineNo">040</span> * links=<js>"{up:'...',options:'...',query:'$W{queryMenuItem}',contentTypes:'...',source:'...'}"</js><a name="line.40"></a> +<span class="sourceLineNo">041</span> * ),<a name="line.41"></a> +<span class="sourceLineNo">042</span> * converters=Queryable.<jk>class</jk><a name="line.42"></a> +<span class="sourceLineNo">043</span> * )<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <jk>public</jk> Collection&lt;Pet&gt; getPets() {<a name="line.44"></a> +<span class="sourceLineNo">045</span> * </p><a name="line.45"></a> +<span class="sourceLineNo">046</span> *<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * It renders the following popup-box:<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <br><img class='bordered' src='doc-files/QueryMenuItem_1.png'><a name="line.49"></a> +<span class="sourceLineNo">050</span> *<a name="line.50"></a> +<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> +<span class="sourceLineNo">052</span> * Tooltips are provided by hovering over the field names.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <br><img class='bordered' src='doc-files/QueryMenuItem_2.png'><a name="line.53"></a> +<span class="sourceLineNo">054</span> *<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * When submitted, the form submits a GET request against the current URI with special GET search API query parameters.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <br>(e.g. <js>"?s=column1=Foo*&amp;v=column1,column2&amp;o=column1,column2-&amp;p=100&amp;l=100"</js>).<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <br>The {@link Queryable} class knows how to perform these filters against collections of POJOs.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span>public class QueryMenuItem extends MenuItemWidget {<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> * Returns <js>"queryMenuItem"</js>.<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> @Override /* Widget */<a name="line.65"></a> +<span class="sourceLineNo">066</span> public String getName() {<a name="line.66"></a> +<span class="sourceLineNo">067</span> return "queryMenuItem";<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> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * Returns CSS for the tooltips.<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> @Override<a name="line.73"></a> +<span class="sourceLineNo">074</span> public String getStyle(RestRequest req) throws Exception {<a name="line.74"></a> +<span class="sourceLineNo">075</span> return super.getStyle(req)<a name="line.75"></a> +<span class="sourceLineNo">076</span> + "\n"<a name="line.76"></a> +<span class="sourceLineNo">077</span> + getResourceAsString("QueryMenuItem.css").replaceFirst("(?s)\\/\\*{2}(.*?)\\/\\*\\s*", "");<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> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Returns the HTML for rendering the query form and tooltips.<a name="line.81"></a> +<span class="sourceLineNo">082</span> */<a name="line.82"></a> +<span class="sourceLineNo">083</span> @Override /* Widget */<a name="line.83"></a> +<span class="sourceLineNo">084</span> public String getHtml(RestRequest req) throws Exception {<a name="line.84"></a> +<span class="sourceLineNo">085</span> return getResourceAsString("QueryMenuItem.html").replaceFirst("(?s)<!--(.*?)-->\\s*", "");<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryWidget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryWidget.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryWidget.html deleted file mode 100644 index 92612ff..0000000 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/QueryWidget.html +++ /dev/null @@ -1,207 +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.internal.*;<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>import org.apache.juneau.rest.converters.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>/**<a name="line.19"></a> -<span class="sourceLineNo">020</span> * Adds a <code>QUERY</code> link to the page that allows you to perform search/view/sort/paging on the page data.<a name="line.20"></a> -<span class="sourceLineNo">021</span> *<a name="line.21"></a> -<span class="sourceLineNo">022</span> * <p><a name="line.22"></a> -<span class="sourceLineNo">023</span> * A typical usage of the query widget is to include it as a navigation link as shown in the example below<a name="line.23"></a> -<span class="sourceLineNo">024</span> * pulled from the <code>PetStoreResource</code> example:<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p class='bcode'><a name="line.25"></a> -<span class="sourceLineNo">026</span> * <ja>@RestResource</ja>(<a name="line.26"></a> -<span class="sourceLineNo">027</span> * widgets={<a name="line.27"></a> -<span class="sourceLineNo">028</span> * QueryWidget.<jk>class</jk><a name="line.28"></a> -<span class="sourceLineNo">029</span> * },<a name="line.29"></a> -<span class="sourceLineNo">030</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.30"></a> -<span class="sourceLineNo">031</span> * links=<js>"{up:'...',options:'...',query:'$W{query}',source:'...'}"</js><a name="line.31"></a> -<span class="sourceLineNo">032</span> * )<a name="line.32"></a> -<span class="sourceLineNo">033</span> * )<a name="line.33"></a> -<span class="sourceLineNo">034</span> * </p><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> * In the above example, this adds a <code>QUERY</code> that displays a search popup that can be used for filtering the<a name="line.37"></a> -<span class="sourceLineNo">038</span> * page results...<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <img class='bordered' src='doc-files/PetStore_Query.png'><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> * Tooltips are provided by hovering over the field names.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <img class='bordered' src='doc-files/PetStore_Query_tooltip.png'><a name="line.43"></a> -<span class="sourceLineNo">044</span> *<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <p><a name="line.45"></a> -<span class="sourceLineNo">046</span> * When submitted, the form submits a GET request against the current URI with special GET search API query parameters.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * (e.g. <js>"?s=column1=Foo*&amp;v=column1,column2&amp;o=column1,column2-&amp;p=100&amp;l=100"</js>).<a name="line.47"></a> -<span class="sourceLineNo">048</span> *<a name="line.48"></a> -<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> -<span class="sourceLineNo">050</span> * The search arguments can be retrieved programmatically using {@link RequestQuery#getSearchArgs()}.<a name="line.50"></a> -<span class="sourceLineNo">051</span> *<a name="line.51"></a> -<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> -<span class="sourceLineNo">053</span> * Typically, the search functionality is implemented by applying the predefined {@link Queryable} converter on the<a name="line.53"></a> -<span class="sourceLineNo">054</span> * method that's returning a 2-dimensional table of POJOs that you wish to filter:<a name="line.54"></a> -<span class="sourceLineNo">055</span> * <p class='bcode'><a name="line.55"></a> -<span class="sourceLineNo">056</span> * <ja>@RestMethod</ja>(<a name="line.56"></a> -<span class="sourceLineNo">057</span> * name=<js>"GET"</js>,<a name="line.57"></a> -<span class="sourceLineNo">058</span> * path=<js>"/"</js>,<a name="line.58"></a> -<span class="sourceLineNo">059</span> * converters=Queryable.<jk>class</jk><a name="line.59"></a> -<span class="sourceLineNo">060</span> * )<a name="line.60"></a> -<span class="sourceLineNo">061</span> * <jk>public</jk> Collection&lt;Pet&gt; getPets() {<a name="line.61"></a> -<span class="sourceLineNo">062</span> * </p><a name="line.62"></a> -<span class="sourceLineNo">063</span> *<a name="line.63"></a> -<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> -<span class="sourceLineNo">065</span> * The following shows various search arguments and their results on the page:<a name="line.65"></a> -<span class="sourceLineNo">066</span> * <table style='width:auto'><a name="line.66"></a> -<span class="sourceLineNo">067</span> * <tr><a name="line.67"></a> -<span class="sourceLineNo">068</span> * <th>Search type</th><th>Query arguments</th><th>Query results</th><a name="line.68"></a> -<span class="sourceLineNo">069</span> * </tr><a name="line.69"></a> -<span class="sourceLineNo">070</span> * <tr><a name="line.70"></a> -<span class="sourceLineNo">071</span> * <td>No arguments</td><a name="line.71"></a> -<span class="sourceLineNo">072</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q1.png'></td><a name="line.72"></a> -<span class="sourceLineNo">073</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r1.png'></td><a name="line.73"></a> -<span class="sourceLineNo">074</span> * </tr><a name="line.74"></a> -<span class="sourceLineNo">075</span> * <tr><a name="line.75"></a> -<span class="sourceLineNo">076</span> * <td>String search</td><a name="line.76"></a> -<span class="sourceLineNo">077</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q2.png'></td><a name="line.77"></a> -<span class="sourceLineNo">078</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r2.png'></td><a name="line.78"></a> -<span class="sourceLineNo">079</span> * </tr><a name="line.79"></a> -<span class="sourceLineNo">080</span> * <tr><a name="line.80"></a> -<span class="sourceLineNo">081</span> * <td>Numeric range</td><a name="line.81"></a> -<span class="sourceLineNo">082</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q3.png'></td><a name="line.82"></a> -<span class="sourceLineNo">083</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r3.png'></td><a name="line.83"></a> -<span class="sourceLineNo">084</span> * </tr><a name="line.84"></a> -<span class="sourceLineNo">085</span> * <tr><a name="line.85"></a> -<span class="sourceLineNo">086</span> * <td>ANDed terms</td><a name="line.86"></a> -<span class="sourceLineNo">087</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q4.png'></td><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r4.png'></td><a name="line.88"></a> -<span class="sourceLineNo">089</span> * </tr><a name="line.89"></a> -<span class="sourceLineNo">090</span> * <tr><a name="line.90"></a> -<span class="sourceLineNo">091</span> * <td>Date range (entire year)</td><a name="line.91"></a> -<span class="sourceLineNo">092</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q8.png'></td><a name="line.92"></a> -<span class="sourceLineNo">093</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r8.png'></td><a name="line.93"></a> -<span class="sourceLineNo">094</span> * </tr><a name="line.94"></a> -<span class="sourceLineNo">095</span> * <tr><a name="line.95"></a> -<span class="sourceLineNo">096</span> * <td>Date range</td><a name="line.96"></a> -<span class="sourceLineNo">097</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q9.png'></td><a name="line.97"></a> -<span class="sourceLineNo">098</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r9.png'></td><a name="line.98"></a> -<span class="sourceLineNo">099</span> * </tr><a name="line.99"></a> -<span class="sourceLineNo">100</span> * <tr><a name="line.100"></a> -<span class="sourceLineNo">101</span> * <td>Date range</td><a name="line.101"></a> -<span class="sourceLineNo">102</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q10.png'></td><a name="line.102"></a> -<span class="sourceLineNo">103</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r10.png'></td><a name="line.103"></a> -<span class="sourceLineNo">104</span> * </tr><a name="line.104"></a> -<span class="sourceLineNo">105</span> * <tr><a name="line.105"></a> -<span class="sourceLineNo">106</span> * <td>Hide columns</td><a name="line.106"></a> -<span class="sourceLineNo">107</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q5.png'></td><a name="line.107"></a> -<span class="sourceLineNo">108</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r5.png'></td><a name="line.108"></a> -<span class="sourceLineNo">109</span> * </tr><a name="line.109"></a> -<span class="sourceLineNo">110</span> * <tr><a name="line.110"></a> -<span class="sourceLineNo">111</span> * <td>Sort</td><a name="line.111"></a> -<span class="sourceLineNo">112</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q6.png'></td><a name="line.112"></a> -<span class="sourceLineNo">113</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r6.png'></td><a name="line.113"></a> -<span class="sourceLineNo">114</span> * </tr><a name="line.114"></a> -<span class="sourceLineNo">115</span> * <tr><a name="line.115"></a> -<span class="sourceLineNo">116</span> * <td>Sort descending</td><a name="line.116"></a> -<span class="sourceLineNo">117</span> * <td><img class='bordered' src='doc-files/PetStore_Query_q7.png'></td><a name="line.117"></a> -<span class="sourceLineNo">118</span> * <td><img class='bordered' src='doc-files/PetStore_Query_r7.png'></td><a name="line.118"></a> -<span class="sourceLineNo">119</span> * </tr><a name="line.119"></a> -<span class="sourceLineNo">120</span> * </table><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>public class QueryWidget extends Widget {<a name="line.123"></a> -<span class="sourceLineNo">124</span><a name="line.124"></a> -<span class="sourceLineNo">125</span> @Override<a name="line.125"></a> -<span class="sourceLineNo">126</span> public String getName() {<a name="line.126"></a> -<span class="sourceLineNo">127</span> return "query";<a name="line.127"></a> -<span class="sourceLineNo">128</span> }<a name="line.128"></a> -<span class="sourceLineNo">129</span><a name="line.129"></a> -<span class="sourceLineNo">130</span> @Override /* Widget */<a name="line.130"></a> -<span class="sourceLineNo">131</span> public String resolve(RestRequest req) throws Exception {<a name="line.131"></a> -<span class="sourceLineNo">132</span> // Note we're stripping off the license header.<a name="line.132"></a> -<span class="sourceLineNo">133</span> return IOUtils.read(getClass().getResourceAsStream("QueryWidget.html")).replaceFirst("(?s)<!--(.*?)-->\\s*", "");<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> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 42e38e4..c56cdb5 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 @@ -20,40 +20,208 @@ <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.rest.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import org.apache.juneau.rest.annotation.*;<a name="line.16"></a> +<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.*;<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> * Defines an interface for defining resolvers for <js>"$W{...}"</js> string variables.<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> * Widgets are associated with resources through the following<a name="line.22"></a> -<span class="sourceLineNo">023</span> * <ul><a name="line.23"></a> -<span class="sourceLineNo">024</span> * <li>{@link RestResource#widgets() @RestResource.widgets}<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <li>{@link RestMethod#widgets() @RestMethod.widgets}<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <li>{@link RestConfig#addWidget(Class)}<a name="line.26"></a> -<span class="sourceLineNo">027</span> * </ul><a name="line.27"></a> -<span class="sourceLineNo">028</span> */<a name="line.28"></a> -<span class="sourceLineNo">029</span>public abstract class Widget {<a name="line.29"></a> -<span class="sourceLineNo">030</span><a name="line.30"></a> -<span class="sourceLineNo">031</span> /**<a name="line.31"></a> -<span class="sourceLineNo">032</span> * The widget key (i.e. The contents of the <js>"$W{...}"</js> variable).<a name="line.32"></a> -<span class="sourceLineNo">033</span> *<a name="line.33"></a> -<span class="sourceLineNo">034</span> * @return<a name="line.34"></a> -<span class="sourceLineNo">035</span> * The widget key.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Must not be <jk>null</jk>.<a name="line.36"></a> -<span class="sourceLineNo">037</span> */<a name="line.37"></a> -<span class="sourceLineNo">038</span> public abstract String getName();<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> * Resolves the value for the variable.<a name="line.41"></a> -<span class="sourceLineNo">042</span> *<a name="line.42"></a> -<span class="sourceLineNo">043</span> * @param req The HTTP request object.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * @return The resolved value.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * @throws Exception<a name="line.45"></a> -<span class="sourceLineNo">046</span> */<a name="line.46"></a> -<span class="sourceLineNo">047</span> public abstract String resolve(RestRequest req) throws Exception;<a name="line.47"></a> -<span class="sourceLineNo">048</span>}<a name="line.48"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.rest.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.rest.annotation.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.utils.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Defines an interface for resolvers of <js>"$W{...}"</js> string variables.<a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<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=<js>"{mylink:'$W{myWidget}'}"</js>,<a name="line.52"></a> +<span class="sourceLineNo">053</span> * aside=<js>"Check out this widget: $W{myWidget}"</js><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> * </p><a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p><a name="line.58"></a> +<span class="sourceLineNo">059</span> * The following shows an example of a widget that renders an image located in the <code>htdocs</code> static files<a name="line.59"></a> +<span class="sourceLineNo">060</span> * directory in your classpath (see {@link RestResource#staticFiles()}):<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p class='bcode'><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <jk>public class</jk> MyWidget <jk>extends</jk> Widget {<a name="line.62"></a> +<span class="sourceLineNo">063</span> *<a name="line.63"></a> +<span class="sourceLineNo">064</span> * <ja>@Override</ja><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <jk>public</jk> String getName(RestRequest req) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> * return <js>"myWidget"</js>;<a name="line.66"></a> +<span class="sourceLineNo">067</span> * }<a name="line.67"></a> +<span class="sourceLineNo">068</span> *<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <ja>@Override</ja><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <jk>public</jk> String getHtml(RestRequest req) <jk>throws</jk> Exception {<a name="line.70"></a> +<span class="sourceLineNo">071</span> * UriResolver r = req.getUriResolver();<a name="line.71"></a> +<span class="sourceLineNo">072</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.72"></a> +<span class="sourceLineNo">073</span> * }<a name="line.73"></a> +<span class="sourceLineNo">074</span> *<a name="line.74"></a> +<span class="sourceLineNo">075</span> * <ja>@Override</ja><a name="line.75"></a> +<span class="sourceLineNo">076</span> * <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {<a name="line.76"></a> +<span class="sourceLineNo">077</span> * <jk>return</jk> <js>""</js><a name="line.77"></a> +<span class="sourceLineNo">078</span> * + <js>"\n function myalert(imageElement) {"</js><a name="line.78"></a> +<span class="sourceLineNo">079</span> * + <js>"\n alert('cool!');"</js><a name="line.79"></a> +<span class="sourceLineNo">080</span> * + <js>"\n }"</js>;<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">083</span> * <ja>@Override</ja><a name="line.83"></a> +<span class="sourceLineNo">084</span> * <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {<a name="line.84"></a> +<span class="sourceLineNo">085</span> * <jk>return</jk> <js>""</js><a name="line.85"></a> +<span class="sourceLineNo">086</span> * + <js>"\n .myimage {"</js><a name="line.86"></a> +<span class="sourceLineNo">087</span> * + <js>"\n border: 10px solid red;"</js><a name="line.87"></a> +<span class="sourceLineNo">088</span> * + <js>"\n }"</js>;<a name="line.88"></a> +<span class="sourceLineNo">089</span> * }<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> *<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <p><a name="line.93"></a> +<span class="sourceLineNo">094</span> * Note the {@link #getResourceAsString(String)} and {@link #getResourceAsString(String, Locale)} convenience methods<a name="line.94"></a> +<span class="sourceLineNo">095</span> * provided for quickly loading javascript and css files from the classpath or file system.<a name="line.95"></a> +<span class="sourceLineNo">096</span> * These are useful if your script or styles are complex and you want them loaded from files.<a name="line.96"></a> +<span class="sourceLineNo">097</span> *<a name="line.97"></a> +<span class="sourceLineNo">098</span> * <p><a name="line.98"></a> +<span class="sourceLineNo">099</span> * <p class='bcode'><a name="line.99"></a> +<span class="sourceLineNo">100</span> * <jk>public class</jk> MyWidget <jk>extends</jk> Widget {<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> *<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <ja>@Override</ja><a name="line.104"></a> +<span class="sourceLineNo">105</span> * <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {<a name="line.105"></a> +<span class="sourceLineNo">106</span> * <jk>return</jk> getResourceAsString(<js>"MyWidget.js"</js>);<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> * <ja>@Override</ja><a name="line.109"></a> +<span class="sourceLineNo">110</span> * <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <jk>return</jk> getResourceAsString(<js>"MyWidget.css"</js>);<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> * </p><a name="line.114"></a> +<span class="sourceLineNo">115</span> */<a name="line.115"></a> +<span class="sourceLineNo">116</span>public abstract class Widget {<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> private final ResourceFinder resourceFinder = new ResourceFinder(getClass());<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> * The widget key.<a name="line.121"></a> +<span class="sourceLineNo">122</span> *<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <p><a name="line.123"></a> +<span class="sourceLineNo">124</span> * (i.e. The contents of the <js>"$W{...}"</js> variable).<a name="line.124"></a> +<span class="sourceLineNo">125</span> *<a name="line.125"></a> +<span class="sourceLineNo">126</span> * <p><a name="line.126"></a> +<span class="sourceLineNo">127</span> * The returned value must not be <jk>null</jk>.<a name="line.127"></a> +<span class="sourceLineNo">128</span> *<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @return The widget key.<a name="line.129"></a> +<span class="sourceLineNo">130</span> */<a name="line.130"></a> +<span class="sourceLineNo">131</span> public abstract String getName();<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> * Resolves the HTML content for this widget.<a name="line.134"></a> +<span class="sourceLineNo">135</span> *<a name="line.135"></a> +<span class="sourceLineNo">136</span> * <p><a name="line.136"></a> +<span class="sourceLineNo">137</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.137"></a> +<span class="sourceLineNo">138</span> *<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param req The HTTP request object.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * @return The HTML content of this widget.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * @throws Exception<a name="line.141"></a> +<span class="sourceLineNo">142</span> */<a name="line.142"></a> +<span class="sourceLineNo">143</span> public String getHtml(RestRequest req) throws Exception {<a name="line.143"></a> +<span class="sourceLineNo">144</span> return null;<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> /**<a name="line.147"></a> +<span class="sourceLineNo">148</span> * Resolves any Javascript that should be added to the <xt>&lt;head&gt;/&lt;script&gt;</xt> element.<a name="line.148"></a> +<span class="sourceLineNo">149</span> *<a name="line.149"></a> +<span class="sourceLineNo">150</span> * <p><a name="line.150"></a> +<span class="sourceLineNo">151</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.151"></a> +<span class="sourceLineNo">152</span> *<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @param req The HTTP request object.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * @return The Javascript needed by this widget.<a name="line.154"></a> +<span class="sourceLineNo">155</span> * @throws Exception<a name="line.155"></a> +<span class="sourceLineNo">156</span> */<a name="line.156"></a> +<span class="sourceLineNo">157</span> public String getScript(RestRequest req) throws Exception {<a name="line.157"></a> +<span class="sourceLineNo">158</span> return null;<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<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> * Resolves any CSS styles that should be added to the <xt>&lt;head&gt;/&lt;style&gt;</xt> element.<a name="line.162"></a> +<span class="sourceLineNo">163</span> *<a name="line.163"></a> +<span class="sourceLineNo">164</span> * <p><a name="line.164"></a> +<span class="sourceLineNo">165</span> * A returned value of <jk>null</jk> will cause nothing to be added to the page.<a name="line.165"></a> +<span class="sourceLineNo">166</span> *<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @param req The HTTP request object.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return The CSS styles needed by this widget.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @throws Exception<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> public String getStyle(RestRequest req) throws Exception {<a name="line.171"></a> +<span class="sourceLineNo">172</span> return null;<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> /**<a name="line.175"></a> +<span class="sourceLineNo">176</span> * Retrieves the specified classpath resource and returns the contents as a string.<a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches<a name="line.179"></a> +<span class="sourceLineNo">180</span> * up the parent hierarchy chain.<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> * 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.183"></a> +<span class="sourceLineNo">184</span> * <br>Path traversals outside the working directory are not allowed for security reasons.<a name="line.184"></a> +<span class="sourceLineNo">185</span> *<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param name Name of the desired resource.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @throws IOException<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> protected String getResourceAsString(String name) throws IOException {<a name="line.190"></a> +<span class="sourceLineNo">191</span> return resourceFinder.getResourceAsString(name);<a name="line.191"></a> +<span class="sourceLineNo">192</span> }<a name="line.192"></a> +<span class="sourceLineNo">193</span><a name="line.193"></a> +<span class="sourceLineNo">194</span> /**<a name="line.194"></a> +<span class="sourceLineNo">195</span> * Same as {@link #getResourceAsString(String)} except also looks for localized-versions of the file.<a name="line.195"></a> +<span class="sourceLineNo">196</span> *<a name="line.196"></a> +<span class="sourceLineNo">197</span> * <p><a name="line.197"></a> +<span class="sourceLineNo">198</span> * If the <code>locale</code> is specified, then we look for resources whose name matches that locale.<a name="line.198"></a> +<span class="sourceLineNo">199</span> * <br>For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.199"></a> +<span class="sourceLineNo">200</span> * files in the following order:<a name="line.200"></a> +<span class="sourceLineNo">201</span> * <ol><a name="line.201"></a> +<span class="sourceLineNo">202</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.202"></a> +<span class="sourceLineNo">203</span> * <li><js>"MyResource_ja.txt"</js><a name="line.203"></a> +<span class="sourceLineNo">204</span> * <li><js>"MyResource.txt"</js><a name="line.204"></a> +<span class="sourceLineNo">205</span> * </ol><a name="line.205"></a> +<span class="sourceLineNo">206</span> *<a name="line.206"></a> +<span class="sourceLineNo">207</span> *<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @param name Name of the desired resource.<a name="line.208"></a> +<span class="sourceLineNo">209</span> * @param locale The locale. Can be <jk>null</jk>.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @throws IOException<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> protected String getResourceAsString(String name, Locale locale) throws IOException {<a name="line.213"></a> +<span class="sourceLineNo">214</span> return resourceFinder.getResourceAsString(name, locale);<a name="line.214"></a> +<span class="sourceLineNo">215</span> }<a name="line.215"></a> +<span class="sourceLineNo">216</span>}<a name="line.216"></a>
