Class OffDocumentExtensionAttachment

  • All Implemented Interfaces:
    OffDocumentItem

    public class OffDocumentExtensionAttachment
    extends java.lang.Object
    implements OffDocumentItem
    This class wraps ExtensionAttachments which cannot be transported inside the area tree but need to be handled in the AreaTreeHandler. These attachments are schedules for processing before the first page-sequence, i.e. at the start of the document.
    • Constructor Detail

      • OffDocumentExtensionAttachment

        public OffDocumentExtensionAttachment​(ExtensionAttachment attachment)
        Main constructor
        Parameters:
        attachment - the extension attachment to wrap.
    • Method Detail

      • getAttachment

        public ExtensionAttachment getAttachment()
        Returns:
        the extension attachment.
      • getWhenToProcess

        public int getWhenToProcess()
        Get an indicator of when this item should be processed
        Specified by:
        getWhenToProcess in interface OffDocumentItem
        Returns:
        int constant (IMMEDIATELY, AFTER_PAGE, END_OF_DOC)
      • getName

        public java.lang.String getName()
        Return a human-readable name for this ODI (for error messages, etc.)
        Specified by:
        getName in interface OffDocumentItem
        Returns:
        String name of ODI