Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| fop 1.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.fop.area
Interface OffDocumentItem

All Known Implementing Classes:
  AbstractOffDocumentItem, 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
`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.

Method Summary
`java.lang.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 Detail

### IMMEDIATELY

    public static final int IMMEDIATELY

  Process this extension immediately when being handled by the area tree.

  See Also:
    Constant Field Values

### 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.

  See Also:
    Constant Field Values

### 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.

  See Also:
    Constant Field Values

Method Detail

### getWhenToProcess

    public int getWhenToProcess()

  Get an indicator of when this item should be processed

  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.)

  Returns:
    String name of ODI

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| fop 1.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.