Package org.apache.fop.area

Interface OffDocumentItem

All Known Implementing Classes:
AbstractOffDocumentItem, BookmarkData, DestinationData, OffDocumentExtensionAttachment
public interface OffDocumentItem
Interface for objects that are processed by the renderer outside of the actual document. An object implementing this interface can be handled by the renderer according to these possibilities: IMMEDIATELY, AFTER_PAGE or END_OF_DOC.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AFTER_PAGE
    Process this extension after the next page is rendered or prepared when being handled by the area tree.
    static final int
    END_OF_DOC
    Process this extension at the end of the document once all pages have been fully rendered.
    static final int
    IMMEDIATELY
    Process this extension immediately when being handled by the area tree.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Return a human-readable name for this ODI (for error messages, etc.)
    int
    getWhenToProcess()
    Get an indicator of when this item should be processed

  • Field Details

    • IMMEDIATELY

      static final int IMMEDIATELY
      Process this extension immediately when being handled by the area tree.
      See Also:

    • AFTER_PAGE

      static final int AFTER_PAGE
      Process this extension after the next page is rendered or prepared when being handled by the area tree.
      See Also:

    • END_OF_DOC

      static final int END_OF_DOC
      Process this extension at the end of the document once all pages have been fully rendered.
      See Also:

  • Method Details

    • getWhenToProcess

      int getWhenToProcess()
      Get an indicator of when this item should be processed
      Returns:
      int constant (IMMEDIATELY, AFTER_PAGE, END_OF_DOC)

    • getName

      String getName()
      Return a human-readable name for this ODI (for error messages, etc.)
      Returns:
      String name of ODI