org.apache.fop.pdf

Class PDFDestination

Implemented Interfaces:
PDFWritable

public class PDFDestination
extends PDFObject

class representing a named destination

Field Summary

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFDestination(String idRef, Object goToRef)
Create a named destination

Method Summary

boolean
equals(Object obj)
Check if this equals another object.
Object
getGoToReference()
Returns the GoToReference from the associated DestinationData object.
String
getIDRef()
Returns the RefID from the associated DestinationData object.
int
hashCode()
void
setGoToReference(Object goToReference)
Sets the GoToReference in the associated DestinationData object.
void
setGoToReference(String goToReference)
Deprecated. use setGoToReference(Object) instead
String
toKeyValuePair()
Creates the key/value pair for this destination entry for the name tree.
protected String
toPDFString()

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, output, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF, toPDFString

Constructor Details

PDFDestination

public PDFDestination(String idRef,
                      Object goToRef)
Create a named destination
Parameters:
idRef - ID Reference for this destination (the name of the destination)
goToRef - Object reference to the GoTo Action

Method Details

equals

public boolean equals(Object obj)
Check if this equals another object.
Parameters:
obj - the object to compare
Returns:
true if this equals other object

getGoToReference

public Object getGoToReference()
Returns the GoToReference from the associated DestinationData object.
Returns:
the GoToReference from the associated DestinationData object.

getIDRef

public String getIDRef()
Returns the RefID from the associated DestinationData object.
Returns:
the RefID from the associated DestinationData object.

hashCode

public int hashCode()
See Also:
java.lang.Object.hashCode()

setGoToReference

public void setGoToReference(Object goToReference)
Sets the GoToReference in the associated DestinationData object.
Parameters:
goToReference - the reference to set in the associated DestinationData object.

setGoToReference

public void setGoToReference(String goToReference)

Deprecated. use setGoToReference(Object) instead

Sets the GoToReference in the associated DestinationData object.
Parameters:
goToReference - the reference to set in the associated DestinationData object.

toKeyValuePair

public String toKeyValuePair()
Creates the key/value pair for this destination entry for the name tree.
Returns:
the formatted key/value pair

toPDFString

protected String toPDFString()
Overrides:
toPDFString in interface PDFObject

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