Class PDFNavigator

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFDictionary

org.apache.fop.pdf.PDFIdentifiedDictionary

org.apache.fop.pdf.PDFNavigator

All Implemented Interfaces:

CompressedObject, PDFWritable

public class PDFNavigator
extends PDFIdentifiedDictionary

Navigation Node Dictionary, which we call a 'navigator'. This class is used to for sub-page navigation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PDFNavigator.Resolver

Field Summary

Fields

Modifier and Type	Field	Description
private PDFNavigator.Resolver	resolver

Fields inherited from class PDFDictionary

entries, order

Fields inherited from class PDFObject

log

Constructor Summary

Constructors

Constructor	Description
PDFNavigator(String id)

Method Summary

Modifier and Type	Method	Description
int	output(OutputStream stream)	Write the PDF represention of this object
void	populate(Object nextAction, Object nextNode, Object prevAction, Object prevNode, Object duration)
void	setResolver(PDFNavigator.Resolver resolver)

Methods inherited from class PDFIdentifiedDictionary

getId, hasId

Methods inherited from class PDFDictionary

containsKey, get, getChildren, getChildren, keySet, put, put, remove, writeDictionary

Methods inherited from class PDFObject

contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, supportsObjectStream, toPDF, toPDFString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

resolver

private PDFNavigator.Resolver resolver

Constructor Details

PDFNavigator

public PDFNavigator(String id)

Method Details

output

public int output(OutputStream stream)
           throws IOException

Description copied from class: PDFDictionary

Write the PDF represention of this object

Specified by:

output in interface CompressedObject

Overrides:

output in class PDFDictionary

Parameters:

stream - the stream to write the PDF to

Returns:

the number of bytes written

Throws:

IOException - if there is an error writing to the stream

setResolver

public void setResolver(PDFNavigator.Resolver resolver)

populate

public void populate(Object nextAction,
 Object nextNode,
 Object prevAction,
 Object prevNode,
 Object duration)