HtmlDoc (Apache Juneau 7.1.1)

```
public @interface HtmlDoc
```
Contains all the configurable annotations for the HtmlDocSerializer.
Used with @RestResource.htmldoc() and @RestMethod.htmldoc() to customize the HTML view of serialized POJOs.
All annotations specified here have no effect on any serializers other than HtmlDocSerializer and is provided as a shorthand method of for specifying configuration properties.
For example, the following two methods for defining the HTML nav links are considered equivalent:
// Defined via properties. @RestResource( properties={ @Property(name=HtmlDocSerializer.HTMLDOC_navlinks, value="{options:'?method=OPTIONS',doc:'doc'}") } ) // Defined via annotation. @RestResource( htmldoc=@HtmlDoc( navlinks={ "options: ?method=OPTIONS", "doc: doc" } ) )

The purpose of these annotation is to populate the HTML document view which by default consists of the following structure:
<html> <head> <style type='text/css'> CSS styles and links to stylesheets </style> </head> <body> <header> Page header </header> <nav> Navigation links </nav> <aside> Side-bar text </aside> <article> Contents of serialized object </article> <footer> Footer message </footer> </body> </html>

See Also:
- Overview > juneau-rest-server > @HtmlDoc

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`String[]`	`aside` Sets the HTML aside section contents.
`String[]`	`footer` Sets the HTML footer section contents.
`String[]`	`head` Adds arbitrary content to the HTML <head> element on the page.
`String[]`	`header` Sets the HTML header section contents.
`String[]`	`nav` Sets the HTML nav section contents.
`String[]`	`navlinks` Sets the links in the HTML nav section.
`String`	`noResultsMessage` Specifies the text to display when serializing an empty array or collection.
`boolean`	`nowrap` Shorthand method for forcing the rendered HTML content to be no-wrap.
`String[]`	`script` Sets the HTML script section contents.
`String[]`	`style` Sets the HTML CSS style section contents.
`String[]`	`stylesheet` Sets the CSS URL in the HTML CSS style section.
`Class<? extends HtmlDocTemplate>`	`template` Specifies the template class to use for rendering the HTML page.
`Class<? extends Widget>[]`	`widgets` Configuration property: HTML Widgets.

- Element Detail
  - aside
```
public abstract String[] aside
```
    Sets the HTML aside section contents.
    The aside section typically floats on the right side of the page.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( aside={ "<p>Custom aside content</p>" } ) )
    
    Notes:
    - The format of this value is HTML.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The parent value can be included by adding the literal "INHERIT" as a value.
    - Multiple values are combined with newlines into a single string.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_aside
    - HtmlDocBuilder.aside(Object...)
    Default:
    
    {}
- - footer
```
public abstract String[] footer
```
    Sets the HTML footer section contents.
    The footer section typically floats on the bottom of the page.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( footer={ "<p>Custom footer content</p>" } ) )
    
    Notes:
    - The format of this value is HTML.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The parent value can be included by adding the literal "INHERIT" as a value.
    - Multiple values are combined with newlines into a single string.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_footer
    - HtmlDocBuilder.footer(Object...)
    Default:
    
    {}
- - head
```
public abstract String[] head
```
    Adds arbitrary content to the HTML <head> element on the page.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( head={ // Add a shortcut link in the browser tab "<link rel='icon' href='$U{servlet:/htdocs/mypageicon.ico}'>", // Reload the page every 5 seconds "<meta http-equiv='refresh' content='5'>" } ) )
    
    Notes:
    - The format of this value is HTML.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The head content from the parent can be included by adding the literal "INHERIT" as a value.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_head
    - HtmlDocBuilder.head(Object...)
    Default:
    
    {}
- - header
```
public abstract String[] header
```
    Sets the HTML header section contents.
    The page header normally contains the title and description, but this value can be used to override the contents to be whatever you want.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( header={ "<p>This is my REST interface</p>" } ) )
    
    Notes:
    - The format of this value is HTML.
    - A value of "NONE" can be used to force no header.
    - The parent value can be included by adding the literal "INHERIT" as a value.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - Multiple values are combined with newlines into a single string.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class if not overridden.
    See Also:
    - HtmlDocSerializer.HTMLDOC_header
    - HtmlDocBuilder.header(Object...)
    Default:
    
    {}
- - nav
```
public abstract String[] nav
```
    Sets the HTML nav section contents.
    The nav section of the page contains the links.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( nav={ "<p>Custom nav content</p>" } ) )
    
    Notes:
    - The format of this value is HTML.
    - When a value is specified, the navlinks() value will be ignored.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The parent value can be included by adding the literal "INHERIT" as a value.
    - Multiple values are combined with newlines into a single string.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_nav
    - HtmlDocBuilder.nav(Object...)
    Default:
    
    {}
- - navlinks
```
public abstract String[] navlinks
```
    Sets the links in the HTML nav section.
    The page links are positioned immediately under the title and text.
    The value is an array of strings with two possible values:
    - A key-value pair representing a hyperlink label and href:
      "google: http://google.com"
    - Arbitrary HTML.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( navlinks={ "up: request:/..", "options: servlet:/?method=OPTIONS" } ) )
    
    Notes:
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The parent links can be included by adding the literal "INHERIT" as a value.
      Use the syntax "key[index]: value" or "[index]: value" to specify an index location to place a link inside the list of parent links.
    - Supports URI resolution (e.g. "servlet:/...", "request:/...").
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_navlinks
    - HtmlDocBuilder.navlinks(Object...)
    Default:
    
    {}
- - noResultsMessage
```
public abstract String noResultsMessage
```
    Specifies the text to display when serializing an empty array or collection.
    Notes:
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    See Also:
    - HtmlDocSerializer.HTMLDOC_noResultsMessage
    - HtmlDocBuilder.noResultsMessage(Object)
    Default:
    
    "no results"
- - nowrap
```
public abstract boolean nowrap
```
    Shorthand method for forcing the rendered HTML content to be no-wrap.
    This only applies to the rendered data portion of the page.
    See Also:
    - HtmlDocSerializer.HTMLDOC_nowrap
    - HtmlDocBuilder.nowrap(boolean)
    Default:
    
    false
- - script
```
public abstract String[] script
```
    Sets the HTML script section contents.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( script={ "alert('Hello!')" } ) )
    
    Notes:
    - The format of this value is Javascript.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The parent value can be included by adding the literal "INHERIT" as a value.
    - Multiple values are combined with newlines into a single string.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_script
    - HtmlDocBuilder.script(Object[])
    Default:
    
    {}
- - style
```
public abstract String[] style
```
    Sets the HTML CSS style section contents.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( style={ ".red{color:red;}", ".blue{color:blue;}" } ) )
    
    Notes:
    - The format of this value is CSS.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - A value of "NONE" can be used to force no value.
    - The parent value can be included by adding the literal "INHERIT" as a value.
    - Multiple values are combined with newlines into a single string.
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_style
    - HtmlDocBuilder.style(Object[])
    Default:
    
    {}
- - stylesheet
```
public abstract String[] stylesheet
```
    Sets the CSS URL in the HTML CSS style section.
    Specifies the URL to the stylesheet to add as a link in the style tag in the header.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( stylesheet="http://someOtherHost/stealTheir.css" ) )
    
    Notes:
    - The format of this value is a URL.
    - Supports initialization-time and request-time variables (e.g. "$L{my.localized.variable}").
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    - HtmlDocSerializer.HTMLDOC_stylesheet
    - HtmlDocBuilder.stylesheet(Object[])
    Default:
    
    {}
- - template
```
public abstract Class<? extends HtmlDocTemplate> template
```
    Specifies the template class to use for rendering the HTML page.
    By default, uses HtmlDocTemplateBasic to render the contents, although you can provide your own custom renderer or subclasses from the basic class to have full control over how the page is rendered.
    Notes:
    - On methods, this value is inherited from the @HtmlDoc annotation on the servlet/resource class.
    - On servlet/resource classes, this value is inherited from the @HtmlDoc annotation on the parent class.
    See Also:
    Default:
    
    org.apache.juneau.html.HtmlDocTemplate.class
- - widgets
```
public abstract Class<? extends Widget>[] widgets
```
    Configuration property: HTML Widgets.
    Defines widgets that can be used in conjunction with string variables of the form "$W{name}"to quickly generate arbitrary replacement text.
    Widgets resolve the following variables:
    - "$W{name}" - Contents returned by Widget.getHtml(RestRequest).
    - "$W{name.script}" - Contents returned by Widget.getScript(RestRequest).
      The script contents are automatically inserted into the <head/script> section in the HTML page.
    - "$W{name.style}" - Contents returned by Widget.getStyle(RestRequest).
      The styles contents are automatically inserted into the <head/style> section in the HTML page.
    The following examples shows how to associate a widget with a REST method and then have it rendered in the links and aside section of the page:
    @RestMethod( widgets={ MyWidget.class } htmldoc=@HtmlDoc( navlinks={ "$W{MyWidget}" }, aside={ "Check out this widget: $W{MyWidget}" } ) )
    
    Notes:
    - Widgets are inherited from parent to child, but can be overridden by reusing the widget name.
    - Values are appended to the existing list.
    See Also:
    - Overview > juneau-rest-server > Widgets
    Default:
    
    {}

Annotation Type HtmlDoc

See Also:

Optional Element Summary

Element Detail

aside

Example:

Notes:

See Also:

footer

Example:

Notes:

See Also:

head

Example:

Notes:

See Also:

header

Example:

Notes:

See Also:

nav

Example:

Notes:

See Also:

navlinks

Example:

Notes:

See Also:

noResultsMessage

Notes:

See Also:

nowrap

See Also:

script

Example:

Notes:

See Also:

style

Example:

Notes:

See Also:

stylesheet

Example:

Notes:

See Also:

template

Notes:

See Also:

widgets

Notes:

See Also: