A B C D E F G H I J K L M N O P Q R S T U V W X Z

A

A - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
AA - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ABBREVIATED_NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
The abbreviated name of this color space.
ABBREVIATED_NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
The abbreviated name of this color space.
ABBREVIATED_NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
The abbreviated name of this color space.
ABBREVIATED_NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDIndexed
The abbreviated name of this color space.
ACRO_FORM - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
AFMEncoding - class org.pdfbox.encoding.AFMEncoding.
This will handle the encoding from an AFM font.
AFMEncoding(FontMetric) - Constructor for class org.pdfbox.encoding.AFMEncoding
Constructor.
ANNOTS - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
AP - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ARCFour - class org.pdfbox.encryption.ARCFour.
This class is an implementation of the alleged RC4 algorithm.
ARCFour() - Constructor for class org.pdfbox.encryption.ARCFour
Constructor.
ARRAY_CLOSE - Static variable in class org.pdfbox.pdfwriter.COSWriter
The array close token.
ARRAY_OPEN - Static variable in class org.pdfbox.pdfwriter.COSWriter
The array open token.
ART_BOX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ASCII85Filter - class org.pdfbox.filter.ASCII85Filter.
This is the used for the ASCIIHexDecode filter.
ASCII85Filter() - Constructor for class org.pdfbox.filter.ASCII85Filter
 
ASCII85InputStream - class org.pdfbox.io.ASCII85InputStream.
This class represents an ASCII85 stream.
ASCII85InputStream(InputStream) - Constructor for class org.pdfbox.io.ASCII85InputStream
Constructor.
ASCII85OutputStream - class org.pdfbox.io.ASCII85OutputStream.
This class represents an ASCII85 output stream.
ASCII85OutputStream(OutputStream) - Constructor for class org.pdfbox.io.ASCII85OutputStream
Constructor.
ASCII85_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ASCII85_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ASCIIHexFilter - class org.pdfbox.filter.ASCIIHexFilter.
This is the used for the ASCIIHexDecode filter.
ASCIIHexFilter() - Constructor for class org.pdfbox.filter.ASCIIHexFilter
 
ASCII_HEX_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ASCII_HEX_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ATTACHMENT_NAME_GRAPH - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
ATTACHMENT_NAME_PAPERCLIP - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
ATTACHMENT_NAME_PUSH_PIN - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
ATTACHMENT_NAME_TAG - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
AbstractExample - class org.pdfbox.examples.AbstractExample.
A simple class which has some methods used by all examples.
AbstractExample() - Constructor for class org.pdfbox.examples.AbstractExample
 
AccessPermission - class org.pdfbox.pdmodel.encryption.AccessPermission.
This class represents the access permissions to a document.
AccessPermission(byte[]) - Constructor for class org.pdfbox.pdmodel.encryption.AccessPermission
Create a new access permission object from a byte array.
AccessPermission() - Constructor for class org.pdfbox.pdmodel.encryption.AccessPermission
Create a new access permission object.
AddJavascript - class org.pdfbox.examples.pdmodel.AddJavascript.
This is an example of how to set some javascript in the document.
AddMessageToEachPage - class org.pdfbox.examples.pdmodel.AddMessageToEachPage.
This is an example of how to add a message to every page in a pdf document.
AddMessageToEachPage() - Constructor for class org.pdfbox.examples.pdmodel.AddMessageToEachPage
Constructor.
AddMetadataFromDocInfo - class org.pdfbox.examples.pdmodel.AddMetadataFromDocInfo.
This is an example on how to add metadata to a document.
Annotation - class org.pdfbox.examples.pdmodel.Annotation.
This is an example on how to add annotations to pages of a PDF document.
AppendRectangleToPath - class org.pdfbox.util.operator.pagedrawer.AppendRectangleToPath.
Implementation of content stream operator for page drawer.
AppendRectangleToPath() - Constructor for class org.pdfbox.util.operator.pagedrawer.AppendRectangleToPath
 
ArrayEntry - class org.pdfbox.pdfviewer.ArrayEntry.
This is a simple class that will contain an index and a value.
ArrayEntry() - Constructor for class org.pdfbox.pdfviewer.ArrayEntry
 
Average - class org.pdfbox.pdmodel.graphics.predictor.Average.
We can use raw on the right hand side of the decoding formula because it is already decoded.
Average() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.Average
 
aboveLeftPixel(byte[], int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the above-left pixel from the buffer.
abovePixel(byte[], int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the above pixel from the buffer.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSArray
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSBase
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSBoolean
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSDictionary
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSDocument
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSFloat
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSInteger
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSName
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSNull
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSObject
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSStream
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.cos.COSString
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.pdfbox.pdmodel.common.COSStreamArray
visitor pattern double dispatch method.
accept(File) - Method in class org.pdfbox.util.ExtensionFileFilter
action - Variable in class org.pdfbox.pdmodel.interactive.action.type.PDAction
The action dictionary.
add(COSBase) - Method in class org.pdfbox.cos.COSArray
This will add an object to the array.
add(COSObjectable) - Method in class org.pdfbox.cos.COSArray
This will add an object to the array.
add(int, COSBase) - Method in class org.pdfbox.cos.COSArray
Add the specified object at the ith location and push the rest to the right.
add(Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
add(int, Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
addAll(Collection) - Method in class org.pdfbox.cos.COSArray
This will add an object to the array.
addAll(COSArray) - Method in class org.pdfbox.cos.COSArray
This will add all objects to this array.
addAll(int, Collection) - Method in class org.pdfbox.cos.COSArray
Add the specified object at the ith location and push the rest to the right.
addAll(COSDictionary) - Method in class org.pdfbox.cos.COSDictionary
This will add all of the dictionarys keys/values to this dictionary.
addAll(Collection) - Method in class org.pdfbox.pdmodel.common.COSArrayList
addAll(int, Collection) - Method in class org.pdfbox.pdmodel.common.COSArrayList
addCharacterEncoding(int, COSName) - Method in class org.pdfbox.encoding.Encoding
This will add a character encoding.
addCompression() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
If there are not compression filters on the current stream then this will add a compression filter, flate compression for example.
addCompression() - Method in class org.pdfbox.pdmodel.common.PDStream
If there are not compression filters on the current stream then this will add a compression filter, flate compression for example.
addFileset(FileSet) - Method in class org.pdfbox.ant.PDFToTextTask
Adds a set of files (nested fileset attribute).
addFilter(COSName, Filter) - Method in class org.pdfbox.filter.FilterManager
This will add an available filter.
addObject(COSObject) - Method in class org.pdfbox.cos.COSDocument
This will add an object to this document.
addPage(PDPage) - Method in class org.pdfbox.pdmodel.PDDocument
This will add a page to the document.
addRecipient(PublicKeyRecipient) - Method in class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Adds a new recipient to the recipients list.
addRegion(String, Rectangle2D) - Method in class org.pdfbox.util.PDFTextStripperByArea
Add a new region to group text by.
addSource(String) - Method in class org.pdfbox.util.PDFMergerUtility
Add a source file to the list of files to merge.
addSource(File) - Method in class org.pdfbox.util.PDFMergerUtility
Add a source file to the list of files to mere.
addTreeModelListener(TreeModelListener) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Adds a listener for the TreeModelEvent posted after the tree changes.
addXRefEntry(COSWriterXRefEntry) - Method in class org.pdfbox.pdfwriter.COSWriter
add an entry in the x ref table for later dump.
addXref(PDFXref) - Method in class org.pdfbox.pdfparser.BaseParser
This will add an xref.
append(byte[]) - Method in class org.pdfbox.cos.COSString
This will append a byte[] to the string.
append(int) - Method in class org.pdfbox.cos.COSString
This will append a byte to the string.
appendBead(PDThreadBead) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Append a bead after this bead.
appendChild(PDOutlineItem) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
append a child node to this node.
appendDocument(PDDocument, PDDocument) - Method in class org.pdfbox.util.PDFMergerUtility
append all pages from source to destination.
appendRawCommands(String) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(byte[]) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendStream(COSStream) - Method in class org.pdfbox.pdmodel.common.COSStreamArray
Appends a new stream to the array that represents this object's stream.
array - Variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Storage for the page destination.
available() - Method in class org.pdfbox.io.ASCII85InputStream
Unsupported.
available() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Available bytes.
available() - Method in class org.pdfbox.io.RandomAccessFileInputStream

B

B - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
BASE_ENCODING - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
BASE_FONT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
BBOX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
BLEED_BOX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
BOUNDARY_ART_BOX - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_BLEED_BOX - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_CROP_BOX - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_MEDIA_BOX - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_TRIM_BOX - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BS_ESCAPE - Static variable in class org.pdfbox.cos.COSString
BS escape characters.
BadSecurityHandlerException - exception org.pdfbox.pdmodel.encryption.BadSecurityHandlerException.
This exception can be thrown by the SecurityHandlersManager class when a document required an unimplemented security handler to be opened.
BadSecurityHandlerException() - Constructor for class org.pdfbox.pdmodel.encryption.BadSecurityHandlerException
Default Constructor.
BadSecurityHandlerException(Exception) - Constructor for class org.pdfbox.pdmodel.encryption.BadSecurityHandlerException
Constructor.
BadSecurityHandlerException(String) - Constructor for class org.pdfbox.pdmodel.encryption.BadSecurityHandlerException
Constructor.
BaseParser - class org.pdfbox.pdfparser.BaseParser.
This class is used to contain parsing logic that will be used by both the PDFParser and the COSStreamParser.
BaseParser(InputStream) - Constructor for class org.pdfbox.pdfparser.BaseParser
Constructor.
BaseParser(byte[]) - Constructor for class org.pdfbox.pdfparser.BaseParser
Constructor.
BeginInlineImage - class org.pdfbox.util.operator.pagedrawer.BeginInlineImage.
Implementation of content stream operator for page drawer.
BeginInlineImage() - Constructor for class org.pdfbox.util.operator.pagedrawer.BeginInlineImage
 
BeginText - class org.pdfbox.util.operator.BeginText.
Titre : PDFEngine Modification.
BeginText() - Constructor for class org.pdfbox.util.operator.BeginText
 
BitFlagHelper - class org.pdfbox.util.BitFlagHelper.
This class will be used for bit flag operations.
ByteArrayPushBackInputStream - class org.pdfbox.io.ByteArrayPushBackInputStream.
PushBackInputStream for byte arrays.
ByteArrayPushBackInputStream(byte[]) - Constructor for class org.pdfbox.io.ByteArrayPushBackInputStream
Constructor.
beginText() - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Begin some text operations.

C

CALGRAY - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
CALRGB - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
CATALOG - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
CCITTFAX_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
CCITTFAX_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
CCITTFaxDecodeFilter - class org.pdfbox.filter.CCITTFaxDecodeFilter.
This is a filter for the CCITTFax Decoder.
CCITTFaxDecodeFilter() - Constructor for class org.pdfbox.filter.CCITTFaxDecodeFilter
Constructor.
CLEAR_TABLE - Static variable in class org.pdfbox.filter.LZWFilter
The LZW clear table code.
COLORSPACE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
COMMENT - Static variable in class org.pdfbox.pdfwriter.COSWriter
The start to a PDF comment.
CONTENTS - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
COSArray - class org.pdfbox.cos.COSArray.
An array of PDFBase objects as part of the PDF document.
COSArray() - Constructor for class org.pdfbox.cos.COSArray
Constructor.
COSArrayList - class org.pdfbox.pdmodel.common.COSArrayList.
This is an implementation of a List that will sync its contents to a COSArray.
COSArrayList() - Constructor for class org.pdfbox.pdmodel.common.COSArrayList
Default constructor.
COSArrayList(List, COSArray) - Constructor for class org.pdfbox.pdmodel.common.COSArrayList
Constructor.
COSArrayList(Object, COSBase, COSDictionary, String) - Constructor for class org.pdfbox.pdmodel.common.COSArrayList
This is a really special constructor.
COSBase - class org.pdfbox.cos.COSBase.
The base object that all objects in the PDF document will extend.
COSBase() - Constructor for class org.pdfbox.cos.COSBase
Constructor.
COSBoolean - class org.pdfbox.cos.COSBoolean.
This class represents a boolean value in the PDF document.
COSDictionary - class org.pdfbox.cos.COSDictionary.
This class represents a dictionary where name/value pairs reside.
COSDictionary() - Constructor for class org.pdfbox.cos.COSDictionary
Constructor.
COSDictionary(COSDictionary) - Constructor for class org.pdfbox.cos.COSDictionary
Copy Constructor.
COSDictionaryMap - class org.pdfbox.pdmodel.common.COSDictionaryMap.
This is a Map that will automatically sync the contents to a COSDictionary.
COSDictionaryMap(Map, COSDictionary) - Constructor for class org.pdfbox.pdmodel.common.COSDictionaryMap
Constructor for this map.
COSDocument - class org.pdfbox.cos.COSDocument.
This is the in-memory representation of the PDF document.
COSDocument() - Constructor for class org.pdfbox.cos.COSDocument
Constructor.
COSDocument(File) - Constructor for class org.pdfbox.cos.COSDocument
Constructor that will create a create a scratch file in the following directory.
COSDocument(RandomAccess) - Constructor for class org.pdfbox.cos.COSDocument
Constructor that will use the following random access file for storage of the PDF streams.
COSFloat - class org.pdfbox.cos.COSFloat.
This class represents a floating point number in a PDF document.
COSFloat(float) - Constructor for class org.pdfbox.cos.COSFloat
Constructor.
COSFloat(String) - Constructor for class org.pdfbox.cos.COSFloat
Constructor.
COSHEXTable - class org.pdfbox.persistence.util.COSHEXTable.
helper type for faster mapping of bytes to their hex equivalent.
COSHEXTable() - Constructor for class org.pdfbox.persistence.util.COSHEXTable
 
COSInteger - class org.pdfbox.cos.COSInteger.
This class represents an integer number in a PDF document.
COSInteger(long) - Constructor for class org.pdfbox.cos.COSInteger
constructor.
COSInteger(int) - Constructor for class org.pdfbox.cos.COSInteger
constructor.
COSInteger(String) - Constructor for class org.pdfbox.cos.COSInteger
This will create a new PDF Int object using a string.
COSName - class org.pdfbox.cos.COSName.
This class represents a PDF named object.
COSNull - class org.pdfbox.cos.COSNull.
This class represents a null PDF object.
COSNumber - class org.pdfbox.cos.COSNumber.
This class represents an abstract number in a PDF document.
COSNumber() - Constructor for class org.pdfbox.cos.COSNumber
 
COSObject - class org.pdfbox.cos.COSObject.
This class represents a PDF object.
COSObject(COSBase) - Constructor for class org.pdfbox.cos.COSObject
Constructor.
COSObjectKey - class org.pdfbox.persistence.util.COSObjectKey.
Object representing the physical reference to an indirect pdf object.
COSObjectKey(COSObject) - Constructor for class org.pdfbox.persistence.util.COSObjectKey
PDFObjectKey constructor comment.
COSObjectKey(long, long) - Constructor for class org.pdfbox.persistence.util.COSObjectKey
PDFObjectKey constructor comment.
COSObjectable - interface org.pdfbox.pdmodel.common.COSObjectable.
This is an interface used to get/create the underlying COSObject.
COSStandardOutputStream - class org.pdfbox.pdfwriter.COSStandardOutputStream.
simple output stream with some minor features for generating "pretty" pdf files.
COSStandardOutputStream(OutputStream) - Constructor for class org.pdfbox.pdfwriter.COSStandardOutputStream
COSOutputStream constructor comment.
COSStream - class org.pdfbox.cos.COSStream.
This class represents a stream object in a PDF document.
COSStream(RandomAccess) - Constructor for class org.pdfbox.cos.COSStream
Constructor.
COSStream(COSDictionary, RandomAccess) - Constructor for class org.pdfbox.cos.COSStream
Constructor.
COSStreamArray - class org.pdfbox.pdmodel.common.COSStreamArray.
This will take an array of streams and sequence them together.
COSStreamArray(COSArray) - Constructor for class org.pdfbox.pdmodel.common.COSStreamArray
Constructor.
COSString - class org.pdfbox.cos.COSString.
This represents a string object in a PDF document.
COSString() - Constructor for class org.pdfbox.cos.COSString
Constructor.
COSString(String) - Constructor for class org.pdfbox.cos.COSString
Explicit constructor for ease of manual PDF construction.
COSString(byte[]) - Constructor for class org.pdfbox.cos.COSString
Explicit constructor for ease of manual PDF construction.
COSVisitorException - exception org.pdfbox.exceptions.COSVisitorException.
An exception that represents something gone wrong when visiting a PDF object.
COSVisitorException(Exception) - Constructor for class org.pdfbox.exceptions.COSVisitorException
COSVisitorException constructor comment.
COSWriter - class org.pdfbox.pdfwriter.COSWriter.
this class acts on a in-memory representation of a pdf document.
COSWriter(OutputStream) - Constructor for class org.pdfbox.pdfwriter.COSWriter
COSWriter constructor comment.
COSWriterXRefEntry - class org.pdfbox.pdfwriter.COSWriterXRefEntry.
this is en entry in the xref section of the physical pdf document generated by the COSWriter.
COSWriterXRefEntry(long, COSBase, COSObjectKey) - Constructor for class org.pdfbox.pdfwriter.COSWriterXRefEntry
COSWriterXRefEntry constructor comment.
COUNT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
COURIER - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
COURIER_BOLD - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
COURIER_BOLD_OBLIQUE - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
COURIER_OBLIQUE - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
CRLF - Static variable in class org.pdfbox.pdfwriter.COSStandardOutputStream
To be used when 2 byte sequence is enforced.
CROP_BOX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
CR_ESCAPE - Static variable in class org.pdfbox.cos.COSString
CR escape characters.
CloseAndStrokePath - class org.pdfbox.util.operator.CloseAndStrokePath.
Implementation of content stream operator for page drawer.
CloseAndStrokePath() - Constructor for class org.pdfbox.util.operator.CloseAndStrokePath
 
ClosePath - class org.pdfbox.util.operator.pagedrawer.ClosePath.
Implementation of content stream operator for page drawer.
ClosePath() - Constructor for class org.pdfbox.util.operator.pagedrawer.ClosePath
 
Concatenate - class org.pdfbox.util.operator.Concatenate.
Titre : PDFEngine Modification.
Concatenate() - Constructor for class org.pdfbox.util.operator.Concatenate
 
ContentStreamWriter - class org.pdfbox.pdfwriter.ContentStreamWriter.
A class that will take a list of tokens and write out a stream with them.
ContentStreamWriter(OutputStream) - Constructor for class org.pdfbox.pdfwriter.ContentStreamWriter
This will create a new content stream writer.
ConvertColorspace - class org.pdfbox.ConvertColorspace.
This is the main program that simply parses the pdf document and replace change a PDF to use a specific colorspace.
CopyDoc - class org.pdfbox.examples.persistence.CopyDoc.
This is an example used to copy a documents contents from a source doc to destination doc via an in-memory document representation.
CopyDoc() - Constructor for class org.pdfbox.examples.persistence.CopyDoc
Constructor.
CreateBlankPDF - class org.pdfbox.examples.pdmodel.CreateBlankPDF.
This will create a blank PDF and write the contents to a file.
CreateBlankPDF() - Constructor for class org.pdfbox.examples.pdmodel.CreateBlankPDF
 
CreateBookmarks - class org.pdfbox.examples.pdmodel.CreateBookmarks.
This is an example on how to add bookmarks to a PDF document.
CryptographyException - exception org.pdfbox.exceptions.CryptographyException.
An exception that indicates that something has gone wrong during a cryptography operation.
CryptographyException(String) - Constructor for class org.pdfbox.exceptions.CryptographyException
Constructor.
CryptographyException(Exception) - Constructor for class org.pdfbox.exceptions.CryptographyException
Constructor.
CurveTo - class org.pdfbox.util.operator.pagedrawer.CurveTo.
Implementation of content stream operator for page drawer.
CurveTo() - Constructor for class org.pdfbox.util.operator.pagedrawer.CurveTo
 
CurveToReplicateFinalPoint - class org.pdfbox.util.operator.pagedrawer.CurveToReplicateFinalPoint.
Implementation of content stream operator for page drawer.
CurveToReplicateFinalPoint() - Constructor for class org.pdfbox.util.operator.pagedrawer.CurveToReplicateFinalPoint
 
CurveToReplicateInitialPoint - class org.pdfbox.util.operator.pagedrawer.CurveToReplicateInitialPoint.
Implementation of content stream operator for page drawer.
CurveToReplicateInitialPoint() - Constructor for class org.pdfbox.util.operator.pagedrawer.CurveToReplicateInitialPoint
 
canAssembleDocument() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can insert/rotate/delete pages.
canAssembleDocument() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can insert/rotate/delete pages.
canExtractContent() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can extract text and images from the PDF document.
canExtractContent() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can extract text and images from the PDF document.
canExtractForAccessibility() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can extract text and images from the PDF document for accessibility purposes.
canExtractForAccessibility() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can extract text and images from the PDF document for accessibility purposes.
canFillInForm() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can fill in interactive forms.
canFillInForm() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can fill in interactive forms.
canModify() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can modify contents of the document.
canModify() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can modify contents of the document.
canModifyAnnotations() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can add/modify text annotations, fill in interactive forms fields.
canModifyAnnotations() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can add/modify text annotations, fill in interactive forms fields.
canPrint() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can print.
canPrint() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can print.
canPrintDegraded() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can print the document in a degraded format.
canPrintDegraded() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will tell if the user can print the document in a degraded format.
centerWindow() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the center window preference.
charactersByArticle - Variable in class org.pdfbox.util.PDFTextStripper
The charactersByArticle is used to extract text by article divisions.
check() - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
Checks the radiobutton.
checkBufsiz(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
check that buffer sizes matches width,height,bpp.
checkBufsiz(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
check that buffer sizes matches width,height,bpp. This implementation is used by most of the filters, but not Uptimum.
clear() - Method in class org.pdfbox.cos.COSArray
This will remove all of the objects in the collection.
clear() - Method in class org.pdfbox.cos.COSDictionary
This will clear all items in the map.
clear() - Method in class org.pdfbox.pdmodel.common.COSArrayList
clear() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
clearResources() - Static method in class org.pdfbox.pdmodel.font.PDFont
This will clear AFM resources that are stored statically.
clearWillEncryptWhenSaving() - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated. Do not rely on this method anymore. It is the responsability of COSWriter to hold this state.
clone() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
clone() - Method in class org.pdfbox.pdmodel.text.PDTextState
clone() - Method in class org.pdfbox.util.Matrix
Clones this object.
close(FDFDocument) - Method in class org.pdfbox.ExportFDF
Close the document.
close(PDDocument) - Method in class org.pdfbox.ExportFDF
Close the document.
close(FDFDocument) - Method in class org.pdfbox.ExportXFDF
Close the document.
close(PDDocument) - Method in class org.pdfbox.ExportXFDF
Close the document.
close(FDFDocument) - Method in class org.pdfbox.ImportFDF
Close the document.
close(PDDocument) - Method in class org.pdfbox.ImportFDF
Close the document.
close(FDFDocument) - Method in class org.pdfbox.ImportXFDF
Close the document.
close(PDDocument) - Method in class org.pdfbox.ImportXFDF
Close the document.
close() - Method in class org.pdfbox.cos.COSDocument
This will close all storage and delete the tmp files.
close(InputStream) - Method in class org.pdfbox.examples.AbstractExample
Close the stream.
close(OutputStream) - Method in class org.pdfbox.examples.AbstractExample
Close the stream.
close(COSDocument) - Method in class org.pdfbox.examples.AbstractExample
Close the document.
close(PDDocument) - Method in class org.pdfbox.examples.AbstractExample
Close the document.
close(COSWriter) - Static method in class org.pdfbox.examples.AbstractExample
Close the writer.
close() - Method in class org.pdfbox.io.ASCII85InputStream
This will close the underlying stream and release any resources.
close() - Method in class org.pdfbox.io.ASCII85OutputStream
This will close the stream.
close() - Method in class org.pdfbox.io.NBitOutputStream
This will close the stream.
close() - Method in interface org.pdfbox.io.RandomAccess
Release resources that are being held.
close() - Method in class org.pdfbox.io.RandomAccessBuffer
Release resources that are being held.
close() - Method in class org.pdfbox.io.RandomAccessFile
Release resources that are being held.
close() - Method in class org.pdfbox.io.RandomAccessFileInputStream
close() - Method in class org.pdfbox.pdfwriter.COSWriter
This will close the stream.
close() - Method in class org.pdfbox.pdmodel.PDDocument
This will close the underlying COSDocument object.
close() - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Close the content stream.
close() - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will close the underlying COSDocument object.
closeNode() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Close this node.
codeToName - Variable in class org.pdfbox.encoding.Encoding
This is a mapping from a character code to a character name.
compare(Object, Object) - Method in class org.pdfbox.util.TextPositionComparator
compareTo(Object) - Method in class org.pdfbox.cos.COSName
compareTo(Object) - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
computeEncryptedKey(byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This will compute the encrypted key.
computeEncryptedKey(byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Compute the encryption key.
computeOwnerPassword(byte[], byte[], int, int) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This algorithm is taked from PDF Reference 1.4 Algorithm 3.3 Page 79.
computeOwnerPassword(byte[], byte[], int, int) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Compute the owner entry in the encryption dictionary.
computeUserPassword(byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This will compute the user password hash.
computeUserPassword(byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
This will compute the user password hash.
contains(Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
contains(float, float) - Method in class org.pdfbox.pdmodel.common.PDRectangle
Method to determine if the x/y point is inside this rectangle.
containsAll(Collection) - Method in class org.pdfbox.pdmodel.common.COSArrayList
containsKey(Object) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
containsValue(Object) - Method in class org.pdfbox.cos.COSDictionary
 
containsValue(Object) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
context - Variable in class org.pdfbox.util.operator.OperatorProcessor
The stream engine processing context.
convert(Map) - Static method in class org.pdfbox.pdmodel.common.COSDictionaryMap
This will take a map<java.lang.String,org.pdfbox.pdmodel.COSObjectable> and convert it into a COSDictionary<COSName,COSBase>.
convertBasicTypesToMap(COSDictionary) - Static method in class org.pdfbox.pdmodel.common.COSDictionaryMap
This will take a COS dictionary and convert it into COSDictionaryMap.
convertCOSNameCOSArrayToList(COSArray) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will take an array of COSName and return a COSArrayList of java.lang.String values.
convertCOSStringCOSArrayToList(COSArray) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will take an array of COSString and return a COSArrayList of java.lang.String values.
convertCOSToPD(COSBase) - Method in class org.pdfbox.pdmodel.PDDestinationNameTreeNode
Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply use reflection to create the correct object type. Subclasses can do whatever they want.
convertCOSToPD(COSBase) - Method in class org.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply use reflection to create the correct object type. Subclasses can do whatever they want.
convertCOSToPD(COSBase) - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Method to convert the COS value in the name tree to the PD Model object.
convertDocument(InputStream) - Method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
Convert the PDF stream to a lucene document.
convertDocument(File) - Method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
This will take a reference to a PDF document and create a lucene document.
convertDocument(URL) - Method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
Convert the document from a PDF to a lucene document.
convertFloatCOSArrayToList(COSArray) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will take an array of COSNumbers and return a COSArrayList of java.lang.Float values.
convertIntegerCOSArrayToList(COSArray) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will take an array of COSNumbers and return a COSArrayList of java.lang.Integer values.
convertStringListToCOSNameCOSArray(List) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will take an list of string objects and return a COSArray of COSName objects.
convertStringListToCOSStringCOSArray(List) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will take an list of string objects and return a COSArray of COSName objects.
convertToImage() - Method in class org.pdfbox.pdmodel.PDPage
Convert this page to an output image.
converterToCOSArray(List) - Static method in class org.pdfbox.pdmodel.common.COSArrayList
This will convert a list of COSObjectables to an array list of COSBase objects.
copy() - Method in class org.pdfbox.util.Matrix
This will copy the text matrix data.
copyIntoGraphicsState(PDGraphicsState) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will implement the gs operator.
create(String) - Method in class org.pdfbox.examples.pdmodel.CreateBlankPDF
This will create a blank PDF and write the contents to a file.
create(COSBase) - Static method in class org.pdfbox.pdmodel.common.function.PDFunction
Create the correct PD Model function based on the COS base function.
create(COSBase) - Static method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
This will create a new destination depending on the type of COSBase that is passed in.
createAction(COSDictionary) - Static method in class org.pdfbox.pdmodel.interactive.action.PDActionFactory
This will create the correct type of action based on the type specified in the dictionary.
createAffineTransform() - Method in class org.pdfbox.util.Matrix
Create an affine transform from this matrix's values.
createAnnotation(COSBase) - Static method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Create the correct annotation from the base COS object.
createChildNode(COSDictionary) - Method in class org.pdfbox.pdmodel.PDDestinationNameTreeNode
Create a child node object.
createChildNode(COSDictionary) - Method in class org.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Create a child node object.
createChildNode(COSDictionary) - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Create a child node object.
createColor() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
Create the current color from the colorspace and values.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpace
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDPattern
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
Create a Java color model for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpace
Create a Java colorspace for this colorspace.
createColorSpace(COSBase) - Static method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(String) - Static method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(PDDocument, ColorSpace) - Static method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space from a java colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDPattern
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
Create a Java colorspace for this colorspace.
createDimension() - Method in class org.pdfbox.pdmodel.common.PDRectangle
A convenience method to create a dimension object for AWT operations.
createFS(COSBase) - Static method in class org.pdfbox.pdmodel.common.filespecification.PDFileSpecification
A file specfication can either be a COSString or a COSDictionary.
createField(PDAcroForm, COSDictionary) - Static method in class org.pdfbox.pdmodel.interactive.form.PDFieldFactory
This method creates a COSField subclass from the given field.
createFilteredStream() - Method in class org.pdfbox.cos.COSStream
This will create a new stream for which filtered byte should be written to.
createFilteredStream(COSBase) - Method in class org.pdfbox.cos.COSStream
This will create a new stream for which filtered byte should be written to.
createFilteredStream() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will create a new stream for which filtered byte should be written to.
createFilteredStream(COSBase) - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will create a new stream for which filtered byte should be written to.
createFont(COSDictionary, Map) - Static method in class org.pdfbox.pdmodel.font.PDFontFactory
Create a font from the dictionary.
createFont(COSDictionary) - Static method in class org.pdfbox.pdmodel.font.PDFontFactory
This will create the correct font based on information in the dictionary.
createFromCOS(COSBase) - Static method in class org.pdfbox.pdmodel.common.PDStream
Create a pd stream from either a regular COSStream on a COSArray of cos streams.
createFromHexString(String) - Static method in class org.pdfbox.cos.COSString
This will create a COS string from a string of hex characters.
createImage(COSStream) - Method in class org.pdfbox.pdmodel.font.Type3StreamParser
This will parse a type3 stream and create an image from it.
createImage() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will take the inlined image information and create a java.awt.Image from it.
createInputStream() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get a stream that can be read from.
createInputStream() - Method in class org.pdfbox.pdmodel.common.PDStream
This will get a stream that can be read from.
createNewDocument() - Method in class org.pdfbox.util.Splitter
Create a new document to write the splitted contents to.
createNewDocumentIfNecessary() - Method in class org.pdfbox.util.Splitter
Interface method, you can control where a document gets split by implementing this method.
createOutputStream() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get a stream that can be written to.
createOutputStream() - Method in class org.pdfbox.pdmodel.common.PDStream
This will get a stream that can be written to.
createPDFFromImage(String, String) - Method in class org.pdfbox.examples.pdmodel.ImageToPDF
create the second sample document from the PDF file format specification.
createPDFFromText(Reader) - Method in class org.pdfbox.TextToPDF
Create a PDF document with some text.
createRetranslatedRectangle() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will create a translated rectangle based off of this rectangle, such that the new rectangle retains the same dimensions(height/width), but the lower left x,y values are zero.
createStream(PDDocument) - Static method in class org.pdfbox.pdmodel.common.PDObjectStream
This will create a new PDStream object.
createTextStream(COSBase) - Static method in class org.pdfbox.pdmodel.common.PDTextStream
This will create the text stream object.
createUnfilteredStream() - Method in class org.pdfbox.cos.COSStream
This will create an output stream that can be written to.
createUnfilteredStream() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will create an output stream that can be written to.
createXObject(COSBase) - Static method in class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Create the correct xobject from the cos base.
currentAccessPermission - Variable in class org.pdfbox.pdmodel.encryption.SecurityHandler
The access permission granted to the current user for the document.
currentDocument - Variable in class org.pdfbox.util.Splitter
The current PDF document that contains the splitted page.

D

DCTFilter - class org.pdfbox.filter.DCTFilter.
This is the used for the DCTDecode filter.
DCTFilter() - Constructor for class org.pdfbox.filter.DCTFilter
 
DCT_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DCT_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DEF - Static variable in class org.pdfbox.pdfparser.BaseParser
This is a byte array that will be used for comparisons.
DEFAULT_ENCODING - Static variable in class org.pdfbox.ExtractText
This is the default encoding of the text to be output.
DEFAULT_LENGTH - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default length for the encryption key.
DEFAULT_NAME - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default security handler.
DEFAULT_PERMISSIONS - Static variable in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. The default set of permissions which is to allow all.
DEFAULT_REVISION - Static variable in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. The default revision of one is not specified.
DEFAULT_VERSION - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default version, according to the PDF Reference.
DESCENDANT_FONTS - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DEST - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DEVICECMYK - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DEVICEGRAY - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DEVICEN - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DEVICERGB - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DICT_CLOSE - Static variable in class org.pdfbox.pdfwriter.COSWriter
The dictionary close token.
DICT_OPEN - Static variable in class org.pdfbox.pdfwriter.COSWriter
The dictionary open token.
DIFFERENCES - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DV - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
DateConverter - class org.pdfbox.util.DateConverter.
This class is used to convert dates to strings and back using the PDF date standards.
Decrypt - class org.pdfbox.Decrypt.
This will read a document from the filesystem, decrypt it and and then write the results to the filesystem.
Decrypt() - Constructor for class org.pdfbox.Decrypt
 
DecryptionMaterial - class org.pdfbox.pdmodel.encryption.DecryptionMaterial.
This class represents data required to decrypt PDF documents.
DecryptionMaterial() - Constructor for class org.pdfbox.pdmodel.encryption.DecryptionMaterial
 
DictionaryEncoding - class org.pdfbox.encoding.DictionaryEncoding.
This will perform the encoding from a dictionary.
DictionaryEncoding(COSDictionary) - Constructor for class org.pdfbox.encoding.DictionaryEncoding
Constructor.
DocumentEncryption - class org.pdfbox.encryption.DocumentEncryption.
Deprecated. use the new security API instead.
DocumentEncryption(PDDocument) - Constructor for class org.pdfbox.encryption.DocumentEncryption
Deprecated. Constructor.
DocumentEncryption(COSDocument) - Constructor for class org.pdfbox.encryption.DocumentEncryption
Deprecated. Constructor.
DualCOSObjectable - interface org.pdfbox.pdmodel.common.DualCOSObjectable.
This is an interface to represent a PDModel object that holds two COS objects.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.ASCII85Filter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.ASCIIHexFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.CCITTFaxDecodeFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.DCTFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in interface org.pdfbox.filter.Filter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.FlateFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.LZWFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.RunLengthDecodeFilter
This will decode some compressed data.
decode(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.None
decode a byte array full of image data using the filter that this object implements.
decode(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
decode a byte array full of image data using the filter that this object implements.
decode(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
decode a byte array full of image data using the filter that this object implements.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Average
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.None
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Paeth
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Sub
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Up
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
decode line of pixel data in src from src_offset and width*bpp bytes forward, put the decoded bytes into dest.
decrypt(Object, long, long) - Method in class org.pdfbox.encryption.DocumentEncryption
Deprecated. This will dispatch to the correct method.
decrypt(String) - Method in class org.pdfbox.pdmodel.PDDocument
This will decrypt a document.
decryptDocument(String) - Method in class org.pdfbox.encryption.DocumentEncryption
Deprecated. This will decrypt the document.
decryptDocument(PDDocument, DecryptionMaterial) - Method in class org.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Decrypt the document.
decryptDocument(PDDocument, DecryptionMaterial) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
Prepare the document for decryption.
decryptDocument(PDDocument, DecryptionMaterial) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Decrypt the document.
decryptStream(COSStream, long, long) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
This will decrypt a stream.
decryptString(COSString, long, long) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
This will decrypt a string.
dereferenceObjectStreams() - Method in class org.pdfbox.cos.COSDocument
This method will search the list of objects for types of ObjStm.
displayDocTitle() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the display doc title preference.
displayPage(PDPage) - Method in class org.pdfbox.pdfviewer.PageWrapper
This will display the PDF page in this component.
doIt(String, String, String) - Method in class org.pdfbox.examples.pdmodel.AddMessageToEachPage
create the second sample document from the PDF file format specification.
doIt(String) - Method in class org.pdfbox.examples.pdmodel.EmbeddedFiles
create the second sample document from the PDF file format specification.
doIt(String, String) - Method in class org.pdfbox.examples.pdmodel.HelloWorld
create the second sample document from the PDF file format specification.
doIt(String, String, String) - Method in class org.pdfbox.examples.pdmodel.HelloWorldTTF
create the second sample document from the PDF file format specification.
doIt(String, String, String) - Method in class org.pdfbox.examples.pdmodel.HelloWorldType1AfmPfb
create the second sample document from the PDF file format specification.
doIt(String, String, String, String) - Method in class org.pdfbox.examples.pdmodel.ReplaceString
Locate a string in a PDF and replace it with a new string.
doIt(String) - Method in class org.pdfbox.examples.pdmodel.ShowColorBoxes
create the second sample document from the PDF file format specification.
doIt(String, String) - Method in class org.pdfbox.examples.persistence.CopyDoc
This will perform the document copy.
doIt(String, String) - Method in class org.pdfbox.examples.persistence.WriteDecodedDoc
This will perform the document reading, decoding and writing.
doNotScroll() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
doNotSpellCheck() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
doWriteBody(COSDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
This will write the body of the document.
doWriteHeader(COSDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
This will write the header to the PDF document.
doWriteObject(COSBase) - Method in class org.pdfbox.pdfwriter.COSWriter
This will write a COS object.
doWriteTrailer(COSDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
This will write the trailer to the PDF document.
doWriteXRef(COSDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
write the x ref section for the pdf file currently, the pdf is reconstructed from the scratch, so we write a single section todo support for incremental writing?
document - Variable in class org.pdfbox.pdmodel.encryption.SecurityHandler
The document whose security is handled by this security handler.
doubleValue() - Method in class org.pdfbox.cos.COSFloat
The value of the double object that this one wraps.
doubleValue() - Method in class org.pdfbox.cos.COSInteger
polymorphic access to value as float.
doubleValue() - Method in class org.pdfbox.cos.COSNumber
This will get the double value of this number.
drawImage(PDXObjectImage, float, float) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Draw an image at the x,y coordinates, with the default size of the image.
drawImage(PDXObjectImage, float, float, float, float) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Draw an image at the x,y coordinates and a certain width and height.
drawPage(Graphics, PDPage, Dimension) - Method in class org.pdfbox.pdfviewer.PageDrawer
This will draw the page to the requested context.
drawString(String) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
This will draw a string at the current location on the screen.
drawString(String, Graphics, float, float, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will draw a string on a canvas using the font.
drawString(String, Graphics, float, float, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDFont
This will draw a string on a canvas using the font.
drawString(String, Graphics, float, float, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will draw a string on a canvas using the font.
drawString(String, Graphics, float, float, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDTrueTypeFont
This will draw a string on a canvas using the font.
drawString(String, Graphics, float, float, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDType0Font
This will draw a string on a canvas using the font.
drawString(String, Graphics, float, float, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDType1Font
This will draw a string on a canvas using the font.
drawString(String, Graphics, float, float, float) - Method in class org.pdfbox.pdmodel.font.PDType3Font
This will draw a string on a canvas using the font.

E

ENCODING - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ENCODING_90MS_RKSJ_H - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ENCODING_90MS_RKSJ_V - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ENCODING_ETEN_B5_H - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ENCODING_ETEN_B5_V - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ENCRYPT_PADDING - Static variable in class org.pdfbox.encryption.PDFEncryption
Deprecated. The encryption padding defined in the PDF 1.4 Spec algorithm 3.2.
ENCRYPT_PADDING - Static variable in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Standard padding for encryption.
ENDOBJ - Static variable in class org.pdfbox.pdfwriter.COSWriter
The end object token.
ENDSTREAM - Static variable in class org.pdfbox.pdfparser.BaseParser
This is a byte array that will be used for comparisons.
ENDSTREAM - Static variable in class org.pdfbox.pdfwriter.COSWriter
The close stream token.
EOD - Static variable in class org.pdfbox.filter.LZWFilter
The LZW end of data code.
EOF - Static variable in class org.pdfbox.pdfwriter.COSWriter
The EOF constant.
EOL - Static variable in class org.pdfbox.pdfwriter.COSStandardOutputStream
standard line separator on this platform.
EOL - Static variable in class org.pdfbox.pdfwriter.ContentStreamWriter
standard line separator on this platform.
ESCAPE - Static variable in class org.pdfbox.cos.COSString
the escape character in strings.
EXT_G_STATE - Static variable in class org.pdfbox.Overlay
COSName constant.
EmbeddedFiles - class org.pdfbox.examples.pdmodel.EmbeddedFiles.
This is an example that creates a simple document and embeds a file into it..
EmbeddedFiles() - Constructor for class org.pdfbox.examples.pdmodel.EmbeddedFiles
Constructor.
Encoding - class org.pdfbox.encoding.Encoding.
This is an interface to a text encoder.
Encoding() - Constructor for class org.pdfbox.encoding.Encoding
 
EncodingManager - class org.pdfbox.encoding.EncodingManager.
This class will handle getting the appropriate encodings.
EncodingManager() - Constructor for class org.pdfbox.encoding.EncodingManager
 
Encrypt - class org.pdfbox.Encrypt.
This will read a document from the filesystem, encrypt it and and then write the results to the filesystem.
Encrypt() - Constructor for class org.pdfbox.Encrypt
 
EndPath - class org.pdfbox.util.operator.pagedrawer.EndPath.
Implementation of content stream operator for page drawer.
EndPath() - Constructor for class org.pdfbox.util.operator.pagedrawer.EndPath
 
EndText - class org.pdfbox.util.operator.EndText.
Titre : PDFEngine Modification.
EndText() - Constructor for class org.pdfbox.util.operator.EndText
 
ErrorLogger - class org.pdfbox.util.ErrorLogger.
This class deals with some logging that is not handled by the log4j replacement.
ExportFDF - class org.pdfbox.ExportFDF.
This example will take a PDF document and fill the fields with data from the FDF fields.
ExportFDF() - Constructor for class org.pdfbox.ExportFDF
Creates a new instance of ImportFDF.
ExportXFDF - class org.pdfbox.ExportXFDF.
This example will take a PDF document and fill the fields with data from the FDF fields.
ExportXFDF() - Constructor for class org.pdfbox.ExportXFDF
Creates a new instance of ImportFDF.
ExtensionFileFilter - class org.pdfbox.util.ExtensionFileFilter.
A FileFilter that will only accept files of a certain extension.
ExtensionFileFilter(String[], String) - Constructor for class org.pdfbox.util.ExtensionFileFilter
Constructor.
ExtractImages - class org.pdfbox.ExtractImages.
This will read a read pdf and extract images.
ExtractImages() - Constructor for class org.pdfbox.ExtractImages
 
ExtractText - class org.pdfbox.ExtractText.
This is the main program that simply parses the pdf document and transforms it into text.
ExtractTextByArea - class org.pdfbox.examples.util.ExtractTextByArea.
This is an example on how to extract text from a specific area on the PDF document.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.ASCII85Filter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.ASCIIHexFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.CCITTFaxDecodeFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.DCTFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in interface org.pdfbox.filter.Filter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.FlateFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.LZWFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.pdfbox.filter.RunLengthDecodeFilter
This will encode some data.
encode(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDFont
This will perform the encoding of a character if needed.
encode(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.None
encode a byte array full of image data using the filter that this object implements.
encode(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
encode a byte array full of image data using the filter that this object implements.
encode(byte[], byte[]) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
encode a byte array full of image data using the filter that this object implements.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Average
Not an optimal version, but close to the def.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.None
encode line of pixel data in src from srcOffset and width*bpp bytes forward, put the decoded bytes into dest.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Paeth
encode line of pixel data in src from srcOffset and width*bpp bytes forward, put the decoded bytes into dest.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
encode line of pixel data in src from srcOffset and width*bpp bytes forward, put the decoded bytes into dest.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Sub
encode line of pixel data in src from srcOffset and width*bpp bytes forward, put the decoded bytes into dest.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Up
encode line of pixel data in src from srcOffset and width*bpp bytes forward, put the decoded bytes into dest.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
encode line of pixel data in src from srcOffset and width*bpp bytes forward, put the decoded bytes into dest.
encrypt(String, String) - Method in class org.pdfbox.pdmodel.PDDocument
This will mark a document to be encrypted.
encryptData(long, long, byte[], InputStream, OutputStream) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This will encrypt a piece of data.
encryptData(long, long, InputStream, OutputStream) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
Encrypt a set of data.
encryptionDictionary - Variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
COS encryption dictionary.
encryptionKey - Variable in class org.pdfbox.pdmodel.encryption.SecurityHandler
The encryption key that will used to encrypt / decrypt.
endDocument(PDDocument) - Method in class org.pdfbox.util.PDFText2HTML
This method is available for subclasses of this class. It will be called after processing of the document finishes.
endDocument(PDDocument) - Method in class org.pdfbox.util.PDFTextStripper
This method is available for subclasses of this class.
endPage(PDPage) - Method in class org.pdfbox.util.PDFHighlighter
End a page. Default implementation is to do nothing. Subclasses may provide additional information.
endPage(PDPage) - Method in class org.pdfbox.util.PDFTextStripper
End a page.
endParagraph() - Method in class org.pdfbox.util.PDFText2HTML
Write out the paragraph separator.
endParagraph() - Method in class org.pdfbox.util.PDFTextStripper
End a paragraph.
endText() - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
End some text operations.
entrySet() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
equals(Object) - Method in class org.pdfbox.cos.COSFloat
equals(Object) - Method in class org.pdfbox.cos.COSInteger
equals(Object) - Method in class org.pdfbox.cos.COSName
equals(Object) - Method in class org.pdfbox.cos.COSString
equals(Object) - Method in class org.pdfbox.pdmodel.PDPage
equals(Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
equals(Object) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
equals(Object) - Method in class org.pdfbox.pdmodel.font.PDFont
equals(Object) - Method in class org.pdfbox.persistence.util.COSObjectKey
execute() - Method in class org.pdfbox.ant.PDFToTextTask
This will perform the execution.
exportFDF() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will export all FDF form data.
extractRegions(PDPage) - Method in class org.pdfbox.util.PDFTextStripperByArea
Process the page to extract the region text.
extractScaling() - Method in class org.pdfbox.util.Matrix
Create a new matrix with just the scaling operators.
extractTranslating() - Method in class org.pdfbox.util.Matrix
Create a new matrix with just the translating operators.

F

FALSE - Static variable in class org.pdfbox.cos.COSBoolean
The PDF false value.
FALSE_BYTES - Static variable in class org.pdfbox.cos.COSBoolean
The false boolean token.
FDFAnnotation - class org.pdfbox.pdmodel.fdf.FDFAnnotation.
This represents an FDF annotation that is part of the FDF document.
FDFAnnotation() - Constructor for class org.pdfbox.pdmodel.fdf.FDFAnnotation
Default constructor.
FDFAnnotation(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFAnnotation
Constructor.
FDFCatalog - class org.pdfbox.pdmodel.fdf.FDFCatalog.
This represents an FDF catalog that is part of the FDF document.
FDFCatalog() - Constructor for class org.pdfbox.pdmodel.fdf.FDFCatalog
Default constructor.
FDFCatalog(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFCatalog
Constructor.
FDFCatalog(Element) - Constructor for class org.pdfbox.pdmodel.fdf.FDFCatalog
This will create an FDF catalog from an XFDF XML document.
FDFDictionary - class org.pdfbox.pdmodel.fdf.FDFDictionary.
This represents an FDF dictionary that is part of the FDF document.
FDFDictionary() - Constructor for class org.pdfbox.pdmodel.fdf.FDFDictionary
Default constructor.
FDFDictionary(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFDictionary
Constructor.
FDFDictionary(Element) - Constructor for class org.pdfbox.pdmodel.fdf.FDFDictionary
This will create an FDF dictionary from an XFDF XML document.
FDFDocument - class org.pdfbox.pdmodel.fdf.FDFDocument.
This is the in-memory representation of the FDF document.
FDFDocument() - Constructor for class org.pdfbox.pdmodel.fdf.FDFDocument
Constructor, creates a new FDF document.
FDFDocument(COSDocument) - Constructor for class org.pdfbox.pdmodel.fdf.FDFDocument
Constructor that uses an existing document.
FDFDocument(Document) - Constructor for class org.pdfbox.pdmodel.fdf.FDFDocument
This will create an FDF document from an XFDF XML document.
FDFField - class org.pdfbox.pdmodel.fdf.FDFField.
This represents an FDF field that is part of the FDF document.
FDFField() - Constructor for class org.pdfbox.pdmodel.fdf.FDFField
Default constructor.
FDFField(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFField
Constructor.
FDFField(Element) - Constructor for class org.pdfbox.pdmodel.fdf.FDFField
This will create an FDF field from an XFDF XML document.
FDFIconFit - class org.pdfbox.pdmodel.fdf.FDFIconFit.
This represents an Icon fit dictionary for an FDF field.
FDFIconFit() - Constructor for class org.pdfbox.pdmodel.fdf.FDFIconFit
Default constructor.
FDFIconFit(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFIconFit
Constructor.
FDFJavaScript - class org.pdfbox.pdmodel.fdf.FDFJavaScript.
This represents an FDF JavaScript dictionary that is part of the FDF document.
FDFJavaScript() - Constructor for class org.pdfbox.pdmodel.fdf.FDFJavaScript
Default constructor.
FDFJavaScript(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFJavaScript
Constructor.
FDFNamedPageReference - class org.pdfbox.pdmodel.fdf.FDFNamedPageReference.
This represents an FDF named page reference that is part of the FDF field.
FDFNamedPageReference() - Constructor for class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
Default constructor.
FDFNamedPageReference(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
Constructor.
FDFOptionElement - class org.pdfbox.pdmodel.fdf.FDFOptionElement.
This represents an object that can be used in a Field's Opt entry to represent an available option and a default appearance string.
FDFOptionElement() - Constructor for class org.pdfbox.pdmodel.fdf.FDFOptionElement
Default constructor.
FDFOptionElement(COSArray) - Constructor for class org.pdfbox.pdmodel.fdf.FDFOptionElement
Constructor.
FDFPage - class org.pdfbox.pdmodel.fdf.FDFPage.
This represents an FDF page that is part of the FDF document.
FDFPage() - Constructor for class org.pdfbox.pdmodel.fdf.FDFPage
Default constructor.
FDFPage(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFPage
Constructor.
FDFPageInfo - class org.pdfbox.pdmodel.fdf.FDFPageInfo.
This represents an FDF page info that is part of the FDF page.
FDFPageInfo() - Constructor for class org.pdfbox.pdmodel.fdf.FDFPageInfo
Default constructor.
FDFPageInfo(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFPageInfo
Constructor.
FDFTemplate - class org.pdfbox.pdmodel.fdf.FDFTemplate.
This represents an FDF template that is part of the FDF page.
FDFTemplate() - Constructor for class org.pdfbox.pdmodel.fdf.FDFTemplate
Default constructor.
FDFTemplate(COSDictionary) - Constructor for class org.pdfbox.pdmodel.fdf.FDFTemplate
Constructor.
FF_ESCAPE - Static variable in class org.pdfbox.cos.COSString
FF escape characters.
FIELDS - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FILTER - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FILTER - Static variable in class org.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
The filter name.
FILTER - Static variable in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Type of security handler.
FILTER_NAME - Static variable in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. The 'Filter' name for this security handler.
FIRST_CHAR - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FLAG_COMB - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_DO_NOT_SCROLL - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_DO_NOT_SPELL_CHECK - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_FILE_SELECT - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_HIDDEN - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_INVISIBLE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_LOCKED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_MULTILINE - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_NO_EXPORT - Static variable in class org.pdfbox.pdmodel.interactive.form.PDField
A Ff flag.
FLAG_NO_ROTATE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_NO_VIEW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_NO_ZOOM - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_PASSWORD - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_PRINTED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_RADIOS_IN_UNISON - Static variable in class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
A Ff flag.
FLAG_READ_ONLY - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_READ_ONLY - Static variable in class org.pdfbox.pdmodel.interactive.form.PDField
A Ff flag.
FLAG_REQUIRED - Static variable in class org.pdfbox.pdmodel.interactive.form.PDField
A Ff flag.
FLAG_RICH_TEXT - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_TOGGLE_NO_VIEW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLATE_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FLATE_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FONT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FONT_DESC - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FONT_FILE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FONT_FILE2 - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FONT_FILE3 - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FONT_MATRIX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FORMTYPE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FRM - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
FastByteArrayOutputStream - class org.pdfbox.io.FastByteArrayOutputStream.
An byte array output stream that allows direct access to the byte array.
FastByteArrayOutputStream(int) - Constructor for class org.pdfbox.io.FastByteArrayOutputStream
Constructor.
FillEvenOddRule - class org.pdfbox.util.operator.pagedrawer.FillEvenOddRule.
Implementation of content stream operator for page drawer.
FillEvenOddRule() - Constructor for class org.pdfbox.util.operator.pagedrawer.FillEvenOddRule
 
FillNonZeroRule - class org.pdfbox.util.operator.pagedrawer.FillNonZeroRule.
Implementation of content stream operator for page drawer.
FillNonZeroRule() - Constructor for class org.pdfbox.util.operator.pagedrawer.FillNonZeroRule
 
Filter - interface org.pdfbox.filter.Filter.
This is the interface that will be used to apply filters to a byte stream.
FilterManager - class org.pdfbox.filter.FilterManager.
This will contain manage all the different types of filters that are available.
FilterManager() - Constructor for class org.pdfbox.filter.FilterManager
Constructor.
FlateFilter - class org.pdfbox.filter.FlateFilter.
This is the used for the FlateDecode filter.
FlateFilter() - Constructor for class org.pdfbox.filter.FlateFilter
 
fillBuffer() - Method in class org.pdfbox.io.PushBackInputStream
This is a method used to fix PDFBox issue 974661, the PDF parsing code needs to know if there is at least x amount of data left in the stream, but the available() method returns how much data will be available without blocking.
fillRect(float, float, float, float) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Draw a rectangle on the page using the current non stroking color.
finalize() - Method in class org.pdfbox.cos.COSDocument
The sole purpose of this is to inform a client of PDFBox that they did not close the document.
finalize() - Method in class org.pdfbox.io.ASCII85OutputStream
This will flush the stream.
findCropBox() - Method in class org.pdfbox.pdmodel.PDPage
This will find the CropBox for this page by looking up the hierarchy until it finds them.
findCropBox() - Method in class org.pdfbox.pdmodel.PDPageNode
This will find the CropBox for this page by looking up the hierarchy until it finds them.
findDestinationPage(PDDocument) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
This method will attempt to find the page in this PDF document that this outline points to.
findFieldType() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Find the field type and optionally do a recursive upward search.
findKid(String[], int) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will find one of the child elements.
findMediaBox() - Method in class org.pdfbox.pdmodel.PDPage
This will find the MediaBox for this page by looking up the hierarchy until it finds them.
findMediaBox() - Method in class org.pdfbox.pdmodel.PDPageNode
This will find the MediaBox for this page by looking up the hierarchy until it finds them.
findResources() - Method in class org.pdfbox.pdmodel.PDPage
This will find the resources for this page by looking up the hierarchy until it finds them.
findResources() - Method in class org.pdfbox.pdmodel.PDPageNode
This will find the resources for this page by looking up the hierarchy until it finds them.
findRotation() - Method in class org.pdfbox.pdmodel.PDPage
This will find the rotation for this page by looking up the hierarchy until it finds them.
findRotation() - Method in class org.pdfbox.pdmodel.PDPageNode
This will find the rotation for this page by looking up the hierarchy until it finds them.
fitBoundingBox() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
A flag indicating if this page destination should just fit bounding box of the PDF.
fitBoundingBox() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
A flag indicating if this page destination should just fit bounding box of the PDF.
fitBoundingBox() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
A flag indicating if this page destination should just fit bounding box of the PDF.
fitWindow() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the fit window preference.
fixY(double, double) - Method in class org.pdfbox.pdfviewer.PageDrawer
Fix the y coordinate based on page rotation.
floatValue() - Method in class org.pdfbox.cos.COSFloat
The value of the float object that this one wraps.
floatValue() - Method in class org.pdfbox.cos.COSInteger
polymorphic access to value as float.
floatValue() - Method in class org.pdfbox.cos.COSNumber
This will get the float value of this number.
flush() - Method in class org.pdfbox.io.ASCII85OutputStream
This will flush the data to the stream.
flushText() - Method in class org.pdfbox.util.PDFText2HTML
This will print the text to the output stream.
flushText() - Method in class org.pdfbox.util.PDFTextStripper
This will print the text to the output stream.
flushText() - Method in class org.pdfbox.util.PDFTextStripperByArea
This will print the text to the output stream.
font - Variable in class org.pdfbox.pdmodel.font.PDFont
The cos dictionary for this font.

G

GARBAGE - Static variable in class org.pdfbox.pdfwriter.COSWriter
Garbage bytes used to create the PDF header.
GRestore - class org.pdfbox.util.operator.GRestore.
Titre : PDFEngine Modification.
GRestore() - Constructor for class org.pdfbox.util.operator.GRestore
 
GSave - class org.pdfbox.util.operator.GSave.
Titre : PDFEngine Modification.
GSave() - Constructor for class org.pdfbox.util.operator.GSave
 
GUIDELINE_STYLE_DASHED - Static variable in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Style for guideline.
GUIDELINE_STYLE_SOLID - Static variable in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Style for guideline.
GoToSecondBookmarkOnOpen - class org.pdfbox.examples.pdmodel.GoToSecondBookmarkOnOpen.
This is an example on how to an action to go to the second page when the PDF is opened.
generateXMLHighlight(PDDocument, String, Writer) - Method in class org.pdfbox.util.PDFHighlighter
Generate an XML highlight string based on the PDF.
generateXMLHighlight(PDDocument, String[], Writer) - Method in class org.pdfbox.util.PDFHighlighter
Generate an XML highlight string based on the PDF.
get(int) - Method in class org.pdfbox.cos.COSArray
This will get an object from the array.
get(String) - Static method in class org.pdfbox.cos.COSNumber
This factory method will get the appropriate number object.
get(int) - Method in class org.pdfbox.pdmodel.common.COSArrayList
get(Object) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
getAFM() - Method in class org.pdfbox.pdmodel.font.PDFont
This will get an AFM object if one exists.
getARange() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will get the valid range for the a component.
getAcroForm() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
This will get the documents acroform.
getAcroForm() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will get the acroform that this field is part of.
getAction() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the action that is associated with this field.
getAction() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
 
getAction() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the action to be performed when this annotation is to be activated.
getAction() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the action of this node.
getActions() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
 
getActions() - Method in class org.pdfbox.pdmodel.PDPage
Get the page actions.
getActions() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the additional actions for this field.
getActions() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Get the additional actions for this field.
getAdditionalActions() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get a list of additional actions that will get executed based on events.
getAfter() - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
This will get the javascript that is executed after the import.
getAllKids(List) - Method in class org.pdfbox.pdmodel.PDPageNode
This will return all kids of this node as PDPage.
getAllPages() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
The PDF document contains a hierarchical structure of PDPageNode and PDPages, which is mostly just a way to store this information.
getAlphaConstants() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the alpha constants property.
getAlphaSourceFlag() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the alpha source flag.
getAlternateColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the alternate color space for this separation.
getAlternateColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the alternate color space for this separation.
getAlternateColorSpaces() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will return a list of alternate color spaces(PDColorSpace) if the display application does not support this icc stream.
getAnnotationFlags() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the flags for this field.
getAnnotationName() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the name, a string intended to uniquely identify each annotatoin within a page.
getAnnotations() - Method in class org.pdfbox.pdmodel.PDPage
This will return a list of the Annotations for this page.
getAnnotations() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of FDF Annotations.
getAppearance() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the appearance dictionary associated with this annotation.
getAppearanceDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the appearance dictionary that specifies the appearance of a pushbutton field.
getAppearanceStream() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the name of the current appearance stream if any.
getAppearanceStreamReference() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get named page references..
getArtBox() - Method in class org.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the extent of the page's meaningful content (including potential white space) as intended by the page's creator The default isthe CropBox.
getAsStream() - Method in class org.pdfbox.pdmodel.common.PDTextStream
This is the preferred way of getting data with this class as it uses a stream object.
getAsString() - Method in class org.pdfbox.pdmodel.common.PDTextStream
This will get this value as a string.
getAscent() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the ascent for the font.
getAscent() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the ascent for the font.
getAscent() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the ascent for the font.
getAttachmentName() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
This is the name used to draw the type of attachment.
getAttributes() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the attributes that are associated with the deviceN color space.
getAuthor() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the author of the document.
getAutomaticStrokeAdjustment() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the automatic stroke adjustment flag.
getAverageFontWidth() - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.pdfbox.pdmodel.font.PDType0Font
This will get the average font width for all characters.
getAverageFontWidthFromAFMFile() - Method in class org.pdfbox.pdmodel.font.PDFont
This will attempt to get the average font width from an AFM file.
getAverageWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the average width for the font.
getAverageWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the average width for the font.
getAverageWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the average width for the font.
getB() - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
This will get the b value of the tristimulus.
getBRange() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will get the valid range for the b component.
getBase() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will get the base URI to be used in resolving relative URI references.
getBaseColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will get the color space that acts as the index for this color space.
getBaseFont() - Method in class org.pdfbox.pdmodel.font.PDFont
The PostScript name of the font.
getBefore() - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
This will get the javascript that is executed before the import.
getBitsInChunk() - Method in class org.pdfbox.io.NBitInputStream
Getter for property bitsToRead.
getBitsInChunk() - Method in class org.pdfbox.io.NBitOutputStream
Getter for property bitsToRead.
getBitsPerComponent() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
The bits per component of this image.
getBitsPerComponent() - Method in class org.pdfbox.util.ImageParameters
The bits per component of this image.
getBitsPerSample() - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Get the number of bits that the output value will take up.
getBl() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the annotation loses the input focus.
getBlackPoint() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will return the BlackPoint tristimulus.
getBlackPoint() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will return the BlackPoint tristimulus.
getBlackPoint() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will return the BlackPoint tristimulus.
getBleedBox() - Method in class org.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production environment.
getBoderStyle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
getBoolean(boolean) - Static method in class org.pdfbox.cos.COSBoolean
This will get the boolean value.
getBoolean(Boolean) - Static method in class org.pdfbox.cos.COSBoolean
This will get the boolean value.
getBoolean(String, boolean) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a cos boolean and convert it to a primitive boolean.
getBoolean(COSName, boolean) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a COSBoolean and convert it to a primitive boolean.
getBorderEffect() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
getBottom() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the bottom y coordinate.
getBottomStatusPanel() - Method in class org.pdfbox.PDFReader
Get the bottom status panel.
getBoundingBox() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Get the bounding box for this appearance.
getBpp() - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getByteArray() - Method in class org.pdfbox.io.FastByteArrayOutputStream
This will get the underlying byte array.
getByteArray() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will copy the stream into a byte array.
getByteArray() - Method in class org.pdfbox.pdmodel.common.PDStream
This will copy the stream into a byte array.
getBytes() - Method in class org.pdfbox.cos.COSString
This will get the bytes of the string.
getC() - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will get a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes.
getC() - Method in class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will get an action to be performed when the page is closed.
getCOSArray() - Method in class org.pdfbox.pdmodel.common.PDMatrix
This will get the underlying array value.
getCOSArray() - Method in class org.pdfbox.pdmodel.common.PDRange
This will get the underlying array value.
getCOSArray() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the underlying array for this rectangle.
getCOSArray() - Method in class org.pdfbox.pdmodel.fdf.FDFOptionElement
Convert this standard java object to a COS object.
getCOSArray() - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
Convert this standard java object to a COS object.
getCOSArray() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Convert this standard java object to a COS object.
getCOSColorSpaceValue() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
This will get the color space values.
getCOSDashPattern() - Method in class org.pdfbox.pdmodel.graphics.PDLineDashPattern
Get the line dash pattern as a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.PDDocumentNameDictionary
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.PDPage
This will get the underlying dictionary that this class acts on.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.PDResources
This will get the underlying dictionary.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
Get the underlying cos dictionary.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Get the low level dictionary that this object wraps.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Get the low level dictionary that this object wraps.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the dictionary associated with this encryption dictionary.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFAnnotation
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFField
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFPage
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFPageInfo
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the dictionary for this object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the underlying dictionary that this class acts on.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
This will get the underlying cos dictionary.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.cos.COSBase
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.encoding.AFMEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.encoding.DictionaryEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.encoding.MacRomanEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.encoding.PdfDocEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.encoding.StandardEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.encoding.WinAnsiEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.PDDocumentNameDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.PDPage
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.PDPageNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.PDResources
Convert this standard java object to a COS object.
getCOSObject() - Method in interface org.pdfbox.pdmodel.common.COSObjectable
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDMatrix
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDRange
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDRectangle
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.PDTextStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFAnnotation
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFField
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFOptionElement
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFPage
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFPageInfo
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.font.PDFont
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.PDFontSetting
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.PDLineDashPattern
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpace
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Returns the stream.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Interface method for COSObjectable.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
returns the dictionary.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
returns the dictionary.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
returns the dictionary.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.form.PDXFA
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Convert this standard java object to a COS object.
getCOSStream() - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will get the underlying array value.
getCOSStream() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Returns the stream.
getCapHeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the CapHeight for the font.
getCapHeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the CapHeight for the font.
getCapHeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the CapHeight for the font.
getCaption() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve if the contents are shown as a caption or not.
getCatalog() - Method in class org.pdfbox.cos.COSDocument
This will get the document catalog.
getCatalog() - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will get the FDF Catalog.
getCertificate() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
Returns the certificate contained in the keystore.
getCharSet() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the character set for the font.
getCharSet() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the character set for the font.
getCharSet() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the character set for the font.
getCharacter(int) - Method in class org.pdfbox.encoding.Encoding
This will get the character from the code.
getCharacter(COSName) - Static method in class org.pdfbox.encoding.Encoding
This will get the character from the name.
getCharacter() - Method in class org.pdfbox.util.TextPosition
This will the character that will be displayed on the screen.
getCharacterSpacing() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the characterSpacing.
getCharactersByArticle() - Method in class org.pdfbox.util.PDFTextStripper
Character strings are grouped by articles.
getCheckSum() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the check sum of the embedded file.
getChild(Object, int) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Returns the child of parent at index index in the parent's child array.
getChildCount(Object) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Returns the number of children of parent.
getClearFieldFlags() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the ClrFf entry of the cos dictionary.
getClearWidgetFieldFlags() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the ClrF entry of the cos dictionary.
getCode(COSName) - Method in class org.pdfbox.encoding.Encoding
This will get the character code for the name.
getCodeFromArray(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDFont
Used for multibyte encodings.
getColorSpace() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
This will get the current colorspace.
getColorSpace() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
This will get the color space or null if none exists.
getColorSpace() - Method in class org.pdfbox.util.ImageParameters
This will get the color space or null if none exists.
getColorSpaceValue() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
This will get the color space values.
getColorSpaces() - Method in class org.pdfbox.pdmodel.PDResources
This will get the map of colorspaces.
getColorSpaces() - Method in class org.pdfbox.util.PDFStreamEngine
 
getColorantName() - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the separation name.
getColorantNames() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the colorant names.
getColorants() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
This will get a map of colorants.
getColour() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the colour used in drawing various elements.
getConstantOpacity() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the constant opacity value used when rendering the annotation (excluing any popup).
getContents() - Method in class org.pdfbox.pdmodel.PDPage
This will get the contents of the PDF Page, in the case that the contents of the page is an array then then the entire array of streams will be be wrapped and appear as a single stream.
getContents() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the "contents" of the field.
getContext() - Method in class org.pdfbox.util.operator.OperatorProcessor
Get the context for processing.
getCount() - Method in class org.pdfbox.pdfparser.PDFXref
This will get the count attribute.
getCount() - Method in class org.pdfbox.pdmodel.PDPageNode
This will get the count of descendent page objects.
getCreationDate() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the creation date of the document.
getCreationDate() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the creation date of the embedded file.
getCreationDate() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the date and time the annotation was created.
getCreator() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the creator of the document.
getCropBox() - Method in class org.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the visible region of default user space.
getCropBox() - Method in class org.pdfbox.pdmodel.PDPageNode
This will get the CropBox at this page and not look up the hierarchy.
getCurrentAccessPermission() - Method in class org.pdfbox.pdmodel.PDDocument
Returns the access permissions granted when the document was decrypted.
getCurrentAccessPermission() - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
Returns the access permissions that were computed during document decryption.
getCurrentPage() - Method in class org.pdfbox.util.PDFStreamEngine
Get the current page that is being processed.
getCurrentPageNo() - Method in class org.pdfbox.util.PDFTextStripper
Get the current page number that is being processed.
getCurrentTransformationMatrix() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the CTM.
getCustomMetadataValue(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the value of a custom metadata information field for the document.
getD() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the mouse button is pressed inside the annotation's active area.
getD() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get the string specifying the default directory in standard DOS syntax.
getD() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will get the destination to jump to.
getDP() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed after printing a document.
getDS() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed after saving a document.
getDashPattern() - Method in class org.pdfbox.pdmodel.graphics.PDLineDashPattern
This will return a list of java.lang.Integer objects that represent the line dash pattern appearance.
getDashStyle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will retrieve the dash style used for drawing the border.
getDate(String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getDate(COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getDate(String, Calendar) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a date.
getDate(COSName, Calendar) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a date.
getDateTimeResolution() - Method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
Get the Lucene data time resolution.
getDecodeForParameter(int) - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Get the decode for the input parameter.
getDecodeParams() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Get the list of decode parameters.
getDecodeParams() - Method in class org.pdfbox.pdmodel.common.PDStream
Get the list of decode parameters.
getDecodeParams() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDPixelMap
DecodeParms is an optional parameter for filters.
getDecryptionCertificate() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Getter of the property decryptionCertificate.
getDefaultAppearance() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
getDefaultAppearanceString() - Method in class org.pdfbox.pdmodel.fdf.FDFOptionElement
This will get the string of default appearance string.
getDefaultResources() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the default resources for the acro form.
getDefaultWidth() - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will get the default width.
getDescent() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the descent for the font.
getDescent() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the descent for the font.
getDescent() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the descent for the font.
getDescription() - Method in class org.pdfbox.util.ExtensionFileFilter
getDestination() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
This will get the destination to jump to.
getDestination() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Get the destination to be displayed when the annotation is activated.
getDestination() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the page destination of this node.
getDestinationFileName() - Method in class org.pdfbox.util.PDFMergerUtility
Get the name of the destination file.
getDests() - Method in class org.pdfbox.pdmodel.PDDocumentNameDictionary
Get the destination named tree node.
getDictionary() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.pdfbox.pdmodel.PDPageNode
This will get the underlying dictionary that this class acts on.
getDictionary() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get the dictionary that is associated with this stream.
getDictionary() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Convert this standard java object to a COS object.
getDictionary() - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Convert this standard java object to a COS object.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
returns the dictionary.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
returns the dictionary.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
returns the dictionary.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
returns the dictionary.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the dictionary that this form wraps.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will get the dictionary associated with this field.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.pdfbox.util.ImageParameters
This will get the dictionary that stores the image parameters.
getDictionaryObject(String) - Method in class org.pdfbox.cos.COSDictionary
This will get an object from this dictionary.
getDictionaryObject(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a special case of getDictionaryObject that takes multiple keys, it will handle the situation where multiple keys could get the same value, ie if either CS or ColorSpace is used to get the colorspace.
getDictionaryObject(String[]) - Method in class org.pdfbox.cos.COSDictionary
This is a special case of getDictionaryObject that takes multiple keys, it will handle the situation where multiple keys could get the same value, ie if either CS or ColorSpace is used to get the colorspace.
getDictionaryObject(COSName) - Method in class org.pdfbox.cos.COSDictionary
This will get an object from this dictionary.
getDictionaryObject(COSName) - Method in class org.pdfbox.cos.COSObject
This will get the dictionary object in this object that has the name key and if it is a pdfobjref then it will dereference that and return it.
getDictionaryObject(COSName) - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get an object from this streams dictionary and dereference it if necessary.
getDifferences() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the incremental updates since the PDF was last opened.
getDirectory() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The dir to launch from.
getDocument() - Method in class org.pdfbox.pdfparser.PDFParser
This will get the document that was parsed.
getDocument() - Method in class org.pdfbox.pdmodel.PDDocument
This will get the low level document.
getDocument() - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will get the low level document.
getDocument() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the document associated with this form.
getDocument(InputStream) - Static method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
This will get a lucene document from a PDF file.
getDocument(File) - Static method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
This will get a lucene document from a PDF file.
getDocument(URL) - Static method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
This will get a lucene document from a PDF file.
getDocumentCatalog() - Method in class org.pdfbox.pdmodel.PDDocument
This will get the document CATALOG.
getDocumentID() - Method in class org.pdfbox.cos.COSDocument
This will get the document ID.
getDocumentInformation() - Method in class org.pdfbox.pdmodel.PDDocument
This will get the document info dictionary.
getDocumentOutline() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get the outline associated with this document or null if it does not exist.
getDomainForInput(int) - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
This will get the range for a certain input parameter. This is will never return null. If it is not present then the range 0 to 0 will be returned.
getDomainForInput(int) - Method in class org.pdfbox.pdmodel.common.function.PDFunction
This will get the range for a certain input parameter.
getDomainForInput(int) - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will get the range for a certain input parameter.
getDownAppearance() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getE() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the cursor enters the annotation's active area.
getEmbedded() - Method in class org.pdfbox.exceptions.CryptographyException
This will get the exception that caused this exception.
getEmbeddedDate(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getEmbeddedDate(String, COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getEmbeddedDate(String, String, Calendar) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a date.
getEmbeddedDate(String, COSName, Calendar) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a date.
getEmbeddedFDFs() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of embedded FDF entries, or null if the entry is null.
getEmbeddedFile() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded file.
getEmbeddedFileDos() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded dos file.
getEmbeddedFileMac() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded Mac file.
getEmbeddedFileUnix() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded Unix file.
getEmbeddedFiles() - Method in class org.pdfbox.pdmodel.PDDocumentNameDictionary
Get the embedded files named tree node.
getEmbeddedInt(String, String) - Method in class org.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(String, COSName) - Method in class org.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(String, String, int) - Method in class org.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(String, COSName, int) - Method in class org.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedString(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getEmbeddedString(String, COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getEmbeddedString(String, String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getEmbeddedString(String, COSName, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getEncodeForParameter(int) - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Get the encode for the input parameter.
getEncoding(COSName) - Method in class org.pdfbox.encoding.EncodingManager
This will get an encoding by name.
getEncoding() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
The encoding to be used for a FDF field.
getEncoding() - Method in class org.pdfbox.pdmodel.font.PDFont
This will get or create the encoder.
getEncryptionDictionary() - Method in class org.pdfbox.cos.COSDocument
This will get the encryption dictionary if the document is encrypted or null if the document is not encrypted.
getEncryptionDictionary() - Method in class org.pdfbox.pdmodel.PDDocument
This will get the encryption dictionary for this document.
getEncryptionDictionary(COSDictionary) - Static method in class org.pdfbox.pdmodel.encryption.PDEncryptionManager
Deprecated. This will get the correct security handler for the encryption dictionary.
getEncryptionKeyLength() - Method in class org.pdfbox.pdmodel.encryption.ProtectionPolicy
Get the length of the secrete key that will be used to encrypt document data.
getEndBookmark() - Method in class org.pdfbox.util.PDFTextStripper
Get the bookmark where text extraction should end, inclusive.
getEndPage() - Method in class org.pdfbox.util.PDFTextStripper
This will get the last page that will be extracted.
getEndPointEndingStyle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
getExecuteParam() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
A parameter to pass the executable.
getExpectedLength() - Method in class org.pdfbox.io.RandomAccessFileOutputStream
This will get the length that the PDF document specified this stream should be.
getExtends() - Method in class org.pdfbox.pdmodel.common.PDObjectStream
A reference to an object stream, of which the current object stream is considered an extension.
getF() - Method in class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Get the F action.
getF() - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will get a JavaScript action to be performed before the field is formatted to display its current value.
getF() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get the file name to be launched or the document to be opened or printed, in standard Windows pathname format.
getFDF() - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will get the FDF dictionary.
getFDFDocument() - Method in class org.pdfbox.pdfparser.PDFParser
This will get the FDF document that was parsed.
getField(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get a field by name, possibly using the cache if setCache is true.
getFieldFlags() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the Ff entry of the cos dictionary.
getFieldFlags() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will get the flags for this field.
getFieldType() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Get the FT entry of the field.
getFields() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of FDF Fields.
getFields() - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
This will get a list of fields that are part of this template.
getFields() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will return all of the fields in the document.
getFile() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get the file specification for this stream.
getFile() - Method in class org.pdfbox.pdmodel.common.PDStream
This will get the file specification for this stream.
getFile() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the file name.
getFile() - Method in class org.pdfbox.pdmodel.common.filespecification.PDFileSpecification
This will get the file name.
getFile() - Method in class org.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
This will get the file name.
getFile() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
The source file or target file: the PDF document file that this FDF file was exported from or is intended to be imported into.
getFile() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get the application to be launched or the document to be opened or printed.
getFile() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will get the file in which the destination is located.
getFile() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Return the attached file.
getFileDecodeParams() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Get the list of decode parameters.
getFileDecodeParams() - Method in class org.pdfbox.pdmodel.common.PDStream
Get the list of decode parameters.
getFileDos() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Dos file.
getFileFilters() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get the list of filters that are associated with this stream.
getFileFilters() - Method in class org.pdfbox.pdmodel.common.PDStream
This will get the list of filters that are associated with this stream.
getFileMac() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Mac file.
getFileSpecification() - Method in class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will get the file specification of this reference.
getFileUnix() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Unix file.
getFilename() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The file to launch.
getFilter(COSName) - Method in class org.pdfbox.filter.FilterManager
This will get a filter by name.
getFilter(String) - Method in class org.pdfbox.filter.FilterManager
This will get a filter by name.
getFilter() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Get the name of the filter.
getFilter(int) - Static method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getFilterManager() - Method in class org.pdfbox.cos.COSBase
This will get the filter manager to use to filter streams.
getFilteredStream() - Method in class org.pdfbox.cos.COSStream
This will get the stream with all of the filters applied.
getFilteredStream() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get the stream with all of the filters applied.
getFilters() - Method in class org.pdfbox.cos.COSStream
This will return the filters to apply to the byte stream.
getFilters() - Method in class org.pdfbox.filter.FilterManager
This will get all of the filters that are available in the system.
getFilters() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will return the filters to apply to the byte stream the method will return
getFilters() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get the list of filters that are associated with this stream.
getFilters() - Method in class org.pdfbox.pdmodel.common.PDStream
This will get the list of filters that are associated with this stream.
getFilters() - Method in class org.pdfbox.util.ImageParameters
This will get the list of filters that are associated with this stream.
getFirstBead() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Get the first bead in the thread, or null if it has not been set yet.
getFirstByteOffset() - Method in class org.pdfbox.pdmodel.common.PDObjectStream
The byte offset (in the decoded stream) of the first compressed object.
getFirstCOSObject() - Method in interface org.pdfbox.pdmodel.common.DualCOSObjectable
Convert this standard java object to a COS object.
getFirstCOSObject() - Method in class org.pdfbox.pdmodel.common.PDNamedTextStream
Convert this standard java object to a COS object.
getFirstChar() - Method in class org.pdfbox.pdmodel.font.PDFont
The code for the first char or -1 if there is none.
getFirstChild() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Return the first child or null if there is no child.
getFlag(COSDictionary, String, int) - Static method in class org.pdfbox.util.BitFlagHelper
Gets the boolean value from the flags at the given bit position.
getFlags() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the font flags.
getFlags() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the font flags.
getFlags() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the font flags.
getFlatness() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the flatness property.
getFlatnessTolerance() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the flatness tolerance.
getFloat(String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an int
getFloat(COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float
getFloat(String, float) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a float.
getFloat(COSName, float) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float.
getFo() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the annotation receives the input focus.
getFont() - Method in class org.pdfbox.TextToPDF
 
getFont() - Method in class org.pdfbox.pdmodel.graphics.PDFontSetting
This will get the font for this font setting.
getFont() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the font.
getFont() - Method in class org.pdfbox.util.TextPosition
This will get the font for the text being drawn.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will get the fonts bounding box.
getFontBoundingBox() - Method in class org.pdfbox.pdmodel.font.PDType0Font
This will get the fonts bouding box.
getFontDescriptor() - Method in class org.pdfbox.pdmodel.font.PDCIDFont
Get the font descriptor associated with this CID font.
getFontDescriptor() - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will get the font descriptor for this font.
getFontDescriptor() - Method in class org.pdfbox.pdmodel.font.PDType1AfmPfbFont
This will get the font descriptor for this font.
getFontFamily() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A string representing the preferred font family.
getFontFamily() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
A string representing the preferred font family.
getFontFamily() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A string representing the preferred font family.
getFontFile() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A stream containing a Type 1 font program.
getFontFile2() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A stream containing a true type font program.
getFontFile3() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A stream containing a font program that is not true type or type 1.
getFontHeight(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will get the font height for a character.
getFontHeight(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the font width for a character.
getFontHeight(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will get the font width for a character.
getFontHeight(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDType0Font
This will get the font height for a character.
getFontMatrix() - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the matrix that is used to transform glyph space to text space.
getFontName() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
Get the font name.
getFontName() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
Get the font name.
getFontName() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Get the font name.
getFontSetting() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the font setting of the graphics state.
getFontSize() - Method in class org.pdfbox.TextToPDF
 
getFontSize() - Method in class org.pdfbox.pdmodel.graphics.PDFontSetting
This will get the size of the font.
getFontSize() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the fontSize.
getFontSize() - Method in class org.pdfbox.util.TextPosition
This will get the font size that this object is suppose to be drawn at.
getFontStretch() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A string representing the preferred font stretch.
getFontStretch() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
A string representing the preferred font stretch.
getFontStretch() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A string representing the preferred font stretch.
getFontWeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
The weight of the font.
getFontWeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
The weight of the font.
getFontWeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
The weight of the font.
getFontWidth(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will get the font width for a character.
getFontWidth(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the font width for a character.
getFontWidth(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will get the font width for a character.
getFontWidth(byte[], int, int) - Method in class org.pdfbox.pdmodel.font.PDType0Font
This will get the font width for a character.
getFontWidthFromAFMFile(int) - Method in class org.pdfbox.pdmodel.font.PDFont
This will attempt to get the font width from an AFM file.
getFonts(Map) - Method in class org.pdfbox.pdmodel.PDResources
This will get the map of fonts.
getFonts() - Method in class org.pdfbox.pdmodel.PDResources
This will get the map of fonts.
getFonts() - Method in class org.pdfbox.util.PDFStreamEngine
 
getFormType() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will get the form type, currently 1 is the only form type.
getFractionalSpaceToAllocate() - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This is guaranteed to never return null.
getFullyQualifiedName() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Returns the fully qualified name of the field, which is a concatenation of the names of all the parents fields.
getG() - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
This will get the g value of the tristimulus.
getGamma() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will get the gamma value.
getGamma() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will get the gamma value.
getGeneration() - Method in class org.pdfbox.persistence.util.COSObjectKey
This will get the generation number.
getGenerationNumber() - Method in class org.pdfbox.cos.COSObject
Getter for property generationNumber.
getGraphics() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the graphics that we are currently drawing on.
getGraphicsStack() - Method in class org.pdfbox.util.PDFStreamEngine
 
getGraphicsState() - Method in class org.pdfbox.util.PDFStreamEngine
 
getGraphicsStates() - Method in class org.pdfbox.pdmodel.PDResources
This will get the map of graphic states.
getGraphicsStates() - Method in class org.pdfbox.util.PDFStreamEngine
 
getGuidelineColor() - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the color to be used for the guidelines.
getGuidelineStyle() - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the style for the guideline.
getGuidelineWidth() - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the width of the of the guideline in default user space units.
getHeaderString() - Method in class org.pdfbox.cos.COSDocument
 
getHeight() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the height of this rectangle as calculated by upperRightY - lowerLeftY.
getHeight() - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getHeight() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Get the height of the image.
getHeight() - Method in class org.pdfbox.util.ImageParameters
The height of this image.
getHeight() - Method in class org.pdfbox.util.TextPosition
This will get the maximum height of all characters in this string.
getHexString() - Method in class org.pdfbox.cos.COSString
This will take this string and create a hex representation of the bytes that make the string.
getHighValue() - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
Get the highest value for the lookup.
getHighlightMode() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Set the highlight mode for when the mouse is depressed.
getHorizontalScalingPercent() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the horizontalScaling.
getID() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This is the FDF id.
getIconFit() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the icon fit that is associated with this field.
getImageData() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
Get the bytes for the image.
getImageData() - Method in class org.pdfbox.util.PDFOperator
This is the special case for the ID operator where there are just random bytes inlined the stream.
getImageParameters() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will get the image parameters.
getImageParameters() - Method in class org.pdfbox.util.PDFOperator
This will get the image parameters, this is only valid for BI operators.
getImages() - Method in class org.pdfbox.pdmodel.PDResources
This will get the map of images.
getInReplyTo() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
getIndex() - Method in class org.pdfbox.pdfviewer.ArrayEntry
This will get the index of the array entry.
getIndexOfChild(Object, Object) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Returns the index of child in parent.
getInputStreamAsString() - Method in class org.pdfbox.pdmodel.common.PDStream
A convenience method to get this stream as a string.
getInstance() - Static method in class org.pdfbox.pdmodel.encryption.SecurityHandlersManager
Get the singleton instance.
getInt(int) - Method in class org.pdfbox.cos.COSArray
Get the value of the array as an integer.
getInt(int, int) - Method in class org.pdfbox.cos.COSArray
Get the value of the array as an integer, return the default if it does not exist.
getInt(String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an int
getInt(COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an int
getInt(String[], int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getInt(String, int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getInt(COSName, int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getIntensity() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will retrieve the intensity of the applied effect.
getIntent() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
getInteriorColour() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the interior colour of the line endings defined in the LE entry.
getInteriorColour() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the interior colour of the drawn area Colour is in DeviceRGB colourspace.
getItalicAngle() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the italic angle for the font.
getItalicAngle() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the italic angle for the font.
getItalicAngle() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the italic angle for the font.
getItem(COSName) - Method in class org.pdfbox.cos.COSDictionary
This will do a lookup into the dictionary.
getItem(COSName) - Method in class org.pdfbox.cos.COSObject
This will get the dictionary object in this object that has the name key.
getItem(COSName) - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get an object from this streams dictionary.
getJavaScript() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the java script entry.
getK() - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will get a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.
getKey() - Method in class org.pdfbox.pdfviewer.MapEntry
Get the key for this entry.
getKey() - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
This will get the Object key.
getKeyForValue(Object) - Method in class org.pdfbox.cos.COSDictionary
Search in the map for the value that matches the parameter and return the first key that maps to that value.
getKeyLength() - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
Getter of the property keyLength.
getKeywords() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the keywords of the document.
getKids() - Method in class org.pdfbox.pdmodel.PDPageNode
This will return all kids of this node, either PDPageNode or PDPage.
getKids() - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Return the children of this node.
getKids() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the list of kids.
getKids() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will get all the kids of this field.
getKids() - Method in class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
This will return a list of PDField objects that are part of this radio collection.
getKnockoutFlag() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the knockout.
getLanguage() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
The language for the document.
getLastChar() - Method in class org.pdfbox.pdmodel.font.PDFont
The code for the last char or -1 if there is none.
getLastChild() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Return the last child or null if there is no child.
getLastModified() - Method in class org.pdfbox.pdmodel.PDPage
This will get the date that the content stream was last modified.
getLeading() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the leading for the font.
getLeading() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the leading for the font.
getLeading() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the leading for the font.
getLeading() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the leading.
getLeft() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Get the left x coordinate.
getLeft() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the left x coordinate.
getLeft() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the left x coordinate.
getLength() - Method in class org.pdfbox.io.RandomAccessFileOutputStream
The number of bytes written to the stream.
getLength() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get the length of the filtered/compressed stream.
getLength() - Method in class org.pdfbox.pdmodel.common.PDStream
This will get the length of the filtered/compressed stream.
getLength() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will return the Length entry of the encryption dictionary.
getLine() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).
getLineCap() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line cap.
getLineCapStyle() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the line cap style.
getLineDashPattern() - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the line dash pattern for this box style.
getLineDashPattern() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the dash pattern.
getLineDashPattern() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the current line dash pattern.
getLineJoin() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line join.
getLineJoinStyle() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the line join style.
getLineLength() - Method in class org.pdfbox.io.ASCII85OutputStream
This will get the length of the line.
getLinePath() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the current line path to be drawn.
getLineSeparator() - Method in class org.pdfbox.util.PDFTextStripper
This will get the line separator.
getLineSubPaths() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the current list of line paths to be drawn.
getLineWidth() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the line width.
getLineWidth() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line width.
getLinearInterpretation() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will get the linear interpretation array.
getLong(String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long
getLong(COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long
getLong(String[], long) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long.
getLong(String, long) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getLong(COSName, long) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getLowerLeftX() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the lower left x coordinate.
getLowerLeftY() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the lower left y coordinate.
getLowerLimit() - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Get the lowest value for a key in the name map.
getMacCreator() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac Creator.
getMacResFork() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac ResFork.
getMacSubtype() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac subtype.
getMarkInfo() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get info about doc's usage of tagged features.
getMax() - Method in class org.pdfbox.pdmodel.common.PDRange
This will get the maximum value of the range.
getMaxWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the max width for the font.
getMaxWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the max width for the font.
getMaxWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the max width for the font.
getMediaBox() - Method in class org.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed This will get the MediaBox at this page and not look up the hierarchy.
getMediaBox() - Method in class org.pdfbox.pdmodel.PDPageNode
This will get the MediaBox at this page and not look up the hierarchy.
getMessage() - Method in class org.pdfbox.exceptions.WrappedException
Gets the wrapped exception message.
getMessage() - Method in class org.pdfbox.exceptions.WrappedIOException
Gets the wrapped exception message.
getMetadata() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.pdfbox.pdmodel.PDPage
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.pdfbox.pdmodel.common.PDStream
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will get the metadata stream for this object.
getMetadata() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Get the metadata that is part of the document catalog.
getMin() - Method in class org.pdfbox.pdmodel.common.PDRange
This will get the minimum value of the range.
getMissingWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the missing width for the font.
getMissingWidth() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the missing width for the font.
getMiterLimit() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the miter limit.
getMiterLimit() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the miter limit.
getModDate() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mod date of the embedded file.
getModificationDate() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the modification date of the document.
getModifiedDate() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the date and time the annotation was modified.
getName(int) - Method in class org.pdfbox.cos.COSArray
Get the value of the array as a string.
getName(int, String) - Method in class org.pdfbox.cos.COSArray
Get an entry in the array that is expected to be a COSName.
getName() - Method in class org.pdfbox.cos.COSName
This will get the name of this COSName object.
getName(int) - Method in class org.pdfbox.encoding.Encoding
This will take a character code and get the name from the code.
getName() - Method in class org.pdfbox.pdmodel.common.PDNamedTextStream
The name of the named text stream.
getName() - Method in class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will get the name of the referenced page.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpace
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDPattern
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will return the name of the color space.
getName() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.
getName() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.
getNameAsString(String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getNameAsString(COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getNameAsString(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getNameAsString(COSName, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getNameFromCharacter(char) - Method in class org.pdfbox.encoding.Encoding
This will take a character code and get the name from the code.
getNamedDestination() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
This will get the name of the destination.
getNamedJavaScripts() - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
This will return a list of PDNamedTextStream objects.
getNames() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
 
getNames() - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
This will return a map of names.
getNext() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
This will get the next action, or sequence of actions, to be performed after this one.
getNextBead() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the next bead.
getNextSibling() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Return the next sibling or null if there is no next sibling.
getNextUniqueKey(Map, String) - Static method in class org.pdfbox.util.MapUtil
Generate a unique key for the map based on a prefix.
getNodeValue(Element) - Static method in class org.pdfbox.util.XMLUtil
This will get the text value of an element.
getNonFullScreenPageMode() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the non full screen page mode preference.
getNonStrokingAlpaConstant() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the non stroking alpha constant.
getNonStrokingColor() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the non stroking color.
getNonStrokingColorSpace() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the nonstroking color space instance.
getNonStrokingOverprintControl() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control for non stroking operations.
getNormalAppearance() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getNumber() - Method in class org.pdfbox.pdfwriter.COSWriter
This will get the current object number.
getNumber() - Method in class org.pdfbox.persistence.util.COSObjectKey
This will get the objects id.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpace
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will return the number of color components.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will return the number of color components.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDPattern
This will get the number of components that this color space is made up of.
getNumberOfComponents() - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the number of components that this color space is made up of.
getNumberOfInputParameters() - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
This will get the number of input parameters that have a domain specified.
getNumberOfInputParameters() - Method in class org.pdfbox.pdmodel.common.function.PDFunction
This will get the number of input parameters that have a domain specified.
getNumberOfInputParameters() - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will get the number of input parameters that have a domain specified.
getNumberOfObjects() - Method in class org.pdfbox.pdmodel.common.PDObjectStream
Get the number of compressed object.
getNumberOfOutputParameters() - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
This will get the number of output parameters that have a range specified. A range for output parameters is optional so this may return zero for a function that does have output parameters, this will simply return the number that have the rnage specified.
getNumberOfOutputParameters() - Method in class org.pdfbox.pdmodel.common.function.PDFunction
This will get the number of output parameters that have a range specified.
getNumberOfOutputParameters() - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will get the number of output parameters that have a range specified.
getNumberOfPages() - Method in class org.pdfbox.pdmodel.PDDocument
getNumberOfSamples() - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
The "Size" entry, which is the number of samples in each input dimension of the sample table.
getO() - Method in class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will get an action to be performed when the page is opened.
getO() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get the string specifying the operation to perform: open to open a document print to print a document If the F entry designates an application instead of a document, this entry is ignored and the application is launched.
getObject(int) - Method in class org.pdfbox.cos.COSArray
This will get an object from the array.
getObject() - Method in class org.pdfbox.cos.COSObject
This will get the object that this object encapsulates.
getObject() - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
This will get the object.
getObjectByType(String) - Method in class org.pdfbox.cos.COSDocument
This will get the first dictionary object by type.
getObjectByType(COSName) - Method in class org.pdfbox.cos.COSDocument
This will get the first dictionary object by type.
getObjectFromPath(String) - Method in class org.pdfbox.cos.COSDictionary
Nice method, gives you every object you want Arrays works properly too.
getObjectFromPool(COSObjectKey) - Method in class org.pdfbox.cos.COSDocument
This will get an object from the pool.
getObjectKeys() - Method in class org.pdfbox.pdfwriter.COSWriter
This will get all available object keys.
getObjectNumber() - Method in class org.pdfbox.cos.COSObject
Getter for property objectNumber.
getObjects() - Method in class org.pdfbox.cos.COSDocument
This will get a list of all available objects.
getObjects() - Method in class org.pdfbox.pdfparser.PDFObjectStreamParser
This will get the objects that were parsed from the stream.
getObjectsByType(String) - Method in class org.pdfbox.cos.COSDocument
This will get all dictionary objects by type.
getObjectsByType(COSName) - Method in class org.pdfbox.cos.COSDocument
This will get a dictionary object by type.
getOffValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
This will get the value of the radio button.
getOffset() - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
This will get the offset into the document.
getOnValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
This will get the value of the radio button.
getOpen() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will retrieve the initial state of the annotation, open Or closed (default closed).
getOpen() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will retrieve the initial state of the annotation, open Or closed (default closed).
getOpenAction() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get the Document Open Action for this object.
getOpenCount() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Get the number of open nodes.
getOperation() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Get the operation to perform on the file.
getOperation() - Method in class org.pdfbox.util.PDFOperator
This will get the operation that this operator represents.
getOperator(String) - Static method in class org.pdfbox.util.PDFOperator
This is used to create/cache operators in the system.
getOption() - Method in class org.pdfbox.pdmodel.fdf.FDFOptionElement
This will get the string of one of the available options.
getOptions() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will return a list of options for a choice field.
getOptions() - Method in class org.pdfbox.pdmodel.interactive.form.PDChoiceButton
This will get the option values "Opt" entry of the pdf button.
getOutput() - Method in class org.pdfbox.pdfwriter.COSWriter
This will get the output stream.
getOutput() - Method in class org.pdfbox.util.PDFTextStripper
The output stream that is being written to.
getOverprintMode() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control mode.
getOverprintMode() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the overprint mode property.
getOwnerAccessPermission() - Static method in class org.pdfbox.pdmodel.encryption.AccessPermission
returns an access permission object for a document owner.
getOwnerKey() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the O entry in the standard encryption dictionary.
getOwnerKey() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will get the O entry in the standard encryption dictionary.
getOwnerPassword() - Method in class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Getter of the property ownerPassword.
getOwnerPasswordForEncryption() - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated. Do not rely on this method anymore.
getP() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get a parameter string to be passed to the application designated by the F entry.
getPC() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the page containing the annotation is closed.
getPDDocument() - Method in class org.pdfbox.pdfparser.PDFParser
This will get the PD document that was parsed.
getPDFName(String) - Static method in class org.pdfbox.cos.COSName
This will get a COSName object with that name.
getPDStream() - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
Get the pd stream for this icc color space.
getPDStream() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Returns the stream.
getPI() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.
getPO() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the page containing the annotation is opened.
getPV() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.
getPage() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the page that is currently being drawn.
getPage() - Method in class org.pdfbox.pdmodel.fdf.FDFAnnotation
This will get the page number or null if it does not exist.
getPage() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
This will get the page for this destination.
getPage() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Get the page that this bead is part of.
getPageCount() - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated. Use the getNumberOfPages method instead!
getPageFormat(int) - Method in class org.pdfbox.pdmodel.PDDocument
getPageInfo() - Method in class org.pdfbox.pdmodel.fdf.FDFPage
This will get the FDF page info object.
getPageLayout() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the page layout, see the PAGE_LAYOUT_XXX constants.
getPageMode() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the page display mode, see the PAGE_MODE_XXX constants.
getPageNumber() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
This will get the page number for this destination.
getPageSeparator() - Method in class org.pdfbox.util.PDFTextStripper
This will get the page separator.
getPageSize() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the size of the page that is currently being drawn.
getPages() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
This will get the root node for the pages.
getPages() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of FDF Pages.
getPanel() - Method in class org.pdfbox.pdfviewer.PageWrapper
This will get the JPanel that can be displayed.
getParent() - Method in class org.pdfbox.pdmodel.PDPage
This is the parent page node.
getParent() - Method in class org.pdfbox.pdmodel.PDPageNode
This is the parent page node.
getParent() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will retrieve the markup annotation which this popup relates to.
getParent() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Get the parent of this object.
getParent() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Get the parent field to this field, or null if none exists.
getPartialFieldName() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the "T" entry in the field dictionary.
getPartialName() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Returns the partial name of the field.
getPartiallyFilteredStream(List) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will get a stream with some filters applied but not others.
getPartiallyFilteredStream(List) - Method in class org.pdfbox.pdmodel.common.PDStream
This will get a stream with some filters applied but not others.
getPassword() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
Returns the password given by the user and that will be used to open the private key.
getPassword() - Method in class org.pdfbox.pdmodel.encryption.StandardDecryptionMaterial
Returns the password.
getPermission() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyRecipient
Returns the access permission granted to the recipient.
getPermissionBytes() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
The returns an integer representing the access permissions.
getPermissionBytesForPublicKey() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This returns an integer representing the access permissions.
getPermissions() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the permissions bit mask.
getPermissions() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will get the permissions bit mask.
getPermissions() - Method in class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Getter of the property permissions.
getPhaseStart() - Method in class org.pdfbox.pdmodel.graphics.PDLineDashPattern
This will get the line dash pattern phase.
getPopup() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the popup annotation used for entering/editing the text for this annotation.
getPos() - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will get the current position in the stream.
getPosition() - Method in class org.pdfbox.io.RandomAccessFileOutputStream
This will get the position in the RAF that the stream was written to.
getPredictor() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDPixelMap
A code that selects the predictor algorithm.
getPreviousBead() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the previous bead.
getPreviousSibling() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Return the previous sibling or null if there is no sibling.
getPreviousURI() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the previous URI action, in case it's needed.
getPrintArea() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the PrintArea preference.
getPrintClip() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the PrintClip preference.
getPrintable(int) - Method in class org.pdfbox.pdmodel.PDDocument
getPrivateKey() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
returns The private key that will be used to open the document protection.
getProducer() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the producer of the document.
getQ() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
This will get the 'quadding' or justification of the text to be displayed. 0 - Left(default)
1 - Centered
2 - Right
Please see the QUADDING_CONSTANTS.
getQuadPoints() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will retrieve the set of quadpoints which encompass the areas of this annotation which will activate.
getQuadPoints() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will retrieve the set of quadpoints which encompass the areas of this annotation.
getR() - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
This will get the r value of the tristimulus.
getRGBImage() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDCcitt
Returns an image of the CCITT Fax, or null if TIFFs are not supported.
getRGBImage() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDJpeg
Returns an image of the JPeg, or null if JPegs are not supported.
getRGBImage() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Returns a BufferedImage of the COSStream set in the constructor or null if the COSStream could not be encoded.
getRGBImage() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Returns an java.awt.Image, that can be used for display etc.
getRangeForComponent(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will get the range for a certain component number.
getRangeForOutput(int) - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
This will get the range for a certain output parameters. This is will never return null. If it is not present then the range 0 to 0 will be returned.
getRangeForOutput(int) - Method in class org.pdfbox.pdmodel.common.function.PDFunction
This will get the range for a certain output parameters.
getRangeForOutput(int) - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will get the range for a certain output parameters.
getReadingDirection() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the reading direction preference.
getRecipientStringAt(int) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
returns the COSString contained in the Recipients field at position i.
getRecipientsIterator() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Returns an iterator to browse the list of recipients.
getRecipientsLength() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Returns the number of recipients contained in the Recipients field of the dictionary.
getRecipientsNumber() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Returns the number of recipients.
getRectDifference() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will get the rectangle difference rectangle.
getRectangle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
The annotation rectangle, defining the location of the annotation on the page in default user space units.
getRectangle() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
The rectangle on the page that this bead is part of.
getRegions() - Method in class org.pdfbox.util.PDFTextStripperByArea
Get the list of regions that have been setup.
getRenderingIntent() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the rendering intent.
getRenderingIntent() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the rendering intent.
getRenderingMode() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the renderingMode.
getReplyType() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
getResources() - Method in class org.pdfbox.pdmodel.PDPage
This will get the resources at this page and not look up the hierarchy.
getResources() - Method in class org.pdfbox.pdmodel.PDPageNode
This will get the resources at this page node and not look up the hierarchy.
getResources() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will get the resources at this page and not look up the hierarchy.
getResources() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will get the resources for this appearance stream.
getResources() - Method in class org.pdfbox.util.PDFStreamEngine
 
getRevision() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will return the R entry of the encryption dictionary.
getRevision() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will return the R entry of the encryption dictionary.
getRichContents() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the rich text stream which is displayed in the popup window.
getRichText() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the rich text that is associated with this field.
getRight() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the right x coordinate.
getRise() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the rise.
getRolloverAppearance() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getRoot() - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Returns the root of the tree.
getRotation() - Method in class org.pdfbox.pdmodel.PDPage
A value representing the rotation.
getRotation() - Method in class org.pdfbox.pdmodel.PDPageNode
A value representing the rotation.
getS() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will get the type of action that the actions dictionary describes.
getS() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will get the type of action that the actions dictionary describes.
getScaleInstance(float, float) - Static method in class org.pdfbox.util.Matrix
Convenience method to create a scaled instance.
getScaleOption() - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will get the scale option.
getScaleType() - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will get the scale type.
getScratchFile() - Method in class org.pdfbox.cos.COSDocument
This will get the scratch file for this document.
getScratchFile() - Method in class org.pdfbox.cos.COSStream
This will get the scratch file associated with this stream.
getScratchFile() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get the scratch file associated with this stream.
getSecondCOSObject() - Method in interface org.pdfbox.pdmodel.common.DualCOSObjectable
Convert this standard java object to a COS object.
getSecondCOSObject() - Method in class org.pdfbox.pdmodel.common.PDNamedTextStream
Convert this standard java object to a COS object.
getSecurityHandler() - Method in class org.pdfbox.pdmodel.PDDocument
Get the security handler that is used for document encryption.
getSecurityHandler(ProtectionPolicy) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandlersManager
Get the security handler for the protection policy.
getSecurityHandler(String) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandlersManager
Retrieve the appropriate SecurityHandler for a the given filter name.
getSetFieldFlags() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the SetFf entry of the cos dictionary.
getSetWidgetFieldFlags() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the SetF entry of the cos dictionary.
getSignature() - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will get the signature or null if there is none.
getSize() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the size of the embedded file.
getSmoothness() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the smoothness property.
getSmoothnessTolerance() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the smothness tolerance.
getSplitAtPage() - Method in class org.pdfbox.util.Splitter
This will return how many pages each split document will contain.
getStandard14Names() - Static method in class org.pdfbox.pdmodel.font.PDType1Font
This will get the names of the standard 14 fonts.
getStandardEncoding() - Method in class org.pdfbox.encoding.EncodingManager
This will get the standard encoding.
getStandardFont(String) - Static method in class org.pdfbox.pdmodel.font.PDType1Font
A convenience method to get one of the standard 14 font from name.
getStandardOutput() - Method in class org.pdfbox.pdfwriter.COSWriter
This will get the standard output stream.
getStart() - Method in class org.pdfbox.pdfparser.PDFXref
This will get the start attribute.
getStartBookmark() - Method in class org.pdfbox.util.PDFTextStripper
Get the bookmark where text extraction should start, inclusive.
getStartPage() - Method in class org.pdfbox.util.PDFTextStripper
This is the page that the text extraction will start on.
getStartPointEndingStyle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
getStartxref() - Method in class org.pdfbox.pdfwriter.COSWriter
This will get the current start xref.
getStatus() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the status string to be displayed as the result of an action.
getStatusLabel() - Method in class org.pdfbox.pdfviewer.ReaderBottomPanel
This method initializes status label.
getStemH() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the stemH for the font.
getStemH() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the stemH for the font.
getStemH() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the stemH for the font.
getStemV() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the stemV for the font.
getStemV() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the stemV for the font.
getStemV() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the stemV for the font.
getStream() - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Get the cos stream associated with this object.
getStream() - Method in class org.pdfbox.pdmodel.common.PDNamedTextStream
This will get the stream.
getStream() - Method in class org.pdfbox.pdmodel.common.PDStream
Get the cos stream associated with this object.
getStream() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will return the underlying stream.
getStreamTokens() - Method in class org.pdfbox.cos.COSStream
This will get all the tokens in the stream.
getStreamTokens() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get all the tokens in the stream.
getString(int) - Method in class org.pdfbox.cos.COSArray
Get the value of the array as a string.
getString(int, String) - Method in class org.pdfbox.cos.COSArray
Get an entry in the array that is expected to be a COSName.
getString(String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getString(COSName) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getString(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getString(COSName, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
getString() - Method in class org.pdfbox.cos.COSString
This will get the string that this object wraps.
getStringWidth(String) - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the width of this string for this font.
getStrokingAlpaConstant() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the stroking alpha constant.
getStrokingColor() - Method in class org.pdfbox.pdfviewer.PageDrawer
Get the stroking color.
getStrokingColorSpace() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the current stroking colorspace.
getStrokingOverprintControl() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control.
getStructureElement() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the structure element of this node.
getStructureTreeRoot() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get the document's structure tree root.
getStyle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will retrieve the border effect, see the STYLE_* constants for valid values.
getStyle() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will retrieve the border style, see the STYLE_* constants for valid values.
getSubType() - Method in class org.pdfbox.pdmodel.font.PDFont
This will get the subtype of font, Type1, Type3, ...
getSubType() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
This will get the type of action that the actions dictionary describes.
getSubject() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the subject of the document.
getSubject() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the short description of the subject of the annotation.
getSubtype() - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the subtype(mimetype) for the embedded file.
getSubtype() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
getSubtype() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
getSuffix() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
This will get the suffix for this image type, jpg/png.
getTarget() - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will get the target frame in the browser to open this document.
getTemplateReference() - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
This is the template reference.
getTemplates() - Method in class org.pdfbox.pdmodel.fdf.FDFPage
This will get a list of FDFTemplage objects that describe the named pages that serve as templates.
getTerminator() - Method in class org.pdfbox.io.ASCII85OutputStream
This will get the terminating character.
getText(PDDocument) - Method in class org.pdfbox.util.PDFTextStripper
This will return the text of a document.
getText(COSDocument) - Method in class org.pdfbox.util.PDFTextStripper
Deprecated.  
getTextColor() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the text color of this node.
getTextForRegion(String) - Method in class org.pdfbox.util.PDFTextStripperByArea
Get the text for the region, this should be called after extractRegions().
getTextKnockoutFlag() - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the text knockout flag.
getTextLineMatrix() - Method in class org.pdfbox.util.PDFStreamEngine
 
getTextMatrix() - Method in class org.pdfbox.util.PDFStreamEngine
 
getTextState() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the graphics text state.
getThread() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the thread that this bead is part of.
getThreadBeads() - Method in class org.pdfbox.pdmodel.PDPage
This will get a list of PDThreadBead objects, which are article threads in the document.
getThreadInfo() - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Get info about the thread, or null if there is nothing.
getThreads() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get the list threads for this pdf document.
getTintTransform() - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the tint transform function.
getTintTransform() - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the tint transform function.
getTitle() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the title of the document.
getTitle() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the title of this node.
getTitleGuess() - Method in class org.pdfbox.util.PDFText2HTML
The guess to the document title.
getTitlePopup() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Retrieve the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
getToUnicode() - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will get the ToUnicode stream.
getTokens() - Method in class org.pdfbox.pdfparser.PDFStreamParser
This will get the tokens that were parsed from the stream.
getTop() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the top y coordinate.
getTop() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Get the top y coordinate.
getTop() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the top y coordinate.
getTrailer() - Method in class org.pdfbox.cos.COSDocument
This will get the document trailer.
getTranslatingInstance(float, float) - Static method in class org.pdfbox.util.Matrix
Convenience method to create a translating instance.
getTrapped() - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will get the trapped value for the document.
getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) - Method in class org.pdfbox.pdfviewer.PDFTreeCellRenderer
getTrimBox() - Method in class org.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the intended dimensions of the finished page after trimming.
getType() - Method in class org.pdfbox.pdmodel.common.PDObjectStream
Get the type of this object, should always return "ObjStm".
getType() - Method in class org.pdfbox.pdmodel.font.PDFont
This will always return "Font" for fonts.
getType() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
This will get the type of PDF object that the actions dictionary describes.
getU() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the mouse button is released inside the annotation's active area.
getURI() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Document level information in the URI.
getURI() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will get the uniform resource identifier to resolve, encoded in 7-bit ASCII.
getUnfilteredStream() - Method in class org.pdfbox.cos.COSStream
This will get the logical content stream with none of the filters.
getUnfilteredStream() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
This will get the logical content stream with none of the filters.
getUpperLimit() - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Get the highest value for a key in the name map.
getUpperRightX() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the upper right x coordinate.
getUpperRightY() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the upper right y coordinate.
getUserKey() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the U entry in the standard encryption dictionary.
getUserKey() - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will get the U entry in the standard encryption dictionary.
getUserPassword(byte[], byte[], int, long) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This will get the user password from the owner password and the documents o value.
getUserPassword() - Method in class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Getter of the property userPassword.
getUserPassword(byte[], byte[], int, long) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Get the user password based on the owner password.
getUserPasswordForEncryption() - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated. Do not rely on this method anymore.
getV() - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will get a JavaScript action to be performed when the field's value is changed.
getValue() - Method in class org.pdfbox.cos.COSBoolean
This will get the value that this object wraps.
getValue() - Method in class org.pdfbox.pdfviewer.ArrayEntry
This will get the value for this entry.
getValue() - Method in class org.pdfbox.pdfviewer.MapEntry
This will get the value for this entry.
getValue(int, int) - Method in class org.pdfbox.pdmodel.common.PDMatrix
This will get a matrix value at some point.
getValue(String) - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
The name to retrieve.
getValue() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the value for the field.
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
getValue gets the fields value to as a string.
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
getValue gets the fields value to as a string.
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDPushButton
getValue gets the fields value to as a string.
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
getValue gets the fields value to as a string.
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDSignature
 
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDUnknownField
getValue gets the fields value to as a string.
getValue() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
getValue gets the fields value to as a string.
getValue(int, int) - Method in class org.pdfbox.util.Matrix
This will get a matrix value at some point.
getValueAsObject() - Method in class org.pdfbox.cos.COSBoolean
This will get the value that this object wraps.
getValues() - Method in class org.pdfbox.cos.COSDictionary
This will get all of the values for the dictionary.
getValues() - Method in class org.pdfbox.util.Matrix
Return a single dimension array of all values in the matrix.
getValuesAsDouble() - Method in class org.pdfbox.util.Matrix
Return a single dimension array of all values in the matrix.
getVersion() - Static method in class org.pdfbox.Version
Get the version of PDFBox or unknown if it is not known.
getVersion() - Method in class org.pdfbox.cos.COSDocument
This will get the version of this PDF document.
getVersion() - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will return the V entry of the encryption dictionary.
getVersion() - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will get the version that was specified in the catalog dictionary.
getViewArea() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the ViewArea preference.
getViewClip() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the ViewClip preference.
getViewerPreferences() - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Get the viewer preferences associated with this document or null if they do not exist.
getWC() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before closing a document.
getWP() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before printing a document.
getWS() - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before saving a document.
getWhitepoint() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will return the whitepoint tristimulus.
getWhitepoint() - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will return the whitepoint tristimulus.
getWhitepoint() - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will return the whitepoint tristimulus.
getWidget() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will get the single associated widget that is part of this field.
getWidgetFieldFlags() - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the F entry of the cos dictionary.
getWidth() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will get the width of this rectangle as calculated by upperRightX - lowerLeftX.
getWidth() - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getWidth() - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Get the width of the image.
getWidth() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will retrieve the border width in points, 0 = no border.
getWidth() - Method in class org.pdfbox.util.ImageParameters
The width of this image.
getWidth() - Method in class org.pdfbox.util.TextPosition
This will get the width of this character.
getWidthOfSpace() - Method in class org.pdfbox.util.TextPosition
This will get the width of a space character.
getWidths() - Method in class org.pdfbox.pdmodel.font.PDFont
The widths of the characters.
getWinLaunchParams() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get a dictionary containing Windows-specific launch parameters.
getWordSeparator() - Method in class org.pdfbox.util.PDFTextStripper
This will get the word separator.
getWordSpacing() - Method in class org.pdfbox.pdmodel.text.PDTextState
Get the value of the wordSpacing.
getWordSpacing() - Method in class org.pdfbox.util.TextPosition
This will get the current word spacing.
getX() - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
This will get the x value of the tristimulus.
getX() - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the cursor exits the annotation's active area.
getX() - Method in class org.pdfbox.util.TextPosition
This will get the x position of the character.
getX509() - Method in class org.pdfbox.pdmodel.encryption.PublicKeyRecipient
Returns the X509 certificate of the recipient.
getXFA() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.
getXHeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will get the x height for the font.
getXHeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the x height for the font.
getXHeight() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the x height for the font.
getXObjects() - Method in class org.pdfbox.pdmodel.PDResources
This will get the map of PDXObjects that are in the resource dictionary.
getXObjects() - Method in class org.pdfbox.util.PDFStreamEngine
 
getXPosition() - Method in class org.pdfbox.util.Matrix
Get the x position in the matrix.
getXRefEntries() - Method in class org.pdfbox.pdfwriter.COSWriter
This will get the xref entries.
getXScale() - Method in class org.pdfbox.util.Matrix
Get the xscaling factor of this matrix.
getXScale() - Method in class org.pdfbox.util.TextPosition
 
getXrefs() - Method in class org.pdfbox.pdfparser.BaseParser
This will get all of the xrefs.
getY() - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
This will get the y value of the tristimulus.
getY() - Method in class org.pdfbox.util.TextPosition
This will get the y position of the character.
getYPosition() - Method in class org.pdfbox.util.Matrix
Get the y position.
getYScale() - Method in class org.pdfbox.util.Matrix
Get the y scaling factor of this matrix.
getYScale() - Method in class org.pdfbox.util.TextPosition
 
getZ() - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
This will get the z value of the tristimulus.
getZoom() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the zoom value.
growToSize(int) - Method in class org.pdfbox.cos.COSArray
This will add null values until the size of the array is at least as large as the parameter.
growToSize(int, COSBase) - Method in class org.pdfbox.cos.COSArray
This will add the object until the size of the array is at least as large as the parameter.
guessTitle(Iterator) - Method in class org.pdfbox.util.PDFText2HTML
This method will attempt to guess the title of the document.

H

H - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
HEIGHT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
HELVETICA - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
HELVETICA_BOLD - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
HELVETICA_BOLD_OBLIQUE - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
HELVETICA_OBLIQUE - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
HEX_STRING_CLOSE - Static variable in class org.pdfbox.cos.COSString
One of the close string tokens.
HEX_STRING_OPEN - Static variable in class org.pdfbox.cos.COSString
One of the open string tokens.
HEX_TABLE - Static variable in class org.pdfbox.persistence.util.COSHEXTable
ASCII byte values for the hex strings.
HIGHLIGHT_MODE_INVERT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
HIGHLIGHT_MODE_NONE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
HIGHLIGHT_MODE_OUTLINE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
HIGHLIGHT_MODE_PUSH - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
HT_ESCAPE - Static variable in class org.pdfbox.cos.COSString
HT escape characters.
HelloWorld - class org.pdfbox.examples.pdmodel.HelloWorld.
This is an example that creates a simple document.
HelloWorld() - Constructor for class org.pdfbox.examples.pdmodel.HelloWorld
Constructor.
HelloWorldTTF - class org.pdfbox.examples.pdmodel.HelloWorldTTF.
This is an example that creates a simple document with a ttf-font.
HelloWorldTTF() - Constructor for class org.pdfbox.examples.pdmodel.HelloWorldTTF
 
HelloWorldType1AfmPfb - class org.pdfbox.examples.pdmodel.HelloWorldType1AfmPfb.
This is an example that creates a simple document with a Type 1 font (afm + pfb).
HelloWorldType1AfmPfb() - Constructor for class org.pdfbox.examples.pdmodel.HelloWorldType1AfmPfb
 
hashCode() - Method in class org.pdfbox.cos.COSFloat
hashCode() - Method in class org.pdfbox.cos.COSInteger
hashCode() - Method in class org.pdfbox.cos.COSName
hashCode() - Method in class org.pdfbox.cos.COSString
hashCode() - Method in class org.pdfbox.pdmodel.PDPage
hashCode() - Method in class org.pdfbox.pdmodel.common.COSArrayList
hashCode() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
hashCode() - Method in class org.pdfbox.pdmodel.font.PDFont
hashCode() - Method in class org.pdfbox.persistence.util.COSObjectKey
hideMenubar() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the menubar preference.
hideToolbar() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the toolbar preference.
hideWindowUI() - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the window UI preference.

I

ICCBASED - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ICOSVisitor - interface org.pdfbox.cos.ICOSVisitor.
An interface for visiting a PDF document at the type (COS) level.
IDENTITY_H - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
IMAGE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
INDEXED - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
INFO - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
INSTANCE - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
The single instance of this class.
INSTANCE - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
This is the single instance of this class.
IT_LINE_ARROW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for annotation intent of Arrow.
IT_LINE_DIMENSION - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for annotation intent of a dimension line.
ImageParameters - class org.pdfbox.util.ImageParameters.
This contains all of the image parameters for in inlined image.
ImageParameters() - Constructor for class org.pdfbox.util.ImageParameters
Constructor.
ImageParameters(COSDictionary) - Constructor for class org.pdfbox.util.ImageParameters
Constructor.
ImageToPDF - class org.pdfbox.examples.pdmodel.ImageToPDF.
This is an example that creates a simple document.
ImageToPDF() - Constructor for class org.pdfbox.examples.pdmodel.ImageToPDF
 
ImportFDF - class org.pdfbox.ImportFDF.
This example will take a PDF document and fill the fields with data from the FDF fields.
ImportFDF() - Constructor for class org.pdfbox.ImportFDF
Creates a new instance of ImportFDF.
ImportXFDF - class org.pdfbox.ImportXFDF.
This example will take a PDF document and fill the fields with data from the XFDF fields.
ImportXFDF() - Constructor for class org.pdfbox.ImportXFDF
Creates a new instance of ImportFDF.
IndexFiles - class org.pdfbox.searchengine.lucene.IndexFiles.
This is a class that will index some files on a local filesystem.
IndexFiles() - Constructor for class org.pdfbox.searchengine.lucene.IndexFiles
 
InvalidPasswordException - exception org.pdfbox.exceptions.InvalidPasswordException.
An exception that indicates an invalid password was supplied.
InvalidPasswordException(String) - Constructor for class org.pdfbox.exceptions.InvalidPasswordException
Constructor.
Invoke - class org.pdfbox.util.operator.Invoke.
Invoke named XObject.
Invoke() - Constructor for class org.pdfbox.util.operator.Invoke
 
Invoke - class org.pdfbox.util.operator.pagedrawer.Invoke.
Implementation of content stream operator for page drawer.
Invoke() - Constructor for class org.pdfbox.util.operator.pagedrawer.Invoke
 
importFDF(PDDocument, FDFDocument) - Method in class org.pdfbox.ImportFDF
This will takes the values from the fdf document and import them into the PDF document.
importFDF(PDDocument, FDFDocument) - Method in class org.pdfbox.ImportXFDF
This will takes the values from the fdf document and import them into the PDF document.
importFDF(FDFDocument) - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This method will import an entire FDF document into the PDF document that this acroform is part of.
importFDF(FDFField) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will import a fdf field from a fdf document.
importPage(PDPage) - Method in class org.pdfbox.pdmodel.PDDocument
This will import and copy the contents from another location.
index(File, boolean, String) - Method in class org.pdfbox.searchengine.lucene.IndexFiles
This will index a directory.
indexOf(COSBase) - Method in class org.pdfbox.cos.COSArray
This will return the index of the entry or -1 if it is not found.
indexOf(Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
initForEncryption() - Method in class org.pdfbox.encryption.DocumentEncryption
Deprecated. This will encrypt the given document, given the owner password and user password.
insertSiblingAfter(PDOutlineItem) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Insert a sibling after this node.
intValue() - Method in class org.pdfbox.cos.COSFloat
This will get the integer value of this object.
intValue() - Method in class org.pdfbox.cos.COSInteger
Polymorphic access to value as int This will get the integer value of this object.
intValue() - Method in class org.pdfbox.cos.COSNumber
This will get the integer value of this number.
isAllCap() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isAlphaSource() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the alpha source property.
isBold() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
A flag telling if the text should be bold.
isCachingFields() - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will tell if this acro form is caching the fields.
isChecked() - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
This will tell if this radio button is currently checked or not.
isClosing() - Method in class org.pdfbox.pdfparser.BaseParser
This will tell if the next character is a closing brace( close of PDF array ).
isClosing(int) - Method in class org.pdfbox.pdfparser.BaseParser
This will tell if the next character is a closing brace( close of PDF array ).
isEOF() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
A simple test to see if we are at the end of the stream.
isEOF() - Method in class org.pdfbox.io.PushBackInputStream
A simple test to see if we are at the end of the stream.
isEOL() - Method in class org.pdfbox.pdfparser.BaseParser
This will tell if the next byte to be read is an end of line byte.
isEOL(int) - Method in class org.pdfbox.pdfparser.BaseParser
This will tell if the next byte to be read is an end of line byte.
isEmpty() - Method in class org.pdfbox.pdmodel.common.COSArrayList
isEmpty() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
isEncrypted() - Method in class org.pdfbox.cos.COSDocument
This will tell if this is an encrypted document.
isEncrypted() - Method in class org.pdfbox.pdmodel.PDDocument
This will tell if this document is encrypted or not.
isEndOfName(char) - Method in class org.pdfbox.pdfparser.BaseParser
Determine if a character terminates a PDF name.
isFileSelect() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
isFixedPitch() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isForceBold() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isFree() - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
Gets the xref 'free' attribute.
isHidden() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the hidden flag.
isInvisible() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the invisible flag.
isItalic() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isItalic() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
A flag telling if the text should be italic.
isLeaf(Object) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Returns true if node is a leaf.
isLocked() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the locked flag.
isMarked() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Tells if this is a tagged PDF.
isMultiline() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
isNewDocNecessary() - Method in class org.pdfbox.util.Splitter
Check if it is necessary to create a new document.
isNoExport() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
 
isNoRotate() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the noRotate flag.
isNoView() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the noView flag.
isNoZoom() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the noZoom flag.
isNodeOpen() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Node is open if the open count is greater than zero.
isNonSymbolic() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isOnNewLine() - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will tell if we are on a newling.
isOverprint() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the overprint property.
isOwnerPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This will tell if this is the owner password or not.
isOwnerPassword(String) - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated.  
isOwnerPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check for owner password.
isOwnerPermission() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the access permission corresponds to owner access permission (no restriction).
isPassword() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
isPrinted() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the printed flag.
isRadiosInUnison() - Method in class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
 
isReadOnly() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the object has been set as read only.
isReadOnly() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the readOnly flag.
isReadonly() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
 
isRequired() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
 
isRichText() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
isScript() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSerif() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSmallCap() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isStrokeAdjustment() - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the stroke adjustment parameter.
isSuppressParagraphs() - Method in class org.pdfbox.util.PDFText2HTML
 
isSuspect() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Tells if this PDF contain 'suspect' tags.
isSymbolic() - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isToggleNoView() - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the toggleNoView flag.
isUserPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.encryption.PDFEncryption
Deprecated. This will tell if this is a valid user password.
isUserPassword(String) - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated.  
isUserPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check if a plaintext password is the user password.
isVolatile() - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get if the file is volatile.
isWhitespace() - Method in class org.pdfbox.pdfparser.BaseParser
This will tell if the next byte is whitespace or not.
isWhitespace(int) - Method in class org.pdfbox.pdfparser.BaseParser
This will tell if the next byte is whitespace or not.
iterator() - Method in class org.pdfbox.cos.COSArray
Get access to the list.
iterator() - Method in class org.pdfbox.pdmodel.common.COSArrayList

J

JPX_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.

K

KIDS - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
keyLength - Variable in class org.pdfbox.pdmodel.encryption.SecurityHandler
The length of the secret key used to encrypt the document.
keyList() - Method in class org.pdfbox.cos.COSDictionary
This will get the keys for all objects in the dictionary in the sequence that they were added.
keySet() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap

L

LAB - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
LAST_CHAR - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
LENGTH - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
LENGTH1 - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
LE_BUTT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a butt line ending.
LE_CIRCLE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a circle line ending.
LE_CLOSED_ARROW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a closed arrow line ending.
LE_DIAMOND - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a diamond line ending.
LE_NONE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for no line ending.
LE_OPEN_ARROW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a open arrow line ending.
LE_R_CLOSED_ARROW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a revered closed arrow line ending.
LE_R_OPEN_ARROW - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a reversed open arrow line ending.
LE_SLASH - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a slash line ending.
LE_SQUARE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a square line ending.
LF - Static variable in class org.pdfbox.pdfwriter.COSStandardOutputStream
Line feed character.
LF_ESCAPE - Static variable in class org.pdfbox.cos.COSString
LF escape characters.
LZWFilter - class org.pdfbox.filter.LZWFilter.
This is the used for the LZWDecode filter.
LZWFilter() - Constructor for class org.pdfbox.filter.LZWFilter
 
LZW_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
LZW_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
LineTo - class org.pdfbox.util.operator.pagedrawer.LineTo.
Implementation of content stream operator for page drawer.
LineTo() - Constructor for class org.pdfbox.util.operator.pagedrawer.LineTo
 
LucenePDFDocument - class org.pdfbox.searchengine.lucene.LucenePDFDocument.
This class is used to create a document for the lucene search engine.
LucenePDFDocument() - Constructor for class org.pdfbox.searchengine.lucene.LucenePDFDocument
Constructor.
lastIndexOf(Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
leftPixel(byte[], int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the left pixel from the buffer.
length() - Method in interface org.pdfbox.io.RandomAccess
The total number of bytes that are available.
length() - Method in class org.pdfbox.io.RandomAccessBuffer
The total number of bytes that are available.
length() - Method in class org.pdfbox.io.RandomAccessFile
The total number of bytes that are available.
listIterator() - Method in class org.pdfbox.pdmodel.common.COSArrayList
listIterator(int) - Method in class org.pdfbox.pdmodel.common.COSArrayList
load(URL) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from a url.
load(URL, RandomAccess) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from a url.
load(String) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(String, RandomAccess) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(File) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(File, RandomAccess) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(InputStream) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from an input stream.
load(InputStream, RandomAccess) - Static method in class org.pdfbox.pdmodel.PDDocument
This will load a document from an input stream.
load(String) - Static method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
load(File) - Static method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
load(InputStream) - Static method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from an input stream.
loadProperties(String) - Static method in class org.pdfbox.util.ResourceLoader
This will attempt to load the resource given the resource name.
loadProperties(String, Properties) - Static method in class org.pdfbox.util.ResourceLoader
This will attempt to load the resource given the resource name.
loadResource(String) - Static method in class org.pdfbox.util.ResourceLoader
This will attempt to load the resource given the resource name.
loadTTF(PDDocument, String) - Static method in class org.pdfbox.pdmodel.font.PDTrueTypeFont
This will load a TTF font from a font file.
loadTTF(PDDocument, File) - Static method in class org.pdfbox.pdmodel.font.PDTrueTypeFont
This will load a TTF to be embedding into a document.
loadXFDF(String) - Static method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
loadXFDF(File) - Static method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
loadXFDF(InputStream) - Static method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from an input stream.
localRead(byte[], int, int) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Read a number of bytes.
log(String) - Static method in class org.pdfbox.util.ErrorLogger
Log an error message.
log(String, Throwable) - Static method in class org.pdfbox.util.ErrorLogger
Log an error message.
longValue() - Method in class org.pdfbox.cos.COSFloat
This will get the integer value of this object.
longValue() - Method in class org.pdfbox.cos.COSInteger
Polymorphic access to value as int This will get the integer value of this object.
longValue() - Method in class org.pdfbox.cos.COSNumber
This will get the long value of this number.
lookupColor(int, int) - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will perform a lookup into the color lookup table.

M

MAC_ROMAN_ENCODING - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
MATRIX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
MEDIA_BOX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
METADATA - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
MacRomanEncoding - class org.pdfbox.encoding.MacRomanEncoding.
This is an interface to a text encoder.
MacRomanEncoding() - Constructor for class org.pdfbox.encoding.MacRomanEncoding
Constructor.
MapEntry - class org.pdfbox.pdfviewer.MapEntry.
This is a simple class that will contain a key and a value.
MapEntry() - Constructor for class org.pdfbox.pdfviewer.MapEntry
 
MapUtil - class org.pdfbox.util.MapUtil.
This class with handle some simple Map operations.
Matrix - class org.pdfbox.util.Matrix.
This class will be used for matrix manipulation.
Matrix() - Constructor for class org.pdfbox.util.Matrix
Constructor.
MoveAndShow - class org.pdfbox.util.operator.MoveAndShow.
Titre : PDFEngine Modification.
MoveAndShow() - Constructor for class org.pdfbox.util.operator.MoveAndShow
 
MoveText - class org.pdfbox.util.operator.MoveText.
Titre : PDFEngine Modification.
MoveText() - Constructor for class org.pdfbox.util.operator.MoveText
 
MoveTextSetLeading - class org.pdfbox.util.operator.MoveTextSetLeading.
Titre : PDFEngine Modification.
MoveTextSetLeading() - Constructor for class org.pdfbox.util.operator.MoveTextSetLeading
 
MoveTo - class org.pdfbox.util.operator.pagedrawer.MoveTo.
Implementation of content stream operator for page drawer.
MoveTo() - Constructor for class org.pdfbox.util.operator.pagedrawer.MoveTo
 
main(String[]) - Static method in class org.pdfbox.ConvertColorspace
Infamous main method.
main(String[]) - Static method in class org.pdfbox.Decrypt
This is the entry point for the application.
main(String[]) - Static method in class org.pdfbox.Encrypt
This is the entry point for the application.
main(String[]) - Static method in class org.pdfbox.ExportFDF
This will import an fdf document and write out another pdf.
main(String[]) - Static method in class org.pdfbox.ExportXFDF
This will import an fdf document and write out another pdf.
main(String[]) - Static method in class org.pdfbox.ExtractImages
This is the entry point for the application.
main(String[]) - Static method in class org.pdfbox.ExtractText
Infamous main method.
main(String[]) - Static method in class org.pdfbox.ImportFDF
This will import an fdf document and write out another pdf.
main(String[]) - Static method in class org.pdfbox.ImportXFDF
This will import an fdf document and write out another pdf.
main(String[]) - Static method in class org.pdfbox.Overlay
This will overlay a document and write out the results.
main(String[]) - Static method in class org.pdfbox.PDFDebugger
 
main(String[]) - Static method in class org.pdfbox.PDFMerger
Infamous main method.
main(String[]) - Static method in class org.pdfbox.PDFReader
 
main(String[]) - Static method in class org.pdfbox.PDFSplit
Infamous main method.
main(String[]) - Static method in class org.pdfbox.PDFToImage
Infamous main method.
main(String[]) - Static method in class org.pdfbox.PrintPDF
Infamous main method.
main(String[]) - Static method in class org.pdfbox.TextToPDF
This will create a PDF document with a single image on it.
main(String[]) - Static method in class org.pdfbox.Version
This will print out the version of PDF to System.out.
main(String[]) - Static method in class org.pdfbox.examples.fdf.PrintFields
This will read a PDF file and print out the form elements.
main(String[]) - Static method in class org.pdfbox.examples.fdf.SetField
This will read a PDF file and set a field and then write it the pdf out again.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.AddJavascript
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.AddMessageToEachPage
This will create a hello world PDF document.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.AddMetadataFromDocInfo
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.Annotation
This will create a doucument showing various annotations.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.CreateBlankPDF
This will create a blank document.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.CreateBookmarks
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.EmbeddedFiles
This will create a hello world PDF document with an embedded file.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.GoToSecondBookmarkOnOpen
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.HelloWorld
This will create a hello world PDF document.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.HelloWorldTTF
This will create a hello world PDF document with a ttf-font.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.HelloWorldType1AfmPfb
This will create a hello world PDF document with a ttf-font.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.ImageToPDF
This will create a PDF document with a single image on it.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.PrintBookmarks
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.PrintDocumentMetaData
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.PrintURLs
This will create a hello world PDF document.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.RemoveFirstPage
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.ReplaceString
This will open a PDF and replace a string if it finds it.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.ReplaceURLs
This will read in a document and replace all of the urls with http://www.pdfbox.org.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.RubberStamp
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.pdmodel.ShowColorBoxes
This will create a hello world PDF document.
main(String[]) - Static method in class org.pdfbox.examples.persistence.CopyDoc
This will copy a PDF document.
main(String[]) - Static method in class org.pdfbox.examples.persistence.WriteDecodedDoc
This will write a PDF document with completely decoded streams.
main(String[]) - Static method in class org.pdfbox.examples.signature.ShowSignature
This is the entry point for the application.
main(String[]) - Static method in class org.pdfbox.examples.util.ExtractTextByArea
This will print the documents text in a certain area.
main(String[]) - Static method in class org.pdfbox.examples.util.PrintImageLocations
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.util.PrintTextLocations
This will print the documents data.
main(String[]) - Static method in class org.pdfbox.examples.util.RemoveAllText
This will remove all text from a PDF document.
main(String[]) - Static method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Simple command line program to test the algorithm.
main(String[]) - Static method in class org.pdfbox.searchengine.lucene.IndexFiles
This is the main entry point for the indexer.
main(String[]) - Static method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
This will test creating a document.
main(String[]) - Static method in class org.pdfbox.util.PDFHighlighter
Command line application.
mark(int) - Method in class org.pdfbox.io.ASCII85InputStream
Unsupported.
mark(int) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Save the state of this stream.
markSupported() - Method in class org.pdfbox.io.ASCII85InputStream
non supported interface methods.
markSupported() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Check if mark is supported.
mergeDocuments() - Method in class org.pdfbox.util.PDFMergerUtility
Merge the list of source documents, saving the result in the destination file.
mergeInto(COSDictionary) - Method in class org.pdfbox.cos.COSDictionary
This will add all of the dictionarys keys/values to this dictionary, but only if they don't already exist.
mouseDragged(MouseEvent) - Method in class org.pdfbox.pdfviewer.PageWrapper
mouseMoved(MouseEvent) - Method in class org.pdfbox.pdfviewer.PageWrapper
move(float, float) - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will move the rectangle the given relative amount.
moveTextPositionByAmount(float, float) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
The Td operator.
multiply(Matrix) - Method in class org.pdfbox.util.Matrix
This will take the current matrix and multipy it with a matrix that is passed in.

N

N - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
NAME - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDCalGray
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDICCBased
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDIndexed
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDLab
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDPattern
The name of this color space.
NAME - Static variable in class org.pdfbox.pdmodel.graphics.color.PDSeparation
The name of this color space.
NAME_APPROVED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_AS_IS - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_COMMENT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_CONFIDENTIAL - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_DEPARTMENTAL - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_DRAFT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_ESCAPE - Static variable in class org.pdfbox.cos.COSName
The escape character for a name.
NAME_EXPERIMENTAL - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_EXPIRED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_FINAL - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_FOR_COMMENT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_FOR_PUBLIC_RELEASE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_HELP - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_INSERT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_KEY - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_NEW_PARAGRAPH - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_NOTE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_NOT_APPROVED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_NOT_FOR_PUBLIC_RELEASE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_PARAGRAPH - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_PREFIX - Static variable in class org.pdfbox.cos.COSName
The prefix to a PDF name.
NAME_SOLD - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_TOP_SECRET - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NBitInputStream - class org.pdfbox.io.NBitInputStream.
This is an n-bit input stream.
NBitInputStream(InputStream) - Constructor for class org.pdfbox.io.NBitInputStream
Constructor.
NBitOutputStream - class org.pdfbox.io.NBitOutputStream.
This is an n-bit output stream.
NBitOutputStream(OutputStream) - Constructor for class org.pdfbox.io.NBitOutputStream
Constructor.
NON_FULL_SCREEN_PAGE_MODE_USE_NONE - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Neither document outline nor thumbnail images visible".
NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Optional content group panel visible".
NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Document outline visible".
NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Thumbnail images visible".
NULL - Static variable in class org.pdfbox.cos.COSNull
The one null object in the system.
NULL_BYTES - Static variable in class org.pdfbox.cos.COSNull
The null token.
NextLine - class org.pdfbox.util.operator.NextLine.
Titre : PDFEngine Modification.
NextLine() - Constructor for class org.pdfbox.util.operator.NextLine
 
None - class org.pdfbox.pdmodel.graphics.predictor.None.
The none algorithm.
None() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.None
 
nameToCode - Variable in class org.pdfbox.encoding.Encoding
This is a mapping from a character name to a character code.
node - Variable in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
The dictionary for this node.

O

OBJ - Static variable in class org.pdfbox.pdfwriter.COSWriter
The starting object token.
ONE - Static variable in class org.pdfbox.cos.COSNumber
ONE.
OPERATION_OPEN - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The open operation for the launch.
OPERATION_PRINT - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The print operation for the lanuch.
OperatorProcessor - class org.pdfbox.util.operator.OperatorProcessor.
Titre : OperatorProcessor Description : This class is the strategy abstract class in the strategy GOF pattern.
OperatorProcessor() - Constructor for class org.pdfbox.util.operator.OperatorProcessor
Constructor.
OutlineNotLocalException - exception org.pdfbox.exceptions.OutlineNotLocalException.
This exception will be thrown when a local destination(page within the same PDF) is required but the bookmark(PDOutlineItem) refers to an external destination or an action that does not point to a page.
OutlineNotLocalException(String) - Constructor for class org.pdfbox.exceptions.OutlineNotLocalException
Constructor.
Overlay - class org.pdfbox.Overlay.
Overlay on document with another one.
Overlay() - Constructor for class org.pdfbox.Overlay
 
openNode() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
This will set this node to be open when it is shown in the viewer.
openProtection(DecryptionMaterial) - Method in class org.pdfbox.pdmodel.PDDocument
Tries to decrypt the document in memory using the provided decryption material.
org.pdfbox - package org.pdfbox
This package holds executable classes that interact with the PDFBox application.
org.pdfbox.ant - package org.pdfbox.ant
ANT tasks that utilize PDFBox features can be found in this package.
org.pdfbox.cos - package org.pdfbox.cos
These are the low level objects that make up a PDF document.
org.pdfbox.encoding - package org.pdfbox.encoding
This package contains the implementations for all of the encodings that are used in PDF documents.
org.pdfbox.encryption - package org.pdfbox.encryption
These classes deal with encryption algorithms that are used in the PDF Document.
org.pdfbox.examples - package org.pdfbox.examples
The packages in this package will show how to use the PDFBox API.
org.pdfbox.examples.fdf - package org.pdfbox.examples.fdf
These are examples that use the FDF features of a PDF document.
org.pdfbox.examples.pdmodel - package org.pdfbox.examples.pdmodel
These examples show how to use the classes in the PDModel package.
org.pdfbox.examples.persistence - package org.pdfbox.examples.persistence
These examples will show how to use the persistence features of the PDFBox.
org.pdfbox.examples.signature - package org.pdfbox.examples.signature
These examples will show how to gain access to the PDF signature.
org.pdfbox.examples.util - package org.pdfbox.examples.util
The packages in this package will show how to use the PDFBox util API.
org.pdfbox.exceptions - package org.pdfbox.exceptions
This package is a place holder for exceptions that are used in the PDFBox project.
org.pdfbox.filter - package org.pdfbox.filter
This package will hold the PDFBox implementations of the filters that are used in PDF documents.
org.pdfbox.io - package org.pdfbox.io
This package contains IO streams.
org.pdfbox.pdfparser - package org.pdfbox.pdfparser
The pdfparser package contains classes to parse PDF documents and objects within the document.
org.pdfbox.pdfviewer - package org.pdfbox.pdfviewer
The pdfviewer package contains classes to graphically display information about a PDF document.
org.pdfbox.pdfwriter - package org.pdfbox.pdfwriter
This is the persistence layer used to write the PDFBox documents to a stream.
org.pdfbox.pdmodel - package org.pdfbox.pdmodel
The PDModel package represents a high level API for creating and manipulating PDF documents.
org.pdfbox.pdmodel.common - package org.pdfbox.pdmodel.common
High level PD classes that are used throughout several packages are placed in the PDModel common package.
org.pdfbox.pdmodel.common.filespecification - package org.pdfbox.pdmodel.common.filespecification
The file specification package defines classes that are used for the PDF File Specification logic.
org.pdfbox.pdmodel.common.function - package org.pdfbox.pdmodel.common.function
This package contains functions that are available in the PDF specification.
org.pdfbox.pdmodel.documentinterchange.logicalstructure - package org.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.pdfbox.pdmodel.documentinterchange.prepress - package org.pdfbox.pdmodel.documentinterchange.prepress
This package contains classes for prepress support in PDFBox.
org.pdfbox.pdmodel.edit - package org.pdfbox.pdmodel.edit
The PDModel edit package will be used to store classes for creating page content.
org.pdfbox.pdmodel.encryption - package org.pdfbox.pdmodel.encryption
The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
org.pdfbox.pdmodel.fdf - package org.pdfbox.pdmodel.fdf
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
org.pdfbox.pdmodel.font - package org.pdfbox.pdmodel.font
Classes to deal with font functionality in a PDF Document.
org.pdfbox.pdmodel.graphics - package org.pdfbox.pdmodel.graphics
The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
org.pdfbox.pdmodel.graphics.color - package org.pdfbox.pdmodel.graphics.color
This package deals with colors that are stored in a PDF document.
org.pdfbox.pdmodel.graphics.predictor - package org.pdfbox.pdmodel.graphics.predictor
The predictor package contains code for different PNG predictor algorithms that are present in PDF documents.
org.pdfbox.pdmodel.graphics.xobject - package org.pdfbox.pdmodel.graphics.xobject
This package deals with images that are stored in a PDF document.
org.pdfbox.pdmodel.interactive.action - package org.pdfbox.pdmodel.interactive.action
This package represents actions that can be performed in a PDF document.
org.pdfbox.pdmodel.interactive.action.type - package org.pdfbox.pdmodel.interactive.action.type
This package contains all of the available PDF action types.
org.pdfbox.pdmodel.interactive.annotation - package org.pdfbox.pdmodel.interactive.annotation
The annotation package contains classes that work with PDF annotation elements.
org.pdfbox.pdmodel.interactive.digitalsignature - package org.pdfbox.pdmodel.interactive.digitalsignature
The digitial signature library will manage signatures that are stored in the PDF document.
org.pdfbox.pdmodel.interactive.documentnavigation.destination - package org.pdfbox.pdmodel.interactive.documentnavigation.destination
The destination package allows destinations into a pdf document to be specified.
org.pdfbox.pdmodel.interactive.documentnavigation.outline - package org.pdfbox.pdmodel.interactive.documentnavigation.outline
The outline package allows for a PDF outline(bookmarks) to be created.
org.pdfbox.pdmodel.interactive.form - package org.pdfbox.pdmodel.interactive.form
The interactive package contains classes that deal with interactive annotations such as textfields and buttons.
org.pdfbox.pdmodel.interactive.pagenavigation - package org.pdfbox.pdmodel.interactive.pagenavigation
A package to allow provide access to PDF page navigation functionality.
org.pdfbox.pdmodel.interactive.viewerpreferences - package org.pdfbox.pdmodel.interactive.viewerpreferences
A package to allow access to document viewing preferences.
org.pdfbox.pdmodel.text - package org.pdfbox.pdmodel.text
The PDModel text package deals with text states, operations, and parameters within the PDF document.
org.pdfbox.persistence.util - package org.pdfbox.persistence.util
These are utilities used by the persistence layer.
org.pdfbox.searchengine.lucene - package org.pdfbox.searchengine.lucene
This package holds classes that are used to integrate the PDFBox project with lucene.
org.pdfbox.util - package org.pdfbox.util
This package contains utility classes that are used by the PDFBox project.
org.pdfbox.util.operator - package org.pdfbox.util.operator
This package contains implementations of all of the PDF operators.
org.pdfbox.util.operator.pagedrawer - package org.pdfbox.util.operator.pagedrawer
This package contains implementations of all of the PDF operators.
output - Variable in class org.pdfbox.util.PDFTextStripper
The stream to write the output to.
overlay(PDDocument, PDDocument) - Method in class org.pdfbox.Overlay
This will overlay two documents onto each other.

P

P - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PAGE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PAGES - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PAGE_LAYOUT_ONE_COLUMN - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Display the pages in one column.
PAGE_LAYOUT_SINGLE_PAGE - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Display one page at a time.
PAGE_LAYOUT_TWO_COLUMN_LEFT - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Display the pages in two columns, with odd numbered pagse on the left.
PAGE_LAYOUT_TWO_COLUMN_RIGHT - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Display the pages in two columns, with odd numbered pagse on the right.
PAGE_LAYOUT_TWO_PAGE_LEFT - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Display the pages two at a time, with odd-numbered pages on the left.
PAGE_LAYOUT_TWO_PAGE_RIGHT - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Display the pages two at a time, with odd-numbered pages on the right.
PAGE_MODE_FULL_SCREEN - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Full screen mode with no menu bar, window controls.
PAGE_MODE_USE_ATTACHMENTS - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Attachments panel is visible.
PAGE_MODE_USE_NONE - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Page mode where neither the outline nor the thumbnails are displayed.
PAGE_MODE_USE_OPTIONAL_CONTENT - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Optional content group panel is visible when opened.
PAGE_MODE_USE_OUTLINES - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Show bookmarks when pdf is opened.
PAGE_MODE_USE_THUMBS - Static variable in class org.pdfbox.pdmodel.PDDocumentCatalog
Show thumbnails when pdf is opened.
PAGE_SIZE_LETTER - Static variable in class org.pdfbox.pdmodel.PDPage
A page size of LETTER or 8.5x11.
PARENT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PATTERN - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PDAcroForm - class org.pdfbox.pdmodel.interactive.form.PDAcroForm.
This class represents the acroform of a PDF document.
PDAcroForm(PDDocument) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDAcroForm
Constructor.
PDAcroForm(PDDocument, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDAcroForm
Constructor.
PDAction - class org.pdfbox.pdmodel.interactive.action.type.PDAction.
This represents an action that can be executed in a PDF document.
PDAction() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDAction
Default constructor.
PDAction(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDAction
Constructor.
PDActionFactory - class org.pdfbox.pdmodel.interactive.action.PDActionFactory.
This class will take a dictionary and determine which type of action to create.
PDActionGoTo - class org.pdfbox.pdmodel.interactive.action.type.PDActionGoTo.
This represents a go-to action that can be executed in a PDF document.
PDActionGoTo() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
Default constructor.
PDActionGoTo(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
Constructor.
PDActionJavaScript - class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript.
This represents a JavaScript action.
PDActionJavaScript() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
Constructor #1.
PDActionJavaScript(String) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
Constructor.
PDActionJavaScript(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
Constructor #2.
PDActionLaunch - class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch.
This represents a launch action that can be executed in a PDF document.
PDActionLaunch() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
Default constructor.
PDActionLaunch(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
Constructor.
PDActionRemoteGoTo - class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo.
This represents a remote go-to action that can be executed in a PDF document.
PDActionRemoteGoTo() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Default constructor.
PDActionRemoteGoTo(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Constructor.
PDActionURI - class org.pdfbox.pdmodel.interactive.action.type.PDActionURI.
This represents a URI action that can be executed in a PDF document.
PDActionURI() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
Default constructor.
PDActionURI(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
Constructor.
PDAdditionalActions - class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions.
This represents a dictionary of actions that occur due to events.
PDAdditionalActions() - Constructor for class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Default constructor.
PDAdditionalActions(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Constructor.
PDAnnotation - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation.
This class represents a PDF annotation.
PDAnnotation() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Constructor.
PDAnnotation(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Constructor.
PDAnnotationAdditionalActions - class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions.
This class represents an annotation's dictionary of actions that occur due to events.
PDAnnotationAdditionalActions() - Constructor for class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Default constructor.
PDAnnotationAdditionalActions(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Constructor.
PDAnnotationFileAttachment - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment.
This is the class that represents a file attachement.
PDAnnotationFileAttachment() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Constructor.
PDAnnotationFileAttachment(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationLine - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine.
This is the class that represents a line annotation.
PDAnnotationLine() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constructor.
PDAnnotationLine(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationLink - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink.
This is the class that represents a link annotation.
PDAnnotationLink() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Constructor.
PDAnnotationLink(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationMarkup - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup.
This class represents the additonal fields of a Markup type Annotation.
PDAnnotationMarkup() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constructor.
PDAnnotationMarkup(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constructor.
PDAnnotationPopup - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup.
This is the class that represents a popup annotation.
PDAnnotationPopup() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
Constructor.
PDAnnotationPopup(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
Creates a popup annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationRubberStamp - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp.
This is the class that represents a rubber stamp annotation.
PDAnnotationRubberStamp() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constructor.
PDAnnotationRubberStamp(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationSquareCircle - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle.
This is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .
PDAnnotationSquareCircle(String) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Creates a Circle or Square annotation of the specified sub type.
PDAnnotationSquareCircle(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationText - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText.
This is the class that represents a text annotation.
PDAnnotationText() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constructor.
PDAnnotationText(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Creates a Text annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationTextMarkup - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup.
This is the abstract class that represents a text markup annotation Introduced in PDF 1.3 specification, except Squiggly lines in 1.4.
PDAnnotationTextMarkup(String) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
Creates a TextMarkup annotation of the specified sub type.
PDAnnotationTextMarkup(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationUnknown - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnknown.
This is the class that represents an arbitary Unknown Annotation type.
PDAnnotationUnknown(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnknown
Creates an arbitary annotation from a COSDictionary, expected to be a correct object definition for some sort of annotation.
PDAnnotationWidget - class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget.
This is the class that represents a widget.
PDAnnotationWidget() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Constructor.
PDAnnotationWidget(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF.
PDAppearance - class org.pdfbox.pdmodel.interactive.form.PDAppearance.
This one took me a while, but i'm proud to say that it handles the appearance of a textbox.
PDAppearance(PDAcroForm, PDVariableText) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDAppearance
Constructs a COSAppearnce from the given field.
PDAppearanceDictionary - class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary.
This class represents a PDF /AP entry the appearance dictionary.
PDAppearanceDictionary() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
Constructor.
PDAppearanceDictionary(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
Constructor.
PDAppearanceStream - class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream.
This class represents an appearance for an annotation.
PDAppearanceStream(COSStream) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Constructor.
PDBorderEffectDictionary - class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary.
This class represents a PDF /BE entry the border effect dictionary.
PDBorderEffectDictionary() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constructor.
PDBorderEffectDictionary(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constructor.
PDBorderStyleDictionary - class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary.
This class represents a PDF /BS entry the border style dictionary.
PDBorderStyleDictionary() - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constructor.
PDBorderStyleDictionary(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constructor.
PDBoxStyle - class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle.
The Box Style specifies visual characteristics for displaying box areas.
PDBoxStyle() - Constructor for class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Default Constructor.
PDBoxStyle(COSDictionary) - Constructor for class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Constructor for an existing BoxStyle element.
PDCIDFont - class org.pdfbox.pdmodel.font.PDCIDFont.
This is implementation for the CIDFontType0/CIDFontType2 Fonts.
PDCIDFont() - Constructor for class org.pdfbox.pdmodel.font.PDCIDFont
Constructor.
PDCIDFont(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDCIDFont
Constructor.
PDCIDFontType0Font - class org.pdfbox.pdmodel.font.PDCIDFontType0Font.
This is implementation of the CIDFontType0 Font.
PDCIDFontType0Font() - Constructor for class org.pdfbox.pdmodel.font.PDCIDFontType0Font
Constructor.
PDCIDFontType0Font(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDCIDFontType0Font
Constructor.
PDCIDFontType2Font - class org.pdfbox.pdmodel.font.PDCIDFontType2Font.
This is implementation of the CIDFontType2 Font.
PDCIDFontType2Font() - Constructor for class org.pdfbox.pdmodel.font.PDCIDFontType2Font
Constructor.
PDCIDFontType2Font(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDCIDFontType2Font
Constructor.
PDCalGray - class org.pdfbox.pdmodel.graphics.color.PDCalGray.
This class represents a Cal Gray color space.
PDCalGray() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDCalGray
Constructor.
PDCalGray(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDCalGray
Constructor with array.
PDCalRGB - class org.pdfbox.pdmodel.graphics.color.PDCalRGB.
This class represents a Cal RGB color space.
PDCalRGB() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDCalRGB
Constructor.
PDCalRGB(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDCalRGB
Constructor with array.
PDCcitt - class org.pdfbox.pdmodel.graphics.xobject.PDCcitt.
An image class for CCITT Fax.
PDCcitt(PDStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDCcitt
Standard constructor.
PDCcitt(PDDocument, RandomAccess) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDCcitt
Construct from a tiff file.
PDCheckbox - class org.pdfbox.pdmodel.interactive.form.PDCheckbox.
A class for handling the PDF field as a checkbox.
PDCheckbox(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDCheckbox
 
PDChoiceButton - class org.pdfbox.pdmodel.interactive.form.PDChoiceButton.
This holds common functionality for check boxes and radio buttons.
PDChoiceButton(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDChoiceButton
 
PDChoiceField - class org.pdfbox.pdmodel.interactive.form.PDChoiceField.
A class for handling the PDF field as a choicefield.
PDChoiceField(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDChoiceField
 
PDColorSpace - class org.pdfbox.pdmodel.graphics.color.PDColorSpace.
This class represents a color space in a pdf document.
PDColorSpace() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDColorSpace
 
PDColorSpaceFactory - class org.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory.
This class represents a color space in a pdf document.
PDColorSpaceInstance - class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance.
This class represents a color space and the color value for that colorspace.
PDColorSpaceInstance() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
Default constructor.
PDColorSpaceInstance(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
Constructor with an existing color set.
PDComplexFileSpecification - class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification.
This represents a file specification.
PDComplexFileSpecification() - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Default Constructor.
PDComplexFileSpecification(COSDictionary) - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Constructor.
PDDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination.
This represents a destination in a PDF document.
PDDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
 
PDDestinationNameTreeNode - class org.pdfbox.pdmodel.PDDestinationNameTreeNode.
This class holds all of the name trees that are available at the document level.
PDDestinationNameTreeNode() - Constructor for class org.pdfbox.pdmodel.PDDestinationNameTreeNode
Constructor.
PDDestinationNameTreeNode(COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDDestinationNameTreeNode
Constructor.
PDDestinationOrAction - interface org.pdfbox.pdmodel.common.PDDestinationOrAction.
This is an interface used for some elements such as the document OpenAction that can be either a Destination or an Action.
PDDeviceCMYK - class org.pdfbox.pdmodel.graphics.color.PDDeviceCMYK.
This class represents a CMYK color space.
PDDeviceGray - class org.pdfbox.pdmodel.graphics.color.PDDeviceGray.
This class represents a Gray color space.
PDDeviceGray() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
PDDeviceN - class org.pdfbox.pdmodel.graphics.color.PDDeviceN.
This class represents a DeviceN color space.
PDDeviceN() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDDeviceN
Constructor.
PDDeviceN(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDDeviceN
Constructor.
PDDeviceNAttributes - class org.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes.
This class represents attributes for a DeviceN color space.
PDDeviceNAttributes() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Constructor.
PDDeviceNAttributes(COSDictionary) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Constructor.
PDDeviceRGB - class org.pdfbox.pdmodel.graphics.color.PDDeviceRGB.
This class represents an RGB color space.
PDDictionaryFunction - class org.pdfbox.pdmodel.common.function.PDDictionaryFunction.
This class represents a function in a PDF document.
PDDictionaryFunction(int) - Constructor for class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
Constructor to create a new blank function, should only be called by subclasses.
PDDictionaryFunction(COSDictionary) - Constructor for class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
Constructor.
PDDocument - class org.pdfbox.pdmodel.PDDocument.
This is the in-memory representation of the PDF document.
PDDocument() - Constructor for class org.pdfbox.pdmodel.PDDocument
Constructor, creates a new PDF Document with no pages.
PDDocument(COSDocument) - Constructor for class org.pdfbox.pdmodel.PDDocument
Constructor that uses an existing document.
PDDocumentCatalog - class org.pdfbox.pdmodel.PDDocumentCatalog.
This class represents the acroform of a PDF document.
PDDocumentCatalog(PDDocument) - Constructor for class org.pdfbox.pdmodel.PDDocumentCatalog
Constructor.
PDDocumentCatalog(PDDocument, COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDDocumentCatalog
Constructor.
PDDocumentCatalogAdditionalActions - class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions.
This class represents a document catalog's dictionary of actions that occur due to events.
PDDocumentCatalogAdditionalActions() - Constructor for class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Default constructor.
PDDocumentCatalogAdditionalActions(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Constructor.
PDDocumentInformation - class org.pdfbox.pdmodel.PDDocumentInformation.
This is the document metadata.
PDDocumentInformation() - Constructor for class org.pdfbox.pdmodel.PDDocumentInformation
Default Constructor.
PDDocumentInformation(COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDDocumentInformation
Constructor that is used for a preexisting dictionary.
PDDocumentNameDictionary - class org.pdfbox.pdmodel.PDDocumentNameDictionary.
This class holds all of the name trees that are available at the document level.
PDDocumentNameDictionary(PDDocumentCatalog) - Constructor for class org.pdfbox.pdmodel.PDDocumentNameDictionary
Constructor.
PDDocumentNameDictionary(PDDocumentCatalog, COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDDocumentNameDictionary
Constructor.
PDDocumentOutline - class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline.
This represents an outline in a pdf document.
PDDocumentOutline() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
Default Constructor.
PDDocumentOutline(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
Constructor for an existing document outline.
PDEmbeddedFile - class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile.
This represents an embedded file in a file specification.
PDEmbeddedFile(PDDocument) - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFile(COSStream) - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFile(PDDocument, InputStream) - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFile(PDDocument, InputStream, boolean) - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFilesNameTreeNode - class org.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode.
This class holds all of the name trees that are available at the document level.
PDEmbeddedFilesNameTreeNode() - Constructor for class org.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Constructor.
PDEmbeddedFilesNameTreeNode(COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Constructor.
PDEncryptionDictionary - class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary.
This class is a specialized view of the encryption dictionary of a PDF document.
PDEncryptionDictionary() - Constructor for class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
creates a new empty encryption dictionary.
PDEncryptionDictionary(COSDictionary) - Constructor for class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
creates a new encryption dictionary from the low level dictionary provided.
PDEncryptionManager - class org.pdfbox.pdmodel.encryption.PDEncryptionManager.
Deprecated. Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
PDExtendedGraphicsState - class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState.
This class represents the graphics state dictionary that is stored in the PDF document.
PDExtendedGraphicsState() - Constructor for class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Default constructor, creates blank graphics state.
PDExtendedGraphicsState(COSDictionary) - Constructor for class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Create a graphics state from an existing dictionary.
PDFDebugger - class org.pdfbox.PDFDebugger.
 
PDFDebugger() - Constructor for class org.pdfbox.PDFDebugger
Constructor.
PDFEncryption - class org.pdfbox.encryption.PDFEncryption.
Deprecated. use the new security layer instead
PDFEncryption() - Constructor for class org.pdfbox.encryption.PDFEncryption
Deprecated.  
PDFHighlighter - class org.pdfbox.util.PDFHighlighter.
Highlighting of words in a PDF document with an XML file.
PDFHighlighter() - Constructor for class org.pdfbox.util.PDFHighlighter
Default constructor.
PDFMerger - class org.pdfbox.PDFMerger.
This is the main program that will take a list of pdf documents and merge them, saving the result in a new document.
PDFMerger() - Constructor for class org.pdfbox.PDFMerger
 
PDFMergerUtility - class org.pdfbox.util.PDFMergerUtility.
This class will take a list of pdf documents and merge them, saving the result in a new document.
PDFMergerUtility() - Constructor for class org.pdfbox.util.PDFMergerUtility
Instantiate a new PDFMergerUtility.
PDFObjectStreamParser - class org.pdfbox.pdfparser.PDFObjectStreamParser.
This will parse a PDF 1.5 object stream and extract all of the objects from the stream.
PDFObjectStreamParser(COSStream, COSDocument) - Constructor for class org.pdfbox.pdfparser.PDFObjectStreamParser
Constructor.
PDFOperator - class org.pdfbox.util.PDFOperator.
This class represents an Operator in the content stream.
PDFPagePanel - class org.pdfbox.pdfviewer.PDFPagePanel.
This is a simple JPanel that can be used to display a PDF page.
PDFPagePanel() - Constructor for class org.pdfbox.pdfviewer.PDFPagePanel
Constructor.
PDFParser - class org.pdfbox.pdfparser.PDFParser.
This class will handle the parsing of the PDF document.
PDFParser(InputStream) - Constructor for class org.pdfbox.pdfparser.PDFParser
Constructor.
PDFParser(InputStream, RandomAccess) - Constructor for class org.pdfbox.pdfparser.PDFParser
Constructor to allow control over RandomAccessFile.
PDFReader - class org.pdfbox.PDFReader.
An application to read PDF documents.
PDFReader() - Constructor for class org.pdfbox.PDFReader
Constructor.
PDFSplit - class org.pdfbox.PDFSplit.
This is the main program that will take a pdf document and split it into a number of other documents.
PDFSplit() - Constructor for class org.pdfbox.PDFSplit
 
PDFStreamEngine - class org.pdfbox.util.PDFStreamEngine.
This class will run through a PDF content stream and execute certain operations and provide a callback interface for clients that want to do things with the stream.
PDFStreamEngine() - Constructor for class org.pdfbox.util.PDFStreamEngine
Constructor.
PDFStreamEngine(Properties) - Constructor for class org.pdfbox.util.PDFStreamEngine
Constructor with engine properties.
PDFStreamParser - class org.pdfbox.pdfparser.PDFStreamParser.
This will parse a PDF byte stream and extract operands and such.
PDFStreamParser(InputStream, RandomAccess) - Constructor for class org.pdfbox.pdfparser.PDFStreamParser
Constructor that takes a stream to parse.
PDFStreamParser(PDStream) - Constructor for class org.pdfbox.pdfparser.PDFStreamParser
Constructor.
PDFStreamParser(COSStream) - Constructor for class org.pdfbox.pdfparser.PDFStreamParser
Constructor.
PDFText2HTML - class org.pdfbox.util.PDFText2HTML.
Wrap stripped text in simple HTML, trying to form HTML paragraphs.
PDFText2HTML() - Constructor for class org.pdfbox.util.PDFText2HTML
Constructor.
PDFTextStripper - class org.pdfbox.util.PDFTextStripper.
This class will take a pdf document and strip out all of the text and ignore the formatting and such.
PDFTextStripper() - Constructor for class org.pdfbox.util.PDFTextStripper
Instantiate a new PDFTextStripper object.
PDFTextStripper(Properties) - Constructor for class org.pdfbox.util.PDFTextStripper
Instantiate a new PDFTextStripper object.
PDFTextStripperByArea - class org.pdfbox.util.PDFTextStripperByArea.
This will extract text from a specified region in the PDF.
PDFTextStripperByArea() - Constructor for class org.pdfbox.util.PDFTextStripperByArea
Constructor.
PDFToImage - class org.pdfbox.PDFToImage.
Convert a PDF document to an image.
PDFToTextTask - class org.pdfbox.ant.PDFToTextTask.
This is an ant task that will allow pdf documents to be converted using an and task.
PDFToTextTask() - Constructor for class org.pdfbox.ant.PDFToTextTask
 
PDFTreeCellRenderer - class org.pdfbox.pdfviewer.PDFTreeCellRenderer.
A class to render tree cells for the pdfviewer.
PDFTreeCellRenderer() - Constructor for class org.pdfbox.pdfviewer.PDFTreeCellRenderer
 
PDFTreeModel - class org.pdfbox.pdfviewer.PDFTreeModel.
A class to model a PDF document as a tree structure.
PDFTreeModel() - Constructor for class org.pdfbox.pdfviewer.PDFTreeModel
constructor.
PDFTreeModel(PDDocument) - Constructor for class org.pdfbox.pdfviewer.PDFTreeModel
Constructor to take a document.
PDFXref - class org.pdfbox.pdfparser.PDFXref.
This class represents a PDF xref.
PDFXref(long, long) - Constructor for class org.pdfbox.pdfparser.PDFXref
constructor.
PDF_DOC_ENCODING - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PDField - class org.pdfbox.pdmodel.interactive.form.PDField.
This is the superclass for a Field element in a PDF.
PDField(PDAcroForm) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDField
Constructor.
PDField(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDField
Creates a COSField from a COSDictionary, expected to be a correct object definition for a field in PDF.
PDFieldFactory - class org.pdfbox.pdmodel.interactive.form.PDFieldFactory.
This is the Factory for creating and returning the correct field elements.
PDFileSpecification - class org.pdfbox.pdmodel.common.filespecification.PDFileSpecification.
This represents a file specification.
PDFileSpecification() - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDFileSpecification
 
PDFont - class org.pdfbox.pdmodel.font.PDFont.
This is the base class for all PDF fonts.
PDFont() - Constructor for class org.pdfbox.pdmodel.font.PDFont
Constructor.
PDFont(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDFont
Constructor.
PDFontDescriptor - class org.pdfbox.pdmodel.font.PDFontDescriptor.
This class represents an interface to the font description.
PDFontDescriptor() - Constructor for class org.pdfbox.pdmodel.font.PDFontDescriptor
 
PDFontDescriptorAFM - class org.pdfbox.pdmodel.font.PDFontDescriptorAFM.
This class represents the font descriptor when the font information is coming from an AFM file.
PDFontDescriptorAFM(FontMetric) - Constructor for class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
Constructor.
PDFontDescriptorDictionary - class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary.
This class represents an implementation to the font descriptor that gets its information from a COS Dictionary.
PDFontDescriptorDictionary() - Constructor for class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Constructor.
PDFontDescriptorDictionary(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Constructor.
PDFontFactory - class org.pdfbox.pdmodel.font.PDFontFactory.
This will create the correct type of font based on information in the dictionary.
PDFontSetting - class org.pdfbox.pdmodel.graphics.PDFontSetting.
This class represents a font setting used for the graphics state.
PDFontSetting() - Constructor for class org.pdfbox.pdmodel.graphics.PDFontSetting
Creates a blank font setting, font will be null, size will be 1.
PDFontSetting(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.PDFontSetting
Constructs a font setting from an existing array.
PDFormFieldAdditionalActions - class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions.
This class represents a form field's dictionary of actions that occur due to events.
PDFormFieldAdditionalActions() - Constructor for class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Default constructor.
PDFormFieldAdditionalActions(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Constructor.
PDFunction - class org.pdfbox.pdmodel.common.function.PDFunction.
This class represents a function in a PDF document.
PDFunction() - Constructor for class org.pdfbox.pdmodel.common.function.PDFunction
 
PDFunctionType0 - class org.pdfbox.pdmodel.common.function.PDFunctionType0.
This class represents a type 0 function in a PDF document.
PDFunctionType0(PDDocument) - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType0
Constructor to create a new blank type 0 function.
PDFunctionType0(PDStream) - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType0
Constructor.
PDFunctionType2 - class org.pdfbox.pdmodel.common.function.PDFunctionType2.
This class represents a type 2 function in a PDF document.
PDFunctionType2() - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType2
Constructor to create a new blank type 2 function.
PDFunctionType2(COSDictionary) - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType2
Constructor.
PDFunctionType3 - class org.pdfbox.pdmodel.common.function.PDFunctionType3.
This class represents a type 3 function in a PDF document.
PDFunctionType3() - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType3
Constructor to create a new blank type 3 function.
PDFunctionType3(COSDictionary) - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType3
Constructor.
PDFunctionType4 - class org.pdfbox.pdmodel.common.function.PDFunctionType4.
This class represents a type 4 function in a PDF document.
PDFunctionType4(PDDocument) - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType4
Constructor to create a new blank type 4 function.
PDFunctionType4(PDStream) - Constructor for class org.pdfbox.pdmodel.common.function.PDFunctionType4
Constructor.
PDGamma - class org.pdfbox.pdmodel.graphics.color.PDGamma.
A gamma array, or collection of three floating point parameters used for color operations.
PDGamma() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDGamma
Constructor.
PDGamma(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDGamma
Constructor from COS object.
PDGraphicsState - class org.pdfbox.pdmodel.graphics.PDGraphicsState.
This class will hold the current state of the graphics parameters when executing a content stream.
PDGraphicsState() - Constructor for class org.pdfbox.pdmodel.graphics.PDGraphicsState
 
PDICCBased - class org.pdfbox.pdmodel.graphics.color.PDICCBased.
This class represents a ICC profile color space.
PDICCBased(PDDocument) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDICCBased
Default constructor, creates empty stream.
PDICCBased(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDICCBased
Constructor.
PDIndexed - class org.pdfbox.pdmodel.graphics.color.PDIndexed.
This class represents an Indexed color space.
PDIndexed() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDIndexed
Constructor, default DeviceRGB, hival 255.
PDIndexed(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDIndexed
Constructor.
PDInlinedImage - class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage.
This class represents an inlined image.
PDInlinedImage() - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
 
PDJpeg - class org.pdfbox.pdmodel.graphics.xobject.PDJpeg.
An image class for JPegs.
PDJpeg(PDStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDJpeg
Standard constructor.
PDJpeg(PDDocument, InputStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDJpeg
Construct from a stream.
PDJpeg(PDDocument, BufferedImage) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDJpeg
Construct from a buffered image.
PDLab - class org.pdfbox.pdmodel.graphics.color.PDLab.
This class represents a Lab color space.
PDLab() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDLab
Constructor.
PDLab(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDLab
Constructor with array.
PDLineDashPattern - class org.pdfbox.pdmodel.graphics.PDLineDashPattern.
This class represents the line dash pattern for a graphics state.
PDLineDashPattern() - Constructor for class org.pdfbox.pdmodel.graphics.PDLineDashPattern
Creates a blank line dash pattern.
PDLineDashPattern(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.PDLineDashPattern
Constructs a line dash pattern from an existing array.
PDLineDashPattern(COSArray, int) - Constructor for class org.pdfbox.pdmodel.graphics.PDLineDashPattern
Constructs a line dash pattern from an existing array.
PDMMType1Font - class org.pdfbox.pdmodel.font.PDMMType1Font.
This is implementation of the Multiple Master Type1 Font.
PDMMType1Font() - Constructor for class org.pdfbox.pdmodel.font.PDMMType1Font
Constructor.
PDMMType1Font(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDMMType1Font
Constructor.
PDMarkInfo - class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo.
The MarkInfo provides additional information relevant to specialized uses of structured documents.
PDMarkInfo() - Constructor for class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Default Constructor.
PDMarkInfo(COSDictionary) - Constructor for class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Constructor for an existing MarkInfo element.
PDMatrix - class org.pdfbox.pdmodel.common.PDMatrix.
This class will be used for matrix manipulation.
PDMatrix() - Constructor for class org.pdfbox.pdmodel.common.PDMatrix
Constructor.
PDMatrix(COSArray) - Constructor for class org.pdfbox.pdmodel.common.PDMatrix
Constructor.
PDMemoryStream - class org.pdfbox.pdmodel.common.PDMemoryStream.
A PDStream represents a stream in a PDF document.
PDMemoryStream(byte[]) - Constructor for class org.pdfbox.pdmodel.common.PDMemoryStream
This will create a new PDStream object.
PDMetadata - class org.pdfbox.pdmodel.common.PDMetadata.
This class represents metadata for various objects in a PDF document.
PDMetadata(PDDocument) - Constructor for class org.pdfbox.pdmodel.common.PDMetadata
This will create a new PDMetadata object.
PDMetadata(PDDocument, InputStream, boolean) - Constructor for class org.pdfbox.pdmodel.common.PDMetadata
Constructor.
PDMetadata(COSStream) - Constructor for class org.pdfbox.pdmodel.common.PDMetadata
Constructor.
PDNameTreeNode - class org.pdfbox.pdmodel.common.PDNameTreeNode.
This class represends a PDF Name tree.
PDNameTreeNode(Class) - Constructor for class org.pdfbox.pdmodel.common.PDNameTreeNode
Constructor.
PDNameTreeNode(COSDictionary, Class) - Constructor for class org.pdfbox.pdmodel.common.PDNameTreeNode
Constructor.
PDNamedDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination.
This represents a destination to a page by referencing it with a name.
PDNamedDestination(COSString) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Constructor.
PDNamedDestination(COSName) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Constructor.
PDNamedDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Default constructor.
PDNamedDestination(String) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Default constructor.
PDNamedTextStream - class org.pdfbox.pdmodel.common.PDNamedTextStream.
A named text stream is a combination of a name and a PDTextStream object.
PDNamedTextStream() - Constructor for class org.pdfbox.pdmodel.common.PDNamedTextStream
Constructor.
PDNamedTextStream(COSName, COSBase) - Constructor for class org.pdfbox.pdmodel.common.PDNamedTextStream
Constructor.
PDObjectStream - class org.pdfbox.pdmodel.common.PDObjectStream.
A PDStream represents a stream in a PDF document.
PDObjectStream(COSStream) - Constructor for class org.pdfbox.pdmodel.common.PDObjectStream
Constructor.
PDOutlineItem - class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem.
This represents an outline in a pdf document.
PDOutlineItem() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Default Constructor.
PDOutlineItem(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Constructor for an existing outline item.
PDOutlineNode - class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.
This represents an node in an outline in a pdf document.
PDOutlineNode() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Default Constructor.
PDOutlineNode(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Default Constructor.
PDPage - class org.pdfbox.pdmodel.PDPage.
This represents a single page in a PDF document.
PDPage() - Constructor for class org.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage with a size of 8.5x11.
PDPage(COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage.
PDPageAdditionalActions - class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions.
This class represents a page object's dictionary of actions that occur due to events.
PDPageAdditionalActions() - Constructor for class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Default constructor.
PDPageAdditionalActions(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Constructor.
PDPageContentStream - class org.pdfbox.pdmodel.edit.PDPageContentStream.
This class will is a convenience for creating page content streams.
PDPageContentStream(PDDocument, PDPage) - Constructor for class org.pdfbox.pdmodel.edit.PDPageContentStream
Create a new PDPage content stream.
PDPageContentStream(PDDocument, PDPage, boolean, boolean) - Constructor for class org.pdfbox.pdmodel.edit.PDPageContentStream
Create a new PDPage content stream.
PDPageDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination.
This represents a destination to a page, see subclasses for specific parameters.
PDPageDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Constructor to create empty page destination.
PDPageDestination(COSArray) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Constructor to create empty page destination.
PDPageFitDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination.
This represents a destination to a page and the page contents will be magnified to just fit on the screen.
PDPageFitDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
Default constructor.
PDPageFitDestination(COSArray) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
Constructor from an existing destination array.
PDPageFitHeightDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination.
This represents a destination to a page at a x location and the height is magnified to just fit on the screen.
PDPageFitHeightDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Default constructor.
PDPageFitHeightDestination(COSArray) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Constructor from an existing destination array.
PDPageFitRectangleDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination.
This represents a destination to a page at a y location and the width is magnified to just fit on the screen.
PDPageFitRectangleDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Default constructor.
PDPageFitRectangleDestination(COSArray) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Constructor from an existing destination array.
PDPageFitWidthDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination.
This represents a destination to a page at a y location and the width is magnified to just fit on the screen.
PDPageFitWidthDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Default constructor.
PDPageFitWidthDestination(COSArray) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Constructor from an existing destination array.
PDPageNode - class org.pdfbox.pdmodel.PDPageNode.
This represents a page node in a pdf document.
PDPageNode() - Constructor for class org.pdfbox.pdmodel.PDPageNode
Creates a new instance of PDPage.
PDPageNode(COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDPageNode
Creates a new instance of PDPage.
PDPageXYZDestination - class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination.
This represents a destination to a page at an x,y coordinate with a zoom setting.
PDPageXYZDestination() - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Default constructor.
PDPageXYZDestination(COSArray) - Constructor for class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Constructor from an existing destination array.
PDPattern - class org.pdfbox.pdmodel.graphics.color.PDPattern.
This class represents a Pattern color space.
PDPattern() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDPattern
Default constructor.
PDPattern(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDPattern
Constructor.
PDPixelMap - class org.pdfbox.pdmodel.graphics.xobject.PDPixelMap.
This class contains a PixelMap Image.
PDPixelMap(PDStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Standard constructor.
PDPushButton - class org.pdfbox.pdmodel.interactive.form.PDPushButton.
A class for handling the PDF field as a PDPushButton.
PDPushButton(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDPushButton
 
PDRadioCollection - class org.pdfbox.pdmodel.interactive.form.PDRadioCollection.
A class for handling the PDF field as a Radio Collection.
PDRadioCollection(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
 
PDRange - class org.pdfbox.pdmodel.common.PDRange.
This class will be used to signify a range.
PDRange() - Constructor for class org.pdfbox.pdmodel.common.PDRange
Constructor with an initial range of 0..1.
PDRange(COSArray) - Constructor for class org.pdfbox.pdmodel.common.PDRange
Constructor assumes a starting index of 0.
PDRange(COSArray, int) - Constructor for class org.pdfbox.pdmodel.common.PDRange
Constructor with an index into an array.
PDRectangle - class org.pdfbox.pdmodel.common.PDRectangle.
This represents a rectangle in a PDF document.
PDRectangle() - Constructor for class org.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectangle(float, float) - Constructor for class org.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectangle(BoundingBox) - Constructor for class org.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectangle(COSArray) - Constructor for class org.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDResources - class org.pdfbox.pdmodel.PDResources.
This represents a set of resources available at the page/pages/stream level.
PDResources() - Constructor for class org.pdfbox.pdmodel.PDResources
Default constructor.
PDResources(COSDictionary) - Constructor for class org.pdfbox.pdmodel.PDResources
Prepopulated resources.
PDSeparation - class org.pdfbox.pdmodel.graphics.color.PDSeparation.
This class represents a Separation color space.
PDSeparation() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDSeparation
Constructor.
PDSeparation(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDSeparation
Constructor.
PDSignature - class org.pdfbox.pdmodel.interactive.digitalsignature.PDSignature.
This represents a digital signature that can be attached to a document.
PDSignature() - Constructor for class org.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Default constructor.
PDSignature(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Constructor.
PDSignature - class org.pdfbox.pdmodel.interactive.form.PDSignature.
A class for handling the PDF field as a signature.
PDSignature(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDSignature
 
PDSimpleFileSpecification - class org.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification.
A file specification that is just a string.
PDSimpleFileSpecification() - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
Constructor.
PDSimpleFileSpecification(COSString) - Constructor for class org.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
Constructor.
PDSimpleFont - class org.pdfbox.pdmodel.font.PDSimpleFont.
This class contains implementation details of the simple pdf fonts.
PDSimpleFont() - Constructor for class org.pdfbox.pdmodel.font.PDSimpleFont
Constructor.
PDSimpleFont(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDSimpleFont
Constructor.
PDStandardEncryption - class org.pdfbox.pdmodel.encryption.PDStandardEncryption.
Deprecated. Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
PDStandardEncryption() - Constructor for class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Default constructor that uses Version 2, Revision 3, 40 bit encryption, all permissions allowed.
PDStandardEncryption(COSDictionary) - Constructor for class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Constructor from existing dictionary.
PDStream - class org.pdfbox.pdmodel.common.PDStream.
A PDStream represents a stream in a PDF document.
PDStream() - Constructor for class org.pdfbox.pdmodel.common.PDStream
This will create a new PDStream object.
PDStream(PDDocument) - Constructor for class org.pdfbox.pdmodel.common.PDStream
This will create a new PDStream object.
PDStream(COSStream) - Constructor for class org.pdfbox.pdmodel.common.PDStream
Constructor.
PDStream(PDDocument, InputStream) - Constructor for class org.pdfbox.pdmodel.common.PDStream
Constructor.
PDStream(PDDocument, InputStream, boolean) - Constructor for class org.pdfbox.pdmodel.common.PDStream
Constructor.
PDStreamFunction - class org.pdfbox.pdmodel.common.function.PDStreamFunction.
This class represents a function in a PDF document.
PDStreamFunction(PDDocument, int) - Constructor for class org.pdfbox.pdmodel.common.function.PDStreamFunction
Constructor to create a new blank function, should only be called by subclasses.
PDStreamFunction(PDStream) - Constructor for class org.pdfbox.pdmodel.common.function.PDStreamFunction
Constructor.
PDStructureElement - class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement.
A structure element.
PDStructureElement() - Constructor for class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Default Constructor.
PDStructureElement(COSDictionary) - Constructor for class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Constructor for an existing structure element.
PDStructureTreeRoot - class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot.
A root of a structure tree.
PDStructureTreeRoot() - Constructor for class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Default Constructor.
PDStructureTreeRoot(COSDictionary) - Constructor for class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Constructor for an existing structure element.
PDTextState - class org.pdfbox.pdmodel.text.PDTextState.
This class will hold the current state of the text parameters when executing a content stream.
PDTextState() - Constructor for class org.pdfbox.pdmodel.text.PDTextState
 
PDTextStream - class org.pdfbox.pdmodel.common.PDTextStream.
A PDTextStream class is used when the PDF specification supports either a string or a stream for the value of an object.
PDTextStream(COSString) - Constructor for class org.pdfbox.pdmodel.common.PDTextStream
Constructor.
PDTextStream(String) - Constructor for class org.pdfbox.pdmodel.common.PDTextStream
Constructor.
PDTextStream(COSStream) - Constructor for class org.pdfbox.pdmodel.common.PDTextStream
Constructor.
PDTextbox - class org.pdfbox.pdmodel.interactive.form.PDTextbox.
A class for handling the PDF field as a textbox.
PDTextbox(PDAcroForm) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDTextbox
 
PDTextbox(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDTextbox
 
PDThread - class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread.
This a single thread in a PDF document.
PDThread(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Constructor that is used for a preexisting dictionary.
PDThread() - Constructor for class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Default constructor.
PDThreadBead - class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead.
This a single bead in a thread in a PDF document.
PDThreadBead(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Constructor that is used for a preexisting dictionary.
PDThreadBead() - Constructor for class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Default constructor.
PDTristimulus - class org.pdfbox.pdmodel.graphics.color.PDTristimulus.
A tristimulus, or collection of three floating point parameters used for color operations.
PDTristimulus() - Constructor for class org.pdfbox.pdmodel.graphics.color.PDTristimulus
Constructor.
PDTristimulus(COSArray) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDTristimulus
Constructor from COS object.
PDTristimulus(float[]) - Constructor for class org.pdfbox.pdmodel.graphics.color.PDTristimulus
Constructor from COS object.
PDTrueTypeFont - class org.pdfbox.pdmodel.font.PDTrueTypeFont.
This is the TrueType implementation of fonts.
PDTrueTypeFont() - Constructor for class org.pdfbox.pdmodel.font.PDTrueTypeFont
Constructor.
PDTrueTypeFont(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDTrueTypeFont
Constructor.
PDType0Font - class org.pdfbox.pdmodel.font.PDType0Font.
This is implementation of the Type0 Font.
PDType0Font() - Constructor for class org.pdfbox.pdmodel.font.PDType0Font
Constructor.
PDType0Font(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDType0Font
Constructor.
PDType1AfmPfbFont - class org.pdfbox.pdmodel.font.PDType1AfmPfbFont.
This is implementation of the Type1 Font with a afm and a pfb file.
PDType1AfmPfbFont(PDDocument, String) - Constructor for class org.pdfbox.pdmodel.font.PDType1AfmPfbFont
Create a new object.
PDType1AfmPfbFont(PDDocument, InputStream, InputStream) - Constructor for class org.pdfbox.pdmodel.font.PDType1AfmPfbFont
Create a new object.
PDType1Font - class org.pdfbox.pdmodel.font.PDType1Font.
This is implementation of the Type1 Font.
PDType1Font() - Constructor for class org.pdfbox.pdmodel.font.PDType1Font
Constructor.
PDType1Font(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDType1Font
Constructor.
PDType1Font(String) - Constructor for class org.pdfbox.pdmodel.font.PDType1Font
Constructor.
PDType3Font - class org.pdfbox.pdmodel.font.PDType3Font.
This is implementation of the Type3 Font.
PDType3Font() - Constructor for class org.pdfbox.pdmodel.font.PDType3Font
Constructor.
PDType3Font(COSDictionary) - Constructor for class org.pdfbox.pdmodel.font.PDType3Font
Constructor.
PDUnknownField - class org.pdfbox.pdmodel.interactive.form.PDUnknownField.
This class represents a form field with an unknown type.
PDUnknownField(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDUnknownField
 
PDVariableText - class org.pdfbox.pdmodel.interactive.form.PDVariableText.
A class for handling PDF fields that display text.
PDVariableText(PDAcroForm) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
PDVariableText(PDAcroForm, COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
PDViewerPreferences - class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.
This is the document viewing preferences.
PDViewerPreferences(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Constructor that is used for a preexisting dictionary.
PDWindowsLaunchParams - class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams.
Launch paramaters for the windows OS.
PDWindowsLaunchParams() - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Default constructor.
PDWindowsLaunchParams(COSDictionary) - Constructor for class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Constructor.
PDXFA - class org.pdfbox.pdmodel.interactive.form.PDXFA.
This class represents an XML Forms Architecture Data packet.
PDXFA(COSBase) - Constructor for class org.pdfbox.pdmodel.interactive.form.PDXFA
Constructor.
PDXObject - class org.pdfbox.pdmodel.graphics.xobject.PDXObject.
The base class for all XObjects in the PDF document.
PDXObject(COSStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Standard constuctor.
PDXObject(PDStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Standard constuctor.
PDXObject(PDDocument) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Standard constuctor.
PDXObjectForm - class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm.
A form xobject.
PDXObjectForm(PDStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Standard constuctor.
PDXObjectForm(COSStream) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Standard constuctor.
PDXObjectImage - class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage.
The prototype for all PDImages.
PDXObjectImage(PDStream, String) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Standard constuctor.
PDXObjectImage(PDDocument, String) - Constructor for class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Standard constuctor.
PREV - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
PROC_SET - Static variable in class org.pdfbox.Overlay
COSName constant.
PROTECTION_POLICY_CLASS - Static variable in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Protection policy class for this handler.
Paeth - class org.pdfbox.pdmodel.graphics.predictor.Paeth.
From http://www.w3.org/TR/PNG-Filters.html: The Paeth filter computes a simple linear function of the three neighboring pixels (left, above, upper left), then chooses as predictor the neighboring pixel closest to the computed value.
Paeth() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.Paeth
 
PageDrawer - class org.pdfbox.pdfviewer.PageDrawer.
This will paint a page in a PDF document to a graphics context.
PageDrawer() - Constructor for class org.pdfbox.pdfviewer.PageDrawer
Default constructor, loads properties from file.
PageWrapper - class org.pdfbox.pdfviewer.PageWrapper.
A class to handle some prettyness around a single PDF page.
PageWrapper(PDFReader) - Constructor for class org.pdfbox.pdfviewer.PageWrapper
Constructor.
PdfDocEncoding - class org.pdfbox.encoding.PdfDocEncoding.
This is an interface to a text encoder.
PdfDocEncoding() - Constructor for class org.pdfbox.encoding.PdfDocEncoding
Constructor.
PredictorAlgorithm - class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm.
Implements different PNG predictor algorithms that is used in PDF files.
PredictorAlgorithm() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
PrintBookmarks - class org.pdfbox.examples.pdmodel.PrintBookmarks.
This is an example on how to access the bookmarks that are part of a pdf document.
PrintBookmarks() - Constructor for class org.pdfbox.examples.pdmodel.PrintBookmarks
 
PrintDocumentMetaData - class org.pdfbox.examples.pdmodel.PrintDocumentMetaData.
This is an example on how to get a documents metadata information.
PrintDocumentMetaData() - Constructor for class org.pdfbox.examples.pdmodel.PrintDocumentMetaData
 
PrintFields - class org.pdfbox.examples.fdf.PrintFields.
This example will take a PDF document and print all the fields from the file.
PrintFields() - Constructor for class org.pdfbox.examples.fdf.PrintFields
 
PrintImageLocations - class org.pdfbox.examples.util.PrintImageLocations.
This is an example on how to get the x/y coordinates of image locations.
PrintImageLocations() - Constructor for class org.pdfbox.examples.util.PrintImageLocations
Default constructor.
PrintPDF - class org.pdfbox.PrintPDF.
This is a command line program that will print a PDF document.
PrintTextLocations - class org.pdfbox.examples.util.PrintTextLocations.
This is an example on how to get some x/y coordinates of text.
PrintTextLocations() - Constructor for class org.pdfbox.examples.util.PrintTextLocations
Default constructor.
PrintURLs - class org.pdfbox.examples.pdmodel.PrintURLs.
This is an example of how to access a URL in a PDF document.
ProtectionPolicy - class org.pdfbox.pdmodel.encryption.ProtectionPolicy.
This class represents the protection policy to apply to a document.
ProtectionPolicy() - Constructor for class org.pdfbox.pdmodel.encryption.ProtectionPolicy
 
PublicKeyDecryptionMaterial - class org.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial.
This class holds necessary information to decrypt a PDF document protected by the public key security handler.
PublicKeyDecryptionMaterial(KeyStore, String, String) - Constructor for class org.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
Create a new public key decryption material.
PublicKeyProtectionPolicy - class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy.
This class represents the protection policy to use to protect a document with the public key security handler as described in the PDF specification 1.6 p104.
PublicKeyProtectionPolicy() - Constructor for class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Constructor for encryption.
PublicKeyRecipient - class org.pdfbox.pdmodel.encryption.PublicKeyRecipient.
Represents a recipient in the public key protection policy.
PublicKeyRecipient() - Constructor for class org.pdfbox.pdmodel.encryption.PublicKeyRecipient
 
PublicKeySecurityHandler - class org.pdfbox.pdmodel.encryption.PublicKeySecurityHandler.
This class implements the public key security handler described in the PDF specification.
PublicKeySecurityHandler() - Constructor for class org.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Constructor.
PublicKeySecurityHandler(PublicKeyProtectionPolicy) - Constructor for class org.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Constructor used for encryption.
PushBackInputStream - class org.pdfbox.io.PushBackInputStream.
A simple subclass that adds a few convience methods.
PushBackInputStream(InputStream, int) - Constructor for class org.pdfbox.io.PushBackInputStream
Constructor.
paethPredictor(int, int, int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Paeth
The paeth predictor function.
pageNumber - Variable in class org.pdfbox.util.Splitter
The current page number that we are processing, zero based.
paint(Graphics) - Method in class org.pdfbox.pdfviewer.PDFPagePanel
params - Variable in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The params dictionary.
parse() - Method in class org.pdfbox.pdfparser.PDFObjectStreamParser
This will parse the tokens in the stream.
parse() - Method in class org.pdfbox.pdfparser.PDFParser
This will prase the stream and create the PDF document.
parse() - Method in class org.pdfbox.pdfparser.PDFStreamParser
This will parse the tokens in the stream.
parse(InputStream) - Static method in class org.pdfbox.util.XMLUtil
This will parse an XML stream and create a DOM document.
parseBoolean() - Method in class org.pdfbox.pdfparser.BaseParser
This will parse a boolean object from the stream.
parseCOSArray() - Method in class org.pdfbox.pdfparser.BaseParser
This will parse a PDF array object.
parseCOSDictionary() - Method in class org.pdfbox.pdfparser.BaseParser
This will parse a PDF dictionary.
parseCOSName() - Method in class org.pdfbox.pdfparser.BaseParser
This will parse a PDF name from the stream.
parseCOSStream(COSDictionary, RandomAccess) - Method in class org.pdfbox.pdfparser.BaseParser
This will read a COSStream from the input stream.
parseCOSString() - Method in class org.pdfbox.pdfparser.BaseParser
This will parse a PDF string.
parseDirObject() - Method in class org.pdfbox.pdfparser.BaseParser
This will parse a directory object from the stream.
parseXrefSection() - Method in class org.pdfbox.pdfparser.PDFParser
This will parse the xref table and trailers from the stream.
parseXrefTable(int[]) - Method in class org.pdfbox.pdfparser.PDFParser
This will parse the xref table from the stream.
pdfDocument - Variable in class org.pdfbox.util.Splitter
The source PDF document.
pdfSource - Variable in class org.pdfbox.pdfparser.BaseParser
This is the stream that will be read from.
peek() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
This will peek at the next byte.
peek() - Method in class org.pdfbox.io.PushBackInputStream
This will peek at the next byte.
prepareDocumentForEncryption(PDDocument) - Method in class org.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Prepare the document for encryption.
prepareDocumentForEncryption(PDDocument) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
Prepare the document for encryption.
prepareDocumentForEncryption(PDDocument) - Method in class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Prepare document for encryption.
print() - Method in class org.pdfbox.cos.COSDocument
This will print contents to stdout.
print() - Method in class org.pdfbox.pdmodel.PDDocument
This will send the PDF document to a printer.
print(Graphics, PageFormat, int) - Method in class org.pdfbox.pdmodel.PDPage
printBookmark(PDOutlineNode, String) - Method in class org.pdfbox.examples.pdmodel.PrintBookmarks
This will print the documents bookmarks to System.out.
printFields(PDDocument) - Method in class org.pdfbox.examples.fdf.PrintFields
This will print all the fields from the document.
printMetadata(PDDocument) - Method in class org.pdfbox.examples.pdmodel.PrintDocumentMetaData
This will print the documents data to System.out.
printStackTrace(PrintStream) - Method in class org.pdfbox.exceptions.WrappedException
Prints this throwable and its backtrace to the specified print stream.
printStackTrace(PrintStream) - Method in class org.pdfbox.exceptions.WrappedIOException
Prints this throwable and its backtrace to the specified print stream.
proceedDecryption() - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
This method must be called by an implementation of this class to really proceed to decryption.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.BeginText
process : BT : Begin text object.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.CloseAndStrokePath
s close and stroke the path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.Concatenate
process : cm : Concatenate matrix to current transformation matrix.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.EndText
process : ET : End text object.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.GRestore
process : Q : Restore graphics state.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.GSave
process : q : Save graphics state.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.Invoke
process : Do - Invoke a named xobject.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.MoveAndShow
' Move to next line and show text.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.MoveText
process : Td : Move text position.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.MoveTextSetLeading
process : TD Move text position and set leading.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.NextLine
process : T* Move to start of next text line.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.OperatorProcessor
process the operator.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetCharSpacing
process : Tc Set character spacing.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetGraphicsStateParameters
gs Set parameters from graphics state parameter dictionary.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetHorizontalTextScaling
Tz Set horizontal text scaling.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetLineWidth
w Set line width.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetMatrix
Tm Set text matrix and text line matrix.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetMoveAndShow
" Set word and character spacing, move to next line, and show text.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetNonStrokingCMYKColor
cs Set color space for non stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetNonStrokingColorSpace
cs Set color space for non stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetNonStrokingRGBColor
rg Set color space for non stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetStrokingCMYKColor
CS Set color space for stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetStrokingColorSpace
CS Set color space for stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetStrokingRGBColor
RG Set color space for stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetTextFont
Tf selectfont Set text font and size.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetTextLeading
TL Set text leading.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetTextRenderingMode
Tr Set text rendering mode.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetTextRise
Ts Set text rise.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.SetWordSpacing
Tw Set word spacing.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.ShowText
Tj show Show text.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.ShowTextGlyph
TJ Show text, allowing individual glyph positioning.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.AppendRectangleToPath
process : re : append rectangle to path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.BeginInlineImage
process : BI : begin inline image.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.ClosePath
process : h : Close path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.CurveTo
process : c : Append curved segment to path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.CurveToReplicateFinalPoint
process : y : Append curved segment to path (final point replicated).
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.CurveToReplicateInitialPoint
process : v : Append curved segment to path (initial point replicated).
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.EndPath
process : n : End path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.FillEvenOddRule
process : f* : fill path using even odd rule.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.FillNonZeroRule
process : F/f : fill path using non zero winding rule.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.Invoke
process : re : append rectangle to path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.LineTo
process : l : Append straight line segment to path.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.MoveTo
process : m : Begin new subpath.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetLineWidth
w Set line width.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetNonStrokingCMYKColor
k Set color space for non stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetNonStrokingColorSpace
cs Set color space for non stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetNonStrokingRGBColor
rg Set color space for non stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetStrokingCMYKColor
CS Set color space for stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetStrokingColorSpace
CS Set color space for stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.SetStrokingRGBColor
RG Set color space for stroking operations.
process(PDFOperator, List) - Method in class org.pdfbox.util.operator.pagedrawer.StrokePath
S stroke the path.
processNextPage(PDPage) - Method in class org.pdfbox.util.Splitter
Interface to start processing a new page.
processOperator(PDFOperator, List) - Method in class org.pdfbox.examples.util.PrintImageLocations
This is used to handle an operation.
processOperator(PDFOperator, List) - Method in class org.pdfbox.pdmodel.font.Type3StreamParser
This is used to handle an operation.
processOperator(String, List) - Method in class org.pdfbox.util.PDFStreamEngine
This is used to handle an operation.
processOperator(PDFOperator, List) - Method in class org.pdfbox.util.PDFStreamEngine
This is used to handle an operation.
processPage(PDPage, COSStream) - Method in class org.pdfbox.util.PDFTextStripper
This will process the contents of a page.
processPages(List) - Method in class org.pdfbox.util.PDFTextStripper
This will process all of the pages and the text that is in them.
processPages(List) - Method in class org.pdfbox.util.Splitter
Interface method to handle the start of the page processing.
processStream(PDPage, PDResources, COSStream) - Method in class org.pdfbox.util.PDFStreamEngine
This will process the contents of the stream.
processSubStream(PDPage, PDResources, COSStream) - Method in class org.pdfbox.util.PDFStreamEngine
Process a sub stream of the current stream.
protect(ProtectionPolicy) - Method in class org.pdfbox.pdmodel.PDDocument
Protects the document with the protection policy pp.
put(Object, Object) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
putAll(Map) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap

Q

QUADDING_CENTERED - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Q value.
QUADDING_LEFT - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Q value.
QUADDING_RIGHT - Static variable in class org.pdfbox.pdmodel.interactive.form.PDVariableText
A Q value.

R

R - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
READING_DIRECTION_L2R - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Reading direction.
READING_DIRECTION_R2L - Static variable in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Reading direction.
REFERENCE - Static variable in class org.pdfbox.pdfwriter.COSWriter
The reference token.
RENDERING_INTENT_ABSOLUTE_COLORIMETRIC - Static variable in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_INTENT_PERCEPTUAL - Static variable in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_INTENT_RELATIVE_COLORIMETRIC - Static variable in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_INTENT_SATURATION - Static variable in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_MODE_ADD_TEXT_TO_PATH_FOR_CLIPPING - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_TEXT - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_TEXT_AND_ADD_TO_PATH_FOR_CLIPPING - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_THEN_STROKE_TEXT - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_THEN_STROKE_TEXT_AND_ADD_TO_PATH_FOR_CLIPPING - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_NEITHER_FILL_NOR_STROKE_TEXT - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_STROKE_TEXT - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_STROKE_TEXT_AND_ADD_TO_PATH_FOR_CLIPPING - Static variable in class org.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RESOURCES - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
REVISION2 - Static variable in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Encryption revision 2.
REVISION3 - Static variable in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Encryption revision 3.
REVISION4 - Static variable in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Encryption revision 4.
ROOT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
ROTATE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
RT_GROUP - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an annotation reply type.
RT_REPLY - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an annotation reply type.
RUN_LENGTH_DECODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
RUN_LENGTH_DECODE_ABBREVIATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
RandomAccess - interface org.pdfbox.io.RandomAccess.
An interface to allow PDF files to be stored completely in memory or to use a scratch file on the disk.
RandomAccessBuffer - class org.pdfbox.io.RandomAccessBuffer.
An interface to allow PDF files to be stored completely in memory.
RandomAccessBuffer() - Constructor for class org.pdfbox.io.RandomAccessBuffer
Default constructor.
RandomAccessFile - class org.pdfbox.io.RandomAccessFile.
An interface to allow temp PDF data to be stored in a scratch file on the disk to reduce memory consumption.
RandomAccessFile(File, String) - Constructor for class org.pdfbox.io.RandomAccessFile
Constructor.
RandomAccessFileInputStream - class org.pdfbox.io.RandomAccessFileInputStream.
This class allows a section of a RandomAccessFile to be accessed as an input stream.
RandomAccessFileInputStream(RandomAccess, long, long) - Constructor for class org.pdfbox.io.RandomAccessFileInputStream
Constructor.
RandomAccessFileOutputStream - class org.pdfbox.io.RandomAccessFileOutputStream.
This will write to a RandomAccessFile in the filesystem and keep track of the position it is writing to and the length of the stream.
RandomAccessFileOutputStream(RandomAccess) - Constructor for class org.pdfbox.io.RandomAccessFileOutputStream
Constructor to create an output stream that will write to the end of a random access file.
ReaderBottomPanel - class org.pdfbox.pdfviewer.ReaderBottomPanel.
A panel to display at the bottom of the window for status and other stuff.
ReaderBottomPanel() - Constructor for class org.pdfbox.pdfviewer.ReaderBottomPanel
This is the default constructor.
RemoveAllText - class org.pdfbox.examples.util.RemoveAllText.
This is an example on how to remove all text from PDF document.
RemoveFirstPage - class org.pdfbox.examples.pdmodel.RemoveFirstPage.
This is an example on how to remove pages from a PDF document.
ReplaceString - class org.pdfbox.examples.pdmodel.ReplaceString.
This is an example that will replace a string in a PDF with a new one.
ReplaceString() - Constructor for class org.pdfbox.examples.pdmodel.ReplaceString
Constructor.
ReplaceURLs - class org.pdfbox.examples.pdmodel.ReplaceURLs.
This is an example of how to replace a URL in a PDF document.
ResourceLoader - class org.pdfbox.util.ResourceLoader.
This class will handle loading resource files(AFM/CMAP).
RubberStamp - class org.pdfbox.examples.pdmodel.RubberStamp.
This is an example on how to add annotations to pages of a PDF document.
RunLengthDecodeFilter - class org.pdfbox.filter.RunLengthDecodeFilter.
This is a filter for the RunLength Decoder.
RunLengthDecodeFilter() - Constructor for class org.pdfbox.filter.RunLengthDecodeFilter
Constructor.
rc4 - Variable in class org.pdfbox.pdmodel.encryption.SecurityHandler
The RC4 implementation used for cryptographic functions.
read() - Method in class org.pdfbox.io.ASCII85InputStream
This will read the next byte from the stream.
read(byte[], int, int) - Method in class org.pdfbox.io.ASCII85InputStream
This will read a chunk of data.
read() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Read a byte.
read(byte[]) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Read a number of bytes.
read(byte[], int, int) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Read a number of bytes.
read() - Method in class org.pdfbox.io.NBitInputStream
This will read the next n bits from the stream and return the unsigned value of those bits.
read() - Method in interface org.pdfbox.io.RandomAccess
Read a single byte of data.
read(byte[], int, int) - Method in interface org.pdfbox.io.RandomAccess
Read a buffer of data.
read() - Method in class org.pdfbox.io.RandomAccessBuffer
Read a single byte of data.
read(byte[], int, int) - Method in class org.pdfbox.io.RandomAccessBuffer
Read a buffer of data.
read() - Method in class org.pdfbox.io.RandomAccessFile
Read a single byte of data.
read(byte[], int, int) - Method in class org.pdfbox.io.RandomAccessFile
Read a buffer of data.
read() - Method in class org.pdfbox.io.RandomAccessFileInputStream
read(byte[], int, int) - Method in class org.pdfbox.io.RandomAccessFileInputStream
readExpectedString(String) - Method in class org.pdfbox.pdfparser.BaseParser
This will read bytes until the end of line marker occurs.
readInt() - Method in class org.pdfbox.pdfparser.BaseParser
This will read an integer from the stream.
readLine() - Method in class org.pdfbox.pdfparser.BaseParser
This will read bytes until the end of line marker occurs.
readOperator() - Method in class org.pdfbox.pdfparser.PDFStreamParser
This will read an operator from the stream.
readString() - Method in class org.pdfbox.pdfparser.BaseParser
This will read the next string from the stream.
readString(int) - Method in class org.pdfbox.pdfparser.BaseParser
This will read the next string from the stream up to a certain length.
registerHandler(String, Class, Class) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandlersManager
register a security handler.
registerOperatorProcessor(String, OperatorProcessor) - Method in class org.pdfbox.util.PDFStreamEngine
Register a custom operator processor with the engine.
registerSecurityHandler(String, Class) - Static method in class org.pdfbox.pdmodel.encryption.PDEncryptionManager
Deprecated. This will allow the user to register new security handlers when unencrypting a document.
remove(int) - Method in class org.pdfbox.cos.COSArray
This will remove an element from the array.
remove(COSBase) - Method in class org.pdfbox.cos.COSArray
This will remove an element from the array.
remove(Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
remove(int) - Method in class org.pdfbox.pdmodel.common.COSArrayList
remove(Object) - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
removeAll(Collection) - Method in class org.pdfbox.cos.COSArray
This will remove all of the objects in the collection.
removeAll(Collection) - Method in class org.pdfbox.pdmodel.common.COSArrayList
removeItem(COSName) - Method in class org.pdfbox.cos.COSDictionary
This will remove an item for the dictionary.
removePage(PDPage) - Method in class org.pdfbox.pdmodel.PDDocument
Remove the page from the document.
removePage(int) - Method in class org.pdfbox.pdmodel.PDDocument
Remove the page from the document.
removeRecipient(PublicKeyRecipient) - Method in class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Removes a recipient from the recipients list.
removeTreeModelListener(TreeModelListener) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Removes a listener previously added with addTreeModelListener.
replaceWithStream(COSStream) - Method in class org.pdfbox.cos.COSStream
This will replace this object with the data from the new object.
reset() - Method in class org.pdfbox.cos.COSString
This will reset the internal buffer.
reset() - Method in class org.pdfbox.io.ASCII85InputStream
Unsupported.
reset() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Restore the state of this stream to the last saveState call.
resetEngine() - Method in class org.pdfbox.util.PDFStreamEngine
This method must be called between processing documents.
retainAll(Collection) - Method in class org.pdfbox.cos.COSArray
This will retain all of the objects in the collection.
retainAll(Collection) - Method in class org.pdfbox.pdmodel.common.COSArrayList

S

SCALE_OPTION_ALWAYS - Static variable in class org.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_OPTION_NEVER - Static variable in class org.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER - Static variable in class org.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER - Static variable in class org.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_TYPE_ANAMORPHIC - Static variable in class org.pdfbox.pdmodel.fdf.FDFIconFit
Scale to fill with of annotation, disregarding aspect ratio.
SCALE_TYPE_PROPORTIONAL - Static variable in class org.pdfbox.pdmodel.fdf.FDFIconFit
Scale to fit width or height, smaller of two, while retaining aspect ration.
SEPARATION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
SPACE - Static variable in class org.pdfbox.pdfwriter.COSWriter
space character.
SPACE - Static variable in class org.pdfbox.pdfwriter.ContentStreamWriter
space character.
STANDARD_ENCODING - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
STARTXREF - Static variable in class org.pdfbox.pdfwriter.COSWriter
The start xref token.
STREAM - Static variable in class org.pdfbox.pdfwriter.COSWriter
The open stream token.
STRING_CLOSE - Static variable in class org.pdfbox.cos.COSString
One of the close string tokens.
STRING_OPEN - Static variable in class org.pdfbox.cos.COSString
One of the open string tokens.
STYLE_BEVELED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a beveled style.
STYLE_CLOUDY - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constant for the name of a cloudy effect.
STYLE_DASHED - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a dashed style.
STYLE_INSET - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a inset style.
STYLE_SOLID - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constant for the name for no effect.
STYLE_SOLID - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a solid style.
STYLE_UNDERLINE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a underline style.
SUBTYPE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
The XObject subtype.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
The XObject subtype.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
This type of action this object represents.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This type of action this object represents.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This type of action this object represents.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
The type of annotation.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
The type of annotation.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
The type of annotation.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
The type of annotation.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
The type of annotation.
SUB_TYPE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
The type of annotation.
SUB_TYPE_CIRCLE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Constant for an Eliptical type of annotation.
SUB_TYPE_HIGHLIGHT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUB_TYPE_SQUARE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Constant for a Rectangular type of annotation.
SUB_TYPE_SQUIGGLY - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUB_TYPE_STRIKEOUT - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUB_TYPE_UNDERLINE - Static variable in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SYMBOL - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
SecurityHandler - class org.pdfbox.pdmodel.encryption.SecurityHandler.
This class represents a security handler as described in the PDF specifications.
SecurityHandler() - Constructor for class org.pdfbox.pdmodel.encryption.SecurityHandler
 
SecurityHandlersManager - class org.pdfbox.pdmodel.encryption.SecurityHandlersManager.
This class manages security handlers for the application.
SetCharSpacing - class org.pdfbox.util.operator.SetCharSpacing.
Titre : PDFEngine Modification.
SetCharSpacing() - Constructor for class org.pdfbox.util.operator.SetCharSpacing
 
SetField - class org.pdfbox.examples.fdf.SetField.
This example will take a PDF document and set a FDF field in it.
SetField() - Constructor for class org.pdfbox.examples.fdf.SetField
 
SetGraphicsStateParameters - class org.pdfbox.util.operator.SetGraphicsStateParameters.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetGraphicsStateParameters() - Constructor for class org.pdfbox.util.operator.SetGraphicsStateParameters
 
SetHorizontalTextScaling - class org.pdfbox.util.operator.SetHorizontalTextScaling.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetHorizontalTextScaling() - Constructor for class org.pdfbox.util.operator.SetHorizontalTextScaling
 
SetLineWidth - class org.pdfbox.util.operator.SetLineWidth.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetLineWidth() - Constructor for class org.pdfbox.util.operator.SetLineWidth
 
SetLineWidth - class org.pdfbox.util.operator.pagedrawer.SetLineWidth.
Implementation of content stream operator for page drawer.
SetLineWidth() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetLineWidth
 
SetMatrix - class org.pdfbox.util.operator.SetMatrix.
Titre : PDFEngine Modification.
SetMatrix() - Constructor for class org.pdfbox.util.operator.SetMatrix
 
SetMoveAndShow - class org.pdfbox.util.operator.SetMoveAndShow.
Titre : PDFEngine Modification.
SetMoveAndShow() - Constructor for class org.pdfbox.util.operator.SetMoveAndShow
 
SetNonStrokingCMYKColor - class org.pdfbox.util.operator.SetNonStrokingCMYKColor.
Set the non stroking color space.
SetNonStrokingCMYKColor() - Constructor for class org.pdfbox.util.operator.SetNonStrokingCMYKColor
 
SetNonStrokingCMYKColor - class org.pdfbox.util.operator.pagedrawer.SetNonStrokingCMYKColor.
Implementation of content stream operator for page drawer.
SetNonStrokingCMYKColor() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetNonStrokingCMYKColor
 
SetNonStrokingColorSpace - class org.pdfbox.util.operator.SetNonStrokingColorSpace.
Set the non stroking color space.
SetNonStrokingColorSpace() - Constructor for class org.pdfbox.util.operator.SetNonStrokingColorSpace
 
SetNonStrokingColorSpace - class org.pdfbox.util.operator.pagedrawer.SetNonStrokingColorSpace.
Implementation of content stream operator for page drawer.
SetNonStrokingColorSpace() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetNonStrokingColorSpace
 
SetNonStrokingRGBColor - class org.pdfbox.util.operator.SetNonStrokingRGBColor.
Set the non stroking color space.
SetNonStrokingRGBColor() - Constructor for class org.pdfbox.util.operator.SetNonStrokingRGBColor
 
SetNonStrokingRGBColor - class org.pdfbox.util.operator.pagedrawer.SetNonStrokingRGBColor.
Implementation of content stream operator for page drawer.
SetNonStrokingRGBColor() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetNonStrokingRGBColor
 
SetStrokingCMYKColor - class org.pdfbox.util.operator.SetStrokingCMYKColor.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingCMYKColor() - Constructor for class org.pdfbox.util.operator.SetStrokingCMYKColor
 
SetStrokingCMYKColor - class org.pdfbox.util.operator.pagedrawer.SetStrokingCMYKColor.
Implementation of content stream operator for page drawer.
SetStrokingCMYKColor() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetStrokingCMYKColor
 
SetStrokingColorSpace - class org.pdfbox.util.operator.SetStrokingColorSpace.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingColorSpace() - Constructor for class org.pdfbox.util.operator.SetStrokingColorSpace
 
SetStrokingColorSpace - class org.pdfbox.util.operator.pagedrawer.SetStrokingColorSpace.
Implementation of content stream operator for page drawer.
SetStrokingColorSpace() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetStrokingColorSpace
 
SetStrokingRGBColor - class org.pdfbox.util.operator.SetStrokingRGBColor.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingRGBColor() - Constructor for class org.pdfbox.util.operator.SetStrokingRGBColor
 
SetStrokingRGBColor - class org.pdfbox.util.operator.pagedrawer.SetStrokingRGBColor.
Implementation of content stream operator for page drawer.
SetStrokingRGBColor() - Constructor for class org.pdfbox.util.operator.pagedrawer.SetStrokingRGBColor
 
SetTextFont - class org.pdfbox.util.operator.SetTextFont.
Titre : PDFEngine Modification.
SetTextFont() - Constructor for class org.pdfbox.util.operator.SetTextFont
 
SetTextLeading - class org.pdfbox.util.operator.SetTextLeading.
Titre : PDFEngine Modification.
SetTextLeading() - Constructor for class org.pdfbox.util.operator.SetTextLeading
 
SetTextRenderingMode - class org.pdfbox.util.operator.SetTextRenderingMode.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetTextRenderingMode() - Constructor for class org.pdfbox.util.operator.SetTextRenderingMode
 
SetTextRise - class org.pdfbox.util.operator.SetTextRise.
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetTextRise() - Constructor for class org.pdfbox.util.operator.SetTextRise
 
SetWordSpacing - class org.pdfbox.util.operator.SetWordSpacing.
Titre : PDFEngine Modification.
SetWordSpacing() - Constructor for class org.pdfbox.util.operator.SetWordSpacing
 
ShowColorBoxes - class org.pdfbox.examples.pdmodel.ShowColorBoxes.
This is an example that creates a simple document.
ShowColorBoxes() - Constructor for class org.pdfbox.examples.pdmodel.ShowColorBoxes
Constructor.
ShowSignature - class org.pdfbox.examples.signature.ShowSignature.
This will read a document from the filesystem, decrypt it and do something with the signature.
ShowSignature() - Constructor for class org.pdfbox.examples.signature.ShowSignature
 
ShowText - class org.pdfbox.util.operator.ShowText.
Titre : PDFEngine Modification.
ShowText() - Constructor for class org.pdfbox.util.operator.ShowText
 
ShowTextGlyph - class org.pdfbox.util.operator.ShowTextGlyph.
Titre : PDFEngine Modification.
ShowTextGlyph() - Constructor for class org.pdfbox.util.operator.ShowTextGlyph
 
Splitter - class org.pdfbox.util.Splitter.
Split a document into several other documents.
Splitter() - Constructor for class org.pdfbox.util.Splitter
 
StandardDecryptionMaterial - class org.pdfbox.pdmodel.encryption.StandardDecryptionMaterial.
Represents the necessary information to decrypt a document protected by the standard security handler (password protection).
StandardDecryptionMaterial(String) - Constructor for class org.pdfbox.pdmodel.encryption.StandardDecryptionMaterial
Create a new standard decryption material with the given password.
StandardEncoding - class org.pdfbox.encoding.StandardEncoding.
This is an interface to a text encoder.
StandardEncoding() - Constructor for class org.pdfbox.encoding.StandardEncoding
Constructor.
StandardProtectionPolicy - class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy.
This class represents the protection policy to add to a document for password-based protection.
StandardProtectionPolicy(String, String, AccessPermission) - Constructor for class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Creates an new instance of the standard protection policy in order to protect a PDF document with passwords.
StandardSecurityHandler - class org.pdfbox.pdmodel.encryption.StandardSecurityHandler.
The class implements the standard security handler as decribed in the PDF specifications.
StandardSecurityHandler() - Constructor for class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Constructor.
StandardSecurityHandler(StandardProtectionPolicy) - Constructor for class org.pdfbox.pdmodel.encryption.StandardSecurityHandler
Constructor used for encryption.
StrokePath - class org.pdfbox.util.operator.pagedrawer.StrokePath.
Implementation of content stream operator for page drawer.
StrokePath() - Constructor for class org.pdfbox.util.operator.pagedrawer.StrokePath
 
Sub - class org.pdfbox.pdmodel.graphics.predictor.Sub.
The sub algorithm.
Sub() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.Sub
 
save(String) - Method in class org.pdfbox.pdmodel.PDDocument
This will save this document to the filesystem.
save(OutputStream) - Method in class org.pdfbox.pdmodel.PDDocument
This will save the document to an output stream.
save(File) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
save(String) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
save(OutputStream) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will save the document to an output stream.
saveXFDF(File) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
saveXFDF(String) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
saveXFDF(Writer) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will save the document to an output stream and close the stream.
seek(int) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Position the stream at a given index.
seek(long) - Method in interface org.pdfbox.io.RandomAccess
Seek to a position in the data.
seek(long) - Method in class org.pdfbox.io.RandomAccessBuffer
Seek to a position in the data.
seek(long) - Method in class org.pdfbox.io.RandomAccessFile
Seek to a position in the data.
set(int, COSBase) - Method in class org.pdfbox.cos.COSArray
This will set an object at a specific index.
set(int, int) - Method in class org.pdfbox.cos.COSArray
This will set an object at a specific index.
set(int, COSObjectable) - Method in class org.pdfbox.cos.COSArray
This will set an object at a specific index.
set(int, Object) - Method in class org.pdfbox.pdmodel.common.COSArrayList
setARange(PDRange) - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will set the a range for this color space.
setAcroForm(PDAcroForm) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the acro form for this catalog.
setAcroForm(PDAcroForm) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will set the form this field is on.
setAction(PDAction) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the action that is associated with this field.
setAction(PDTextStream) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
 
setAction(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
 
setAction(PDAction) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the annotation action.
setAction(PDAction) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the action for this node.
setActions(PDDocumentCatalogAdditionalActions) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the additional actions for the document.
setActions(PDPageAdditionalActions) - Method in class org.pdfbox.pdmodel.PDPage
Set the page actions.
setActions(PDAdditionalActions) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the actions of the field.
setActions(PDFormFieldAdditionalActions) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Set the actions of the field.
setAdditionalActions(PDAdditionalActions) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the additional actions that are associated with this field.
setAfter(PDTextStream) - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
This will set the javascript code the will get execute after the import.
setAllCap(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setAlphaConstants(double) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the alpha constants property.
setAlphaSource(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the alpha source property.
setAlphaSourceFlag(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the alpha source flag.
setAlternateColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the alternate color space.
setAlternateColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will set the alternate color space.
setAlternateColorSpaces(List) - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the list of alternate color spaces.
setAnnotationFlags(int) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the flags for this field.
setAnnotationName(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the name, a string intended to uniquely identify each annotatoin within a page.
setAnnotations(List) - Method in class org.pdfbox.pdmodel.PDPage
This will set the list of annotations.
setAnnotations(List) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of annotations.
setAppearance(PDAppearanceDictionary) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the appearance associated with this annotation.
setAppearanceDictionary(PDAppearanceDictionary) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the appearance dictionary.
setAppearanceStream(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the annotations appearance stream name.
setAppearanceStreamReference(FDFNamedPageReference) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the named page references.
setAppearanceValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDAppearance
This is the public method for setting the appearance stream.
setArtBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPage
This will set the ArtBox for this page.
setAscent(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the ascent for the font.
setAscent(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the ascent for the font.
setAscent(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the ascent for the font.
setAttachementName(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Set the name used to draw the attachement icon.
setAttributes(PDDeviceNAttributes) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the color space attributes.
setAuthor(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the author of the document.
setAutomaticStrokeAdjustment(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the automatic stroke adjustment flag.
setAverageWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the average width for the font.
setAverageWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the average width for the font.
setAverageWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the average width for the font.
setB(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
This will set the b value of the tristimulus.
setBRange(PDRange) - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will set the b range for this color space.
setBase(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will set the base URI to be used in resolving relative URI references.
setBaseColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will set the base color space.
setBaseFont(String) - Method in class org.pdfbox.pdmodel.font.PDFont
Set the PostScript name of the font.
setBefore(PDTextStream) - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
This will set the javascript code the will get execute before the import.
setBitsInChunk(int) - Method in class org.pdfbox.io.NBitInputStream
Setter for property bitsToRead.
setBitsInChunk(int) - Method in class org.pdfbox.io.NBitOutputStream
Setter for property bitsToRead.
setBitsPerComponent(int) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the number of bits per component.
setBitsPerComponent(int) - Method in class org.pdfbox.util.ImageParameters
Set the number of bits per component.
setBitsPerSample(int) - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Set the number of bits that the output value will take up.
setBl(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the annotation loses the input focus.
setBlackPoint(PDTristimulus) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will set the BlackPoint tristimulus.
setBlackPoint(PDTristimulus) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will set the BlackPoint tristimulus.
setBlackPoint(PDTristimulus) - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will set the BlackPoint tristimulus.
setBleedBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPage
This will set the BleedBox for this page.
setBold(boolean) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the bold property of the text.
setBoolean(String, boolean) - Method in class org.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setBoolean(COSName, boolean) - Method in class org.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setBorderEffect(PDBorderEffectDictionary) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the border effect dictionary, specifying effects to be applied when drawing the line.
setBorderStyle(PDBorderStyleDictionary) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
setBottom(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setBoundingBox(PDRectangle) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will set the bounding box for this appearance stream.
setBpp(int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
setBpp(int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
setC(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes.
setC(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will set an action to be performed when the page is closed.
setCacheFields(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will tell this form to cache the fields into a Map structure for fast access via the getField method.
setCanAssembleDocument(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can insert/rotate/delete pages.
setCanAssembleDocument(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can insert/rotate/delete pages.
setCanExtractContent(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can extract content from the document.
setCanExtractContent(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can extract content from the document.
setCanExtractForAccessibility(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can extract content from the document for accessibility purposes.
setCanExtractForAccessibility(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can extract content from the document for accessibility purposes.
setCanFillInForm(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can fill in interactive forms.
setCanFillInForm(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can fill in interactive forms.
setCanModify(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can modify the document.
setCanModify(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can modify the document.
setCanModifyAnnotations(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can modify annotations.
setCanModifyAnnotations(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can modify annotations.
setCanPrint(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can print.
setCanPrint(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can print.
setCanPrintDegraded(boolean) - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can print the document in a degraded format.
setCanPrintDegraded(boolean) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. Set if the user can print the document in a degraded format.
setCapHeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the cap height for the font.
setCapHeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the cap height for the font.
setCapHeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the cap height for the font.
setCaption(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set if the contents are shown as a caption to the line.
setCatalog(FDFCatalog) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will set the FDF catalog for this FDF document.
setCenterWindow(boolean) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the center window preference.
setCharacterSet(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the character set for the font.
setCharacterSet(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the character set for the font.
setCharacterSet(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the character set for the font.
setCharacterSpacing(float) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the characterSpacing.
setCheckSum(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the check sum.
setClearFieldFlags(Integer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClearFieldFlags(int) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClearWidgetFieldFlags(Integer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClearWidgetFieldFlags(int) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
This will set the current colorspace.
setColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
This will set the color space for this image.
setColorSpace(PDColorSpace) - Method in class org.pdfbox.util.ImageParameters
This will set the color space for this image.
setColorSpaceValue(float[]) - Method in class org.pdfbox.pdmodel.graphics.color.PDColorSpaceInstance
This will update the colorspace values.
setColorSpaces(Map) - Method in class org.pdfbox.pdmodel.PDResources
This will set the map of colorspaces.
setColorSpaces(Map) - Method in class org.pdfbox.util.PDFStreamEngine
 
setColorantName(String) - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will set the separation name.
setColorantNames(List) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the list of colorants.
setColorants(Map) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
This will replace the existing colorant attribute.
setColour(PDGamma) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the colour used in drawing various elements.
setComb(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the comb bit.
setConstantOpacity(float) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the constant opacity value used when rendering the annotation (excluing any popup).
setContents(PDStream) - Method in class org.pdfbox.pdmodel.PDPage
This will set the contents of this page.
setContents(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the "contents" of the field.
setContext(PDFStreamEngine) - Method in class org.pdfbox.util.operator.OperatorProcessor
Set the processing context.
setCreationDate(Calendar) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the creation date of the document.
setCreationDate(Calendar) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the creation date.
setCreationDate(Calendar) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the the date and time the annotation was created.
setCreator(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the creator of the document.
setCropBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPage
This will set the CropBox for this page.
setCropBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPageNode
This will set the CropBox for this page.
setCurrentTransformationMatrix(Matrix) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Set the value of the CTM.
setCustomMetadataValue(String, String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
Set the custom metadata value.
setD(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the mouse button is pressed inside the annotation's active area.
setD(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the string specifying the default directory in standard DOS syntax.
setD(COSBase) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will set the destination to jump to.
setDP(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed after printing a document.
setDS(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed after saving a document.
setDashPattern(List) - Method in class org.pdfbox.pdmodel.graphics.PDLineDashPattern
This will replace the existing line dash pattern.
setDashStyle(PDLineDashPattern) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the dash style used for drawing the border.
setDate(String, Calendar) - Method in class org.pdfbox.cos.COSDictionary
Set the value of a date entry in the dictionary.
setDate(COSName, Calendar) - Method in class org.pdfbox.cos.COSDictionary
Set the date object.
setDateTimeResolution(DateTools.Resolution) - Method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
Set the Lucene data time resolution.
setDecodeForParameter(int, PDRange) - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Set the decode range for the param number.
setDecodeParams(List) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will set the list of decode params.
setDecodeParams(List) - Method in class org.pdfbox.pdmodel.common.PDStream
This will set the list of decode params.
setDecryptionCertificate(X509Certificate) - Method in class org.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Setter of the property decryptionCertificate.
setDefaultAppearanceString(String) - Method in class org.pdfbox.pdmodel.fdf.FDFOptionElement
This will set the default appearance string.
setDefaultResources(PDResources) - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
This will set the default resources for the acroform.
setDefaultWidth(long) - Method in class org.pdfbox.pdmodel.font.PDCIDFont
This will set the default width for the glyphs of this font.
setDescent(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the descent for the font.
setDescent(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the descent for the font.
setDescent(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the descent for the font.
setDestination(PDDestination) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
This will set the destination to jump to.
setDestination(PDDestination) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
The new destination value.
setDestination(PDDestination) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the page destination for this node.
setDestination(PDPage) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
A convenience method that will create an XYZ destination using only the defaults.
setDestinationFileName(String) - Method in class org.pdfbox.util.PDFMergerUtility
Set the name of the destination file.
setDests(PDDestinationNameTreeNode) - Method in class org.pdfbox.pdmodel.PDDocumentNameDictionary
Set the named destinations that are associated with this document.
setDifferences(COSStream) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the differences stream.
setDirectory(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the dir to launch from.
setDisplayDocTitle(boolean) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the display doc title preference.
setDoNotScroll(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the doNotScroll bit.
setDoNotSpellCheck(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the doNotSpellCheck bit.
setDocument(COSDocument) - Method in class org.pdfbox.pdfparser.BaseParser
Set the document for this stream.
setDocument(PDDocument) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Set the document to display in the tree.
setDocumentID(COSArray) - Method in class org.pdfbox.cos.COSDocument
This will set the document ID.
setDocumentInformation(PDDocumentInformation) - Method in class org.pdfbox.pdmodel.PDDocument
This will set the document information for this document.
setDocumentOutline(PDDocumentOutline) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the document outlines.
setDomainForInput(PDRange, int) - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
This will set the domain for the input values.
setDomainForInput(PDRange, int) - Method in class org.pdfbox.pdmodel.common.function.PDFunction
This will set the domain for the input values.
setDomainForInput(PDRange, int) - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will set the domain for the input values.
setDownAppearance(Map) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set a list of appearances.
setE(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the cursor enters the annotation's active area.
setEmbeddedDate(String, String, Calendar) - Method in class org.pdfbox.cos.COSDictionary
Set the value of a date entry in the dictionary.
setEmbeddedDate(String, COSName, Calendar) - Method in class org.pdfbox.cos.COSDictionary
Set the date object.
setEmbeddedFDFs(List) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of embedded FDFs.
setEmbeddedFile(PDEmbeddedFile) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded file for this spec.
setEmbeddedFileDos(PDEmbeddedFile) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded dos file for this spec.
setEmbeddedFileMac(PDEmbeddedFile) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded Mac file for this spec.
setEmbeddedFileUnix(PDEmbeddedFile) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded Unix file for this spec.
setEmbeddedFiles(PDEmbeddedFilesNameTreeNode) - Method in class org.pdfbox.pdmodel.PDDocumentNameDictionary
Set the named embedded files that are associated with this document.
setEmbeddedInt(String, String, int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setEmbeddedInt(String, COSName, int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setEmbeddedString(String, String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setEmbeddedString(String, COSName, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setEncodeForParameter(int, PDRange) - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Set the encode range for the param number.
setEncoding(String) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the encoding.
setEncoding(Encoding) - Method in class org.pdfbox.pdmodel.font.PDFont
The will set the encoding for this font.
setEncryptionDictionary(COSDictionary) - Method in class org.pdfbox.cos.COSDocument
This will set the encryption dictionary, this should only be called when encypting the document.
setEncryptionDictionary(PDEncryptionDictionary) - Method in class org.pdfbox.pdmodel.PDDocument
This will set the encryption dictionary for this document.
setEncryptionKeyLength(int) - Method in class org.pdfbox.pdmodel.encryption.ProtectionPolicy
set the length in (bits) of the secret key that will be used to encrypt document data.
setEndBookmark(PDOutlineItem) - Method in class org.pdfbox.util.PDFTextStripper
Set the bookmark where the text extraction should stop.
setEndPage(int) - Method in class org.pdfbox.util.PDFTextStripper
This will set the last page to be extracted by this class.
setEndPointEndingStyle(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the line ending style for the end point, see the LE_ constants for the possible values.
setExecuteParam(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the parameter to pass the executable.
setExpectedLength(COSBase) - Method in class org.pdfbox.io.RandomAccessFileOutputStream
This will set the expected length of this stream.
setExtends(PDObjectStream) - Method in class org.pdfbox.pdmodel.common.PDObjectStream
A reference to an object stream, of which the current object stream is considered an extension.
setF(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Set the F action.
setF(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed before the field is formatted to display its current value.
setF(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the file name to be launched or the document to be opened or printed, in standard Windows pathname format.
setFDF(FDFDictionary) - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will set the FDF document.
setField(PDDocument, String, String) - Method in class org.pdfbox.examples.fdf.SetField
This will set a single field in the document.
setFieldFlags(Integer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setFieldFlags(int) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setFieldFlags(int) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will set the flags for this field.
setFields(List) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of fields.
setFields(List) - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
This will set a list of fields for this template.
setFields(List) - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the fields that are part of this AcroForm.
setFile(PDFileSpecification) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Set the file specification.
setFile(PDFileSpecification) - Method in class org.pdfbox.pdmodel.common.PDStream
Set the file specification.
setFile(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set the file name.
setFile(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDFileSpecification
This will set the file name.
setFile(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
This will set the file name.
setFile(PDFileSpecification) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the file specification.
setFile(PDFileSpecification) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the application to be launched or the document to be opened or printed.
setFile(PDFileSpecification) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will set the file in which the destination is located.
setFile(PDFileSpecification) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Set the attached file.
setFileDecodeParams(List) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will set the list of decode params.
setFileDecodeParams(List) - Method in class org.pdfbox.pdmodel.common.PDStream
This will set the list of decode params.
setFileDos(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set name representing a dos file.
setFileFilters(List) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will set the filters that are part of this stream.
setFileFilters(List) - Method in class org.pdfbox.pdmodel.common.PDStream
This will set the filters that are part of this stream.
setFileMac(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set name representing a Mac file.
setFileSelect(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the file select bit.
setFileSpecification(PDFileSpecification) - Method in class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will set the file specification for this named page reference.
setFileUnix(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set name representing a Unix file.
setFilename(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the file to launch.
setFilter(String) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Sets the filter entry of the encryption dictionary.
setFilters(COSBase) - Method in class org.pdfbox.cos.COSStream
set the filters to be applied to the stream.
setFilters(COSBase) - Method in class org.pdfbox.pdmodel.common.COSStreamArray
set the filters to be applied to the stream.
setFilters(List) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
This will set the filters that are part of this stream.
setFilters(List) - Method in class org.pdfbox.pdmodel.common.PDStream
This will set the filters that are part of this stream.
setFilters(List) - Method in class org.pdfbox.util.ImageParameters
This will set the filters that are part of this stream.
setFirstBead(PDThreadBead) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
This will set the first bead in the thread.
setFirstByteOffset(int) - Method in class org.pdfbox.pdmodel.common.PDObjectStream
The byte offset (in the decoded stream) of the first compressed object.
setFirstChar(int) - Method in class org.pdfbox.pdmodel.font.PDFont
Set the first character this font supports.
setFirstChild(PDOutlineNode) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the first child, this will be maintained by this class.
setFitBoundingBox(boolean) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
Set if this page destination should just fit the bounding box.
setFitBoundingBox(boolean) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Set if this page destination should just fit the bounding box.
setFitBoundingBox(boolean) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Set if this page destination should just fit the bounding box.
setFitWindow(boolean) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the fit window preference.
setFixedPitch(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setFlag(COSDictionary, String, int, boolean) - Static method in class org.pdfbox.util.BitFlagHelper
Sets the given boolean value at bitPos in the flags.
setFlags(int) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font flags.
setFlags(int) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font flags.
setFlags(int) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font flags.
setFlatness(double) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the flatness property.
setFlatnessTolerance(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the flatness tolerance.
setFloat(String, float) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSFloat object.
setFloat(COSName, float) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSFloat object.
setFloatArray(float[]) - Method in class org.pdfbox.cos.COSArray
Clear the current contents of the COSArray and set it with the float[].
setFo(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the annotation receives the input focus.
setFont(PDSimpleFont) - Method in class org.pdfbox.TextToPDF
 
setFont(PDFont, float) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the font to draw text with.
setFont(PDFont) - Method in class org.pdfbox.pdmodel.graphics.PDFontSetting
This will set the font for this font setting.
setFont(PDFont) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the font.
setFontBoundingBox(PDRectangle) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
Set the fonts bounding box.
setFontBoundingBox(PDRectangle) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
Set the fonts bounding box.
setFontBoundingBox(PDRectangle) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the fonts bounding box.
setFontDescriptor(PDFontDescriptorDictionary) - Method in class org.pdfbox.pdmodel.font.PDCIDFont
Set the font descriptor associated with this CID Font.
setFontDescriptor(PDFontDescriptorDictionary) - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will set the font descriptor.
setFontFamily(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font family.
setFontFamily(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font family.
setFontFamily(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font family.
setFontFile(PDStream) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the type 1 font program.
setFontFile2(PDStream) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the true type font program.
setFontFile3(PDStream) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set a stream containing a font program that is not true type or type 1.
setFontMatrix(PDMatrix) - Method in class org.pdfbox.pdmodel.font.PDType3Font
Set the font matrix for this type3 font.
setFontName(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font name.
setFontName(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font name.
setFontName(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font name.
setFontSetting(PDFontSetting) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the font setting for this graphics state.
setFontSize(int) - Method in class org.pdfbox.TextToPDF
 
setFontSize(float) - Method in class org.pdfbox.pdmodel.graphics.PDFontSetting
This will set the size of the font.
setFontSize(float) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the fontSize.
setFontStretch(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font stretch.
setFontStretch(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font stretch.
setFontStretch(String) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font stretch.
setFontWeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
Set the weight of the font.
setFontWeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
Set the weight of the font.
setFontWeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the weight of the font.
setFonts(Map) - Method in class org.pdfbox.pdmodel.PDResources
This will set the map of fonts.
setFonts(Map) - Method in class org.pdfbox.util.PDFStreamEngine
 
setForceBold(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setForceLiteralForm(boolean) - Method in class org.pdfbox.cos.COSString
Forces the string to be written in literal form instead of hexadecimal form.
setFormType(int) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Set the form type.
setFractionalSpaceToAllocate(PDRange) - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will set frational space to allocate.
setFree(boolean) - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
This will set the free attribute.
setFromAffineTransform(AffineTransform) - Method in class org.pdfbox.util.Matrix
Set the values of the matrix from the AffineTransform.
setG(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
This will set the g value of the tristimulus.
setGamma(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
Set the gamma value.
setGamma(PDGamma) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
Set the gamma value.
setGeneration(long) - Method in class org.pdfbox.persistence.util.COSObjectKey
This will set the objects generation number.
setGenerationNumber(COSInteger) - Method in class org.pdfbox.cos.COSObject
Setter for property generationNumber.
setGraphicsStack(Stack) - Method in class org.pdfbox.util.PDFStreamEngine
 
setGraphicsState(PDGraphicsState) - Method in class org.pdfbox.util.PDFStreamEngine
 
setGraphicsStates(Map) - Method in class org.pdfbox.pdmodel.PDResources
This will set the map of graphics states.
setGraphicsStates(Map) - Method in class org.pdfbox.util.PDFStreamEngine
 
setGuideLineColor(PDColorSpaceInstance) - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the color space instance for this box style.
setGuidelineStyle(String) - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the style for the box.
setGuidelineWidth(float) - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the guideline width.
setHeaderString(String) - Method in class org.pdfbox.cos.COSDocument
 
setHeight(int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
setHeight(int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
setHeight(int) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the height of the image.
setHeight(int) - Method in class org.pdfbox.util.ImageParameters
Set the height of the image.
setHidden(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the hidden flag.
setHideMenubar(boolean) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the menubar preference.
setHideToolbar(boolean) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the toolbar preference.
setHideWindowUI(boolean) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the window UI preference.
setHighValue(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will set the highest value that is allowed.
setHighlightMode(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Set the highlight mode.
setHorizontalScalingPercent(float) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the horizontalScaling.
setID(COSArray) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the FDF id.
setIconFit(FDFIconFit) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the icon fit entry.
setImageData(byte[]) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
Set the bytes that make up the image.
setImageData(byte[]) - Method in class org.pdfbox.util.PDFOperator
This will set the image data, this is only used for the ID operator.
setImageParameters(ImageParameters) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will set the image parameters for this image.
setImageParameters(ImageParameters) - Method in class org.pdfbox.util.PDFOperator
This will set the image parameters, this is only valid for BI operators.
setInReplyTo(PDAnnotation) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
setIndex(int) - Method in class org.pdfbox.pdfviewer.ArrayEntry
This will set the index value.
setInt(int, int) - Method in class org.pdfbox.cos.COSArray
Set the value in the array as an integer.
setInt(String, int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setInt(COSName, int) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setIntensity(float) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will set the intensity of the applied effect.
setIntent(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
setInteriorColour(PDGamma) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set interior colour of the line endings defined in the LE entry.
setInteriorColour(PDGamma) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set interior colour of the drawn area Colour is in DeviceRGB colourspace.
setInvisible(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the invisible flag.
setItalic(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setItalic(boolean) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the italic property of the text.
setItalicAngle(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the italic angle for the font.
setItalicAngle(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the italic angle for the font.
setItalicAngle(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the italic angle for the font.
setItem(COSName, COSBase) - Method in class org.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setItem(COSName, COSObjectable) - Method in class org.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setItem(String, COSObjectable) - Method in class org.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setItem(String, COSBase) - Method in class org.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setJavaScript(FDFJavaScript) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the JavaScript entry.
setK(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.
setKey(byte[]) - Method in class org.pdfbox.encryption.ARCFour
This will reset the key to be used.
setKey(Object) - Method in class org.pdfbox.pdfviewer.MapEntry
This will set the key for this entry.
setKeyLength(int) - Method in class org.pdfbox.pdmodel.encryption.SecurityHandler
Setter of the property keyLength.
setKeywords(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the keywords of the document.
setKids(List) - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Set the children of this named tree.
setKids(List) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the list of kids.
setKids(List) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will set the list of kids.
setKnockoutFlag(boolean) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the knockout.
setLanguage(String) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the Language for the document.
setLastChar(int) - Method in class org.pdfbox.pdmodel.font.PDFont
Set the last character this font supports.
setLastChild(PDOutlineNode) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the last child, this will be maintained by this class.
setLeading(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the leading for the font.
setLeading(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the leading for the font.
setLeading(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the leading for the font.
setLeading(float) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the leading.
setLeft(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setLeft(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setLeft(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setLength(int) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the number of bits to use for the encryption algorithm.
setLine(float[]) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set start and end coordinates of the line (or leader line if LL entry is set).
setLineCap(int) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the line cap.
setLineCapStyle(int) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the line cap style for the graphics state.
setLineDashPattern(PDLineDashPattern) - Method in class org.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the line dash pattern associated with this box style.
setLineDashPattern(PDLineDashPattern) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the dash pattern for the graphics state.
setLineDashPattern(PDLineDashPattern) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the current line dash pattern.
setLineJoin(int) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line join.
setLineJoinStyle(int) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the line join style.
setLineLength(int) - Method in class org.pdfbox.io.ASCII85OutputStream
This will set the line length that will be used.
setLinePath(GeneralPath) - Method in class org.pdfbox.pdfviewer.PageDrawer
Set the line path to draw.
setLineSeparator(String) - Method in class org.pdfbox.util.PDFTextStripper
Set the desired line separator for output text.
setLineSubPaths(List) - Method in class org.pdfbox.pdfviewer.PageDrawer
Set the list of line paths to draw.
setLineWidth(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the line width.
setLineWidth(double) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the line width.
setLinearInterpretation(PDMatrix) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will set the linear interpretation matrix.
setLocked(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the locked flag.
setLong(String, long) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setLong(COSName, long) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setLookupColor(int, int, int) - Method in class org.pdfbox.pdmodel.graphics.color.PDIndexed
This will set a color in the color lookup table.
setLowerLeftX(float) - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will set the lower left x coordinate.
setLowerLeftY(float) - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will set the lower left y coordinate.
setMacCreator(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mac Creator.
setMacResFork(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mac ResFork.
setMacSubtype(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mac subtype.
setMarkInfo(PDMarkInfo) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set information about the doc's usage of tagged features.
setMarked(boolean) - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Set if this is a tagged PDF.
setMax(float) - Method in class org.pdfbox.pdmodel.common.PDRange
This will set the maximum value for the range.
setMaxWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the max width for the font.
setMaxWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the max width for the font.
setMaxWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the max width for the font.
setMediaBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPage
This will set the mediaBox for this page.
setMediaBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPageNode
This will set the mediaBox for this page.
setMetadata(PDMetadata) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the metadata for this object.
setMetadata(PDMetadata) - Method in class org.pdfbox.pdmodel.PDPage
Set the metadata for this object.
setMetadata(PDMetadata) - Method in class org.pdfbox.pdmodel.common.PDMemoryStream
Set the metadata for this object.
setMetadata(PDMetadata) - Method in class org.pdfbox.pdmodel.common.PDStream
Set the metadata for this object.
setMetadata(COSStream) - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the metadata stream that is associated with this color space.
setMetadata(PDMetadata) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObject
Set the metadata for this object.
setMin(float) - Method in class org.pdfbox.pdmodel.common.PDRange
This will set the minimum value for the range.
setMissingWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the missing width for the font.
setMissingWidth(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the missing width for the font.
setMiterLimit(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the miter limit for the graphics state.
setMiterLimit(double) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the miter limit.
setModDate(Calendar) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mod date.
setModificationDate(Calendar) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the modification date of the document.
setModifiedDate(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the the date and time the annotation was modified.
setMultiline(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the multiline bit.
setName(int, String) - Method in class org.pdfbox.cos.COSArray
Set the value in the array as a name.
setName(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSName object.
setName(COSName, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSName object.
setName(String) - Method in class org.pdfbox.pdmodel.common.PDNamedTextStream
This will set the name of the named text stream.
setName(String) - Method in class org.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will set the name of the referenced page.
setName(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
This will set the name (and hence appearance, AP taking precedence) For this annotation.
setName(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will set the name (and hence appearance, AP taking precedence) For this annotation.
setNamedDestination(String) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Set the named destination.
setNamedJavaScripts(List) - Method in class org.pdfbox.pdmodel.fdf.FDFJavaScript
This should be a list of PDNamedTextStream objects.
setNames(PDDocumentNameDictionary) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the names dictionary for the document.
setNames(Map) - Method in class org.pdfbox.pdmodel.common.PDNameTreeNode
Set the names of for this node.
setNext(List) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
This will set the next action, or sequence of actions, to be performed after this one.
setNextBead(PDThreadBead) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the next bead in the thread.
setNextSibling(PDOutlineNode) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the next sibling, this will be maintained by this class.
setNoExport(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
sets the field to be not exported..
setNoRotate(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the noRotate flag.
setNoView(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the noView flag.
setNoZoom(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the noZoom flag.
setNonFullScreenPageMode(String) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the non full screen page mode preference.
setNonStrokingAlphaConstant(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the non stroking alpha constant.
setNonStrokingColor(Color) - Method in class org.pdfbox.pdfviewer.PageDrawer
Set the non stroking color.
setNonStrokingColor(Color) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as RGB.
setNonStrokingColor(float[]) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the color components of current non stroking colorspace.
setNonStrokingColor(int, int, int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as RGB, 0-255.
setNonStrokingColor(int, int, int, int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as CMYK, 0-255.
setNonStrokingColor(double, double, double, double) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as CMYK, 0.0-1.0.
setNonStrokingColor(int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as grayscale, 0-255.
setNonStrokingColor(double) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as Grayscale 0.0-1.0.
setNonStrokingColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color space.
setNonStrokingColorSpace(PDColorSpaceInstance) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the non-stroking colorspace instance.
setNonStrokingOverprintControl(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control(OP).
setNonSymbolic(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setNormalAppearance(Map) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set a list of appearances.
setNormalAppearance(PDAppearanceStream) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set the normal appearance when there is only one appearance to be shown.
setNumber(long) - Method in class org.pdfbox.pdfwriter.COSWriter
This will set the current object number.
setNumber(long) - Method in class org.pdfbox.persistence.util.COSObjectKey
This will set the objects id.
setNumberOfComponents(int) - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the number of color components.
setNumberOfObjects(int) - Method in class org.pdfbox.pdmodel.common.PDObjectStream
Set the number of objects.
setNumberOfSamples(List) - Method in class org.pdfbox.pdmodel.common.function.PDFunctionType0
Set the samples data, the "Size" entry in the type 0 function.
setO(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will set an action to be performed when the page is opened.
setO(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the string specifying the operation to perform: open to open a document print to print a document If the F entry designates an application instead of a document, this entry is ignored and the application is launched.
setObject(COSBase) - Method in class org.pdfbox.cos.COSObject
This will set the object that this object encapsulates.
setObjectNumber(COSInteger) - Method in class org.pdfbox.cos.COSObject
Setter for property objectNumber.
setOffset(long) - Method in class org.pdfbox.pdfwriter.COSWriterXRefEntry
The offset attribute.
setOnNewLine(boolean) - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will set a flag telling if we are on a newline.
setOpen(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will set inital state of the annotation, open or closed.
setOpen(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will set inital state of the annotation, open or closed.
setOpenAction(PDDestinationOrAction) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the Document Open Action for this object.
setOpenCount(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the open count.
setOpenInNewWindow(boolean) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will specify the destination document to open in a new window.
setOpenInNewWindow(boolean) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will specify the destination document to open in a new window.
setOperation(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the operation to perform..
setOption(String) - Method in class org.pdfbox.pdmodel.fdf.FDFOptionElement
This will set the string for an available option.
setOptions(List) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the options for the choice field.
setOptions(List) - Method in class org.pdfbox.pdmodel.interactive.form.PDChoiceButton
This will will set the list of options for this button.
setOverprint(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the overprint property.
setOverprintMode(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint mode(OPM).
setOverprintMode(double) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the overprint mode property.
setOwnerKey(byte[]) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the O entry in the standard encryption dictionary.
setOwnerKey(byte[]) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will set the O entry in the standard encryption dictionary.
setOwnerPassword(String) - Method in class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Setter of the property ownerPassword.
setP(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set a parameter string to be passed to the application designated by the F entry.
setPC(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation is closed.
setPI(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.
setPO(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation is opened.
setPV(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.
setPage(PDPage) - Method in class org.pdfbox.pdfviewer.PDFPagePanel
This will set the page that should be displayed in this panel.
setPage(int) - Method in class org.pdfbox.pdmodel.fdf.FDFAnnotation
This will set the page.
setPage(PDPage) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Set the page for this destination.
setPage(PDPage) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the page that this bead is part of.
setPageInfo(FDFPageInfo) - Method in class org.pdfbox.pdmodel.fdf.FDFPage
This will set the page info.
setPageLayout(String) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the page layout.
setPageMode(String) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the page mode.
setPageNumber(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Set the page number for this destination.
setPageSeparator(String) - Method in class org.pdfbox.util.PDFTextStripper
Set the desired page separator for output text.
setPages(List) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of pages.
setParent(PDPageNode) - Method in class org.pdfbox.pdmodel.PDPage
This will set the parent of this page.
setParent(PDPageNode) - Method in class org.pdfbox.pdmodel.PDPageNode
This will set the parent of this page.
setParent(PDAnnotationMarkup) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will set the markup annotation which this popup relates to.
setParent(PDOutlineNode) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the parent of this object, this is maintained by these objects and should not be called by any clients of PDFBox code.
setParent(PDField) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
Set the parent of this field.
setPartialFieldName(String) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the partial field name.
setPartialName(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will set the partial name of the field.
setPassword(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the password bit.
setPermission(AccessPermission) - Method in class org.pdfbox.pdmodel.encryption.PublicKeyRecipient
Set the access permission granted to the recipient.
setPermissions(int) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the permissions bit mask.
setPermissions(int) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will set the permissions bit mask.
setPermissions(AccessPermission) - Method in class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Setter of the property permissions.
setPhaseStart(int) - Method in class org.pdfbox.pdmodel.graphics.PDLineDashPattern
This will set the line dash pattern phase.
setPopup(PDAnnotationPopup) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the popup annotation used for entering/editing the text for this annotation.
setPreviousBead(PDThreadBead) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the previous bead in the thread.
setPreviousSibling(PDOutlineNode) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the previous sibling, this will be maintained by this class.
setPreviousURI(PDActionURI) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the previous URI action, in case it needs to be retrieved at later date.
setPrintArea(String) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the PrintArea preference.
setPrintClip(String) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the PrintClip preference.
setPrinted(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the printed flag.
setProducer(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the producer of the document.
setQ(int) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
This will set the quadding/justification of the text.
setQuadPoints(float[]) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the set of quadpoints which encompass the areas of this annotation which will activate.
setQuadPoints(float[]) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will set the set of quadpoints which encompass the areas of this annotation.
setR(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDGamma
This will set the r value of the tristimulus.
setRadiosInUnison(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
From the PDF Spec
If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.
setRangeForComponent(PDRange, int) - Method in class org.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the a range for this color space.
setRangeForOutput(PDRange, int) - Method in class org.pdfbox.pdmodel.common.function.PDDictionaryFunction
This will set the a range for output parameter.
setRangeForOutput(PDRange, int) - Method in class org.pdfbox.pdmodel.common.function.PDFunction
This will set the a range for output parameter.
setRangeForOutput(PDRange, int) - Method in class org.pdfbox.pdmodel.common.function.PDStreamFunction
This will set the a range for output parameter.
setReadOnly() - Method in class org.pdfbox.pdmodel.encryption.AccessPermission
Locks the access permission read only (ie, the setters will have no effects).
setReadOnly(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the readOnly flag.
setReadingDirection(String) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the reading direction preference.
setReadonly(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
sets the field to be read-only.
setRecipients(byte[][]) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the Recipients field of the dictionary.
setRectDifference(PDRectangle) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the rectangle difference rectangle.
setRectangle(PDRectangle) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the rectangle for this annotation.
setRectangle(PDRectangle) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the rectangle on the page that this bead covers.
setRename(boolean) - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
This will set if the fields can be renamed.
setRenderingIntent(String) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the rendering intent for the graphics state.
setRenderingIntent(String) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the rendering intent.
setRenderingMode(int) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the renderingMode.
setReplyType(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
setRequired(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
sets the field to be required.
setResources(PDResources) - Method in class org.pdfbox.pdmodel.PDPage
This will set the resources for this page.
setResources(PDResources) - Method in class org.pdfbox.pdmodel.PDPageNode
This will set the resources for this page.
setResources(PDResources) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will set the resources for this page.
setResources(PDResources) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will set the new resources.
setRevision(int) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the R entry of the encryption dictionary.
setRevision(int) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will set the R entry of the encryption dictionary.
setRichContents(PDTextStream) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the rich text stream which is displayed in the popup window.
setRichText(PDTextStream) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will set the rich text value.
setRichText(boolean) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
Set the richText bit.
setRight(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the right x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setRise(float) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the rise.
setRolloverAppearance(Map) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set a list of appearances.
setRotation(int) - Method in class org.pdfbox.pdmodel.PDPage
This will set the rotation for this page.
setRotation(int) - Method in class org.pdfbox.pdmodel.PDPageNode
This will set the rotation for this page.
setS(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will set the type of action that the actions dictionary describes.
setS(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will set the type of action that the actions dictionary describes.
setScaleOption(String) - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will set the scale option for the icon.
setScaleToFitAnnotation(boolean) - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will tell the icon to scale.
setScaleType(String) - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will set the scale type.
setScript(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSerif(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSetFieldFlags(Integer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setSetFieldFlags(int) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setSetWidgetFieldFlags(Integer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the widget field flags that are associated with this field.
setSetWidgetFieldFlags(int) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the widget field flags that are associated with this field.
setShouldSeparateByBeads(boolean) - Method in class org.pdfbox.util.PDFTextStripper
Set if the text stripper should group the text output by a list of beads.
setSignature(PDSignature) - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will set the signature that is associated with this catalog.
setSize(int) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the size of the embedded file.
setSmallCap(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSmoothness(double) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the smoothness property.
setSmoothnessTolerance(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the smoothness tolerance.
setSortByPosition(boolean) - Method in class org.pdfbox.util.PDFTextStripper
The order of the text tokens in a PDF file may not be in the same as they appear visually on the screen.
setSplitAtPage(int) - Method in class org.pdfbox.util.Splitter
This will tell the splitting algorithm where to split the pages.
setStartBookmark(PDOutlineItem) - Method in class org.pdfbox.util.PDFTextStripper
Set the bookmark where text extraction should start, inclusive.
setStartPage(int) - Method in class org.pdfbox.util.PDFTextStripper
This will set the first page to be extracted by this class.
setStartPointEndingStyle(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the line ending style for the start point, see the LE_ constants for the possible values.
setStartxref(long) - Method in class org.pdfbox.pdfwriter.COSWriter
This will set the start xref.
setStatus(String) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the status string.
setStemH(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the stem H for the font.
setStemH(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the stem H for the font.
setStemH(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the stem H for the font.
setStemV(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the stem V for the font.
setStemV(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the stem V for the font.
setStemV(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the stem V for the font.
setStream(PDTextStream) - Method in class org.pdfbox.pdmodel.common.PDNamedTextStream
This will set the stream.
setString(int, String) - Method in class org.pdfbox.cos.COSArray
Set the value in the array as a string.
setString(String, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setString(COSName, String) - Method in class org.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setStrokeAdjustment(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the stroke adjustment.
setStrokingAlphaConstant(Float) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the stroking alpha constant.
setStrokingColor(Color) - Method in class org.pdfbox.pdfviewer.PageDrawer
Set the stroking color.
setStrokingColor(float[]) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the color components of current stroking colorspace.
setStrokingColor(Color) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as RGB.
setStrokingColor(int, int, int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as RGB, 0-255.
setStrokingColor(int, int, int, int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as CMYK, 0-255.
setStrokingColor(double, double, double, double) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as CMYK, 0.0-1.0.
setStrokingColor(int) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as grayscale, 0-255.
setStrokingColor(double) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as Grayscale 0.0-1.0.
setStrokingColorSpace(PDColorSpace) - Method in class org.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color space.
setStrokingColorSpace(PDColorSpaceInstance) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the current stroking colorspace.
setStrokingOverprintControl(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control(OP).
setStructureTreeRoot(PDStructureTreeRoot) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the document's structure tree root.
setStructuredElement(PDStructureElement) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the structure element for this node.
setStyle(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will set the border effect, see the STYLE_* constants for valid values.
setStyle(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the border style, see the STYLE_* constants for valid values.
setSubFilter(String) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Set the subfilter entry of the encryption dictionary.
setSubType(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
This will set the type of action that the actions dictionary describes.
setSubject(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the subject of the document.
setSubject(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the short description of the subject of the annotation.
setSubtype(String) - Method in class org.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the subtype for this embedded file.
setSubtype(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the sub type (and hence appearance, AP taking precedence) For this annotation.
setSubtype(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will set the sub type (and hence appearance, AP taking precedence) For this annotation.
setSuppressDuplicateOverlappingText(boolean) - Method in class org.pdfbox.util.PDFTextStripper
By default the text stripper will attempt to remove text that overlapps each other.
setSuppressParagraphs(boolean) - Method in class org.pdfbox.util.PDFText2HTML
 
setSuspect(boolean) - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Set the value of the suspects property.
setSymbolic(boolean) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setTarget(String) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will set the target frame in the browser to open this document.
setTempDirectory(File) - Method in class org.pdfbox.pdfparser.PDFParser
This is the directory where pdfbox will create a temporary file for storing pdf document stream in.
setTemplateReference(FDFNamedPageReference) - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
This will set the template reference.
setTemplates(List) - Method in class org.pdfbox.pdmodel.fdf.FDFPage
A list of FDFTemplate objects.
setTerminator(char) - Method in class org.pdfbox.io.ASCII85OutputStream
This will set the terminating character.
setTextColor(PDColorSpaceInstance) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the text color for this node.
setTextColor(Color) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the text color for this node.
setTextKnockoutFlag(boolean) - Method in class org.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the text knockout flag.
setTextLineMatrix(Matrix) - Method in class org.pdfbox.util.PDFStreamEngine
 
setTextMatrix(Matrix) - Method in class org.pdfbox.util.PDFStreamEngine
 
setTextState(PDTextState) - Method in class org.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the graphics text state.
setTextStripper(PDFTextStripper) - Method in class org.pdfbox.searchengine.lucene.LucenePDFDocument
Set the text stripper that will be used during extraction.
setThread(PDThread) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the thread that this bead is part of.
setThreadBeads(List) - Method in class org.pdfbox.pdmodel.PDPage
This will set the list of thread beads.
setThreadInfo(PDDocumentInformation) - Method in class org.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Set the thread info, can be null.
setThreads(List) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the list of threads for this pdf document.
setTintTransform(COSBase) - Method in class org.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the tint transform function.
setTintTransform(PDFunction) - Method in class org.pdfbox.pdmodel.graphics.color.PDSeparation
This will set the tint transform function.
setTitle(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the title of the document.
setTitle(String) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the title for this node.
setTitlePopup(String) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Set the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
setToUnicode(PDStream) - Method in class org.pdfbox.pdmodel.font.PDSimpleFont
This will set the ToUnicode stream.
setToggleNoView(boolean) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the toggleNoView flag.
setTop(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setTop(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setTop(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setTrackMousePosition(boolean) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will specify whether to track the mouse position when the URI is resolved.
setTrailer(COSDictionary) - Method in class org.pdfbox.cos.COSDocument
// MIT added, maybe this should not be supported as trailer is a persistence construct.
setTrapped(String) - Method in class org.pdfbox.pdmodel.PDDocumentInformation
This will set the trapped of the document.
setTrimBox(PDRectangle) - Method in class org.pdfbox.pdmodel.PDPage
This will set the TrimBox for this page.
setType(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDAction
This will set the type of PDF object that the actions dictionary describes.
setU(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the mouse button is released inside the annotation's active area.
setURI(PDActionURI) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the document level uri.
setURI(String) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.
setUpperRightX(float) - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will set the upper right x coordinate.
setUpperRightY(float) - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will set the upper right y coordinate.
setUserKey(byte[]) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the U entry in the standard encryption dictionary.
setUserKey(byte[]) - Method in class org.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will set the U entry in the standard encryption dictionary.
setUserPassword(String) - Method in class org.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Setter of the property userPassword.
setUserProperties(boolean) - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Set if the structure elements contain user properties.
setV(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed when the field's value is changed.
setValue(float) - Method in class org.pdfbox.cos.COSFloat
Set the value of the float object.
setValue(long) - Method in class org.pdfbox.cos.COSInteger
Change the value of this reference.
setValue(Object) - Method in class org.pdfbox.pdfviewer.ArrayEntry
This will set the value for this entry.
setValue(Object) - Method in class org.pdfbox.pdfviewer.MapEntry
This will set the value for this entry.
setValue(int, int, float) - Method in class org.pdfbox.pdmodel.common.PDMatrix
This will set a value at a position.
setValue(Object) - Method in class org.pdfbox.pdmodel.fdf.FDFField
You should pass in a string, or a java.util.List of strings to set the value.
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
setValue sets the fields value to a given string.
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDChoiceField
 
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDField
setValue sets the fields value to a given string.
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDPushButton
 
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDRadioCollection
This setValue method iterates the collection of radiobuttons and checks or unchecks each radiobutton according to the given value.
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDSignature
 
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDUnknownField
setValue sets the fields value to a given string.
setValue(String) - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
setValue(int, int, float) - Method in class org.pdfbox.util.Matrix
This will set a value at a position.
setVersion(float) - Method in class org.pdfbox.cos.COSDocument
This will set the version of this PDF document.
setVersion(int) - Method in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the V entry of the encryption dictionary.
setVersion(String) - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will set the version of the FDF document.
setViewArea(String) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the ViewArea preference.
setViewClip(String) - Method in class org.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the ViewClip preference.
setViewerPreferences(PDViewerPreferences) - Method in class org.pdfbox.pdmodel.PDDocumentCatalog
Set the viewer preferences.
setVolatile(boolean) - Method in class org.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Tell if the underlying file is volatile and should not be cached by the reader application.
setWC(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed before closing a document.
setWP(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed before printing a document.
setWS(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed before saving a document.
setWhitepoint(PDTristimulus) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalGray
This will set the whitepoint tristimulus.
setWhitepoint(PDTristimulus) - Method in class org.pdfbox.pdmodel.graphics.color.PDCalRGB
This will set the whitepoint tristimulus.
setWhitepoint(PDTristimulus) - Method in class org.pdfbox.pdmodel.graphics.color.PDLab
This will set the whitepoint tristimulus.
setWidgetFieldFlags(Integer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the widget field flags that are associated with this field.
setWidgetFieldFlags(int) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setWidth(int) - Method in class org.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
setWidth(int) - Method in class org.pdfbox.pdmodel.graphics.predictor.Uptimum
setWidth(int) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the width of the image.
setWidth(float) - Method in class org.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the border width in points, 0 = no border.
setWidth(int) - Method in class org.pdfbox.util.ImageParameters
Set the width of the image.
setWidths(List) - Method in class org.pdfbox.pdmodel.font.PDFont
Set the widths of the characters code.
setWinLaunchParams(PDWindowsLaunchParams) - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set a dictionary containing Windows-specific launch parameters.
setWordSeparator(String) - Method in class org.pdfbox.util.PDFTextStripper
Set the desired word separator for output text.
setWordSpacing(float) - Method in class org.pdfbox.pdmodel.text.PDTextState
Set the value of the wordSpacing.
setX(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
This will set the x value of the tristimulus.
setX(PDAction) - Method in class org.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the cursor exits the annotation's active area.
setX509(X509Certificate) - Method in class org.pdfbox.pdmodel.encryption.PublicKeyRecipient
Set the X509 certificate of the recipient.
setXFA(PDXFA) - Method in class org.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the XFA resource, this is only used for PDF 1.5+ forms.
setXHeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptor
This will set the x height for the font.
setXHeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the x height for the font.
setXHeight(float) - Method in class org.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the x height for the font.
setXScale(float) - Method in class org.pdfbox.util.TextPosition
 
setY(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
This will set the y value of the tristimulus.
setYScale(float) - Method in class org.pdfbox.util.TextPosition
 
setZ(float) - Method in class org.pdfbox.pdmodel.graphics.color.PDTristimulus
This will set the z value of the tristimulus.
setZoom(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Set the zoom value for the page, a value of -1 implies that the current zoom will be used.
shouldComb() - Method in class org.pdfbox.pdmodel.interactive.form.PDVariableText
 
shouldOpenInNewWindow() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will specify whether to open the destination document in a new window.
shouldOpenInNewWindow() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will specify whether to open the destination document in a new window.
shouldRename() - Method in class org.pdfbox.pdmodel.fdf.FDFTemplate
A flag telling if the fields imported from the template may be renamed if there are conflicts.
shouldScaleToFitAnnotation() - Method in class org.pdfbox.pdmodel.fdf.FDFIconFit
This will tell if the icon should scale to fit the annotation bounds.
shouldSeparateByBeads() - Method in class org.pdfbox.util.PDFTextStripper
This will tell if the text stripper should separate by beads.
shouldSortByPosition() - Method in class org.pdfbox.util.PDFTextStripper
This will tell if the text stripper should sort the text tokens before writing to the stream.
shouldSuppressDuplicateOverlappingText() - Method in class org.pdfbox.util.PDFTextStripper
 
shouldTrackMousePosition() - Method in class org.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will specify whether to track the mouse position when the URI is resolved.
showCharacter(TextPosition) - Method in class org.pdfbox.examples.util.PrintTextLocations
A method provided as an event interface to allow a subclass to perform some specific functionality when a character needs to be displayed.
showCharacter(TextPosition) - Method in class org.pdfbox.pdfviewer.PageDrawer
You should override this method if you want to perform an action when a string is being shown.
showCharacter(TextPosition) - Method in class org.pdfbox.util.PDFStreamEngine
A method provided as an event interface to allow a subclass to perform some specific functionality when a character needs to be displayed.
showCharacter(TextPosition) - Method in class org.pdfbox.util.PDFTextStripper
This will show add a character to the list of characters to be printed to the text file.
showCharacter(TextPosition) - Method in class org.pdfbox.util.PDFTextStripperByArea
This will show add a character to the list of characters to be printed to the text file.
showString(byte[]) - Method in class org.pdfbox.util.PDFStreamEngine
You should override this method if you want to perform an action when a string is being shown.
silentPrint() - Method in class org.pdfbox.pdmodel.PDDocument
This will send the PDF to the default printer without prompting the user for any printer settings.
size() - Method in class org.pdfbox.cos.COSArray
This will get the size of this array.
size() - Method in class org.pdfbox.cos.COSDictionary
This will return the number of elements in this dictionary.
size() - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Totally available bytes in the underlying array.
size() - Method in class org.pdfbox.pdmodel.common.COSArrayList
size() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
skip(long) - Method in class org.pdfbox.io.ASCII85InputStream
Unsupported.
skip(long) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Skips over and discards n bytes of data from this input stream.
skip(long) - Method in class org.pdfbox.io.RandomAccessFileInputStream
skipHeaderFillBytes() - Method in class org.pdfbox.pdfparser.PDFParser
This will skip a header's binary fill bytes.
skipSpaces() - Method in class org.pdfbox.pdfparser.BaseParser
This will skip all spaces and comments that are present.
split(PDDocument) - Method in class org.pdfbox.util.Splitter
This will take a document and split into several other documents.
startDocument(PDDocument) - Method in class org.pdfbox.util.PDFTextStripper
This method is available for subclasses of this class.
startPage(PDPage) - Method in class org.pdfbox.util.PDFTextStripper
Start a new page.
startParagraph() - Method in class org.pdfbox.util.PDFText2HTML
Write out the paragraph separator.
startParagraph() - Method in class org.pdfbox.util.PDFTextStripper
Start a new paragraph.
subList(int, int) - Method in class org.pdfbox.pdmodel.common.COSArrayList

T

TABLE - Static variable in class org.pdfbox.persistence.util.COSHEXTable
ASCII byte values for the hex strings.
TIMES_BOLD - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TIMES_BOLD_ITALIC - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TIMES_ITALIC - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TIMES_ROMAN - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TO_UNICODE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
TRAILER - Static variable in class org.pdfbox.pdfwriter.COSWriter
The trailer token.
TRIM_BOX - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
TRUE - Static variable in class org.pdfbox.cos.COSBoolean
The PDF true value.
TRUE_BYTES - Static variable in class org.pdfbox.cos.COSBoolean
The true boolean token.
TRUE_TYPE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
TYPE - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
TYPE - Static variable in class org.pdfbox.pdmodel.interactive.action.type.PDAction
The type of PDF object.
TYPE - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
The type of this destination.
TYPE - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
The type of this destination.
TYPE - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
The type of this destination.
TYPE - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
The type of this destination.
TYPE - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
The type of this destination.
TYPE0 - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
TYPE_BOUNDED - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
The type of this destination.
TYPE_BOUNDED - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
The type of this destination.
TYPE_BOUNDED - Static variable in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
The type of this destination.
TextPosition - class org.pdfbox.util.TextPosition.
This represents a character and a position on the screen of those characters.
TextPosition(float, float, float, float, float, float, float, String, PDFont, float, float) - Constructor for class org.pdfbox.util.TextPosition
Constructor.
TextPositionComparator - class org.pdfbox.util.TextPositionComparator.
This class is a comparator for TextPosition operators.
TextPositionComparator(PDPage) - Constructor for class org.pdfbox.util.TextPositionComparator
Constuctor, comparison of TextPosition depends on the rotation of the page.
TextToPDF - class org.pdfbox.TextToPDF.
This will take a text file and ouput a pdf with that text.
TextToPDF() - Constructor for class org.pdfbox.TextToPDF
 
Type3StreamParser - class org.pdfbox.pdmodel.font.Type3StreamParser.
This class will handle creating an image for a type 3 glyph.
Type3StreamParser() - Constructor for class org.pdfbox.pdmodel.font.Type3StreamParser
 
toArray() - Method in class org.pdfbox.pdmodel.common.COSArrayList
toArray(Object[]) - Method in class org.pdfbox.pdmodel.common.COSArrayList
toCalendar(COSString) - Static method in class org.pdfbox.util.DateConverter
This will convert a string to a calendar.
toCalendar(String) - Static method in class org.pdfbox.util.DateConverter
This will convert a string to a calendar.
toFloatArray() - Method in class org.pdfbox.cos.COSArray
This will take an COSArray of numbers and convert it to a float[].
toISO8601(Calendar) - Static method in class org.pdfbox.util.DateConverter
Convert the date to iso 8601 string format.
toString() - Method in class org.pdfbox.cos.COSArray
toString() - Method in class org.pdfbox.cos.COSBoolean
Return a string representation of this object.
toString() - Method in class org.pdfbox.cos.COSFloat
toString() - Method in class org.pdfbox.cos.COSInteger
toString() - Method in class org.pdfbox.cos.COSName
toString() - Method in class org.pdfbox.cos.COSObject
toString() - Method in class org.pdfbox.cos.COSString
toString() - Method in class org.pdfbox.pdfviewer.MapEntry
This will output a string representation of this class.
toString() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
toString() - Method in class org.pdfbox.pdmodel.common.COSStreamArray
toString() - Method in class org.pdfbox.pdmodel.common.PDRectangle
This will return a string representation of this rectangle.
toString() - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
Return a string representation of this class.
toString() - Method in class org.pdfbox.pdmodel.interactive.form.PDField
This will return a string representation of this field.
toString() - Method in class org.pdfbox.pdmodel.interactive.form.PDSignature
Return a string rep of this object.
toString() - Method in class org.pdfbox.persistence.util.COSObjectKey
toString(Calendar) - Static method in class org.pdfbox.util.DateConverter
This will convert the calendar to a string.
toString() - Method in class org.pdfbox.util.Matrix
This will return a string representation of the matrix.
toString() - Method in class org.pdfbox.util.PDFOperator
This will print a string rep of this class.

U

UNKNOWN_FONT - Static variable in class org.pdfbox.pdmodel.font.PDTrueTypeFont
This is the key to a property in the Resources/PDFBox_External_Fonts.properties file to load a Font when a mapping does not exist for the current font.
Up - class org.pdfbox.pdmodel.graphics.predictor.Up.
The up algorithm.
Up() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.Up
 
Uptimum - class org.pdfbox.pdmodel.graphics.predictor.Uptimum.
In an Uptimum encoded image, each line takes up width*bpp+1 bytes.
Uptimum() - Constructor for class org.pdfbox.pdmodel.graphics.predictor.Uptimum
 
unCheck() - Method in class org.pdfbox.pdmodel.interactive.form.PDCheckbox
Unchecks the radiobutton.
unread(int) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Pushes back a byte.
unread(byte[], int, int) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Pushes back a portion of an array of bytes by copying it to the front of the pushback buffer.
unread(byte[]) - Method in class org.pdfbox.io.ByteArrayPushBackInputStream
Pushes back a portion of an array of bytes by copying it to the front of the pushback buffer.
unread(long) - Method in class org.pdfbox.io.NBitInputStream
This will unread some data.
updateCount() - Method in class org.pdfbox.pdmodel.PDPageNode
This will update the count attribute of the page node.
updateLastModified() - Method in class org.pdfbox.pdmodel.PDPage
This will update the last modified time for the page object.
updateParentOpenCount(int) - Method in class org.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
The count parameter needs to be updated when you add or remove elements to the outline.
usesUserProperties() - Method in class org.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Tells if structure elements use user properties.

V

V - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
VERSION - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
VERSION - Static variable in class org.pdfbox.pdfwriter.COSWriter
The output version of the PDF.
VERSION0_UNDOCUMENTED_UNSUPPORTED - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION1_40_BIT_ALGORITHM - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION2_VARIABLE_LENGTH_ALGORITHM - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION3_UNPUBLISHED_ALGORITHM - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION4_SECURITY_HANDLER - Static variable in class org.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
Version - class org.pdfbox.Version.
A simple command line utility to get the version of PDFBox.
valueForPathChanged(TreePath, Object) - Method in class org.pdfbox.pdfviewer.PDFTreeModel
Messaged when the user has altered the value for the item identified by path to newValue.
values() - Method in class org.pdfbox.pdmodel.common.COSDictionaryMap
version - Variable in class org.pdfbox.pdmodel.encryption.SecurityHandler
The value of V field of the Encryption dictionary.
visitFromArray(COSArray) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to Array object.
visitFromArray(COSArray) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromArray method comment.
visitFromBoolean(COSBoolean) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to boolean object.
visitFromBoolean(COSBoolean) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromBoolean method comment.
visitFromDictionary(COSDictionary) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to dictionary object.
visitFromDictionary(COSDictionary) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromDictionary method comment.
visitFromDocument(COSDocument) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to document object.
visitFromDocument(COSDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
The visit from document method.
visitFromFloat(COSFloat) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to float object.
visitFromFloat(COSFloat) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromFloat method comment.
visitFromInt(COSInteger) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to integer object.
visitFromInt(COSInteger) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromFloat method comment.
visitFromName(COSName) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to name object.
visitFromName(COSName) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromName method comment.
visitFromNull(COSNull) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to null object.
visitFromNull(COSNull) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromNull method comment.
visitFromStream(COSStream) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to stream object.
visitFromStream(COSStream) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromStream method comment.
visitFromString(COSString) - Method in interface org.pdfbox.cos.ICOSVisitor
Notification of visit to string object.
visitFromString(COSString) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromString method comment.

W

WIDTHS - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
WIN_ANSI_ENCODING - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
WinAnsiEncoding - class org.pdfbox.encoding.WinAnsiEncoding.
This the win ansi encoding.
WinAnsiEncoding() - Constructor for class org.pdfbox.encoding.WinAnsiEncoding
Constructor.
WrappedException - exception org.pdfbox.exceptions.WrappedException.
An exception that that holds a sub exception.
WrappedException(Exception) - Constructor for class org.pdfbox.exceptions.WrappedException
constructor comment.
WrappedIOException - exception org.pdfbox.exceptions.WrappedIOException.
An exception that that holds a sub exception.
WrappedIOException(Throwable) - Constructor for class org.pdfbox.exceptions.WrappedIOException
constructor comment.
WriteDecodedDoc - class org.pdfbox.examples.persistence.WriteDecodedDoc.
load document and write with all streams decoded.
WriteDecodedDoc() - Constructor for class org.pdfbox.examples.persistence.WriteDecodedDoc
Constructor.
wasDecryptedWithOwnerPassword() - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated. use getCurrentAccessPermission instead
willEncryptWhenSaving() - Method in class org.pdfbox.pdmodel.PDDocument
Deprecated. Do not rely on this method anymore. It is the responsibility of COSWriter to hold this state
write(byte, OutputStream) - Method in class org.pdfbox.encryption.ARCFour
This will encrypt and write the next byte.
write(byte[], OutputStream) - Method in class org.pdfbox.encryption.ARCFour
This will encrypt and write the data.
write(InputStream, OutputStream) - Method in class org.pdfbox.encryption.ARCFour
This will encrypt and write the data.
write(byte[], int, int, OutputStream) - Method in class org.pdfbox.encryption.ARCFour
This will encrypt and write the data.
write(int) - Method in class org.pdfbox.io.ASCII85OutputStream
This will write a single byte.
write(byte[], int, int) - Method in class org.pdfbox.io.ASCII85OutputStream
This will write a chunk of data to the stream.
write(long) - Method in class org.pdfbox.io.NBitOutputStream
This will write the next n-bits to the stream.
write(int) - Method in interface org.pdfbox.io.RandomAccess
Write a byte to the stream.
write(byte[], int, int) - Method in interface org.pdfbox.io.RandomAccess
Write a buffer of data to the stream.
write(int) - Method in class org.pdfbox.io.RandomAccessBuffer
Write a byte to the stream.
write(byte[], int, int) - Method in class org.pdfbox.io.RandomAccessBuffer
Write a buffer of data to the stream.
write(byte[], int, int) - Method in class org.pdfbox.io.RandomAccessFile
Write a buffer of data to the stream.
write(int) - Method in class org.pdfbox.io.RandomAccessFile
Write a byte to the stream.
write(byte[], int, int) - Method in class org.pdfbox.io.RandomAccessFileOutputStream
write(int) - Method in class org.pdfbox.io.RandomAccessFileOutputStream
write(byte[], int, int) - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will write some byte to the stream.
write(int) - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will write a single byte to the stream.
write(COSDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
This will write the pdf document.
write(PDDocument) - Method in class org.pdfbox.pdfwriter.COSWriter
This will write the pdf document.
write2OutputStream(OutputStream) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDCcitt
This writes a tiff to out.
write2OutputStream(OutputStream) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDJpeg
This writes the JPeg to out.
write2OutputStream(OutputStream) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Writes the image as .png.
write2OutputStream(OutputStream) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Writes the Image to out.
write2file(String) - Method in class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg".
writeCRLF() - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will write a CRLF to the stream.
writeCharacters(TextPosition) - Method in class org.pdfbox.util.PDFText2HTML
Write the string to the output stream.
writeCharacters(TextPosition) - Method in class org.pdfbox.util.PDFTextStripper
Write the string to the output stream.
writeEOL() - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will write an EOL to the stream.
writeHeader() - Method in class org.pdfbox.util.PDFText2HTML
Write the header to the output document.
writeLF() - Method in class org.pdfbox.pdfwriter.COSStandardOutputStream
This will write a Linefeed to the stream.
writePDF(OutputStream) - Method in class org.pdfbox.cos.COSBoolean
This will write this object out to a PDF stream.
writePDF(OutputStream) - Method in class org.pdfbox.cos.COSFloat
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.pdfbox.cos.COSInteger
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.pdfbox.cos.COSName
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.pdfbox.cos.COSNull
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.pdfbox.cos.COSString
This will output this string as a PDF object.
writeReference(COSBase) - Method in class org.pdfbox.pdfwriter.COSWriter
visitFromObjRef method comment.
writeTagCompression(OutputStream, int) - Method in class org.pdfbox.filter.CCITTFaxDecodeFilter
Write the tag compression.
writeText(COSDocument, Writer) - Method in class org.pdfbox.util.PDFTextStripper
Deprecated.  
writeText(PDDocument, Writer) - Method in class org.pdfbox.util.PDFTextStripper
This will take a PDDocument and write the text of that document to the print writer.
writeTokens(List, int, int) - Method in class org.pdfbox.pdfwriter.ContentStreamWriter
This will write out the list of tokens to the stream.
writeTokens(List) - Method in class org.pdfbox.pdfwriter.ContentStreamWriter
This will write out the list of tokens to the stream.
writeXML(Writer) - Method in class org.pdfbox.pdmodel.fdf.FDFCatalog
This will write this element as an XML document.
writeXML(Writer) - Method in class org.pdfbox.pdmodel.fdf.FDFDictionary
This will write this element as an XML document.
writeXML(Writer) - Method in class org.pdfbox.pdmodel.fdf.FDFDocument
This will write this element as an XML document.
writeXML(Writer) - Method in class org.pdfbox.pdmodel.fdf.FDFField
This will write this element as an XML document.

X

XMLUtil - class org.pdfbox.util.XMLUtil.
This class with handle some simple XML operations.
XOBJECT - Static variable in class org.pdfbox.Overlay
COSName constant.
XOBJECT - Static variable in class org.pdfbox.cos.COSName
A common COSName value.
XREF - Static variable in class org.pdfbox.pdfwriter.COSWriter
The XREF token.
XREF_FREE - Static variable in class org.pdfbox.pdfwriter.COSWriter
The xref free token.
XREF_USED - Static variable in class org.pdfbox.pdfwriter.COSWriter
The xref used token.

Z

ZAPF_DINGBATS - Static variable in class org.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
ZERO - Static variable in class org.pdfbox.cos.COSNumber
ZERO.

A B C D E F G H I J K L M N O P Q R S T U V W X Z