org.apache.fop.pdf
Class PDFAction

org.apache.fop.pdf.PDFObject
  |
  +--org.apache.fop.pdf.PDFAction
Direct Known Subclasses:
PDFGoToRemote, PDFInternalLink, PDFUri

public abstract class PDFAction
extends PDFObject

class representing an action object.


Constructor Summary
PDFAction(int number)
          create an Action object.
PDFAction()
          empty constructor for PDFAction.

Method Summary
 abstract StringgetAction()
          represent the action to call this method should be implemented to return the action which gets called by the Link Object.
 abstract byte[]toPDF()
          represent the object in PDF this method should be implemented to return the PDF which is to be generated by the Action object

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFAction

public PDFAction(int number)
create an Action object. this constructor is used for passing on the object number to the PDFObject
Parameters:
number - the object's number

PDFAction

public PDFAction()
empty constructor for PDFAction. this constructor is used when there is no additional object being created
Method Detail

getAction

public abstract String getAction()
represent the action to call this method should be implemented to return the action which gets called by the Link Object. This could be a reference to another object or the specific destination of the link
Returns: the action to place next to /A within a Link

toPDF

public abstract byte[] toPDF()
represent the object in PDF this method should be implemented to return the PDF which is to be generated by the Action object
Returns: the PDF string