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

public Class PDURIDictionary

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.common.COSObjectable
This is the implementation of an URI dictionary.

Field Summary

Modifier and TypeField and Description
private final COSDictionary
uriDictionary

Constructor Summary

AccessConstructor and Description
public
PDURIDictionary()

Constructor.

public
PDURIDictionary(COSDictionary
the corresponding dictionary
dictionary)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The URI entry of the specific URI dictionary.
getBase()

This will get the base URI to be used in resolving relative URI references.

public COSDictionary

Returns:

the dictionary
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Returns the corresponding dictionary.

public void
setBase(String
The base URI to be used.
base)

This will set the base URI to be used in resolving relative URI references.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

uriDictionaryback to summary
private final COSDictionary uriDictionary

Constructor Detail

PDURIDictionaryback to summary
public PDURIDictionary()

Constructor.

PDURIDictionaryback to summary
public PDURIDictionary(COSDictionary dictionary)

Constructor.

Parameters
dictionary:COSDictionary

the corresponding dictionary

Method Detail

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

Returns:String

The URI entry of the specific URI dictionary.

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Returns the corresponding dictionary.

Returns:COSDictionary

the dictionary

Annotations
@Override
setBaseback to summary
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.

Parameters
base:String

The base URI to be used.