Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.action.type » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.action.type
public class: PDActionRemoteGoTo [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
      org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo

All Implemented Interfaces:
    PDDestinationOrAction

This represents a remote go-to action that can be executed in a PDF document.
Field Summary
public static final  String SUB_TYPE    This type of action this object represents. 
Fields inherited from org.apache.pdfbox.pdmodel.interactive.action.type.PDAction:
TYPE,  action
Constructor:
 public PDActionRemoteGoTo() 
 public PDActionRemoteGoTo(COSDictionary a) 
    Constructor.
    Parameters:
    a - The action dictionary.
Method from org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo Summary:
getCOSDictionary,   getCOSObject,   getD,   getFile,   getS,   setD,   setFile,   setOpenInNewWindow,   setS,   shouldOpenInNewWindow
Methods from org.apache.pdfbox.pdmodel.interactive.action.type.PDAction:
getCOSDictionary,   getCOSObject,   getNext,   getSubType,   getType,   setNext,   setSubType,   setType
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo Detail:
 public COSDictionary getCOSDictionary() 
    Convert this standard java object to a COS object.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public COSBase getD() 
    This will get the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0.
 public PDFileSpecification getFile() throws IOException 
    This will get the file in which the destination is located.
 public String getS() 
    This will get the type of action that the actions dictionary describes. It must be GoToR for a remote go-to action.
 public  void setD(COSBase d) 
    This will set the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0.
 public  void setFile(PDFileSpecification fs) 
    This will set the file in which the destination is located.
 public  void setOpenInNewWindow(boolean value) 
    This will specify the destination document to open in a new window.
 public  void setS(String s) 
    This will set the type of action that the actions dictionary describes. It must be GoToR for a remote go-to action.
 public boolean shouldOpenInNewWindow() 
    This will specify whether to open the destination document in a new window. If this flag is false, the destination document will replace the current document in the same window. If this entry is absent, the viewer application should behave in accordance with the current user preference.