org.pdfbox.pdmodel.interactive.action.type
Class PDActionURI
- COSObjectable, PDDestinationOrAction
This represents a URI action that can be executed in a PDF document.
static String | SUB_TYPE - This type of action this object represents.
|
String | getBase() - This will get the base URI to be used in resolving relative URI references.
|
COSDictionary | getCOSDictionary() - Convert this standard java object to a COS object.
|
COSBase | getCOSObject() - Convert this standard java object to a COS object.
|
String | getS() - This will get the type of action that the actions dictionary describes.
|
String | getURI() - This will get the uniform resource identifier to resolve, encoded in 7-bit ASCII.
|
void | setBase(String base) - This will set the base URI to be used in resolving relative URI references.
|
void | setS(String s) - This will set the type of action that the actions dictionary describes.
|
void | setTrackMousePosition(boolean value) - This will specify whether to track the mouse position when the URI is resolved.
|
void | setURI(String uri) - This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.
|
boolean | shouldTrackMousePosition() - This will specify whether to track the mouse position when the URI is resolved.
|
SUB_TYPE
public static final String SUB_TYPE
This type of action this object represents.
PDActionURI
public PDActionURI()
Default constructor.
PDActionURI
public PDActionURI(COSDictionary a)
Constructor.
a
- The action dictionary.
getBase
public String getBase()
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.
- The URI entry of the specific URI dictionary.
getCOSDictionary
public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
- getCOSDictionary in interface PDAction
- The cos object that matches this Java object.
getS
public String getS()
This will get the type of action that the actions dictionary describes.
It must be URI for a URI action.
- The S entry of the specific URI action dictionary.
getURI
public String getURI()
This will get the uniform resource identifier to resolve, encoded in 7-bit ASCII.
- The URI entry of the specific URI action dictionary.
setBase
public void setBase(String base)
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.
base
- The the base URI to be used.
setS
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.
setTrackMousePosition
public void setTrackMousePosition(boolean value)
This will specify whether to track the mouse position when the URI is resolved.
setURI
public void setURI(String uri)
This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.
uri
- The uniform resource identifier.
shouldTrackMousePosition
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.
- A flag specifying whether to track the mouse position when the URI is resolved.