HtmlDocTemplateBasic (Apache Juneau 7.1.1)

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

All Implemented Interfaces:

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

Constructor Summary

Constructors
Constructor and Description

HtmlDocTemplateBasic()

Constructors
Constructor and Description
`HtmlDocTemplateBasic()`

Method Summary

All Methods Instance Methods Concrete 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.

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

- Constructor Detail
  - HtmlDocTemplateBasic
```
public HtmlDocTemplateBasic()
```
- Method Detail
  - head
```
public void head(HtmlDocSerializerSession session,
                 HtmlWriter w,
                 Object o)
          throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <head> element.
    
    Specified by:
    
    head 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.
  - style
```
public void style(HtmlDocSerializerSession session,
                  HtmlWriter w,
                  Object o)
           throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <head>/<style> element.
    
    Specified by:
    
    style 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.
  - script
```
public void script(HtmlDocSerializerSession session,
                   HtmlWriter w,
                   Object o)
            throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <head>/<script> element.
    
    Specified by:
    
    script 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.
  - body
```
public void body(HtmlDocSerializerSession session,
                 HtmlWriter w,
                 Object o)
          throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <body> element.
    
    Specified by:
    
    body 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.
  - header
```
public void header(HtmlDocSerializerSession session,
                   HtmlWriter w,
                   Object o)
            throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <body>/<header> element.
    
    Specified by:
    
    header 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.
  - nav
```
public void nav(HtmlDocSerializerSession session,
                HtmlWriter w,
                Object o)
         throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <body>/<nav> element.
    
    Specified by:
    
    nav 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.
  - aside
```
public void aside(HtmlDocSerializerSession session,
                  HtmlWriter w,
                  Object o)
           throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <body>/<aside> element.
    
    Specified by:
    
    aside 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.
  - article
```
public void article(HtmlDocSerializerSession session,
                    HtmlWriter w,
                    Object o)
             throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <body>/<article> element.
    
    Specified by:
    
    article 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.
  - footer
```
public void footer(HtmlDocSerializerSession session,
                   HtmlWriter w,
                   Object o)
            throws Exception
```
    Description copied from interface: HtmlDocTemplate
    
    Renders the contents of the <body>/<footer> element.
    
    Specified by:
    
    footer 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.
  - hasStyle
```
public boolean hasStyle(HtmlDocSerializerSession session)
```
    Description copied from interface: HtmlDocTemplate
    
    Returns true if this page should render a <head>/<style> element.
    
    Specified by:
    
    hasStyle in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasScript
```
public boolean hasScript(HtmlDocSerializerSession session)
```
    Description copied from interface: HtmlDocTemplate
    
    Returns true if this page should render a <head>/<script> element.
    
    Specified by:
    
    hasScript in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasHeader
```
public boolean hasHeader(HtmlDocSerializerSession session)
```
    Description copied from interface: HtmlDocTemplate
    
    Returns true if this page should render a <body>/<header> element.
    
    Specified by:
    
    hasHeader in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasNav
```
public boolean hasNav(HtmlDocSerializerSession session)
```
    Description copied from interface: HtmlDocTemplate
    
    Returns true if this page should render a <body>/<nav> element.
    
    Specified by:
    
    hasNav in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasAside
```
public boolean hasAside(HtmlDocSerializerSession session)
```
    Description copied from interface: HtmlDocTemplate
    
    Returns true if this page should render a <body>/<aside> element.
    
    Specified by:
    
    hasAside in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.
  - hasFooter
```
public boolean hasFooter(HtmlDocSerializerSession session)
```
    Description copied from interface: HtmlDocTemplate
    
    Returns true if this page should render a <body>/<footer> element.
    
    Specified by:
    
    hasFooter in interface HtmlDocTemplate
    
    Parameters:
    
    session - The current serializer session.
    
    Returns:
    
    A boolean flag.

Class HtmlDocTemplateBasic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HtmlDocTemplateBasic

Method Detail

head

style

script

body

header

nav

aside

article

footer

hasStyle

hasScript

hasHeader

hasNav

hasAside

hasFooter