HtmlDocSerializer (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.Context
- - org.apache.juneau.BeanContext
  - - org.apache.juneau.serializer.Serializer
    - - org.apache.juneau.serializer.WriterSerializer
      - org.apache.juneau.xml.XmlSerializer
        
        org.apache.juneau.html.HtmlSerializer
        
        org.apache.juneau.html.HtmlStrippedDocSerializer
        
        org.apache.juneau.html.HtmlDocSerializer

Direct Known Subclasses:

HtmlSchemaDocSerializer
```
public class HtmlDocSerializer
extends HtmlStrippedDocSerializer
```
Serializes POJOs to HTTP responses as HTML documents.
Media types
Handles Accept types: text/html
Produces Content-Type types: text/html
Description
Same as HtmlSerializer, except wraps the response in <html>, <head>, and <body> tags so that it can be rendered in a browser.
Configurable properties are typically specified via @RestResource.properties() and @RestMethod.properties() annotations, although they can also be set programmatically via the RestResponse.setProperty() method.
Example:

@RestResource( messages="nls/AddressBookResource", properties={ @Property(name=HtmlDocSerializer.HTMLDOC_title, value="$L{title}"), @Property(name=HtmlDocSerializer.HTMLDOC_description, value="$L{description}"), @Property(name=HtmlDocSerializer.HTMLDOC_navlinks, value="{options:'?method=OPTIONS',doc:'doc'}") } ) public class AddressBookResource extends BasicRestServletJena {

Note that shortcut annotations are also provided for these particular settings:
@RestResource( messages="nls/AddressBookResource", title="$L{title}", description="$L{description}", htmldoc=@HtmlDoc( navlinks={ "options: ?method=OPTIONS", "doc: doc" } ) )

The $L{...} variable represent localized strings pulled from the resource bundle identified by the messages annotation.
These variables are replaced at runtime based on the HTTP request locale.
Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.juneau.html.HtmlSerializer
  HtmlSerializer.Sq, HtmlSerializer.SqReadable
- Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer
  XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable

Field Summary

Fields
Modifier and Type	Field and Description
`static HtmlDocSerializer`	`DEFAULT` Default serializer, all default settings.
`static String`	`HTMLDOC_aside` Configuration property: Aside section contents.
`static String`	`HTMLDOC_footer` Configuration property: Footer section contents.
`static String`	`HTMLDOC_head` Configuration property: Additional head section content.
`static String`	`HTMLDOC_header` Configuration property: Header section contents.
`static String`	`HTMLDOC_nav` Configuration property: Nav section contents.
`static String`	`HTMLDOC_navlinks` Configuration property: Page navigation links.
`static String`	`HTMLDOC_navlinks_add` Configuration property: Add to the `HTMLDOC_navlinks` property.
`static String`	`HTMLDOC_noResultsMessage` Configuration property: No-results message.
`static String`	`HTMLDOC_nowrap` Configuration property: Prevent word wrap on page.
`static String`	`HTMLDOC_script` Configuration property: Javascript code.
`static String`	`HTMLDOC_script_add` Configuration property: Add to the `HTMLDOC_script` property.
`static String`	`HTMLDOC_style` Configuration property: CSS style code.
`static String`	`HTMLDOC_style_add` Configuration property: Add to the `HTMLDOC_style` property.
`static String`	`HTMLDOC_stylesheet` Configuration property: Stylesheet import URLs.
`static String`	`HTMLDOC_stylesheet_add` Configuration property: Add to the `HTMLDOC_stylesheet` property.
`static String`	`HTMLDOC_template` Configuration property: HTML document template.

Fields inherited from class org.apache.juneau.html.HtmlSerializer
DEFAULT_SQ, DEFAULT_SQ_READABLE, HTML_addBeanTypeProperties, HTML_addKeyValueTableHeaders, HTML_detectLabelParameters, HTML_detectLinksInStrings, HTML_labelParameter, HTML_uriAnchorText

Fields inherited from class org.apache.juneau.xml.XmlSerializer
DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, XML_addBeanTypeProperties, XML_addNamespaceUrisToRoot, XML_autoDetectNamespaces, XML_defaultNamespace, XML_enableNamespaces, XML_namespaces, XML_xsNamespace

Fields inherited from class org.apache.juneau.BeanContext
BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_debug, BEAN_excludeProperties, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors
Constructor and Description
`HtmlDocSerializer(PropertyStore ps)` Constructor.
`HtmlDocSerializer(PropertyStore ps, String produces, String... accept)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectMap`	`asMap()` Returns the properties defined on this bean context as a simple map for debugging purposes.
`HtmlDocSerializerSession`	`createSession(SerializerSessionArgs args)` Create the session object used for actual serialization of objects.

Methods inherited from class org.apache.juneau.html.HtmlSerializer
builder, create, getSchemaSerializer

Methods inherited from class org.apache.juneau.serializer.WriterSerializer
isWriterSerializer, println, serialize, toString, toStringObject

Methods inherited from class org.apache.juneau.serializer.Serializer
createDefaultSessionArgs, createSession, getMediaTypes, getResponseContentType, serialize

Methods inherited from class org.apache.juneau.BeanContext
_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, hasSameCache, isBean, isNotABean, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - HTMLDOC_aside
```
public static final String HTMLDOC_aside
```
    Configuration property: Aside section contents.
    Property:
    - Name: "HtmlDocSerializer.aside.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Allows you to specify the contents of the aside section on the HTML page. The aside section floats on the right of the page for providing content supporting the serialized content of the page.
    By default, the aside section is empty.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( aside={ "<ul>", " <li>Item 1", " <li>Item 2", " <li>Item 3", "</ul>" } ) )
    See Also:
    
    Constant Field Values
  - HTMLDOC_footer
```
public static final String HTMLDOC_footer
```
    Configuration property: Footer section contents.
    Property:
    - Name: "HtmlDocSerializer.footer.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Allows you to specify the contents of the footer section on the HTML page.
    By default, the footer section is empty.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( footer={ "<b>This interface is great!</b>" } ) )
    See Also:
    
    Constant Field Values
  - HTMLDOC_head
```
public static final String HTMLDOC_head
```
    Configuration property: Additional head section content.
    Property:
    - Name: "HtmlDocSerializer.head.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Adds the specified HTML content to the head section of the page.
    Example:
    
    @RestResource( properties={ @Property(name=HtmlDocSerializer.HTMLDOC_links, value="['<link rel=\"icon\" href=\"htdocs/mypageicon.ico\">']") } )
    
    A shortcut on @RestResource is also provided for this setting:
    @RestResource( htmldoc=@HtmlDoc( head={ "<link rel='icon' href='$U{servlet:/htdocs/mypageicon.ico}'>" } ) )
    See Also:
    
    Constant Field Values
  - HTMLDOC_header
```
public static final String HTMLDOC_header
```
    Configuration property: Header section contents.
    Property:
    - Name: "HtmlDocSerializer.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Allows you to override the contents of the header section on the HTML page. The header section normally contains the title and description at the top of the page.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( header={ "<h1>My own header</h1>" } ) )
    See Also:
    
    Constant Field Values
  - HTMLDOC_nav
```
public static final String HTMLDOC_nav
```
    Configuration property: Nav section contents.
    Property:
    - Name: "HtmlDocSerializer.nav.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Allows you to override the contents of the nav section on the HTML page. The nav section normally contains the page links at the top of the page.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( nav={ "<p class='special-navigation'>This is my special navigation content</p>" } ) )
    
    When this property is specified, the HTMLDOC_navlinks property is ignored.
    See Also:
    
    Constant Field Values
  - HTMLDOC_navlinks
```
public static final String HTMLDOC_navlinks
```
    Configuration property: Page navigation links.
    Property:
    - Name: "HtmlDocSerializer.navlinks.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Adds a list of hyperlinks immediately under the title and description but above the content of the page.
    This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.
    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.
    Relative URLs are considered relative to the servlet path. For example, if the servlet path is "http://localhost/myContext/myServlet", and the URL is "foo", the link becomes "http://localhost/myContext/myServlet/foo". Absolute ("/myOtherContext/foo") and fully-qualified ("http://localhost2/foo") URLs can also be used in addition to various other protocols specified by UriResolver such as "servlet:/...".
    Example:
    
    The AddressBookResource sample class uses this property...
    @RestResource( properties={ @Property(name=HtmlDocSerializer.HTMLDOC_navlinks, value="['options: ?method=OPTIONS', 'doc: doc']") } ) public class AddressBookResource extends BasicRestServletJena {
    
    ...to produce this list of links on the HTML page...
    A shortcut on @RestResource is also provided for this setting:
    @RestResource( htmldoc=@HtmlDoc( navlinks={ "options: ?method=OPTIONS", "doc: doc" } ) ) public class AddressBookResource extends BasicRestServletJena {
    See Also:
    
    Constant Field Values
  - HTMLDOC_navlinks_add
```
public static final String HTMLDOC_navlinks_add
```
    Configuration property: Add to the HTMLDOC_navlinks property.
    
    See Also:
    
    Constant Field Values
  - HTMLDOC_noResultsMessage
```
public static final String HTMLDOC_noResultsMessage
```
    Configuration property: No-results message.
    Property:
    - Name: "HtmlDocSerializer.noResultsMessage.s"
    - Data type: String
    - Default: "<p>no results</p>"
    - Session-overridable: true
    Description:
    
    Allows you to specify the string message used when trying to serialize an empty array or empty list.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( noResultsMessage="<b>This interface is great!</b>" ) )
    
    A value of "NONE" can be used to represent no value to differentiate it from an empty string.
    See Also:
    
    Constant Field Values
  - HTMLDOC_nowrap
```
public static final String HTMLDOC_nowrap
```
    Configuration property: Prevent word wrap on page.
    Property:
    - Name: "HtmlDocSerializer.nowrap.b"
    - Data type: Boolean
    - Default: false
    - Session-overridable: true
    Description:
    
    Adds "* {white-space:nowrap}" to the CSS instructions on the page to prevent word wrapping.
    See Also:
    
    Constant Field Values
  - HTMLDOC_script
```
public static final String HTMLDOC_script
```
    Configuration property: Javascript code.
    Property:
    - Name: "HtmlDocSerializer.script.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Adds the specified Javascript code to the HTML page.
    Example:
    
    @RestResource( properties={ @Property(name=HtmlDocSerializer.HTMLDOC_script, value="alert('hello!');") } )
    
    A shortcut on @RestResource is also provided for this setting:
    @RestResource( htmldoc=@HtmlDoc( script={ "alert('hello!');" } ) )
    See Also:
    
    Constant Field Values
  - HTMLDOC_script_add
```
public static final String HTMLDOC_script_add
```
    Configuration property: Add to the HTMLDOC_script property.
    
    See Also:
    
    Constant Field Values
  - HTMLDOC_style
```
public static final String HTMLDOC_style
```
    Configuration property: CSS style code.
    Property:
    - Name: "HtmlDocSerializer.style.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Adds the specified CSS instructions to the HTML page.
    Example:
    
    @RestResource( properties={ @Property(name=HtmlDocSerializer.HTMLDOC_style, value="h3 { color: red; }\nh5 { font-weight: bold; }") } )
    
    A shortcut on @RestResource is also provided for this setting:
    @RestResource( htmldoc=@HtmlDoc( style={ "h3 { color: red; }", "h5 { font-weight: bold; }" } ) )
    See Also:
    
    Constant Field Values
  - HTMLDOC_style_add
```
public static final String HTMLDOC_style_add
```
    Configuration property: Add to the HTMLDOC_style property.
    
    See Also:
    
    Constant Field Values
  - HTMLDOC_stylesheet
```
public static final String HTMLDOC_stylesheet
```
    Configuration property: Stylesheet import URLs.
    Property:
    - Name: "HtmlDocSerializer.stylesheet.ls"
    - Data type: List<String>
    - Default: empty list
    - Session-overridable: true
    Description:
    
    Adds a link to the specified stylesheet URL.
    Note that this stylesheet is controlled by the @RestResource.stylesheet() annotation.
    See Also:
    
    Constant Field Values
  - HTMLDOC_stylesheet_add
```
public static final String HTMLDOC_stylesheet_add
```
    Configuration property: Add to the HTMLDOC_stylesheet property.
    
    See Also:
    
    Constant Field Values
  - HTMLDOC_template
```
public static final String HTMLDOC_template
```
    Configuration property: HTML document template.
    Property:
    - Name: "HtmlDocSerializer.template.c"
    - Data type: Class<? extends HtmlDocTemplate>
    - Default: HtmlDocTemplateBasic.class
    - Session-overridable: true
    Description:
    
    Specifies the template to use for serializing the page.
    By default, the HtmlDocTemplateBasic class is used to construct the contents of the HTML page, but can be overridden with your own custom implementation class.
    Example:
    
    @RestResource( htmldoc=@HtmlDoc( template=MySpecialDocTemplate.class ) )
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final HtmlDocSerializer DEFAULT
```
    Default serializer, all default settings.
- Constructor Detail
  - HtmlDocSerializer
```
public HtmlDocSerializer(PropertyStore ps)
```
    Constructor.
    
    Parameters:
    
    ps - The property store containing all the settings for this object.
  - HtmlDocSerializer
```
public HtmlDocSerializer(PropertyStore ps,
                         String produces,
                         String... accept)
```
    Constructor.
    
    Parameters:
    
    ps - The property store containing all the settings for this object.
    
    produces - The media type that this serializer produces.
    
    accept - The accept media types that the serializer can handle.
    Can contain meta-characters per the media-type specification of RFC2616/14.1
    If empty, then assumes the only media type supported is produces.
    For example, if this serializer produces "application/json" but should handle media types of "application/json" and "text/json", then the arguments should be:
    super(ps, "application/json", "application/json", "text/json");
    
    ...or...
    super(ps, "application/json", "*/json");
- Method Detail
  - createSession
```
public HtmlDocSerializerSession createSession(SerializerSessionArgs args)
```
    Description copied from class: Serializer
    
    Create the session object used for actual serialization of objects.
    
    Overrides:
    
    createSession in class HtmlStrippedDocSerializer
    
    Parameters:
    
    args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.
    
    Returns:
    
    The new session object.
  - asMap
```
public ObjectMap asMap()
```
    Description copied from class: Context
    
    Returns the properties defined on this bean context as a simple map for debugging purposes.
    
    Overrides:
    
    asMap in class HtmlSerializer
    
    Returns:
    
    A new map containing the properties defined on this context.

Class HtmlDocSerializer

Media types

Description

Example:

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.html.HtmlSerializer

Nested classes/interfaces inherited from class org.apache.juneau.xml.XmlSerializer

Field Summary

Fields inherited from class org.apache.juneau.html.HtmlSerializer

Fields inherited from class org.apache.juneau.xml.XmlSerializer

Fields inherited from class org.apache.juneau.serializer.Serializer

Fields inherited from class org.apache.juneau.BeanContext

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.html.HtmlSerializer

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

Methods inherited from class org.apache.juneau.serializer.Serializer

Methods inherited from class org.apache.juneau.BeanContext

Methods inherited from class org.apache.juneau.Context

Methods inherited from class java.lang.Object

Field Detail

HTMLDOC_aside

Property:

Description:

Example:

HTMLDOC_footer

Property:

Description:

Example:

HTMLDOC_head

Property:

Description:

Example:

HTMLDOC_header

Property:

Description:

Example:

HTMLDOC_nav

Property:

Description:

Example:

HTMLDOC_navlinks

Property:

Description:

Example:

HTMLDOC_navlinks_add

HTMLDOC_noResultsMessage

Property:

Description:

Example:

HTMLDOC_nowrap

Property:

Description:

HTMLDOC_script

Property:

Description:

Example:

HTMLDOC_script_add

HTMLDOC_style

Property:

Description:

Example:

HTMLDOC_style_add

HTMLDOC_stylesheet

Property:

Description:

HTMLDOC_stylesheet_add

HTMLDOC_template

Property:

Description:

Example:

DEFAULT

Constructor Detail

HtmlDocSerializer

HtmlDocSerializer

Method Detail

createSession

asMap