org.apache.fop.pdf
Class PDFGoTo
java.lang.Object
|
+--org.apache.fop.pdf.PDFObject
|
+--org.apache.fop.pdf.PDFAction
|
+--org.apache.fop.pdf.PDFGoTo
- public class PDFGoTo
- extends PDFAction
class representing a /GoTo object.
This can either have a Goto to a page reference and location
or to a specified PDF reference string.
Constructor Summary |
PDFGoTo(java.lang.String pageReference)
create a /GoTo object. |
Method Summary |
boolean |
equals(java.lang.Object obj)
Check if this equals another object. |
java.lang.String |
getAction()
Get the PDF reference for the GoTo action. |
void |
setDestination(java.lang.String dest)
Set the destination string for this Goto. |
void |
setPageReference(java.lang.String pageReference)
Sets page reference after object has been created |
void |
setXPosition(int xPosition)
Sets the x Position to jump to |
void |
setYPosition(float yPosition)
Sets the Y position to jump to |
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, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, output, referencePDF, setDocument, setObjectNumber, toPDF |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PDFGoTo
public PDFGoTo(java.lang.String pageReference)
- create a /GoTo object.
- Parameters:
pageReference
- the pageReference represented by this object
setPageReference
public void setPageReference(java.lang.String pageReference)
- Sets page reference after object has been created
- Parameters:
pageReference
- the new page reference to use
setYPosition
public void setYPosition(float yPosition)
- Sets the Y position to jump to
- Parameters:
yPosition
- y position
setDestination
public void setDestination(java.lang.String dest)
- Set the destination string for this Goto.
- Parameters:
dest
- the PDF destination string
setXPosition
public void setXPosition(int xPosition)
- Sets the x Position to jump to
- Parameters:
xPosition
- x position
getAction
public java.lang.String getAction()
- Get the PDF reference for the GoTo action.
- Overrides:
getAction
in class PDFAction
- Returns:
- the PDF reference for the action
toPDFString
public 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
- See Also:
PDFObject.toPDFString()
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
Copyright 1999-2006 The Apache Software Foundation. All Rights Reserved.