Generator > Programming > Templates

Templates are used to automatically add page elements to all pages in a document or section. This is useful for things like headers and footers. There are two types of templates that can be applied. These are document wide templates and section wide templates. By default, a page will use both the document and section template if they are set. If you want to disable either template for an individual page, this can be done with the page's ApplyDocumentTemplate or ApplySectionTemplate property. For information on how to break a document into sections and apply a section template, see the Document Sectioning topic.

DynamicPDF™ Generator for Java includes two template classes:

Template
The Template class is used to add Page Element to all pages in the section or document.
Even / Odd Template
The EvenOddTemplate class is used to add different Page Elements to even or odd pages in the section or document.

Document Templates

Document templates are applied by creating a Template class, adding Page Elements to it, then setting it to the Document's Template property:

[Java]
    Template template = new Template();
    template.getElements().add(new Label("Header", 0, 0, 200, 12));
    document.setTemplate(template);
    

Even / Odd templates can be created as follows:

[Java]
    EvenOddTemplate template = new EvenOddTemplate();
    template.getEvenElements().add(new Label("Even Header", 0, 0, 200, 12));
    template.getOddElements().add(new Label("Odd Header", 0, 0, 200, 12));
    template.getElements().add(new Label("Footer", 0, 680, 200, 12));
    document.setTemplate(template);
    

See Also

EvenOddTemplate Class | Template Class | Programming With Generator for Java