com.itextpdf.kernel.pdf

Class PdfDeveloperExtension

java.lang.Object

com.itextpdf.kernel.pdf.PdfDeveloperExtension

public class PdfDeveloperExtension
extends Object

Beginning with BaseVersion 1.7, the extensions dictionary lets developers designate that a given document contains extensions to PDF. The presence of the extension dictionary in a document indicates that it may contain developer-specific PDF properties that extend a particular base version of the PDF specification. The extensions dictionary enables developers to identify their own extensions relative to a base version of PDF. Additionally, the convention identifies extension levels relative to that base version. The intent of this dictionary is to enable developers of PDF-producing applications to identify company-specific specifications that PDF-consuming applications use to interpret the extensions.

Field Summary

Fields

Modifier and Type	Field and Description
static PdfDeveloperExtension	ADOBE_1_7_EXTENSIONLEVEL3 An instance of this class for Adobe 1.7 Extension level 3.
protected PdfName	baseVersion The base version.
static PdfDeveloperExtension	ESIC_1_7_EXTENSIONLEVEL2 An instance of this class for ETSI 1.7 Extension level 2.
static PdfDeveloperExtension	ESIC_1_7_EXTENSIONLEVEL5 An instance of this class for ETSI 1.7 Extension level 5.
protected int	extensionLevel The extension level within the base version.
static PdfDeveloperExtension	ISO_32001 An instance of this class for ISO/TS 32001.
static PdfDeveloperExtension	ISO_32002 An instance of this class for ISO/TS 32002.
protected PdfName	prefix The prefix used in the Extensions dictionary added to the Catalog.

Constructor Summary

Constructors

Constructor and Description
PdfDeveloperExtension(PdfName prefix, PdfName baseVersion, int extensionLevel) Creates a PdfDeveloperExtension object.
PdfDeveloperExtension(PdfName prefix, PdfName baseVersion, int extensionLevel, String url, String extensionRevision, boolean isMultiValued) Creates a PdfDeveloperExtension object.

Method Summary

Modifier and Type	Method and Description
PdfName	getBaseVersion() Gets the baseVersion name.
PdfDictionary	getDeveloperExtensions() Generations the developer extension dictionary corresponding with the prefix.
int	getExtensionLevel() Gets the extension level within the baseVersion.
PdfName	getPrefix() Gets the prefix name.
boolean	isMultiValued() Indicates whether the extension prefix is multivalued (ISO 32000-2:2020).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADOBE_1_7_EXTENSIONLEVEL3

public static final PdfDeveloperExtension ADOBE_1_7_EXTENSIONLEVEL3

An instance of this class for Adobe 1.7 Extension level 3.

ESIC_1_7_EXTENSIONLEVEL2

public static final PdfDeveloperExtension ESIC_1_7_EXTENSIONLEVEL2

An instance of this class for ETSI 1.7 Extension level 2.

ESIC_1_7_EXTENSIONLEVEL5

public static final PdfDeveloperExtension ESIC_1_7_EXTENSIONLEVEL5

An instance of this class for ETSI 1.7 Extension level 5.

ISO_32001

public static final PdfDeveloperExtension ISO_32001

An instance of this class for ISO/TS 32001.

ISO_32002

public static final PdfDeveloperExtension ISO_32002

An instance of this class for ISO/TS 32002.

prefix

protected PdfName prefix

The prefix used in the Extensions dictionary added to the Catalog.

baseVersion

protected PdfName baseVersion

The base version.

extensionLevel

protected int extensionLevel

The extension level within the base version.

Constructor Detail

PdfDeveloperExtension

public PdfDeveloperExtension(PdfName prefix,
                             PdfName baseVersion,
                             int extensionLevel)

Creates a PdfDeveloperExtension object.

Parameters:

prefix - the prefix referring to the developer

baseVersion - the number of the base version

extensionLevel - the extension level within the base version

PdfDeveloperExtension

public PdfDeveloperExtension(PdfName prefix,
                             PdfName baseVersion,
                             int extensionLevel,
                             String url,
                             String extensionRevision,
                             boolean isMultiValued)

Creates a PdfDeveloperExtension object.

Parameters:

prefix - the prefix referring to the developer

baseVersion - the number of the base version

extensionLevel - the extension level within the base version

extensionRevision - the extension revision identifier

url - the URL specifying where to find more information about the extension

isMultiValued - flag indicating whether the extension prefix can have multiple values

Method Detail

getPrefix

public PdfName getPrefix()

Gets the prefix name.

Returns:

a PdfName

getBaseVersion

public PdfName getBaseVersion()

Gets the baseVersion name.

Returns:

a PdfName

getExtensionLevel

public int getExtensionLevel()

Gets the extension level within the baseVersion.

Returns:

an integer

isMultiValued

public boolean isMultiValued()

Indicates whether the extension prefix is multivalued (ISO 32000-2:2020).

Returns:

true if multivalued

getDeveloperExtensions

public PdfDictionary getDeveloperExtensions()

Generations the developer extension dictionary corresponding with the prefix.

Returns:

a PdfDictionary