Package com.teamdev.jxbrowser.print.settings

Interface FooterTemplate<T extends PrintSettings>

Type Parameters:
T - the concrete print settings type
All Known Subinterfaces:
PdfPrinter.HtmlSettings, SystemPrinter.HtmlSettings
public interface FooterTemplate<T extends PrintSettings>
An HTML template for the print footer.

Apply the following CSS classes to insert printing metadata into the template. These classes don't affect the visual appearance of the elements.

  • date: the formatted print date;
  • title: the document title;
  • url: the document location;
  • pageNumber: the current page number;
  • totalPages: the total page count in the document;

For example, <span class=title></span> would generate a span containing a title.

The programming, audio/video, and frame tags are not supported. Images are supported only with Base64 content.

Implemented by concrete PrintSettings implementations that support configuring the footer for printing.

Since:
7.20

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    footer()
    Returns a value used for the footer.
    T
    footer(String html)
    Configures HTML to be displayed in the footer.

  • Method Details

    • footer

      T footer(String html)
      Configures HTML to be displayed in the footer.
      Parameters:
      html - the HTML to use for the footer
      Returns:
      this instance
      Throws:
      ObjectClosedException - if the current printing operation has been completed

    • footer

      String footer()
      Returns a value used for the footer.
      Throws:
      ObjectClosedException - if the current printing operation has been completed