org.apache.pdfbox.pdmodel.interactive.annotation: public class: PDExternalDataDictionary

org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDExternalDataDictionary [javadoc | source]

java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary

All Implemented Interfaces:
COSObjectable

This class represents an external data dictionary.

version: $ - Revision: 1.0 $

Constructor:

Constructor:
public PDExternalDataDictionary() { this.dataDictionary = new COSDictionary(); this.dataDictionary.setName(COSName.TYPE, "ExData"); } Constructor.
public PDExternalDataDictionary(COSDictionary dictionary) { this.dataDictionary = dictionary; } Constructor. Parameters: `dictionary` - Dictionary

 public PDExternalDataDictionary() {
        this.dataDictionary = new COSDictionary();
        this.dataDictionary.setName(COSName.TYPE, "ExData");
}

Constructor.

 public PDExternalDataDictionary(COSDictionary dictionary) {
        this.dataDictionary = dictionary;
}

Constructor.

Parameters:

dictionary - Dictionary

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary Summary:
getCOSObject, getDictionary, getSubtype, getType, setSubtype

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary Detail:
public COSBase getCOSObject() { return this.dataDictionary; } {@inheritDoc}
public COSDictionary getDictionary() { return this.dataDictionary; } returns the dictionary.
public String getSubtype() { return this.getDictionary().getNameAsString(COSName.SUBTYPE); } returns the subtype of the external data dictionary.
public String getType() { return this.getDictionary().getNameAsString(COSName.TYPE, "ExData"); } returns the type of the external data dictionary. It must be "ExData", if present
public void setSubtype(String subtype) { this.getDictionary().setName(COSName.SUBTYPE, subtype); } This will set the subtype of the external data dictionary.

Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary Detail:

 public COSBase getCOSObject() {
        return this.dataDictionary;
}

{@inheritDoc}

 public COSDictionary getDictionary() {
        return this.dataDictionary;
}

returns the dictionary.

 public String getSubtype() {
        return this.getDictionary().getNameAsString(COSName.SUBTYPE);
}

returns the subtype of the external data dictionary.

 public String getType() {
        return this.getDictionary().getNameAsString(COSName.TYPE, "ExData");
}

returns the type of the external data dictionary. It must be "ExData", if present

 public  void setSubtype(String subtype) {
        this.getDictionary().setName(COSName.SUBTYPE, subtype);
}

This will set the subtype of the external data dictionary.