org.daisy.dotify.api.formatter.PageTemplateBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dotify.library Show documentation

Dotify Library

There is a newer version: 1.0.7

package org.daisy.dotify.api.formatter;

/**
 * Provides a page template builder.
 *
 * @author Joel Håkansson
 */
public interface PageTemplateBuilder {

    /**
     * Adds a line to the header.
     *
     * @param obj the field list
     */
    public void addToHeader(FieldList obj);

    /**
     * Adds a line to the header.
     *
     * @param obj the field list
     */
    public void addToFooter(FieldList obj);

    /**
     * Adds a column to the left margin of the page.
     *
     * @param margin the column
     */
    public void addToLeftMargin(MarginRegion margin);

    /**
     * Adds a column to the right margin of the page.
     *
     * @param margin the column
     */
    public void addToRightMargin(MarginRegion margin);
}