fop 0.94

org.apache.fop.pdf
Class PDFDestination

java.lang.Object
  extended by org.apache.fop.pdf.PDFObject
      extended by org.apache.fop.pdf.PDFDestination
All 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(java.lang.String idRef, java.lang.Object goToRef)
          Create a named destination
 
Method Summary
 boolean equals(java.lang.Object obj)
          Check if this equals another object.
 java.lang.Object getGoToReference()
          Returns the GoToReference from the associated DestinationData object.
 java.lang.String getIDRef()
          Returns the RefID from the associated DestinationData object.
 int hashCode()
           
 void setGoToReference(java.lang.Object goToReference)
          Sets the GoToReference in the associated DestinationData object.
 void setGoToReference(java.lang.String goToReference)
          Deprecated. use setGoToReference(Object) instead
 java.lang.String toKeyValuePair()
          Creates the key/value pair for this destination entry for the name tree.
protected  java.lang.String toPDFString()
          This method returns a String representation of the PDF object.
 
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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDFDestination

public PDFDestination(java.lang.String idRef,
                      java.lang.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 Detail

toKeyValuePair

public java.lang.String toKeyValuePair()
Creates the key/value pair for this destination entry for the name tree.

Returns:
the formatted key/value pair

toPDFString

protected java.lang.String toPDFString()
Description copied from class: PDFObject
This method returns a String representation of the PDF object. The result is normally converted/encoded to a byte array by toPDF(). Only use this method to implement the serialization if the object can be fully represented as text. If the PDF representation of the object contains binary content use toPDF() or output(OutputStream) instead.

Overrides:
toPDFString in class PDFObject
Returns:
String the String representation
See Also:
PDFObject.toPDFString()

setGoToReference

public void setGoToReference(java.lang.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.

setGoToReference

public void setGoToReference(java.lang.Object goToReference)
Sets the GoToReference in the associated DestinationData object.

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

getGoToReference

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

Returns:
the GoToReference from the associated DestinationData object.

getIDRef

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

Returns:
the RefID from the associated DestinationData object.

equals

public boolean equals(java.lang.Object obj)
Check if this equals another object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare
Returns:
true if this equals other object

hashCode

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

fop 0.94

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