Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.action

public Class PDActionURI

extends PDAction
Class Inheritance
Imports
java.nio.charset.StandardCharsets, org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSName, .COSString
This represents a URI action that can be executed in a PDF document.
Authors
Ben Litchfield, Panagiotis Toumasis

Field Summary

Modifier and TypeField and Description
public static final String
SUB_TYPE

This type of action this object represents.

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:
actionTYPE

Constructor Summary

AccessConstructor and Description
public
PDActionURI()

Default constructor.

public
PDActionURI(COSDictionary
The action dictionary.
a)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The URI entry of the specific URI action dictionary or null if there isn't any.
getURI()

This will get the uniform resource identifier to resolve.

public void
setTrackMousePosition(boolean
The flag value.
value)

This will specify whether to track the mouse position when the URI is resolved.

public void
setURI(String
The uniform resource identifier.
uri)

This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.

public boolean

Returns:

A flag specifying whether to track the mouse position when the URI is resolved.
shouldTrackMousePosition()

This will specify whether to track the mouse position when the URI is resolved.

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:
getCOSObjectgetNextgetSubTypegetTypesetNextsetSubTypesetType

Field Detail

SUB_TYPEback to summary
public static final String SUB_TYPE

This type of action this object represents.

Constructor Detail

PDActionURIback to summary
public PDActionURI()

Default constructor.

PDActionURIback to summary
public PDActionURI(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getURIback to summary
public String getURI()

This will get the uniform resource identifier to resolve. It should be encoded in 7-bit ASCII, but UTF-8 and UTF-16 are supported too.

Returns:String

The URI entry of the specific URI action dictionary or null if there isn't any.

setTrackMousePositionback to summary
public void setTrackMousePosition(boolean value)

This will specify whether to track the mouse position when the URI is resolved.

Parameters
value:boolean

The flag value.

setURIback to summary
public void setURI(String uri)

This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.

Parameters
uri:String

The uniform resource identifier.

shouldTrackMousePositionback to summary
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.

Returns:boolean

A flag specifying whether to track the mouse position when the URI is resolved.