Uses of Class
org.apache.pdfbox.cos.COSDictionary

Packages that use COSDictionary

Package	Description
org.apache.pdfbox.cos	These are the low level objects that make up a PDF document.
org.apache.pdfbox.encoding	This package contains the implementations for all of the encodings that are used in PDF documents.
org.apache.pdfbox.filter	This package will hold the PDFBox implementations of the filters that are used in PDF documents.
org.apache.pdfbox.pdfparser	The pdfparser package contains classes to parse PDF documents and objects within the document.
org.apache.pdfbox.pdfwriter	This is the persistence layer used to write the PDFBox documents to a stream.
org.apache.pdfbox.pdmodel	The PDModel package represents a high level API for creating and manipulating PDF documents.
org.apache.pdfbox.pdmodel.common	High level PD classes that are used throughout several packages are placed in the PDModel common package.
org.apache.pdfbox.pdmodel.common.filespecification	The file specification package defines classes that are used for the PDF File Specification logic.
org.apache.pdfbox.pdmodel.common.function	This package contains functions that are available in the PDF specification.
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure	The logical structure package provides a mechanism for incorporating structural information about a document's content into a PDF file.
org.apache.pdfbox.pdmodel.documentinterchange.markedcontent	The marked content package provides a mechanism for modeling marked-content sequences.
org.apache.pdfbox.pdmodel.documentinterchange.prepress	This package contains classes for prepress support in PDFBox.
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf	The tagged PDF package provides a mechanism for incorporating "tags" (standard structure types and attributes) into a PDF file.
org.apache.pdfbox.pdmodel.encryption	The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
org.apache.pdfbox.pdmodel.fdf	The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
org.apache.pdfbox.pdmodel.font	Classes to deal with font functionality in a PDF Document.
org.apache.pdfbox.pdmodel.graphics	The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
org.apache.pdfbox.pdmodel.graphics.color	This package deals with colors that are stored in a PDF document.
org.apache.pdfbox.pdmodel.graphics.optionalcontent
org.apache.pdfbox.pdmodel.graphics.pattern	This package deals with patterns which are used instead of colors.
org.apache.pdfbox.pdmodel.graphics.shading	This package deals with shadings which are used for filling instead of a color.
org.apache.pdfbox.pdmodel.graphics.xobject	This package deals with images that are stored in a PDF document.
org.apache.pdfbox.pdmodel.interactive.action	This package represents actions that can be performed in a PDF document.
org.apache.pdfbox.pdmodel.interactive.action.type	This package contains all of the available PDF action types.
org.apache.pdfbox.pdmodel.interactive.annotation	The annotation package contains classes that work with PDF annotation elements.
org.apache.pdfbox.pdmodel.interactive.digitalsignature	The digitial signature library will manage signatures that are stored in the PDF document.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible	This is the visual signature part that help creating the visual representation for the digital signature.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline	The outline package allows for a PDF outline(bookmarks) to be created.
org.apache.pdfbox.pdmodel.interactive.form	The interactive package contains classes that deal with interactive annotations such as textfields and buttons.
org.apache.pdfbox.pdmodel.interactive.measurement	The measurement package contains classes that work with elements specifying measure properties.
org.apache.pdfbox.pdmodel.interactive.pagenavigation	A package to allow provide access to PDF page navigation functionality.
org.apache.pdfbox.pdmodel.interactive.viewerpreferences	A package to allow access to document viewing preferences.
org.apache.pdfbox.pdmodel.markedcontent
org.apache.pdfbox.util	This package contains utility classes that are used by the PDFBox project.

Uses of COSDictionary in org.apache.pdfbox.cos

Subclasses of COSDictionary in org.apache.pdfbox.cos

Modifier and Type	Class and Description
class	COSDictionaryLateBinding
class	COSStream This class represents a stream object in a PDF document.

Methods in org.apache.pdfbox.cos that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	COSDocument.getEncryptionDictionary() This will get the encryption dictionary if the document is encrypted or null if the document is not encrypted.
COSDictionary	COSDocument.getTrailer() This will get the document trailer.

Methods in org.apache.pdfbox.cos that return types with arguments of type COSDictionary

Modifier and Type	Method and Description
java.util.List<COSDictionary>	COSDocument.getSignatureDictionaries() This will return a list of signature dictionaries as COSDictionary.
java.util.List<COSDictionary>	COSDocument.getSignatureFields(boolean onlyEmptyFields) This will return a list of signature fields.

Methods in org.apache.pdfbox.cos with parameters of type COSDictionary

Modifier and Type	Method and Description
void	COSDictionary.addAll(COSDictionary dic) This will add all of the dictionaries keys/values to this dictionary.
COSStream	COSDocument.createCOSStream(COSDictionary dictionary) Create a new COSStream using the underlying scratch file.
void	COSDictionary.mergeInto(COSDictionary dic) Deprecated. This method should no longer be used and will be removed in 3.0 because it could also merge attributes that should not be merged (filter and length) in a COSStream.
void	COSDocument.setEncryptionDictionary(COSDictionary encDictionary) This will set the encryption dictionary, this should only be called when encrypting the document.
void	COSDocument.setTrailer(COSDictionary newTrailer) // MIT added, maybe this should not be supported as trailer is a persistence construct.
java.lang.Object	ICOSVisitor.visitFromDictionary(COSDictionary obj) Notification of visit to dictionary object.

Constructors in org.apache.pdfbox.cos with parameters of type COSDictionary

Constructor and Description
COSDictionary(COSDictionary dict) Copy Constructor.
COSStream(COSDictionary dictionary, RandomAccess storage) Constructor.

Uses of COSDictionary in org.apache.pdfbox.encoding

Constructors in org.apache.pdfbox.encoding with parameters of type COSDictionary

Constructor and Description
DictionaryEncoding(COSDictionary fontEncoding) Constructor.

Uses of COSDictionary in org.apache.pdfbox.filter

Methods in org.apache.pdfbox.filter with parameters of type COSDictionary

Modifier and Type	Method and Description
void	Filter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	FlateFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	CryptFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	IdentityFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	JPXFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) Decode JPEG and JPEG2000 data using Java ImageIO library.
void	RunLengthDecodeFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	LZWFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	JBIG2Filter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) Decode JBIG2 data using Java ImageIO library.
void	CCITTFaxDecodeFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	DCTFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	ASCIIHexFilter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	ASCII85Filter.decode(java.io.InputStream compressedData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will decode some compressed data.
void	Filter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	FlateFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	CryptFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	IdentityFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	JPXFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	RunLengthDecodeFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	LZWFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	JBIG2Filter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	CCITTFaxDecodeFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	DCTFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	ASCIIHexFilter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.
void	ASCII85Filter.encode(java.io.InputStream rawData, java.io.OutputStream result, COSDictionary options, int filterIndex) This will encode some data.

Uses of COSDictionary in org.apache.pdfbox.pdfparser

Methods in org.apache.pdfbox.pdfparser that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	XrefTrailerResolver.getCurrentTrailer() Returns the trailer last set by XrefTrailerResolver.setTrailer(COSDictionary).
COSDictionary	XrefTrailerResolver.getFirstTrailer()
COSDictionary	XrefTrailerResolver.getLastTrailer()
COSDictionary	XrefTrailerResolver.getTrailer() Gets the resolved trailer.
protected COSDictionary	BaseParser.parseCOSDictionary() This will parse a PDF dictionary.
protected COSDictionary	ConformingPDFParser.readDictionaryBackwards()

Methods in org.apache.pdfbox.pdfparser with parameters of type COSDictionary

Modifier and Type	Method and Description
void	PDFXRefStream.addTrailerInfo(COSDictionary trailerDict) Copy all Trailer Information to this file.
protected void	NonSequentialPDFParser.decryptDictionary(COSDictionary dict, long objNr, long objGenNr)
protected COSStream	BaseParser.parseCOSStream(COSDictionary dic, RandomAccess file) This will read a COSStream from the input stream.
protected COSStream	NonSequentialPDFParser.parseCOSStream(COSDictionary dic, RandomAccess file) This will read a COSStream from the input stream using length attribute within dictionary.
protected void	PDFParser.readVersionInTrailer(COSDictionary parsedTrailer) The document catalog can also have a /Version parameter which overrides the version specified in the header if, and only if it is greater.
void	XrefTrailerResolver.setTrailer(COSDictionary trailer) Adds trailer information for current XRef object.

Uses of COSDictionary in org.apache.pdfbox.pdfwriter

Methods in org.apache.pdfbox.pdfwriter with parameters of type COSDictionary

Modifier and Type	Method and Description
java.lang.Object	COSWriter.visitFromDictionary(COSDictionary obj) visitFromDictionary method comment.

Uses of COSDictionary in org.apache.pdfbox.pdmodel

Methods in org.apache.pdfbox.pdmodel that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDDocumentNameDictionary.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDDocumentCatalog.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDResources.getCOSDictionary() This will get the underlying dictionary.
COSDictionary	PDPage.getCOSDictionary() This will get the underlying dictionary that this class acts on.
COSDictionary	PDDocumentNameDestinationDictionary.getCOSObject() Convert this standard java object to a COS object.
COSDictionary	PDDocumentInformation.getDictionary() This will get the underlying dictionary that this object wraps.
COSDictionary	PDPageNode.getDictionary() This will get the underlying dictionary that this class acts on.

Methods in org.apache.pdfbox.pdmodel with parameters of type COSDictionary

Modifier and Type	Method and Description
protected PDNameTreeNode	PDJavascriptNameTreeNode.createChildNode(COSDictionary dic) Create a child node object.
protected PDNameTreeNode	PDDestinationNameTreeNode.createChildNode(COSDictionary dic) Create a child node object.
protected PDNameTreeNode	PDEmbeddedFilesNameTreeNode.createChildNode(COSDictionary dic) Create a child node object.

Constructors in org.apache.pdfbox.pdmodel with parameters of type COSDictionary

Constructor and Description
PDDestinationNameTreeNode(COSDictionary dic) Constructor.
PDDocumentCatalog(PDDocument doc, COSDictionary rootDictionary) Constructor.
PDDocumentInformation(COSDictionary dic) Constructor that is used for a preexisting dictionary.
PDDocumentNameDestinationDictionary(COSDictionary dict) Constructor.
PDDocumentNameDictionary(PDDocumentCatalog cat, COSDictionary names) Constructor.
PDEmbeddedFilesNameTreeNode(COSDictionary dic) Constructor.
PDJavascriptNameTreeNode(COSDictionary dic) Constructor.
PDPage(COSDictionary pageDic) Creates a new instance of PDPage.
PDPageNode(COSDictionary pages) Creates a new instance of PDPage.
PDResources(COSDictionary resourceDictionary) Prepopulated resources.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.common

Subclasses of COSDictionary in org.apache.pdfbox.pdmodel.common

Modifier and Type	Class and Description
class	COSStreamArray This will take an array of streams and sequence them together.

Methods in org.apache.pdfbox.pdmodel.common that return COSDictionary

Modifier and Type	Method and Description
static COSDictionary	COSDictionaryMap.convert(java.util.Map<?,?> someMap) This will take a map<java.lang.String,org.apache.pdfbox.pdmodel.COSObjectable> and convert it into a COSDictionary<COSName,COSBase>.
COSDictionary	PDNumberTreeNode.getCOSDictionary() Convert this standard java object to a COS object.
protected COSDictionary	PDDictionaryWrapper.getCOSDictionary() Gets the COS dictionary.
COSDictionary	PDNameTreeNode.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDPageLabelRange.getCOSDictionary() Returns the underlying dictionary.
COSDictionary	COSStreamArray.getDictionary() This will get the dictionary that is associated with this stream.

Methods in org.apache.pdfbox.pdmodel.common with parameters of type COSDictionary

Modifier and Type	Method and Description
static COSDictionaryMap<java.lang.String,java.lang.Object>	COSDictionaryMap.convertBasicTypesToMap(COSDictionary map) This will take a COS dictionary and convert it into COSDictionaryMap.
protected PDNumberTreeNode	PDNumberTreeNode.createChildNode(COSDictionary dic) Create a child node object.
protected PDNameTreeNode	PDNameTreeNode.createChildNode(COSDictionary dic) Create a child node object.

Constructors in org.apache.pdfbox.pdmodel.common with parameters of type COSDictionary

Constructor and Description
COSArrayList(E actualObject, COSBase item, COSDictionary dictionary, COSName dictionaryKey) This is a really special constructor.
COSArrayList(E actualObject, COSBase item, COSDictionary dictionary, java.lang.String dictionaryKey) Deprecated. use the COSArrayList(Object, COSBase, COSDictionary, COSName) method instead
COSDictionaryMap(java.util.Map<K,V> actualsMap, COSDictionary dicMap) Constructor for this map.
PDDictionaryWrapper(COSDictionary dictionary) Creates a new instance with a given COS dictionary.
PDNameTreeNode(COSDictionary dict, java.lang.Class<? extends COSObjectable> valueClass) Constructor.
PDNumberTreeNode(COSDictionary dict, java.lang.Class<? extends COSObjectable> valueClass) Constructor.
PDPageLabelRange(COSDictionary dict) Creates a new page label range object from the given dictionary.
PDPageLabels(PDDocument document, COSDictionary dict) Creates an page label dictionary for a document using the information in the given COS dictionary.
PDTypedDictionaryWrapper(COSDictionary dictionary) Creates a new instance with a given COS dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.common.filespecification

Methods in org.apache.pdfbox.pdmodel.common.filespecification that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDComplexFileSpecification.getCOSDictionary() Convert this standard java object to a COS object.

Constructors in org.apache.pdfbox.pdmodel.common.filespecification with parameters of type COSDictionary

Constructor and Description
PDComplexFileSpecification(COSDictionary dict) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.common.function

Methods in org.apache.pdfbox.pdmodel.common.function that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDFunction.getDictionary() Returns the stream.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

Methods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure that return COSDictionary

Modifier and Type	Method and Description
protected COSDictionary	PDStructureNode.getCOSDictionary()
protected COSDictionary	PDObjectReference.getCOSDictionary() Returns the underlying dictionary.
protected COSDictionary	PDMarkedContentReference.getCOSDictionary()
COSDictionary	PDMarkInfo.getDictionary() Convert this standard java object to a COS object.

Methods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDStructureNode	PDStructureNode.create(COSDictionary node) Creates a node in the structure tree.
static PDAttributeObject	PDAttributeObject.create(COSDictionary dictionary) Creates an attribute object.

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure with parameters of type COSDictionary

Constructor and Description
PDAttributeObject(COSDictionary dictionary) Creates a new attribute object with a given dictionary.
PDDefaultAttributeObject(COSDictionary dictionary) Creates a default attribute object with a given dictionary.
PDMarkedContentReference(COSDictionary dictionary) Constructor for an existing marked content reference.
PDMarkInfo(COSDictionary dic) Constructor for an existing MarkInfo element.
PDObjectReference(COSDictionary theDictionary) Constructor for an existing object reference.
PDStructureElement(COSDictionary dic) Constructor for an existing structure element.
PDStructureNode(COSDictionary dictionary) Constructor for an existing structure node.
PDStructureTreeRoot(COSDictionary dic) Constructor for an existing structure element.
PDUserAttributeObject(COSDictionary dictionary)
PDUserProperty(COSDictionary dictionary, PDUserAttributeObject userAttributeObject) Creates a user property with a given dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent

Methods in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDMarkedContent.getProperties() Gets the properties.

Methods in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDMarkedContent	PDMarkedContent.create(COSName tag, COSDictionary properties) Creates a marked-content sequence.

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent with parameters of type COSDictionary

Constructor and Description
PDMarkedContent(COSName tag, COSDictionary properties) Creates a new marked content object.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.documentinterchange.prepress

Methods in org.apache.pdfbox.pdmodel.documentinterchange.prepress that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDBoxStyle.getDictionary() Convert this standard java object to a COS object.

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.prepress with parameters of type COSDictionary

Constructor and Description
PDBoxStyle(COSDictionary dic) Constructor for an existing BoxStyle element.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf with parameters of type COSDictionary

Constructor and Description
PDArtifactMarkedContent(COSDictionary properties)
PDExportFormatAttributeObject(COSDictionary dictionary) Creates a new ExportFormat attribute object with a given dictionary.
PDLayoutAttributeObject(COSDictionary dictionary) Creates a new Layout attribute object with a given dictionary.
PDListAttributeObject(COSDictionary dictionary) Creates a new List attribute object with a given dictionary.
PDPrintFieldAttributeObject(COSDictionary dictionary) Creates a new PrintField attribute object with a given dictionary.
PDStandardAttributeObject(COSDictionary dictionary) Creates a new standard attribute object with a given dictionary.
PDTableAttributeObject(COSDictionary dictionary) Creates a new Table attribute object with a given dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.encryption

Fields in org.apache.pdfbox.pdmodel.encryption declared as COSDictionary

Modifier and Type	Field and Description
protected COSDictionary	PDCryptFilterDictionary.cryptFilterDictionary COS crypt filter dictionary.
protected COSDictionary	PDEncryptionDictionary.encryptionDictionary COS encryption dictionary.

Methods in org.apache.pdfbox.pdmodel.encryption that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDCryptFilterDictionary.getCOSDictionary() This will get the dictionary associated with this crypt filter dictionary.
COSDictionary	PDEncryptionDictionary.getCOSDictionary() This will get the dictionary associated with this encryption dictionary.

Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDEncryptionDictionary	PDEncryptionManager.getEncryptionDictionary(COSDictionary dictionary) Deprecated. This will get the correct security handler for the encryption dictionary.

Constructors in org.apache.pdfbox.pdmodel.encryption with parameters of type COSDictionary

Constructor and Description
PDCryptFilterDictionary(COSDictionary d) creates a new crypt filter dictionary from the low level dictionary provided.
PDEncryptionDictionary(COSDictionary d) creates a new encryption dictionary from the low level dictionary provided.
PDStandardEncryption(COSDictionary dict) Deprecated. Constructor from existing dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.fdf

Fields in org.apache.pdfbox.pdmodel.fdf declared as COSDictionary

Modifier and Type	Field and Description
protected COSDictionary	FDFAnnotation.annot Annotation dictionary.

Methods in org.apache.pdfbox.pdmodel.fdf that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	FDFPageInfo.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFTemplate.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFAnnotation.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFDictionary.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFNamedPageReference.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFField.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFCatalog.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFIconFit.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFPage.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	FDFJavaScript.getCOSDictionary() Convert this standard java object to a COS object.

Methods in org.apache.pdfbox.pdmodel.fdf with parameters of type COSDictionary

Modifier and Type	Method and Description
static FDFAnnotation	FDFAnnotation.create(COSDictionary fdfDic) Create the correct FDFAnnotation.

Constructors in org.apache.pdfbox.pdmodel.fdf with parameters of type COSDictionary

Constructor and Description
FDFAnnotation(COSDictionary a) Constructor.
FDFAnnotationCaret(COSDictionary a) Constructor.
FDFAnnotationCircle(COSDictionary a) Constructor.
FDFAnnotationFileAttachment(COSDictionary a) Constructor.
FDFAnnotationFreeText(COSDictionary a) Constructor.
FDFAnnotationHighlight(COSDictionary a) Constructor.
FDFAnnotationInk(COSDictionary a) Constructor.
FDFAnnotationLine(COSDictionary a) Constructor.
FDFAnnotationPolygon(COSDictionary a) Constructor.
FDFAnnotationPolyline(COSDictionary a) Constructor.
FDFAnnotationSound(COSDictionary a) Constructor.
FDFAnnotationSquare(COSDictionary a) Constructor.
FDFAnnotationSquiggly(COSDictionary a) Constructor.
FDFAnnotationStamp(COSDictionary a) Constructor.
FDFAnnotationStrikeOut(COSDictionary a) Constructor.
FDFAnnotationText(COSDictionary a) Constructor.
FDFAnnotationUnderline(COSDictionary a) Constructor.
FDFCatalog(COSDictionary cat) Constructor.
FDFDictionary(COSDictionary fdfDictionary) Constructor.
FDFField(COSDictionary f) Constructor.
FDFIconFit(COSDictionary f) Constructor.
FDFJavaScript(COSDictionary javaScript) Constructor.
FDFNamedPageReference(COSDictionary r) Constructor.
FDFPage(COSDictionary p) Constructor.
FDFPageInfo(COSDictionary p) Constructor.
FDFTemplate(COSDictionary t) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.font

Fields in org.apache.pdfbox.pdmodel.font declared as COSDictionary

Modifier and Type	Field and Description
protected COSDictionary	PDFont.font The cos dictionary for this font.

Methods in org.apache.pdfbox.pdmodel.font that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDFontDescriptorDictionary.getCOSDictionary() This will get the dictionary for this object.

Methods in org.apache.pdfbox.pdmodel.font with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDFont	PDFontFactory.createFont(COSDictionary dic) This will create the correct font based on information in the dictionary.
static PDFont	PDFontFactory.createFont(COSDictionary dic, java.util.Map fontCache) Deprecated. due to some side effects font caching is no longer supported, use PDFontFactory.createFont(COSDictionary) instead

Constructors in org.apache.pdfbox.pdmodel.font with parameters of type COSDictionary

Constructor and Description
PDCIDFont(COSDictionary fontDictionary) Constructor.
PDCIDFontType0Font(COSDictionary fontDictionary) Constructor.
PDCIDFontType2Font(COSDictionary fontDictionary) Constructor.
PDFont(COSDictionary fontDictionary) Constructor.
PDFontDescriptorDictionary(COSDictionary desc) Constructor.
PDMMType1Font(COSDictionary fontDictionary) Constructor.
PDSimpleFont(COSDictionary fontDictionary) Constructor.
PDTrueTypeFont(COSDictionary fontDictionary) Constructor.
PDType0Font(COSDictionary fontDictionary) Constructor.
PDType1CFont(COSDictionary fontDictionary) Constructor.
PDType1Font(COSDictionary fontDictionary) Constructor.
PDType3Font(COSDictionary fontDictionary) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.graphics

Methods in org.apache.pdfbox.pdmodel.graphics that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDExtendedGraphicsState.getCOSDictionary() This will get the underlying dictionary that this class acts on.

Constructors in org.apache.pdfbox.pdmodel.graphics with parameters of type COSDictionary

Constructor and Description
PDExtendedGraphicsState(COSDictionary dictionary) Create a graphics state from an existing dictionary.
PDShading(COSName name, COSDictionary shading) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.graphics.color

Methods in org.apache.pdfbox.pdmodel.graphics.color that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDDeviceNAttributes.getCOSDictionary() This will get the underlying cos dictionary.

Constructors in org.apache.pdfbox.pdmodel.graphics.color with parameters of type COSDictionary

Constructor and Description
PDDeviceNAttributes(COSDictionary attributes) Constructor.
PDOutputIntent(COSDictionary dictionary)

Uses of COSDictionary in org.apache.pdfbox.pdmodel.graphics.optionalcontent

Constructors in org.apache.pdfbox.pdmodel.graphics.optionalcontent with parameters of type COSDictionary

Constructor and Description
PDOptionalContentGroup(COSDictionary dict) Creates a new instance based on a given COSDictionary.
PDOptionalContentProperties(COSDictionary props) Creates a new instance based on a given COSDictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.graphics.pattern

Methods in org.apache.pdfbox.pdmodel.graphics.pattern that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDPatternResources.getCOSDictionary() This will get the underlying dictionary.

Methods in org.apache.pdfbox.pdmodel.graphics.pattern with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDPatternResources	PDPatternResources.create(COSDictionary resourceDictionary) Create the correct PD Model pattern based on the COS base pattern.

Constructors in org.apache.pdfbox.pdmodel.graphics.pattern with parameters of type COSDictionary

Constructor and Description
PDPatternResources(COSDictionary resourceDictionary) Prepopulated pattern resources.
PDShadingPatternResources(COSDictionary resourceDictionary) Prepopulated pattern resources.
PDTilingPatternResources(COSDictionary resourceDictionary) Prepopulated pattern resources.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.graphics.shading

Methods in org.apache.pdfbox.pdmodel.graphics.shading that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDShadingResources.getCOSDictionary() This will get the underlying dictionary.

Methods in org.apache.pdfbox.pdmodel.graphics.shading with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDShadingResources	PDShadingResources.create(COSDictionary resourceDictionary) Create the correct PD Model shading based on the COS base shading.

Constructors in org.apache.pdfbox.pdmodel.graphics.shading with parameters of type COSDictionary

Constructor and Description
PDShadingResources(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType1(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType2(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType3(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType4(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType5(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType6(COSDictionary shadingDictionary) Constructor using the given shading dictionary.
PDShadingType7(COSDictionary shadingDictionary) Constructor using the given shading dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.graphics.xobject

Methods in org.apache.pdfbox.pdmodel.graphics.xobject that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDPixelMap.getDecodeParams() Deprecated. Use PDStream.getDecodeParms() instead

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.action

Methods in org.apache.pdfbox.pdmodel.interactive.action that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDPageAdditionalActions.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDDocumentCatalogAdditionalActions.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDFormFieldAdditionalActions.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDAnnotationAdditionalActions.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDAdditionalActions.getCOSDictionary() Convert this standard java object to a COS object.

Methods in org.apache.pdfbox.pdmodel.interactive.action with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDAction	PDActionFactory.createAction(COSDictionary action) This will create the correct type of action based on the type specified in the dictionary.

Constructors in org.apache.pdfbox.pdmodel.interactive.action with parameters of type COSDictionary

Constructor and Description
PDAdditionalActions(COSDictionary a) Constructor.
PDAnnotationAdditionalActions(COSDictionary a) Constructor.
PDDocumentCatalogAdditionalActions(COSDictionary a) Constructor.
PDFormFieldAdditionalActions(COSDictionary a) Constructor.
PDPageAdditionalActions(COSDictionary a) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.action.type

Fields in org.apache.pdfbox.pdmodel.interactive.action.type declared as COSDictionary

Modifier and Type	Field and Description
protected COSDictionary	PDAction.action The action dictionary.
protected COSDictionary	PDWindowsLaunchParams.params The params dictionary.

Methods in org.apache.pdfbox.pdmodel.interactive.action.type that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDWindowsLaunchParams.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDAction.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDActionNamed.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDActionRemoteGoTo.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDActionURI.getCOSDictionary() Convert this standard java object to a COS object.
COSDictionary	PDURIDictionary.getDictionary() Returns the corresponding dictionary.

Constructors in org.apache.pdfbox.pdmodel.interactive.action.type with parameters of type COSDictionary

Constructor and Description
PDAction(COSDictionary a) Constructor.
PDActionGoTo(COSDictionary a) Constructor.
PDActionJavaScript(COSDictionary a) Constructor #2.
PDActionLaunch(COSDictionary a) Constructor.
PDActionNamed(COSDictionary a) Constructor.
PDActionRemoteGoTo(COSDictionary a) Constructor.
PDActionURI(COSDictionary a) Constructor.
PDURIDictionary(COSDictionary dictionary) Constructor.
PDWindowsLaunchParams(COSDictionary p) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.annotation

Methods in org.apache.pdfbox.pdmodel.interactive.annotation that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDBorderStyleDictionary.getDictionary() returns the dictionary.
COSDictionary	PDExternalDataDictionary.getDictionary() returns the dictionary.
COSDictionary	PDAppearanceDictionary.getDictionary() returns the dictionary.
COSDictionary	PDAppearanceCharacteristicsDictionary.getDictionary() returns the dictionary.
COSDictionary	PDAnnotation.getDictionary() returns the dictionary.
COSDictionary	PDBorderEffectDictionary.getDictionary() returns the dictionary.

Constructors in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type COSDictionary

Constructor and Description
PDAnnotation(COSDictionary dict) Constructor.
PDAnnotationFileAttachment(COSDictionary field) Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationLine(COSDictionary field) Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationLink(COSDictionary field) Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationMarkup(COSDictionary dict) Constructor.
PDAnnotationPopup(COSDictionary field) Creates a popup annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationRubberStamp(COSDictionary field) Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationSquareCircle(COSDictionary field) Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationText(COSDictionary field) Creates a Text annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationTextMarkup(COSDictionary field) Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationUnknown(COSDictionary dic) Creates an arbitary annotation from a COSDictionary, expected to be a correct object definition for some sort of annotation.
PDAnnotationWidget(COSDictionary field) Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF.
PDAppearanceCharacteristicsDictionary(COSDictionary dict) Constructor.
PDAppearanceDictionary(COSDictionary dict) Constructor.
PDBorderEffectDictionary(COSDictionary dict) Constructor.
PDBorderStyleDictionary(COSDictionary dict) Constructor.
PDExternalDataDictionary(COSDictionary dictionary) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.digitalsignature

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDSeedValueTimeStamp.getDictionary() Convert this standard java object to a COS dictionary.
COSDictionary	PDSeedValueMDP.getDictionary() Convert this standard java object to a COS dictionary.
COSDictionary	PDSignature.getDictionary() Convert this standard java object to a COS dictionary.
COSDictionary	PDPropBuildDataDict.getDictionary() Convert this standard java object to a COS dictionary.
COSDictionary	PDPropBuild.getDictionary() Convert this standard java object to a COS dictionary.
COSDictionary	PDSeedValue.getDictionary() Convert this standard java object to a COS dictionary.

Constructors in org.apache.pdfbox.pdmodel.interactive.digitalsignature with parameters of type COSDictionary

Constructor and Description
PDPropBuild(COSDictionary dict) Constructor.
PDPropBuildDataDict(COSDictionary dict) Constructor.
PDSeedValue(COSDictionary dict) Constructor.
PDSeedValueMDP(COSDictionary dict) Constructor.
PDSeedValueTimeStamp(COSDictionary dict) Constructor.
PDSignature(COSDictionary dict) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDFTemplateStructure.getAcroFormDictionary() Gets Dictionary of AcroForm.
COSDictionary	PDFTemplateStructure.getWidgetDictionary() Gets Widget Dictionary.

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with parameters of type COSDictionary

Modifier and Type	Method and Description
void	PDFTemplateStructure.setAcroFormDictionary(COSDictionary acroFormDictionary) Acroform have its Dictionary, so we here set the Dictionary which is in this location: AcroForm/DR
void	PDFTemplateStructure.setWidgetDictionary(COSDictionary widgetDictionary) Sets Widget Dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline

Fields in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline declared as COSDictionary

Modifier and Type	Field and Description
protected COSDictionary	PDOutlineNode.node The dictionary for this node.

Methods in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDOutlineNode.getCOSDictionary() Convert this standard java object to a COS object.

Constructors in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline with parameters of type COSDictionary

Constructor and Description
PDDocumentOutline(COSDictionary dic) Constructor for an existing document outline.
PDOutlineItem(COSDictionary dic) Constructor for an existing outline item.
PDOutlineNode(COSDictionary dict) Default Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.form

Methods in org.apache.pdfbox.pdmodel.interactive.form that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDField.getDictionary() This will get the dictionary associated with this field.
COSDictionary	PDAcroForm.getDictionary() This will get the dictionary that this form wraps.

Methods in org.apache.pdfbox.pdmodel.interactive.form with parameters of type COSDictionary

Modifier and Type	Method and Description
static PDField	PDFieldFactory.createField(PDAcroForm acroForm, COSDictionary field) This method creates a COSField subclass from the given field.

Constructors in org.apache.pdfbox.pdmodel.interactive.form with parameters of type COSDictionary

Constructor and Description
PDAcroForm(PDDocument doc, COSDictionary form) Constructor.
PDCheckbox(PDAcroForm theAcroForm, COSDictionary field)
PDChoiceButton(PDAcroForm theAcroForm, COSDictionary field)
PDChoiceField(PDAcroForm theAcroForm, COSDictionary field)
PDField(PDAcroForm theAcroForm, COSDictionary field) Creates a COSField from a COSDictionary, expected to be a correct object definition for a field in PDF.
PDPushButton(PDAcroForm theAcroForm, COSDictionary field)
PDRadioCollection(PDAcroForm theAcroForm, COSDictionary field)
PDSignature(PDAcroForm theAcroForm, COSDictionary field) Deprecated.
PDSignatureField(PDAcroForm theAcroForm, COSDictionary field)
PDTextbox(PDAcroForm theAcroForm, COSDictionary field)
PDUnknownField(PDAcroForm theAcroForm, COSDictionary field)
PDVariableText(PDAcroForm theAcroForm, COSDictionary field)

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.measurement

Methods in org.apache.pdfbox.pdmodel.interactive.measurement that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDViewportDictionary.getDictionary() This will return the corresponding dictionary.
COSDictionary	PDNumberFormatDictionary.getDictionary() This will return the dictionary.
COSDictionary	PDMeasureDictionary.getDictionary() This will return the corresponding dictionary.

Constructors in org.apache.pdfbox.pdmodel.interactive.measurement with parameters of type COSDictionary

Constructor and Description
PDMeasureDictionary(COSDictionary dictionary) Constructor.
PDNumberFormatDictionary(COSDictionary dictionary) Constructor.
PDRectlinearMeasureDictionary(COSDictionary dictionary) Constructor.
PDViewportDictionary(COSDictionary dictionary) Constructor.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.pagenavigation

Methods in org.apache.pdfbox.pdmodel.interactive.pagenavigation that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDThreadBead.getDictionary() This will get the underlying dictionary that this object wraps.
COSDictionary	PDThread.getDictionary() This will get the underlying dictionary that this object wraps.

Constructors in org.apache.pdfbox.pdmodel.interactive.pagenavigation with parameters of type COSDictionary

Constructor and Description
PDThread(COSDictionary t) Constructor that is used for a preexisting dictionary.
PDThreadBead(COSDictionary b) Constructor that is used for a preexisting dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.interactive.viewerpreferences

Methods in org.apache.pdfbox.pdmodel.interactive.viewerpreferences that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	PDViewerPreferences.getDictionary() This will get the underlying dictionary that this object wraps.

Constructors in org.apache.pdfbox.pdmodel.interactive.viewerpreferences with parameters of type COSDictionary

Constructor and Description
PDViewerPreferences(COSDictionary dic) Constructor that is used for a preexisting dictionary.

Uses of COSDictionary in org.apache.pdfbox.pdmodel.markedcontent

Constructors in org.apache.pdfbox.pdmodel.markedcontent with parameters of type COSDictionary

Constructor and Description
PDPropertyList(COSDictionary dict) Creates a new instance based on a given COSDictionary.

Uses of COSDictionary in org.apache.pdfbox.util

Methods in org.apache.pdfbox.util that return COSDictionary

Modifier and Type	Method and Description
COSDictionary	ImageParameters.getDictionary() This will get the dictionary that stores the image parameters.

Methods in org.apache.pdfbox.util with parameters of type COSDictionary

Modifier and Type	Method and Description
void	PDFMarkedContentExtractor.beginMarkedContentSequence(COSName tag, COSDictionary properties)
static boolean	BitFlagHelper.getFlag(COSDictionary dic, COSName field, int bitFlag) Gets the boolean value from the flags at the given bit position.
static boolean	BitFlagHelper.getFlag(COSDictionary dic, java.lang.String field, int bitFlag) Deprecated. use BitFlagHelper.getFlag(COSDictionary, COSName, int) using COSName constants instead
static void	BitFlagHelper.setFlag(COSDictionary dic, COSName field, int bitFlag, boolean value) Sets the given boolean value at bitPos in the flags.
static void	BitFlagHelper.setFlag(COSDictionary dic, java.lang.String field, int bitFlag, boolean value) Deprecated. use BitFlagHelper.setFlag(COSDictionary, COSName, int, boolean) using COSName constants instead

Constructors in org.apache.pdfbox.util with parameters of type COSDictionary

Constructor and Description
ImageParameters(COSDictionary params) Constructor.