http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html index 3b15785..8067faf 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -131,8 +131,8 @@ </head> <body> <header> - <h3 <xa>class</xa>=<xs>'title'</xs>><xv>Page title</xv></h3> - <h5 <xa>class</xa>=<xs>'description'</xs>><xv>Page description</xv></h5> + <h1><xv>Page title</xv></h1> + <h2><xv>Page description</xv></h2> <xv>Arbitrary page branding</xv> </header> <nav> @@ -169,13 +169,13 @@ <th class="colLast" scope="col">Optional Element and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#aside--">aside</a></span></code> <div class="block">Sets the HTML aside section contents.</div> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#branding--">branding</a></span></code> <div class="block">Sets the HTML page branding in the header section of the page generated by the default HTML doc template.</div> </td> @@ -187,25 +187,25 @@ </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#footer--">footer</a></span></code> <div class="block">Sets the HTML footer section contents.</div> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#header--">header</a></span></code> <div class="block">Sets the HTML header section contents.</div> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#links--">links</a></span></code> <div class="block">Sets the links in the HTML nav section.</div> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#nav--">nav</a></span></code> <div class="block">Sets the HTML nav section contents.</div> </td> @@ -223,13 +223,13 @@ </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#script--">script</a></span></code> <div class="block">Sets the HTML script section contents.</div> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#style--">style</a></span></code> <div class="block">Sets the HTML CSS style section contents.</div> </td> @@ -280,7 +280,7 @@ The format of this value is HTML (phrasing content only). <p> - It gets wrapped in a <code><xt><h3> <xa>class</xa>=<xs>'title'</xs>></xt></code> element and then added + It gets wrapped in a <code><xt><h1></xt></code> element and then added to the <code><xt><header></code> section on the page. <p> @@ -335,7 +335,7 @@ The format of this value is HTML (phrasing content only). <p> - It gets wrapped in a <code><xt><h5> <xa>class</xa>=<xs>'description'</xs>></xt></code> element and then + It gets wrapped in a <code><xt><h2></xt></code> element and then added to the <code><xt><header></code> section on the page. <p> @@ -385,7 +385,7 @@ <ul class="blockList"> <li class="blockList"> <h4>branding</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.187">branding</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.190">branding</a></pre> <div class="block">Sets the HTML page branding in the header section of the page generated by the default HTML doc template. <p> @@ -401,11 +401,14 @@ A value of <js>"NONE"</js> can be used to force no value. <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlBranding-java.lang.String-"><code>RestConfig.setHtmlBranding(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlBranding-java.lang.Object-"><code>RestResponse.setHtmlBranding(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -418,7 +421,7 @@ <ul class="blockList"> <li class="blockList"> <h4>header</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.221">header</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.229">header</a></pre> <div class="block">Sets the HTML header section contents. <p> @@ -432,7 +435,9 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - header=<js>"<p>This is my REST interface</p>"</js> + header={ + <js>"<p>This is my REST interface</p>"</js> + } ) ) </p> @@ -447,11 +452,14 @@ This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlHeader-java.lang.String-"><code>RestConfig.setHtmlHeader(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlHeader-java.lang.Object-"><code>RestResponse.setHtmlHeader(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -464,12 +472,16 @@ <ul class="blockList"> <li class="blockList"> <h4>links</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.255">links</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.270">links</a></pre> <div class="block">Sets the links in the HTML nav section. <p> - The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are - relative (to the servlet) or absolute URLs. + The value is an array of strings with two possible values: + <ul> + <li>A key-value pair representing a hyperlink label and href: + <br><js>"google: http://google.com";</js> + <li>Arbitrary HTML. + </ul> <p> The page links are positioned immediately under the title and text. @@ -478,7 +490,10 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS'}"</js> + links={ + <js>"up: request:/.."</js>, + <js>"options: servlet:/?method=OPTIONS"</js> + } ) ) </p> @@ -494,10 +509,10 @@ <p> The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlLinks-java.lang.String-"><code>RestConfig.setHtmlLinks(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.Object-"><code>RestResponse.setHtmlLinks(Object)</code></a> methods.</div> + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlLinks-java.lang.String:A-"><code>RestConfig.setHtmlLinks(String[])</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.String:A-"><code>RestResponse.setHtmlLinks(String[])</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -510,7 +525,7 @@ <ul class="blockList"> <li class="blockList"> <h4>nav</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.291">nav</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.311">nav</a></pre> <div class="block">Sets the HTML nav section contents. <p> @@ -526,7 +541,9 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - nav=<js>"<p>Custom nav content</p>"</js> + nav={ + <js>"<p>Custom nav content</p>"</js> + } ) ) </p> @@ -541,11 +558,14 @@ A value of <js>"NONE"</js> can be used to force no value. <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlNav-java.lang.String-"><code>RestConfig.setHtmlNav(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNav-java.lang.Object-"><code>RestResponse.setHtmlNav(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -558,7 +578,7 @@ <ul class="blockList"> <li class="blockList"> <h4>aside</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.321">aside</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.346">aside</a></pre> <div class="block">Sets the HTML aside section contents. <p> @@ -571,7 +591,9 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - aside=<js>"<p>Custom aside content</p>"</js> + aside={ + <js>"<p>Custom aside content</p>"</js> + } ) ) </p> @@ -583,11 +605,14 @@ A value of <js>"NONE"</js> can be used to force no value. <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlAside-java.lang.String-"><code>RestConfig.setHtmlAside(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlAside-java.lang.Object-"><code>RestResponse.setHtmlAside(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -600,7 +625,7 @@ <ul class="blockList"> <li class="blockList"> <h4>footer</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.351">footer</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.381">footer</a></pre> <div class="block">Sets the HTML footer section contents. <p> @@ -613,7 +638,9 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - footer=<js>"<p>Custom footer content</p>"</js> + footer={ + <js>"<p>Custom footer content</p>"</js> + } ) ) </p> @@ -625,11 +652,14 @@ A value of <js>"NONE"</js> can be used to force no value. <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlFooter-java.lang.String-"><code>RestConfig.setHtmlFooter(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlFooter-java.lang.Object-"><code>RestResponse.setHtmlFooter(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -642,7 +672,7 @@ <ul class="blockList"> <li class="blockList"> <h4>style</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.378">style</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.414">style</a></pre> <div class="block">Sets the HTML CSS style section contents. <p> @@ -652,7 +682,10 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - style=<js>".red{color:red;}\n.blue{color:blue}"</js> + style={ + <js>".red{color:red;}"</js>, + <js>".blue{color:blue;}"</js> + } ) ) </p> @@ -664,11 +697,14 @@ A value of <js>"NONE"</js> can be used to force no value. <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStyle-java.lang.String-"><code>RestConfig.setHtmlStyle(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStyle-java.lang.Object-"><code>RestResponse.setHtmlStyle(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -681,7 +717,7 @@ <ul class="blockList"> <li class="blockList"> <h4>stylesheet</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.409">stylesheet</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.445">stylesheet</a></pre> <div class="block">Sets the CSS URL in the HTML CSS style section. <p> @@ -724,7 +760,7 @@ <ul class="blockList"> <li class="blockList"> <h4>script</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.436">script</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.477">script</a></pre> <div class="block">Sets the HTML script section contents. <p> @@ -734,7 +770,9 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - script=<js>"alert('Hello!')"</js> + script={ + <js>"alert('Hello!')"</js> + } ) ) </p> @@ -746,11 +784,14 @@ A value of <js>"NONE"</js> can be used to force no value. <p> + Multiple values are combined with newlines into a single string. + + <p> The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlScript-java.lang.String-"><code>RestConfig.setHtmlScript(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlScript-java.lang.Object-"><code>RestResponse.setHtmlScript(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>""</dd> +<dd>{}</dd> </dl> </li> </ul> @@ -763,7 +804,7 @@ <ul class="blockList"> <li class="blockList"> <h4>nowrap</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.444">nowrap</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.485">nowrap</a></pre> <div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. <p> @@ -783,7 +824,7 @@ <ul class="blockList"> <li class="blockList"> <h4>noResultsMessage</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.449">noResultsMessage</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.490">noResultsMessage</a></pre> <div class="block">Specifies the text to display when serializing an empty array or collection.</div> <dl> <dt>Default:</dt> @@ -800,7 +841,7 @@ <ul class="blockListLast"> <li class="blockList"> <h4>template</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.462">template</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.503">template</a></pre> <div class="block">Specifies the template class to use for rendering the HTML page. <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html index 4e97773..81913c1 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -1330,7 +1330,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>htmldoc</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.727">htmldoc</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.732">htmldoc</a></pre> <div class="block">Provides HTML-doc-specific metadata on this method. <p> @@ -1344,19 +1344,24 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota // "servlet:/..." URIs are relative to the servlet URI. // "$C{...}" variables are pulled from the config file.</jc> htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS',source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js>, - aside=<js>""</js> - + <js>"<div style='max-width:400px;min-width:200px'>"</js> - + <js>" <p>Proof-of-concept resource that shows off the capabilities of working with POJO resources.</p>"</js> - + <js>" <p>Provides examples of: </p>"</js> - + <js>" <ul>"</js> - + <js>" <li>XML and RDF namespaces"</js> - + <js>" <li>Swagger documentation"</js> - + <js>" <li>Widgets"</js> - + <js>" </ul>"</js> - + <js>" <p style='text-weight:bold;text-decoration:underline;'>Available Content Types</p>"</js> - + <js>" $W{contentTypeLinks}"</js> - + <js>"</div>"</js>, + links={ + <js>"up: request:/.."</js>, + <js>"options: servlet:/?method=OPTIONS"</js>, + <js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java"</js>, + }, + aside={ + <js>"<div style='max-width:400px;min-width:200px'>"</js>, + <js>" <p>Proof-of-concept resource that shows off the capabilities of working with POJO resources.</p>"</js>, + <js>" <p>Provides examples of: </p>"</js>, + <js>" <ul>"</js>, + <js>" <li>XML and RDF namespaces"</js>, + <js>" <li>Swagger documentation"</js>, + <js>" <li>Widgets"</js>, + <js>" </ul>"</js>, + <js>" <p style='text-weight:bold;text-decoration:underline;'>Available Content Types</p>"</js>, + <js>" $W{contentTypeLinks}"</js>, + <js>"</div>"</js> + }, footer=<js>"$W{poweredByJuneau}"</js> ), http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html index 12df8ff..1c461e8 100644 --- a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html @@ -429,10 +429,10 @@ extends <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title=" <h4>getOptions</h4> <pre><a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation">@RestMethod</a>(<a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#name--">name</a>="OPTIONS", <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#path--">path</a>="/*", + <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--">htmldoc</a>=, <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#summary--">summary</a>="Resource options", - <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Resource options", - <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--">htmldoc</a>=) -public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.270">getOptions</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> + <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Swagger documentation") +public <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.275">getOptions</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> <div class="block">[OPTIONS /*] - Show resource options.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/package-summary.html index 30a380f..6899a3c 100644 --- a/content/site/apidocs/org/apache/juneau/rest/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/package-summary.html @@ -549,7 +549,10 @@ <ja>@RestResource</ja>( messages=<js>"nls/HelloWorldResource"</js>, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS'}"</js> + links={ + <js>"up: request:/.."</js>, + <js>"options: servlet:/?method=OPTIONS"</js> + } ) ) <jk>public class</jk> HelloWorldResource <jk>extends</jk> Resource { @@ -1493,7 +1496,10 @@ <ja>@RestMethod</ja>(name=<js>"OPTIONS"</js>, path=<js>"/*"</js>, summary=<js>"Resource options"</js>, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{back:'$R{servletURI}'}"</js> + links={ + <js>"back: servlet:/,"</js>, + <js>"json: servlet:/?method=OPTIONS&Accept=text/json&plainText=true"</js> + } ) ) <jk>public</jk> Swagger getOptions(RestRequest req) { @@ -2628,6 +2634,7 @@ </p> <h6 class='figure'>Contents of org/apache/juneau/server/samples/UrlEncodedForm.html</h6> + <b>TODO - Needs update</b> <p class='bcode'> <xt><html></xt> <xt><head></xt> @@ -2636,8 +2643,8 @@ <xt></style></xt> <xt></head></xt> <xt><body></xt> - <xt><h3</xt> <xa>class</xa>=<xs>'title'</xs><xt>></xt>$R{servletTitle}<xt></h3></xt> - <xt><h5</xt> <xa>class</xa>=<xs>"description"</xs><xt>></xt>$R{servletDescription}<xt></h5></xt> + <xt><h1></xt>$R{servletTitle}<xt></h1></xt> + <xt><h2></xt>$R{servletDescription}<xt></h2></xt> <xt><div</xt> <xa>class</xa>=<xs>'data'</xs><xt>></xt> <xt><form</xt> <xa>id</xa>=<xs>'form'</xs> <xa>action</xa>=<xs>'$R{servletURI}'</xs> <xa>method</xa>=<xs>'POST'</xs><xt>></xt> <xt><table></xt> @@ -2674,7 +2681,10 @@ title=<js>"URL-encoded Form Post Resource"</js>, description=<js>"Shows how form posts are converted into beans."</js>, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'request:/..',options:'servlet:/?method=OPTIONS'}"</js> + links={ + <js>"up: request:/.."</js>, + <js>"options: servlet:/?method=OPTIONS"</js> + } ) ) <jk>public class</jk> UrlEncodedFormResource <jk>extends</jk> Resource { @@ -3433,7 +3443,9 @@ title=<js>"Photo REST service"</js>, description=<js>"Use a tool like Poster to upload and retrieve jpeg and png images."</js>, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{options:'?method=OPTIONS'}"</js> + links={ + <js>"options: ?method=OPTIONS"</js> + } ) ) <jk>public class</jk> PhotosResource <jk>extends</jk> RestServletDefault { @@ -3743,8 +3755,12 @@ // "servlet:/..." URIs are relative to the servlet URI. // "$C{...}" variables are pulled from the config file.</jc> htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'request:/..', options:'servlet:/?method=OPTIONS', source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js> - + links={ + <js>"up: request:/.."</js>, + <js>"options: servlet:/?method=OPTIONS"</js>, + <js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java"</js> + }, + <jc>// Our stylesheet for the HTML rendition.</jc> stylesheet=<js>"servlet:/styles/devops.css"</js>, ), http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html b/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html index 6eff689..ba2a2cb 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/ContentTypeMenuItem.html @@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.48">ContentTypeMenuItem</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.56">ContentTypeMenuItem</a> extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.html" title="class in org.apache.juneau.rest.widget">MenuItemWidget</a></pre> <div class="block">Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types. @@ -136,7 +136,14 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm ContentTypeMenuItem.<jk>class</jk>, }, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'...',options:'...',query:'...',contentTypes:'$W{contentTypeMenuItem}',source:'...'}"</js> + links={ + <js>"up: ..."</js>, + <js>"options: ..."</js>, + <js>"$W{queryMenuItem}"</js>, + <js>"$W{contentTypeMenuItem}"</js>, + <js>"$W{styleMenuItem}"</js>, + <js>"source: ..."</js> + } ) ) <jk>public</jk> Collection<Pet> getPets() { @@ -235,7 +242,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockListLast"> <li class="blockList"> <h4>ContentTypeMenuItem</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.48">ContentTypeMenuItem</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.56">ContentTypeMenuItem</a>()</pre> </li> </ul> </li> @@ -252,7 +259,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.54">getName</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.62">getName</a>()</pre> <div class="block">Returns <js>"contentTypeMenuItem"</js>.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -268,7 +275,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockListLast"> <li class="blockList"> <h4>getHtml</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.63">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/ContentTypeMenuItem.html#line.71">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Looks at the supported media types from the request and constructs a list of hyperlinks to render the data as plain-text.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/widget/QueryMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/QueryMenuItem.html b/content/site/apidocs/org/apache/juneau/rest/widget/QueryMenuItem.html index e260c5c..4bc6ff4 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/QueryMenuItem.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/QueryMenuItem.html @@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.60">QueryMenuItem</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.67">QueryMenuItem</a> extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.html" title="class in org.apache.juneau.rest.widget">MenuItemWidget</a></pre> <div class="block">Widget that returns a menu-item drop-down form for entering search/view/sort arguments. @@ -141,7 +141,14 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm QueryMenuItem.<jk>class</jk>, }, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'...',options:'...',query:'$W{queryMenuItem}',contentTypes:'...',source:'...'}"</js> + links={ + <js>"up: ..."</js>, + <js>"options: ..."</js>, + <js>"$W{queryMenuItem}"</js>, + <js>"$W{contentTypeMenuItem}"</js>, + <js>"$W{styleMenuItem}"</js>, + <js>"source: ..."</js> + } ), converters=Queryable.<jk>class</jk> ) @@ -255,7 +262,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockListLast"> <li class="blockList"> <h4>QueryMenuItem</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.60">QueryMenuItem</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.67">QueryMenuItem</a>()</pre> </li> </ul> </li> @@ -272,7 +279,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.66">getName</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.73">getName</a>()</pre> <div class="block">Returns <js>"queryMenuItem"</js>.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -288,7 +295,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockList"> <li class="blockList"> <h4>getStyle</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.74">getStyle</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.81">getStyle</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Returns CSS for the tooltips.</div> <dl> @@ -309,7 +316,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockListLast"> <li class="blockList"> <h4>getHtml</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.84">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/QueryMenuItem.html#line.91">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Returns the HTML for rendering the query form and tooltips.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/widget/StyleMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/StyleMenuItem.html b/content/site/apidocs/org/apache/juneau/rest/widget/StyleMenuItem.html index e7e98f4..7a694cf 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/StyleMenuItem.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/StyleMenuItem.html @@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.41">StyleMenuItem</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.48">StyleMenuItem</a> extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.html" title="class in org.apache.juneau.rest.widget">MenuItemWidget</a></pre> <div class="block">Widget that returns back a list of hyperlinks for rendering the contents of a page in the various default styles. @@ -136,7 +136,14 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm StyleMenuItem.<jk>class</jk>, }, htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{up:'...',options:'...',query:'...',contentTypes:'...',style='$W{styleMenuItem}',source:'...'}"</js> + links={ + <js>"up: ..."</js>, + <js>"options: ..."</js>, + <js>"$W{queryMenuItem}"</js>, + <js>"$W{contentTypeMenuItem}"</js>, + <js>"$W{styleMenuItem}"</js>, + <js>"source: ..."</js> + } ) ) <jk>public</jk> Collection<Pet> getPets() { @@ -231,7 +238,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockListLast"> <li class="blockList"> <h4>StyleMenuItem</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.41">StyleMenuItem</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.48">StyleMenuItem</a>()</pre> </li> </ul> </li> @@ -248,7 +255,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.49">getName</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.56">getName</a>()</pre> <div class="block">Returns <js>"styleMenuItem"</js>.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -264,7 +271,7 @@ extends <a href="../../../../../org/apache/juneau/rest/widget/MenuItemWidget.htm <ul class="blockListLast"> <li class="blockList"> <h4>getHtml</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.58">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/StyleMenuItem.html#line.65">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Looks at the supported media types from the request and constructs a list of hyperlinks to render the data as plain-text.</div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/03d6af50/content/site/apidocs/org/apache/juneau/rest/widget/Widget.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/widget/Widget.html b/content/site/apidocs/org/apache/juneau/rest/widget/Widget.html index fbaad44..33ef211 100644 --- a/content/site/apidocs/org/apache/juneau/rest/widget/Widget.html +++ b/content/site/apidocs/org/apache/juneau/rest/widget/Widget.html @@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.116">Widget</a> +<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.120">Widget</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Defines an interface for resolvers of <js>"$W{...}"</js> string variables. @@ -143,8 +143,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? MyWidget.<jk>class</jk> } htmldoc=<ja>@HtmlDoc</ja>( - links=<js>"{mylink:'$W{myWidget}'}"</js>, - aside=<js>"Check out this widget: $W{myWidget}"</js> + links={ + <js>"$W{myWidget}"</js> + }, + aside={ + <js>"Check out this widget: $W{myWidget}"</js> + } ) ) </p> @@ -327,7 +331,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>Widget</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.116">Widget</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.120">Widget</a>()</pre> </li> </ul> </li> @@ -344,7 +348,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.131">getName</a>()</pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.135">getName</a>()</pre> <div class="block">The widget key. <p> @@ -364,7 +368,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getHtml</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.143">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.147">getHtml</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Resolves the HTML content for this widget. @@ -386,7 +390,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getScript</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.157">getScript</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.161">getScript</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Resolves any Javascript that should be added to the <xt><head>/<script></xt> element. @@ -408,7 +412,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getStyle</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.171">getStyle</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.175">getStyle</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Resolves any CSS styles that should be added to the <xt><head>/<style></xt> element. @@ -430,7 +434,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getResourceAsString</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.190">getResourceAsString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.194">getResourceAsString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Retrieves the specified classpath resource and returns the contents as a string. @@ -457,7 +461,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getResourceAsString</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.213">getResourceAsString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.217">getResourceAsString</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Same as <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-"><code>getResourceAsString(String)</code></a> except also looks for localized-versions of the file. @@ -488,7 +492,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>loadScript</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.228">loadScript</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.232">loadScript</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Convenience method for calling <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-"><code>getResourceAsString(String)</code></a> except also strips Javascript comments from the file. @@ -511,7 +515,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>loadStyle</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.246">loadStyle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.250">loadStyle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Convenience method for calling <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-"><code>getResourceAsString(String)</code></a> except also strips CSS comments from the file. @@ -534,7 +538,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>loadHtml</h4> -<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.264">loadHtml</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/rest/widget/Widget.html#line.268">loadHtml</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Convenience method for calling <a href="../../../../../org/apache/juneau/rest/widget/Widget.html#getResourceAsString-java.lang.String-"><code>getResourceAsString(String)</code></a> except also strips HTML comments from the file.
