PDFDestination (Fop API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Home

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.fop.pdf
Class PDFDestination

java.lang.Object
  org.apache.fop.pdf.PDFDestination

public class PDFDestination
extends java.lang.Object

This represents a single destination object in a PDF. Destinations allow specific locations within a PDF document to be referenced by other PDF documents (e.g. to link to a location within a document.)

Author:: Stefan Wachter (based on work by Lloyd McKenzie)

Constructor Summary
`PDFDestination(IDReferences idReferences, java.lang.String destinationName, java.lang.String internalDestination)`

Method Summary
`protected java.lang.String`	`toPDF()` Represent the object in PDF.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFDestination

public PDFDestination(IDReferences idReferences,
                      java.lang.String destinationName,
                      java.lang.String internalDestination)

Parameters:: idReferences - the id nodes container that is used to resolve the internal destination; destinationName - the name under which this destination is referenced; internalDestination - the internal destination that is referenced

Method Detail

toPDF

protected java.lang.String toPDF()

Represent the object in PDF. Outputs a key/value pair in a name tree structure. The key is the destination name the value is an array addressing the corresponding page/position.