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

All Implemented Interfaces:
    PDDestinationOrAction

This represents a URI 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 PDActionURI() 
 public PDActionURI(COSDictionary a) 
    Constructor.
    Parameters:
    a - The action dictionary.
Method from org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI Summary:
getBase,   getCOSDictionary,   getCOSObject,   getS,   getURI,   setBase,   setS,   setTrackMousePosition,   setURI,   shouldTrackMousePosition
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.PDActionURI Detail:
 public String getBase() 
Deprecated! use - PDURIDictionary#getBase() instead

    This will get the base URI to be used in resolving relative URI references. URI actions within the document may specify URIs in partial form, to be interpreted relative to this base address. If no base URI is specified, such partial URIs will be interpreted relative to the location of the document itself. The use of this entry is parallel to that of the body element <BASE>, as described in the HTML 4.01 Specification.
 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 String getS() 
    This will get the type of action that the actions dictionary describes. It must be URI for a URI action.
 public String getURI() 
    This will get the uniform resource identifier to resolve, encoded in 7-bit ASCII.
 public  void setBase(String base) 
Deprecated! use - PDURIDictionary#setBase(String) instead

    This will set the base URI to be used in resolving relative URI references. URI actions within the document may specify URIs in partial form, to be interpreted relative to this base address. If no base URI is specified, such partial URIs will be interpreted relative to the location of the document itself. The use of this entry is parallel to that of the body element <BASE>, as described in the HTML 4.01 Specification.
 public  void setS(String s) 
    This will set the type of action that the actions dictionary describes. It must be URI for a URI action.
 public  void setTrackMousePosition(boolean value) 
    This will specify whether to track the mouse position when the URI is resolved.
 public  void setURI(String uri) 
    This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.
 public boolean shouldTrackMousePosition() 
    This will specify whether to track the mouse position when the URI is resolved. Default value: false. This entry applies only to actions triggered by the user's clicking an annotation; it is ignored for actions associated with outline items or with a document's OpenAction entry.