|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFAction
org.apache.fop.pdf.PDFGoTo
public class PDFGoTo
class representing a /GoTo object. This can either have a Goto to a page reference and location or to a specified PDF reference string.
Field Summary |
---|
Fields inherited from class org.apache.fop.pdf.PDFObject |
---|
DATE_FORMAT, log |
Constructor Summary | |
---|---|
PDFGoTo(java.lang.String pageReference)
create a /GoTo object. |
|
PDFGoTo(java.lang.String pageReference,
java.awt.geom.Point2D position)
create a /GoTo object. |
Method Summary | |
---|---|
protected boolean |
contentEquals(PDFObject obj)
Check if the other PDFObject has the same content as the current 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 |
setPosition(java.awt.geom.Point2D position)
Sets the target (X,Y) position |
void |
setXPosition(float 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, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PDFGoTo(java.lang.String pageReference)
pageReference
- the pageReference represented by this objectpublic PDFGoTo(java.lang.String pageReference, java.awt.geom.Point2D position)
pageReference
- the PDF reference to the target pageposition
- the target area's on-page coordinates in pointsMethod Detail |
---|
public void setPageReference(java.lang.String pageReference)
pageReference
- the new page reference to usepublic void setPosition(java.awt.geom.Point2D position)
position
- the target's on-page coordinates in pointspublic void setXPosition(float xPosition)
xPosition
- x positionpublic void setYPosition(float yPosition)
yPosition
- y positionpublic void setDestination(java.lang.String dest)
dest
- the PDF destination stringpublic java.lang.String getAction()
getAction
in class PDFAction
public java.lang.String toPDFString()
toPDFString
in class PDFObject
protected boolean contentEquals(PDFObject obj)
Note: This function has a contract which is less binding than
Object.equals(Object)
. Whereas equals would require all values to be
identical, this method is not required to check everything. In the case
of PDFObjects, this means that the overriding function does not have to
check for PDFObject.getObjectID()
.
contentEquals
in class PDFObject
obj
- object to compare to.
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |