HtmlDocTemplate (Apache Juneau 7.1.1)

All Known Implementing Classes:

HtmlDocTemplateBasic
```
public interface HtmlDocTemplate
```
Defines the interface for rendering the contents of an HTML page produced by the HtmlDocSerializer serializer.
The HTML doc serializer produces the following document structure with the typical contents:
<html> <head> <style> CSS styles and links to stylesheets </style> <script> Javascript </script> </head> <body> <header> <h1>Page title</h1> <h2>Page description</h2> Arbitrary page branding </header> <nav> Page links </nav> <aside> Side-bar page links </aside> <article> Contents of serialized object </article> <footer> Footer message </footer> </body> </html>

This interface allows you to control how these sections get rendered.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`article(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<body>/<article>` element.
`void`	`aside(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<body>/<aside>` element.
`void`	`body(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<body>` element.
`void`	`footer(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<body>/<footer>` element.
`boolean`	`hasAside(HtmlDocSerializerSession session)` Returns true if this page should render a `<body>/<aside>` element.
`boolean`	`hasFooter(HtmlDocSerializerSession session)` Returns true if this page should render a `<body>/<footer>` element.
`boolean`	`hasHeader(HtmlDocSerializerSession session)` Returns true if this page should render a `<body>/<header>` element.
`boolean`	`hasNav(HtmlDocSerializerSession session)` Returns true if this page should render a `<body>/<nav>` element.
`boolean`	`hasScript(HtmlDocSerializerSession session)` Returns true if this page should render a `<head>/<script>` element.
`boolean`	`hasStyle(HtmlDocSerializerSession session)` Returns true if this page should render a `<head>/<style>` element.
`void`	`head(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<head>` element.
`void`	`header(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<body>/<header>` element.
`void`	`nav(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<body>/<nav>` element.
`void`	`script(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<head>/<script>` element.
`void`	`style(HtmlDocSerializerSession session, HtmlWriter w, Object o)` Renders the contents of the `<head>/<style>` element.

- Method Detail
  - head
```
void head(HtmlDocSerializerSession session,
          HtmlWriter w,
          Object o)
   throws Exception
```
    Renders the contents of the <head> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - style
```
void style(HtmlDocSerializerSession session,
           HtmlWriter w,
           Object o)
    throws Exception
```
    Renders the contents of the <head>/<style> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - script
```
void script(HtmlDocSerializerSession session,
            HtmlWriter w,
            Object o)
     throws Exception
```
    Renders the contents of the <head>/<script> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - body
```
void body(HtmlDocSerializerSession session,
          HtmlWriter w,
          Object o)
   throws Exception
```
    Renders the contents of the <body> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - header
```
void header(HtmlDocSerializerSession session,
            HtmlWriter w,
            Object o)
     throws Exception
```
    Renders the contents of the <body>/<header> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - nav
```
void nav(HtmlDocSerializerSession session,
         HtmlWriter w,
         Object o)
  throws Exception
```
    Renders the contents of the <body>/<nav> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - article
```
void article(HtmlDocSerializerSession session,
             HtmlWriter w,
             Object o)
      throws Exception
```
    Renders the contents of the <body>/<article> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - aside
```
void aside(HtmlDocSerializerSession session,
           HtmlWriter w,
           Object o)
    throws Exception
```
    Renders the contents of the <body>/<aside> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - footer
```
void footer(HtmlDocSerializerSession session,
            HtmlWriter w,
            Object o)
     throws Exception
```
    Renders the contents of the <body>/<footer> element.
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - hasStyle
```
boolean hasStyle(HtmlDocSerializerSession session)
```
    Returns true if this page should render a <head>/<style> element.
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasScript
```
boolean hasScript(HtmlDocSerializerSession session)
```
    Returns true if this page should render a <head>/<script> element.
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasHeader
```
boolean hasHeader(HtmlDocSerializerSession session)
```
    Returns true if this page should render a <body>/<header> element.
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasNav
```
boolean hasNav(HtmlDocSerializerSession session)
```
    Returns true if this page should render a <body>/<nav> element.
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasAside
```
boolean hasAside(HtmlDocSerializerSession session)
```
    Returns true if this page should render a <body>/<aside> element.
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasFooter
```
boolean hasFooter(HtmlDocSerializerSession session)
```
    Returns true if this page should render a <body>/<footer> element.
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.

Interface HtmlDocTemplate

Method Summary

Method Detail

head

style

script

body

header

nav

article

aside

footer

hasStyle

hasScript

hasHeader

hasNav

hasAside

hasFooter