Uses of Class org.apache.pdfbox.cos.COSDictionary (Apache PDFBox 1.8.12 API)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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
`List<COSDictionary>`	COSDocument.`getSignatureDictionaries()` + This will return a list of signature dictionaries as COSDictionary. +
`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 dictionarys keys/values to this dictionary. +
`COSStream`	COSDocument.`createCOSStream(COSDictionary dictionary)` + Create a new COSStream using the underlying scratch file. +
`void`	COSDictionary.`mergeInto(COSDictionary dic)` + This will add all of the dictionarys keys/values to this dictionary, but only if they don't already exist. +
`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. +
`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.
+
+

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`	RunLengthDecodeFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	LZWFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	JPXFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + Decode JPEG and JPEG2000 data using Java ImageIO library. +
`void`	JBIG2Filter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + Decode JBIG2 data using Java ImageIO library. +
`void`	IdentityFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	FlateFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	Filter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	DCTFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	CryptFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	CCITTFaxDecodeFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	ASCIIHexFilter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	ASCII85Filter.`decode(InputStream compressedData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will decode some compressed data. +
`void`	RunLengthDecodeFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	LZWFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	JPXFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	JBIG2Filter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	IdentityFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	FlateFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	Filter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	DCTFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	CryptFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	CCITTFaxDecodeFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	ASCIIHexFilter.`encode(InputStream rawData, + OutputStream result, + COSDictionary options, + int filterIndex)` + This will encode some data. +
`void`	ASCII85Filter.`encode(InputStream rawData, + 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`	NonSequentialPDFParser.`parseCOSStream(COSDictionary dic, + RandomAccess file)` + This will read a COSStream from the input stream using length attribute + within dictionary. +
`protected COSStream`	BaseParser.`parseCOSStream(COSDictionary dic, + RandomAccess file)` + This will read a COSStream from the input stream. +
`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
`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`	PDResources.`getCOSDictionary()` + This will get the underlying dictionary. +
`COSDictionary`	PDPage.`getCOSDictionary()` + This will get the underlying dictionary that this class acts on. +
`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`	PDDocumentNameDestinationDictionary.`getCOSObject()` + Convert this standard java object to a COS object. +
`COSDictionary`	PDPageNode.`getDictionary()` + This will get the underlying dictionary that this class acts on. +
`COSDictionary`	PDDocumentInformation.`getDictionary()` + This will get the underlying dictionary that this object wraps. +

+ + + + + + + + + + + + + + + + + + + + +

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`	PDEmbeddedFilesNameTreeNode.`createChildNode(COSDictionary dic)` + Create a child node object. +
`protected PDNameTreeNode`	PDDestinationNameTreeNode.`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(Map<?,?> someMap)` + This will take a map<java.lang.String,org.apache.pdfbox.pdmodel.COSObjectable> + and convert it into a COSDictionary<COSName,COSBase>. +
`COSDictionary`	PDPageLabelRange.`getCOSDictionary()` + Returns the underlying dictionary. +
`COSDictionary`	PDNumberTreeNode.`getCOSDictionary()` + Convert this standard java object to a COS object. +
`COSDictionary`	PDNameTreeNode.`getCOSDictionary()` + Convert this standard java object to a COS object. +
`protected COSDictionary`	PDDictionaryWrapper.`getCOSDictionary()` + Gets the COS 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<String,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, + String dictionaryKey)` + Deprecated. + use the `COSArrayList.COSArrayList(Object, COSBase, COSDictionary, COSName)` method instead + +
`COSDictionaryMap(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, + Class<? extends COSObjectable> valueClass)` + Constructor. +
`PDNumberTreeNode(COSDictionary dict, + 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. +