BasicHtmlDocTemplate (Apache Juneau 8.1.2)

java.lang.Object
- org.apache.juneau.html.BasicHtmlDocTemplate

All Implemented Interfaces:

HtmlDocTemplate
```
public class BasicHtmlDocTemplate
extends Object
implements HtmlDocTemplate
```
A basic template for the HTML doc serializer.
This class can be subclassed to customize page rendering.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.juneau.html.HtmlDocTemplate
  HtmlDocTemplate.Null

Constructor Summary

Constructors
Constructor and Description

BasicHtmlDocTemplate()

Constructors
Constructor and Description
`BasicHtmlDocTemplate()`

Method Summary

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

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

- Constructor Detail
  - BasicHtmlDocTemplate
```
public BasicHtmlDocTemplate()
```
- Method Detail
  - writeTo
```
public void writeTo(HtmlDocSerializerSession session,
                    HtmlWriter w,
                    Object o)
             throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <head> element.
    
    Specified by:
    
    writeTo in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    w - The writer being written to.
    
    o - The object being serialized.
    
    Throws:
    
    Exception - Any exception can be thrown.
  - head
```
protected 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
```
protected 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
```
protected 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
```
protected 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
```
protected 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
```
protected 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.
  - aside
```
protected 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.
  - article
```
protected 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.
  - footer
```
protected 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
```
protected 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
```
protected 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
```
protected 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
```
protected 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
```
protected 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
```
protected 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.

Class BasicHtmlDocTemplate

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.juneau.html.HtmlDocTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicHtmlDocTemplate

Method Detail

writeTo

head

style

script

body

header

nav

aside

article

footer

hasStyle

hasScript

hasHeader

hasNav

hasAside

hasFooter