http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html index 46556bb..a984e9b 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestResponse.html @@ -775,7 +775,7 @@ <span class="sourceLineNo">767</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.767"></a> <span class="sourceLineNo">768</span> *<a name="line.768"></a> <span class="sourceLineNo">769</span> * <p><a name="line.769"></a> -<span class="sourceLineNo">770</span> * This is the programmatic equivalent to the {@link HtmlDoc#css() @HtmlDoc.css()} annotation.<a name="line.770"></a> +<span class="sourceLineNo">770</span> * This is the programmatic equivalent to the {@link HtmlDoc#style() @HtmlDoc.style()} annotation.<a name="line.770"></a> <span class="sourceLineNo">771</span> *<a name="line.771"></a> <span class="sourceLineNo">772</span> * @param value<a name="line.772"></a> <span class="sourceLineNo">773</span> * The HTML CSS style section contents.<a name="line.773"></a> @@ -788,8 +788,8 @@ <span class="sourceLineNo">780</span> * </ul><a name="line.780"></a> <span class="sourceLineNo">781</span> * @return This object (for method chaining).<a name="line.781"></a> <span class="sourceLineNo">782</span> */<a name="line.782"></a> -<span class="sourceLineNo">783</span> public RestResponse setHtmlCss(Object value) {<a name="line.783"></a> -<span class="sourceLineNo">784</span> properties.put(HtmlDocSerializerContext.HTMLDOC_css, value);<a name="line.784"></a> +<span class="sourceLineNo">783</span> public RestResponse setHtmlStyle(Object value) {<a name="line.783"></a> +<span class="sourceLineNo">784</span> properties.put(HtmlDocSerializerContext.HTMLDOC_style, value);<a name="line.784"></a> <span class="sourceLineNo">785</span> return this;<a name="line.785"></a> <span class="sourceLineNo">786</span> }<a name="line.786"></a> <span class="sourceLineNo">787</span><a name="line.787"></a> @@ -797,7 +797,7 @@ <span class="sourceLineNo">789</span> * Sets the CSS URL in the HTML CSS style section.<a name="line.789"></a> <span class="sourceLineNo">790</span> *<a name="line.790"></a> <span class="sourceLineNo">791</span> * <p><a name="line.791"></a> -<span class="sourceLineNo">792</span> * The format of this value is a URL.<a name="line.792"></a> +<span class="sourceLineNo">792</span> * The format of this value is a comma-delimited list of URLs.<a name="line.792"></a> <span class="sourceLineNo">793</span> *<a name="line.793"></a> <span class="sourceLineNo">794</span> * <p><a name="line.794"></a> <span class="sourceLineNo">795</span> * Specifies the URL to the stylesheet to add as a link in the style tag in the header.<a name="line.795"></a> @@ -810,7 +810,7 @@ <span class="sourceLineNo">802</span> * by {@link UriResolver}.<a name="line.802"></a> <span class="sourceLineNo">803</span> *<a name="line.803"></a> <span class="sourceLineNo">804</span> * <p><a name="line.804"></a> -<span class="sourceLineNo">805</span> * This is the programmatic equivalent to the {@link HtmlDoc#cssUrl() @HtmlDoc.cssUrl()} annotation.<a name="line.805"></a> +<span class="sourceLineNo">805</span> * This is the programmatic equivalent to the {@link HtmlDoc#styleImport() @HtmlDoc.styleImport()} annotation.<a name="line.805"></a> <span class="sourceLineNo">806</span> *<a name="line.806"></a> <span class="sourceLineNo">807</span> * @param value<a name="line.807"></a> <span class="sourceLineNo">808</span> * The CSS URL in the HTML CSS style section.<a name="line.808"></a> @@ -823,85 +823,116 @@ <span class="sourceLineNo">815</span> * </ul><a name="line.815"></a> <span class="sourceLineNo">816</span> * @return This object (for method chaining).<a name="line.816"></a> <span class="sourceLineNo">817</span> */<a name="line.817"></a> -<span class="sourceLineNo">818</span> public RestResponse setHtmlCssUrl(Object value) {<a name="line.818"></a> -<span class="sourceLineNo">819</span> properties.put(HtmlDocSerializerContext.HTMLDOC_cssUrl, value);<a name="line.819"></a> +<span class="sourceLineNo">818</span> public RestResponse setHtmlStyleImport(Object value) {<a name="line.818"></a> +<span class="sourceLineNo">819</span> properties.put(HtmlDocSerializerContext.HTMLDOC_styleImport, value);<a name="line.819"></a> <span class="sourceLineNo">820</span> return this;<a name="line.820"></a> <span class="sourceLineNo">821</span> }<a name="line.821"></a> <span class="sourceLineNo">822</span><a name="line.822"></a> <span class="sourceLineNo">823</span> /**<a name="line.823"></a> -<span class="sourceLineNo">824</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.824"></a> +<span class="sourceLineNo">824</span> * Sets the HTML script section contents.<a name="line.824"></a> <span class="sourceLineNo">825</span> *<a name="line.825"></a> <span class="sourceLineNo">826</span> * <p><a name="line.826"></a> -<span class="sourceLineNo">827</span> * This is the programmatic equivalent to the {@link HtmlDoc#nowrap() @HtmlDoc.nowrap()} annotation.<a name="line.827"></a> +<span class="sourceLineNo">827</span> * The format of this value is Javascript.<a name="line.827"></a> <span class="sourceLineNo">828</span> *<a name="line.828"></a> -<span class="sourceLineNo">829</span> * @param value The new nowrap setting.<a name="line.829"></a> -<span class="sourceLineNo">830</span> * @return This object (for method chaining).<a name="line.830"></a> -<span class="sourceLineNo">831</span> */<a name="line.831"></a> -<span class="sourceLineNo">832</span> public RestResponse setHtmlNoWrap(boolean value) {<a name="line.832"></a> -<span class="sourceLineNo">833</span> properties.put(HtmlDocSerializerContext.HTMLDOC_nowrap, value);<a name="line.833"></a> -<span class="sourceLineNo">834</span> return this;<a name="line.834"></a> -<span class="sourceLineNo">835</span> }<a name="line.835"></a> -<span class="sourceLineNo">836</span><a name="line.836"></a> -<span class="sourceLineNo">837</span> /**<a name="line.837"></a> -<span class="sourceLineNo">838</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.838"></a> -<span class="sourceLineNo">839</span> *<a name="line.839"></a> -<span class="sourceLineNo">840</span> * <p><a name="line.840"></a> -<span class="sourceLineNo">841</span> * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()}<a name="line.841"></a> -<span class="sourceLineNo">842</span> * annotation.<a name="line.842"></a> -<span class="sourceLineNo">843</span> *<a name="line.843"></a> -<span class="sourceLineNo">844</span> * @param value The text to display when serializing an empty array or collection.<a name="line.844"></a> -<span class="sourceLineNo">845</span> * @return This object (for method chaining).<a name="line.845"></a> -<span class="sourceLineNo">846</span> */<a name="line.846"></a> -<span class="sourceLineNo">847</span> public RestResponse setHtmlNoResultsMessage(Object value) {<a name="line.847"></a> -<span class="sourceLineNo">848</span> properties.put(HtmlDocSerializerContext.HTMLDOC_noResultsMessage, value);<a name="line.848"></a> -<span class="sourceLineNo">849</span> return this;<a name="line.849"></a> -<span class="sourceLineNo">850</span> }<a name="line.850"></a> -<span class="sourceLineNo">851</span><a name="line.851"></a> -<span class="sourceLineNo">852</span> /**<a name="line.852"></a> -<span class="sourceLineNo">853</span> * Specifies the template class to use for rendering the HTML page.<a name="line.853"></a> -<span class="sourceLineNo">854</span> *<a name="line.854"></a> -<span class="sourceLineNo">855</span> * <p><a name="line.855"></a> -<span class="sourceLineNo">856</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.856"></a> -<span class="sourceLineNo">857</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.857"></a> -<span class="sourceLineNo">858</span> *<a name="line.858"></a> -<span class="sourceLineNo">859</span> * <p><a name="line.859"></a> -<span class="sourceLineNo">860</span> * This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.<a name="line.860"></a> -<span class="sourceLineNo">861</span> *<a name="line.861"></a> -<span class="sourceLineNo">862</span> * @param value The HTML page template to use to render the HTML page.<a name="line.862"></a> -<span class="sourceLineNo">863</span> * @return This object (for method chaining).<a name="line.863"></a> -<span class="sourceLineNo">864</span> */<a name="line.864"></a> -<span class="sourceLineNo">865</span> public RestResponse setHtmlTemplate(Class<? extends HtmlDocTemplate> value) {<a name="line.865"></a> -<span class="sourceLineNo">866</span> properties.put(HtmlDocSerializerContext.HTMLDOC_template, value);<a name="line.866"></a> -<span class="sourceLineNo">867</span> return this;<a name="line.867"></a> -<span class="sourceLineNo">868</span> }<a name="line.868"></a> -<span class="sourceLineNo">869</span><a name="line.869"></a> -<span class="sourceLineNo">870</span> /**<a name="line.870"></a> -<span class="sourceLineNo">871</span> * Specifies the template class to use for rendering the HTML page.<a name="line.871"></a> -<span class="sourceLineNo">872</span> *<a name="line.872"></a> -<span class="sourceLineNo">873</span> * <p><a name="line.873"></a> -<span class="sourceLineNo">874</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.874"></a> -<span class="sourceLineNo">875</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.875"></a> -<span class="sourceLineNo">876</span> *<a name="line.876"></a> -<span class="sourceLineNo">877</span> * <p><a name="line.877"></a> -<span class="sourceLineNo">878</span> * This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.<a name="line.878"></a> -<span class="sourceLineNo">879</span> *<a name="line.879"></a> -<span class="sourceLineNo">880</span> * @param value The HTML page template to use to render the HTML page.<a name="line.880"></a> -<span class="sourceLineNo">881</span> * @return This object (for method chaining).<a name="line.881"></a> -<span class="sourceLineNo">882</span> */<a name="line.882"></a> -<span class="sourceLineNo">883</span> public RestResponse setHtmlTemplate(HtmlDocTemplate value) {<a name="line.883"></a> -<span class="sourceLineNo">884</span> properties.put(HtmlDocSerializerContext.HTMLDOC_template, value);<a name="line.884"></a> -<span class="sourceLineNo">885</span> return this;<a name="line.885"></a> -<span class="sourceLineNo">886</span> }<a name="line.886"></a> -<span class="sourceLineNo">887</span><a name="line.887"></a> -<span class="sourceLineNo">888</span> @Override /* ServletResponse */<a name="line.888"></a> -<span class="sourceLineNo">889</span> public void flushBuffer() throws IOException {<a name="line.889"></a> -<span class="sourceLineNo">890</span> if (w != null)<a name="line.890"></a> -<span class="sourceLineNo">891</span> w.flush();<a name="line.891"></a> -<span class="sourceLineNo">892</span> if (os != null)<a name="line.892"></a> -<span class="sourceLineNo">893</span> os.flush();<a name="line.893"></a> -<span class="sourceLineNo">894</span> super.flushBuffer();<a name="line.894"></a> -<span class="sourceLineNo">895</span> }<a name="line.895"></a> -<span class="sourceLineNo">896</span>}<a name="line.896"></a> +<span class="sourceLineNo">829</span> * <p><a name="line.829"></a> +<span class="sourceLineNo">830</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.830"></a> +<span class="sourceLineNo">831</span> *<a name="line.831"></a> +<span class="sourceLineNo">832</span> * <p><a name="line.832"></a> +<span class="sourceLineNo">833</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.833"></a> +<span class="sourceLineNo">834</span> *<a name="line.834"></a> +<span class="sourceLineNo">835</span> * <p><a name="line.835"></a> +<span class="sourceLineNo">836</span> * This is the programmatic equivalent to the {@link HtmlDoc#script() @HtmlDoc.script()} annotation.<a name="line.836"></a> +<span class="sourceLineNo">837</span> *<a name="line.837"></a> +<span class="sourceLineNo">838</span> * @param value<a name="line.838"></a> +<span class="sourceLineNo">839</span> * The HTML script section contents.<a name="line.839"></a> +<span class="sourceLineNo">840</span> * Object will be converted to a string using {@link Object#toString()}.<a name="line.840"></a> +<span class="sourceLineNo">841</span> * <p><a name="line.841"></a> +<span class="sourceLineNo">842</span> * <ul class='doctree'><a name="line.842"></a> +<span class="sourceLineNo">843</span> * <li class='info'><a name="line.843"></a> +<span class="sourceLineNo">844</span> * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to<a name="line.844"></a> +<span class="sourceLineNo">845</span> * waste string concatenation cycles on non-HTML views.<a name="line.845"></a> +<span class="sourceLineNo">846</span> * </ul><a name="line.846"></a> +<span class="sourceLineNo">847</span> * @return This object (for method chaining).<a name="line.847"></a> +<span class="sourceLineNo">848</span> */<a name="line.848"></a> +<span class="sourceLineNo">849</span> public RestResponse setHtmlScript(Object value) {<a name="line.849"></a> +<span class="sourceLineNo">850</span> properties.put(HtmlDocSerializerContext.HTMLDOC_script, value);<a name="line.850"></a> +<span class="sourceLineNo">851</span> return this;<a name="line.851"></a> +<span class="sourceLineNo">852</span> }<a name="line.852"></a> +<span class="sourceLineNo">853</span><a name="line.853"></a> +<span class="sourceLineNo">854</span> /**<a name="line.854"></a> +<span class="sourceLineNo">855</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.855"></a> +<span class="sourceLineNo">856</span> *<a name="line.856"></a> +<span class="sourceLineNo">857</span> * <p><a name="line.857"></a> +<span class="sourceLineNo">858</span> * This is the programmatic equivalent to the {@link HtmlDoc#nowrap() @HtmlDoc.nowrap()} annotation.<a name="line.858"></a> +<span class="sourceLineNo">859</span> *<a name="line.859"></a> +<span class="sourceLineNo">860</span> * @param value The new nowrap setting.<a name="line.860"></a> +<span class="sourceLineNo">861</span> * @return This object (for method chaining).<a name="line.861"></a> +<span class="sourceLineNo">862</span> */<a name="line.862"></a> +<span class="sourceLineNo">863</span> public RestResponse setHtmlNoWrap(boolean value) {<a name="line.863"></a> +<span class="sourceLineNo">864</span> properties.put(HtmlDocSerializerContext.HTMLDOC_nowrap, value);<a name="line.864"></a> +<span class="sourceLineNo">865</span> return this;<a name="line.865"></a> +<span class="sourceLineNo">866</span> }<a name="line.866"></a> +<span class="sourceLineNo">867</span><a name="line.867"></a> +<span class="sourceLineNo">868</span> /**<a name="line.868"></a> +<span class="sourceLineNo">869</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.869"></a> +<span class="sourceLineNo">870</span> *<a name="line.870"></a> +<span class="sourceLineNo">871</span> * <p><a name="line.871"></a> +<span class="sourceLineNo">872</span> * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()}<a name="line.872"></a> +<span class="sourceLineNo">873</span> * annotation.<a name="line.873"></a> +<span class="sourceLineNo">874</span> *<a name="line.874"></a> +<span class="sourceLineNo">875</span> * @param value The text to display when serializing an empty array or collection.<a name="line.875"></a> +<span class="sourceLineNo">876</span> * @return This object (for method chaining).<a name="line.876"></a> +<span class="sourceLineNo">877</span> */<a name="line.877"></a> +<span class="sourceLineNo">878</span> public RestResponse setHtmlNoResultsMessage(Object value) {<a name="line.878"></a> +<span class="sourceLineNo">879</span> properties.put(HtmlDocSerializerContext.HTMLDOC_noResultsMessage, value);<a name="line.879"></a> +<span class="sourceLineNo">880</span> return this;<a name="line.880"></a> +<span class="sourceLineNo">881</span> }<a name="line.881"></a> +<span class="sourceLineNo">882</span><a name="line.882"></a> +<span class="sourceLineNo">883</span> /**<a name="line.883"></a> +<span class="sourceLineNo">884</span> * Specifies the template class to use for rendering the HTML page.<a name="line.884"></a> +<span class="sourceLineNo">885</span> *<a name="line.885"></a> +<span class="sourceLineNo">886</span> * <p><a name="line.886"></a> +<span class="sourceLineNo">887</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.887"></a> +<span class="sourceLineNo">888</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.888"></a> +<span class="sourceLineNo">889</span> *<a name="line.889"></a> +<span class="sourceLineNo">890</span> * <p><a name="line.890"></a> +<span class="sourceLineNo">891</span> * This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.<a name="line.891"></a> +<span class="sourceLineNo">892</span> *<a name="line.892"></a> +<span class="sourceLineNo">893</span> * @param value The HTML page template to use to render the HTML page.<a name="line.893"></a> +<span class="sourceLineNo">894</span> * @return This object (for method chaining).<a name="line.894"></a> +<span class="sourceLineNo">895</span> */<a name="line.895"></a> +<span class="sourceLineNo">896</span> public RestResponse setHtmlTemplate(Class<? extends HtmlDocTemplate> value) {<a name="line.896"></a> +<span class="sourceLineNo">897</span> properties.put(HtmlDocSerializerContext.HTMLDOC_template, value);<a name="line.897"></a> +<span class="sourceLineNo">898</span> return this;<a name="line.898"></a> +<span class="sourceLineNo">899</span> }<a name="line.899"></a> +<span class="sourceLineNo">900</span><a name="line.900"></a> +<span class="sourceLineNo">901</span> /**<a name="line.901"></a> +<span class="sourceLineNo">902</span> * Specifies the template class to use for rendering the HTML page.<a name="line.902"></a> +<span class="sourceLineNo">903</span> *<a name="line.903"></a> +<span class="sourceLineNo">904</span> * <p><a name="line.904"></a> +<span class="sourceLineNo">905</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.905"></a> +<span class="sourceLineNo">906</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.906"></a> +<span class="sourceLineNo">907</span> *<a name="line.907"></a> +<span class="sourceLineNo">908</span> * <p><a name="line.908"></a> +<span class="sourceLineNo">909</span> * This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.<a name="line.909"></a> +<span class="sourceLineNo">910</span> *<a name="line.910"></a> +<span class="sourceLineNo">911</span> * @param value The HTML page template to use to render the HTML page.<a name="line.911"></a> +<span class="sourceLineNo">912</span> * @return This object (for method chaining).<a name="line.912"></a> +<span class="sourceLineNo">913</span> */<a name="line.913"></a> +<span class="sourceLineNo">914</span> public RestResponse setHtmlTemplate(HtmlDocTemplate value) {<a name="line.914"></a> +<span class="sourceLineNo">915</span> properties.put(HtmlDocSerializerContext.HTMLDOC_template, value);<a name="line.915"></a> +<span class="sourceLineNo">916</span> return this;<a name="line.916"></a> +<span class="sourceLineNo">917</span> }<a name="line.917"></a> +<span class="sourceLineNo">918</span><a name="line.918"></a> +<span class="sourceLineNo">919</span> @Override /* ServletResponse */<a name="line.919"></a> +<span class="sourceLineNo">920</span> public void flushBuffer() throws IOException {<a name="line.920"></a> +<span class="sourceLineNo">921</span> if (w != null)<a name="line.921"></a> +<span class="sourceLineNo">922</span> w.flush();<a name="line.922"></a> +<span class="sourceLineNo">923</span> if (os != null)<a name="line.923"></a> +<span class="sourceLineNo">924</span> os.flush();<a name="line.924"></a> +<span class="sourceLineNo">925</span> super.flushBuffer();<a name="line.925"></a> +<span class="sourceLineNo">926</span> }<a name="line.926"></a> +<span class="sourceLineNo">927</span>}<a name="line.927"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html index 01a70cf..221910a 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html @@ -156,7 +156,7 @@ <span class="sourceLineNo">148</span> * <h6 class='topic'>Other Notes</h6><a name="line.148"></a> <span class="sourceLineNo">149</span> * <ul class='spaced-list'><a name="line.149"></a> <span class="sourceLineNo">150</span> * <li><a name="line.150"></a> -<span class="sourceLineNo">151</span> * Provides a default HTML stylesheet by setting {@link RestResource#stylesheet() @RestResource.stylesheet()}<a name="line.151"></a> +<span class="sourceLineNo">151</span> * Provides a default HTML stylesheet by setting {@link HtmlDoc#styleImport() @HtmlDoc.styleImport()}<a name="line.151"></a> <span class="sourceLineNo">152</span> * to <js>"styles/juneau.css"</js>.<a name="line.152"></a> <span class="sourceLineNo">153</span> * <li><a name="line.153"></a> <span class="sourceLineNo">154</span> * Provides a default favicon by setting {@link RestResource#favicon() @RestResource.favicon()} to<a name="line.154"></a> @@ -197,35 +197,39 @@ <span class="sourceLineNo">189</span> // Allow &method parameter on safe HTTP methods.<a name="line.189"></a> <span class="sourceLineNo">190</span> @Property(name=REST_allowMethodParam, value="OPTIONS"),<a name="line.190"></a> <span class="sourceLineNo">191</span> },<a name="line.191"></a> -<span class="sourceLineNo">192</span> stylesheet="styles/juneau.css",<a name="line.192"></a> -<span class="sourceLineNo">193</span> htmldoc=@HtmlDoc(<a name="line.193"></a> -<span class="sourceLineNo">194</span> branding="<a href='http://juneau.apache.org'><img src='$U{servlet:/htdocs/juneau.png}' style='position:absolute;top:5;right:5;background-color:transparent;height:30px'></a>"<a name="line.194"></a> +<span class="sourceLineNo">192</span> htmldoc=@HtmlDoc(<a name="line.192"></a> +<span class="sourceLineNo">193</span> branding="<a href='http://juneau.apache.org'><img src='$U{servlet:/htdocs/juneau.png}' style='position:absolute;top:5;right:5;background-color:transparent;height:30px'></a>",<a name="line.193"></a> +<span class="sourceLineNo">194</span> styleImport="servlet:/styles/devops.css"<a name="line.194"></a> <span class="sourceLineNo">195</span> ),<a name="line.195"></a> -<span class="sourceLineNo">196</span> favicon="htdocs/juneau.png",<a name="line.196"></a> -<span class="sourceLineNo">197</span> staticFiles="{htdocs:'htdocs'}"<a name="line.197"></a> -<span class="sourceLineNo">198</span>)<a name="line.198"></a> -<span class="sourceLineNo">199</span>public abstract class RestServletDefault extends RestServlet {<a name="line.199"></a> -<span class="sourceLineNo">200</span> private static final long serialVersionUID = 1L;<a name="line.200"></a> -<span class="sourceLineNo">201</span><a name="line.201"></a> -<span class="sourceLineNo">202</span> /**<a name="line.202"></a> -<span class="sourceLineNo">203</span> * [OPTIONS /*] - Show resource options.<a name="line.203"></a> -<span class="sourceLineNo">204</span> *<a name="line.204"></a> -<span class="sourceLineNo">205</span> * @param req The HTTP request.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * @return A bean containing the contents for the OPTIONS page.<a name="line.206"></a> -<span class="sourceLineNo">207</span> */<a name="line.207"></a> -<span class="sourceLineNo">208</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.208"></a> -<span class="sourceLineNo">209</span> htmldoc=@HtmlDoc(<a name="line.209"></a> -<span class="sourceLineNo">210</span> links="{back:'servlet:/',json:'servlet:/?method=OPTIONS&Accept=text/json&plainText=true'}",<a name="line.210"></a> -<span class="sourceLineNo">211</span> description="Swagger documentation",<a name="line.211"></a> -<span class="sourceLineNo">212</span> aside="NONE"<a name="line.212"></a> -<span class="sourceLineNo">213</span> ),<a name="line.213"></a> -<span class="sourceLineNo">214</span> summary="Resource options",<a name="line.214"></a> -<span class="sourceLineNo">215</span> description="Swagger documentation"<a name="line.215"></a> -<span class="sourceLineNo">216</span> )<a name="line.216"></a> -<span class="sourceLineNo">217</span> public Swagger getOptions(RestRequest req) {<a name="line.217"></a> -<span class="sourceLineNo">218</span> return req.getSwagger();<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">196</span> <a name="line.196"></a> +<span class="sourceLineNo">197</span> // The location on the classpath or file system of the fav-icon.<a name="line.197"></a> +<span class="sourceLineNo">198</span> favicon="htdocs/juneau.png",<a name="line.198"></a> +<span class="sourceLineNo">199</span> <a name="line.199"></a> +<span class="sourceLineNo">200</span> // These are static files that are served up by the servlet under the specified sub-paths.<a name="line.200"></a> +<span class="sourceLineNo">201</span> staticFiles="{htdocs:'htdocs',styles:'styles'}"<a name="line.201"></a> +<span class="sourceLineNo">202</span>)<a name="line.202"></a> +<span class="sourceLineNo">203</span>public abstract class RestServletDefault extends RestServlet {<a name="line.203"></a> +<span class="sourceLineNo">204</span> private static final long serialVersionUID = 1L;<a name="line.204"></a> +<span class="sourceLineNo">205</span><a name="line.205"></a> +<span class="sourceLineNo">206</span> /**<a name="line.206"></a> +<span class="sourceLineNo">207</span> * [OPTIONS /*] - Show resource options.<a name="line.207"></a> +<span class="sourceLineNo">208</span> *<a name="line.208"></a> +<span class="sourceLineNo">209</span> * @param req The HTTP request.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * @return A bean containing the contents for the OPTIONS page.<a name="line.210"></a> +<span class="sourceLineNo">211</span> */<a name="line.211"></a> +<span class="sourceLineNo">212</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.212"></a> +<span class="sourceLineNo">213</span> htmldoc=@HtmlDoc(<a name="line.213"></a> +<span class="sourceLineNo">214</span> links="{back:'servlet:/',json:'servlet:/?method=OPTIONS&Accept=text/json&plainText=true'}",<a name="line.214"></a> +<span class="sourceLineNo">215</span> description="Swagger documentation",<a name="line.215"></a> +<span class="sourceLineNo">216</span> aside="NONE"<a name="line.216"></a> +<span class="sourceLineNo">217</span> ),<a name="line.217"></a> +<span class="sourceLineNo">218</span> summary="Resource options",<a name="line.218"></a> +<span class="sourceLineNo">219</span> description="Swagger documentation"<a name="line.219"></a> +<span class="sourceLineNo">220</span> )<a name="line.220"></a> +<span class="sourceLineNo">221</span> public Swagger getOptions(RestRequest req) {<a name="line.221"></a> +<span class="sourceLineNo">222</span> return req.getSwagger();<a name="line.222"></a> +<span class="sourceLineNo">223</span> }<a name="line.223"></a> +<span class="sourceLineNo">224</span>}<a name="line.224"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html index cc49dc9..c0f36fa 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -368,7 +368,7 @@ <span class="sourceLineNo">360</span> * <p class='bcode'><a name="line.360"></a> <span class="sourceLineNo">361</span> * <ja>@RestResource</ja>(<a name="line.361"></a> <span class="sourceLineNo">362</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.362"></a> -<span class="sourceLineNo">363</span> * css=<js>".red{color:red;}\n.blue{color:blue}"</js><a name="line.363"></a> +<span class="sourceLineNo">363</span> * style=<js>".red{color:red;}\n.blue{color:blue}"</js><a name="line.363"></a> <span class="sourceLineNo">364</span> * )<a name="line.364"></a> <span class="sourceLineNo">365</span> * )<a name="line.365"></a> <span class="sourceLineNo">366</span> * </p><a name="line.366"></a> @@ -381,9 +381,9 @@ <span class="sourceLineNo">373</span> *<a name="line.373"></a> <span class="sourceLineNo">374</span> * <p><a name="line.374"></a> <span class="sourceLineNo">375</span> * The programmatic equivalent to this annotation are the<a name="line.375"></a> -<span class="sourceLineNo">376</span> * {@link RestConfig#setHtmlCss(String)}/{@link RestResponse#setHtmlCss(Object)} methods.<a name="line.376"></a> +<span class="sourceLineNo">376</span> * {@link RestConfig#setHtmlStyle(String)}/{@link RestResponse#setHtmlStyle(Object)} methods.<a name="line.376"></a> <span class="sourceLineNo">377</span> */<a name="line.377"></a> -<span class="sourceLineNo">378</span> String css() default "";<a name="line.378"></a> +<span class="sourceLineNo">378</span> String style() default "";<a name="line.378"></a> <span class="sourceLineNo">379</span><a name="line.379"></a> <span class="sourceLineNo">380</span> /**<a name="line.380"></a> <span class="sourceLineNo">381</span> * Sets the CSS URL in the HTML CSS style section.<a name="line.381"></a> @@ -412,36 +412,63 @@ <span class="sourceLineNo">404</span> *<a name="line.404"></a> <span class="sourceLineNo">405</span> * <p><a name="line.405"></a> <span class="sourceLineNo">406</span> * The programmatic equivalent to this annotation are the<a name="line.406"></a> -<span class="sourceLineNo">407</span> * {@link RestConfig#setHtmlCssUrl(String)}/{@link RestResponse#setHtmlCssUrl(Object)} methods.<a name="line.407"></a> +<span class="sourceLineNo">407</span> * {@link RestConfig#setHtmlStyleImport(String)}/{@link RestResponse#setHtmlStyleImport(Object)} methods.<a name="line.407"></a> <span class="sourceLineNo">408</span> */<a name="line.408"></a> -<span class="sourceLineNo">409</span> String cssUrl() default "servlet:/style.css";<a name="line.409"></a> +<span class="sourceLineNo">409</span> String styleImport() default "";<a name="line.409"></a> <span class="sourceLineNo">410</span><a name="line.410"></a> <span class="sourceLineNo">411</span> /**<a name="line.411"></a> -<span class="sourceLineNo">412</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.412"></a> +<span class="sourceLineNo">412</span> * Sets the HTML script section contents.<a name="line.412"></a> <span class="sourceLineNo">413</span> *<a name="line.413"></a> <span class="sourceLineNo">414</span> * <p><a name="line.414"></a> -<span class="sourceLineNo">415</span> * This only applies to the rendered data portion of the page.<a name="line.415"></a> -<span class="sourceLineNo">416</span> */<a name="line.416"></a> -<span class="sourceLineNo">417</span> boolean nowrap() default false;<a name="line.417"></a> -<span class="sourceLineNo">418</span><a name="line.418"></a> -<span class="sourceLineNo">419</span> /**<a name="line.419"></a> -<span class="sourceLineNo">420</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> String noResultsMessage() default "no results";<a name="line.422"></a> -<span class="sourceLineNo">423</span><a name="line.423"></a> -<span class="sourceLineNo">424</span> /**<a name="line.424"></a> -<span class="sourceLineNo">425</span> * Specifies the template class to use for rendering the HTML page.<a name="line.425"></a> -<span class="sourceLineNo">426</span> *<a name="line.426"></a> -<span class="sourceLineNo">427</span> * <p><a name="line.427"></a> -<span class="sourceLineNo">428</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.428"></a> -<span class="sourceLineNo">429</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.429"></a> -<span class="sourceLineNo">430</span> *<a name="line.430"></a> -<span class="sourceLineNo">431</span> * <p><a name="line.431"></a> -<span class="sourceLineNo">432</span> * The programmatic equivalent to this annotation are the<a name="line.432"></a> -<span class="sourceLineNo">433</span> * {@link RestConfig#setHtmlTemplate(Class)}/{@link RestResponse#setHtmlTemplate(Class)} methods.<a name="line.433"></a> -<span class="sourceLineNo">434</span> */<a name="line.434"></a> -<span class="sourceLineNo">435</span> Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;<a name="line.435"></a> -<span class="sourceLineNo">436</span>}<a name="line.436"></a> +<span class="sourceLineNo">415</span> * The format of this value is Javascript.<a name="line.415"></a> +<span class="sourceLineNo">416</span> *<a name="line.416"></a> +<span class="sourceLineNo">417</span> * <h5 class='section'>Example:</h5><a name="line.417"></a> +<span class="sourceLineNo">418</span> * <p class='bcode'><a name="line.418"></a> +<span class="sourceLineNo">419</span> * <ja>@RestResource</ja>(<a name="line.419"></a> +<span class="sourceLineNo">420</span> * htmldoc=<ja>@HtmlDoc</ja>(<a name="line.420"></a> +<span class="sourceLineNo">421</span> * script=<js>"alert('Hello!')"</js><a name="line.421"></a> +<span class="sourceLineNo">422</span> * )<a name="line.422"></a> +<span class="sourceLineNo">423</span> * )<a name="line.423"></a> +<span class="sourceLineNo">424</span> * </p><a name="line.424"></a> +<span class="sourceLineNo">425</span> *<a name="line.425"></a> +<span class="sourceLineNo">426</span> * <p><a name="line.426"></a> +<span class="sourceLineNo">427</span> * This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.427"></a> +<span class="sourceLineNo">428</span> *<a name="line.428"></a> +<span class="sourceLineNo">429</span> * <p><a name="line.429"></a> +<span class="sourceLineNo">430</span> * A value of <js>"NONE"</js> can be used to force no value.<a name="line.430"></a> +<span class="sourceLineNo">431</span> *<a name="line.431"></a> +<span class="sourceLineNo">432</span> * <p><a name="line.432"></a> +<span class="sourceLineNo">433</span> * The programmatic equivalent to this annotation are the<a name="line.433"></a> +<span class="sourceLineNo">434</span> * {@link RestConfig#setHtmlScript(String)}/{@link RestResponse#setHtmlScript(Object)} methods.<a name="line.434"></a> +<span class="sourceLineNo">435</span> */<a name="line.435"></a> +<span class="sourceLineNo">436</span> String script() default "";<a name="line.436"></a> +<span class="sourceLineNo">437</span><a name="line.437"></a> +<span class="sourceLineNo">438</span> /**<a name="line.438"></a> +<span class="sourceLineNo">439</span> * Shorthand method for forcing the rendered HTML content to be no-wrap.<a name="line.439"></a> +<span class="sourceLineNo">440</span> *<a name="line.440"></a> +<span class="sourceLineNo">441</span> * <p><a name="line.441"></a> +<span class="sourceLineNo">442</span> * This only applies to the rendered data portion of the page.<a name="line.442"></a> +<span class="sourceLineNo">443</span> */<a name="line.443"></a> +<span class="sourceLineNo">444</span> boolean nowrap() default false;<a name="line.444"></a> +<span class="sourceLineNo">445</span><a name="line.445"></a> +<span class="sourceLineNo">446</span> /**<a name="line.446"></a> +<span class="sourceLineNo">447</span> * Specifies the text to display when serializing an empty array or collection.<a name="line.447"></a> +<span class="sourceLineNo">448</span> */<a name="line.448"></a> +<span class="sourceLineNo">449</span> String noResultsMessage() default "no results";<a name="line.449"></a> +<span class="sourceLineNo">450</span><a name="line.450"></a> +<span class="sourceLineNo">451</span> /**<a name="line.451"></a> +<span class="sourceLineNo">452</span> * Specifies the template class to use for rendering the HTML page.<a name="line.452"></a> +<span class="sourceLineNo">453</span> *<a name="line.453"></a> +<span class="sourceLineNo">454</span> * <p><a name="line.454"></a> +<span class="sourceLineNo">455</span> * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom<a name="line.455"></a> +<span class="sourceLineNo">456</span> * renderer or subclasses from the basic class to have full control over how the page is rendered.<a name="line.456"></a> +<span class="sourceLineNo">457</span> *<a name="line.457"></a> +<span class="sourceLineNo">458</span> * <p><a name="line.458"></a> +<span class="sourceLineNo">459</span> * The programmatic equivalent to this annotation are the<a name="line.459"></a> +<span class="sourceLineNo">460</span> * {@link RestConfig#setHtmlTemplate(Class)}/{@link RestResponse#setHtmlTemplate(Class)} methods.<a name="line.460"></a> +<span class="sourceLineNo">461</span> */<a name="line.461"></a> +<span class="sourceLineNo">462</span> Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;<a name="line.462"></a> +<span class="sourceLineNo">463</span>}<a name="line.463"></a>
