org.apache.fop.area
Interface OffDocumentItem
- 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.
static int | AFTER_PAGE - Process this extension after the next page is rendered
or prepared when being handled by the area tree.
|
static int | END_OF_DOC - Process this extension at the end of the document once
all pages have been fully rendered.
|
static int | IMMEDIATELY - Process this extension immediately when
being handled by the area tree.
|
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
|
AFTER_PAGE
public static final int AFTER_PAGE
Process this extension after the next page is rendered
or prepared when being handled by the area tree.
END_OF_DOC
public static final int END_OF_DOC
Process this extension at the end of the document once
all pages have been fully rendered.
IMMEDIATELY
public static final int IMMEDIATELY
Process this extension immediately when
being handled by the area tree.
getName
public String getName()
Return a human-readable name for this ODI (for error messages, etc.)
getWhenToProcess
public int getWhenToProcess()
Get an indicator of when this item should be processed
- int constant (IMMEDIATELY, AFTER_PAGE, END_OF_DOC)
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.