Package org.apache.juneau.html

Interface HtmlDocTemplate

All Known Subinterfaces:
HtmlDocTemplate.Void
All Known Implementing Classes:
BasicHtmlDocTemplate
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.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    HtmlDocTemplate.Void
    Represents a non-existent doc template.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    writeTo(HtmlDocSerializerSession session, HtmlWriter w, Object o)
    Renders the contents of the <head> element.

  • Method Details