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

A

A - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
AA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ABBREVIATED_NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
The abbreviated name of this color space.
ABBREVIATED_NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
The abbreviated name of this color space.
ABBREVIATED_NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
The abbreviated name of this color space.
ABBREVIATED_NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
The abbreviated name of this color space.
aboveLeftPixel(byte[], int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the above-left pixel from the buffer.
abovePixel(byte[], int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the above pixel from the buffer.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSArray
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSBase
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSBoolean
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSDictionary
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSDocument
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSFloat
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSInteger
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSName
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSNull
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSObject
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSStream
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSString
visitor pattern double dispatch method.
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSUnread
 
accept(ICOSVisitor) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
visitor pattern double dispatch method.
accept(File) - Method in class org.apache.pdfbox.util.ExtensionFileFilter
AccessPermission - Class in org.apache.pdfbox.pdmodel.encryption
This class represents the access permissions to a document.
AccessPermission() - Constructor for class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Create a new access permission object.
AccessPermission(byte[]) - Constructor for class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Create a new access permission object from a byte array.
AccessPermission(int) - Constructor for class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Creates a new access permission object from a single integer.
ACRO_FORM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
action - Variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
The action dictionary.
ACTUAL_TEXT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ADBE_PKCS7_DETACHED - Static variable in class org.apache.pdfbox.cos.COSName
A signature subfilter value.
ADBE_PKCS7_SHA1 - Static variable in class org.apache.pdfbox.cos.COSName
A signature subfilter value.
ADBE_X509_RSA_SHA1 - Static variable in class org.apache.pdfbox.cos.COSName
A signature subfilter value.
add(COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will add an object to the array.
add(COSObjectable) - Method in class org.apache.pdfbox.cos.COSArray
This will add an object to the array.
add(int, COSBase) - Method in class org.apache.pdfbox.cos.COSArray
Add the specified object at the ith location and push the rest to the right.
add(E) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
add(int, E) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
addAll(Collection<COSBase>) - Method in class org.apache.pdfbox.cos.COSArray
This will add an object to the array.
addAll(COSArray) - Method in class org.apache.pdfbox.cos.COSArray
This will add all objects to this array.
addAll(int, Collection<COSBase>) - Method in class org.apache.pdfbox.cos.COSArray
Add the specified object at the ith location and push the rest to the right.
addAll(COSDictionary) - Method in class org.apache.pdfbox.cos.COSDictionary
This will add all of the dictionarys keys/values to this dictionary.
addAll(Collection<? extends E>) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
addAll(int, Collection<? extends E>) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
addAttribute(PDAttributeObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Adds an attribute object.
addBezier31(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Append a cubic Bézier curve to the current path.
addBezier312(float, float, float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Append a cubic Bézier curve to the current path.
addBezier32(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Append a cubic Bézier curve to the current path.
addBoolean(boolean) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Adds a bool value.
addCharacterEncoding(int, String) - Method in class org.apache.pdfbox.encoding.Encoding
This will add a character encoding.
addClassName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Adds a class name.
addCompression() - Method in class org.apache.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.apache.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.
addEntry(COSWriterXRefEntry) - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Add an new entry to the XRef stream.
addFilter(COSName, Filter) - Method in class org.apache.pdfbox.filter.FilterManager
This will add an available filter.
addFont(PDFont) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given font to the resources of the current page.
addFont(PDFont, String) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given font to the resources of the current page using the given font key.
addGroup(PDOptionalContentGroup) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Adds an optional content group (OCG).
addInteger(int) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Adds an int value.
addLine(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
add a line to the current path.
addMarkedContent(PDMarkedContent) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Adds a marked content to the contents.
addName(String) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Add a name (ex. an operator)
addObject(T, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Adds an object with a specified revision number.
addOutputIntent(PDOutputIntent) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Add an OutputIntent to the list.
addPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will add a page to the document.
addPolygon(float[], float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Add a polygon to the current path.
addProc(InstructionSequence) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Adds a proc (sub-sequence of instructions).
addReal(float) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Adds a real value.
addRecipient(PublicKeyRecipient) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Adds a new recipient to the recipients list.
addRect(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Add a rectangle to the current path.
addRegion(String, Rectangle2D) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
Add a new region to group text by.
addSignature(PDSignature, SignatureInterface) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Add a signature.
addSignature(PDSignature, SignatureInterface, SignatureOptions) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will add a signature to the document.
addSignatureField(List<PDSignatureField>, SignatureInterface, SignatureOptions) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will add a signaturefield to the document.
addSource(String) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Add a source file to the list of files to merge.
addSource(File) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Add a source file to the list of files to merge.
addSource(InputStream) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Add a source to the list of documents to merge.
addSources(List<InputStream>) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Add a list of sources to the list of documents to merge.
addText(TextPosition) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Adds a text position to the contents.
addTrailerInfo(COSDictionary) - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Copy all Trailer Information to this file.
addTreeModelListener(TreeModelListener) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Adds a listener for the TreeModelEvent posted after the tree changes.
addUserProperty(PDUserProperty) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Adds a user property.
addXObject(PDXObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Adds an XObject to the contents.
addXObject(PDXObject, String) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given XObject to the resources of the current the page.
addXRefEntry(COSWriterXRefEntry) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
add an entry in the x ref table for later dump.
addXRefTable(Map<COSObjectKey, Long>) - Method in class org.apache.pdfbox.cos.COSDocument
Populate XRef HashMap with given values.
adjustTimeZoneNicely(GregorianCalendar, TimeZone) - Static method in class org.apache.pdfbox.util.DateConverter
Install a TimeZone on a GregorianCalendar without changing the hours value.
ADOBE_PPKLITE - Static variable in class org.apache.pdfbox.cos.COSName
A signature filter value.
affineTransformParams(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
AFMEncoding - Class in org.apache.pdfbox.encoding
This will handle the encoding from an AFM font.
AFMEncoding(FontMetric) - Constructor for class org.apache.pdfbox.encoding.AFMEncoding
Constructor.
AIS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ALT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ALTERNATE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ANNOT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ANNOT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Annot
annot - Variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Annotation dictionary.
ANNOTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ANTI_ALIAS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
AP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
AP_REF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
APP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
append(byte[]) - Method in class org.apache.pdfbox.cos.COSString
This will append a byte[] to the string.
append(int) - Method in class org.apache.pdfbox.cos.COSString
This will append a byte to the string.
appendBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Append a bead after this bead.
appendChild(PDOutlineItem) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
append a child node to this node.
appendCOSName(COSName) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will append a COSName to the content stream.
appendDocument(PDDocument, PDDocument) - Method in class org.apache.pdfbox.util.PDFMergerUtility
append all pages from source to destination.
appendFormAsLayer(PDPage, PDXObjectForm, AffineTransform, String) - Method in class org.apache.pdfbox.util.LayerUtility
Places the given form over the existing content of the indicated page (like an overlay).
appendKid(PDMarkedContent) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Appends a marked-content sequence kid.
appendKid(PDMarkedContentReference) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Appends a marked-content reference kid.
appendKid(PDObjectReference) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Appends an object reference kid.
appendKid(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Appends a structure element kid.
appendKid(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Appends a COS base kid.
appendObjectableKid(COSObjectable) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Appends an objectable kid.
appendRawCommands(String) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(byte[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will append raw commands to the content stream.
appendRawCommands(OutputStream, String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
AppendRectangleToPath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
AppendRectangleToPath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.AppendRectangleToPath
 
appendStream(COSStream) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
Appends a new stream to the array that represents this object's stream.
applyMasks(BufferedImage) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
 
ARCFour - Class in org.apache.pdfbox.encryption
This class is an implementation of the alleged RC4 algorithm.
ARCFour() - Constructor for class org.apache.pdfbox.encryption.ARCFour
Constructor.
array - Variable in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
array for the given parameters.
array - Variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Storage for the page destination.
ARRAY_CLOSE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The array close token.
ARRAY_OPEN - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The array open token.
ArrayEntry - Class in org.apache.pdfbox.pdfviewer
This is a simple class that will contain an index and a value.
ArrayEntry() - Constructor for class org.apache.pdfbox.pdfviewer.ArrayEntry
 
arrayToString(Object[]) - Static method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Creates a String representation of an Object array.
arrayToString(float[]) - Static method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Creates a String representation of a float array.
ART - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Art
ART_BOX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ARTIFACT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
AS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ASCENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ASCII85_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ASCII85_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ASCII85Filter - Class in org.apache.pdfbox.filter
This is the used for the ASCIIHexDecode filter.
ASCII85Filter() - Constructor for class org.apache.pdfbox.filter.ASCII85Filter
 
ASCII85InputStream - Class in org.apache.pdfbox.io
This class represents an ASCII85 stream.
ASCII85InputStream(InputStream) - Constructor for class org.apache.pdfbox.io.ASCII85InputStream
Constructor.
ASCII85OutputStream - Class in org.apache.pdfbox.io
This class represents an ASCII85 output stream.
ASCII85OutputStream(OutputStream) - Constructor for class org.apache.pdfbox.io.ASCII85OutputStream
Constructor.
ASCII_HEX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ASCII_HEX_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ASCIIHexFilter - Class in org.apache.pdfbox.filter
This is the used for the ASCIIHexDecode filter.
ASCIIHexFilter() - Constructor for class org.apache.pdfbox.filter.ASCIIHexFilter
 
ATTACHED - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ATTACHMENT_NAME_GRAPH - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
ATTACHMENT_NAME_PAPERCLIP - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
ATTACHMENT_NAME_PUSH_PIN - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
ATTACHMENT_NAME_TAG - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
See get/setAttachmentName.
attributeChanged(PDAttributeObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Updates the revision number for the given attribute object.
AUTHOR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
available() - Method in class org.apache.pdfbox.io.ASCII85InputStream
Unsupported.
available() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Available bytes.
available() - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
 
available() - Method in class org.apache.pdfbox.io.RandomAccessFileInputStream
Average - Class in org.apache.pdfbox.pdmodel.graphics.predictor
We can use raw on the right hand side of the decoding formula because it is already decoded.
Average() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Average
 
AVG_WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
AxialShadingContext - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT PaintContext for axial shading.
AxialShadingContext(PDShadingType2, ColorModel, AffineTransform, Matrix, int, Rectangle) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
Constructor creates an instance to be used for fill operations.
AxialShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT Paint for axial shading.
AxialShadingPaint(PDShadingType2, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingPaint
Constructor.

B

B - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BACKGROUND - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BadSecurityHandlerException - Exception in org.apache.pdfbox.pdmodel.encryption
This exception can be thrown by the SecurityHandlersManager class when a document required an unimplemented security handler to be opened.
BadSecurityHandlerException() - Constructor for exception org.apache.pdfbox.pdmodel.encryption.BadSecurityHandlerException
Default Constructor.
BadSecurityHandlerException(Exception) - Constructor for exception org.apache.pdfbox.pdmodel.encryption.BadSecurityHandlerException
Constructor.
BadSecurityHandlerException(String) - Constructor for exception org.apache.pdfbox.pdmodel.encryption.BadSecurityHandlerException
Constructor.
BASE_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BASE_FONT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BASE_STATE - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for "BaseState".
BaseParser - Class in org.apache.pdfbox.pdfparser
This class is used to contain parsing logic that will be used by both the PDFParser and the COSStreamParser.
BaseParser() - Constructor for class org.apache.pdfbox.pdfparser.BaseParser
Default constructor.
BaseParser(InputStream, boolean) - Constructor for class org.apache.pdfbox.pdfparser.BaseParser
Constructor.
BaseParser(InputStream) - Constructor for class org.apache.pdfbox.pdfparser.BaseParser
Constructor.
BaseParser(byte[]) - Constructor for class org.apache.pdfbox.pdfparser.BaseParser
Constructor.
BBOX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
bboxRect - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
BeginInlineImage - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
BeginInlineImage() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.BeginInlineImage
 
beginMarkedContentSequence(COSName) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Begin a marked content sequence.
beginMarkedContentSequence(COSName, COSName) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary.
BeginMarkedContentSequence - Class in org.apache.pdfbox.util.operator
BMC : Begins a marked-content sequence.
BeginMarkedContentSequence() - Constructor for class org.apache.pdfbox.util.operator.BeginMarkedContentSequence
 
beginMarkedContentSequence(COSName, COSDictionary) - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
 
BeginMarkedContentSequenceWithProperties - Class in org.apache.pdfbox.util.operator
BDC : Begins a marked-content sequence with property list.
BeginMarkedContentSequenceWithProperties() - Constructor for class org.apache.pdfbox.util.operator.BeginMarkedContentSequenceWithProperties
 
beginText() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Begin some text operations.
BeginText - Class in org.apache.pdfbox.util.operator
 
BeginText() - Constructor for class org.apache.pdfbox.util.operator.BeginText
 
BIB_ENTRY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
BibEntry
BitFlagHelper - Class in org.apache.pdfbox.util
This class will be used for bit flag operations.
BITS_PER_COMPONENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BITS_PER_COORDINATE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BITS_PER_FLAG - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BITS_PER_SAMPLE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BLACK_IS_1 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BLACK_MAKE_UP - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
The black make-up code words.
BLACK_POINT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BLACK_TERMINATING - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
The black terminating code words.
BLEED_BOX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BLOCK_ALIGN_AFTER - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BlockAlign: After: After edge of the last child's allocation rectangle aligned with that of the table cell's content rectangle.
BLOCK_ALIGN_BEFORE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BlockAlign: Before: Before edge of the first child's allocation rectangle aligned with that of the table cell's content rectangle.
BLOCK_ALIGN_JUSTIFY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BlockAlign: Justify: Children aligned with both the before and after edges of the table cell's content rectangle.
BLOCK_ALIGN_MIDDLE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BlockAlign: Middle: Children centered within the table cell.
BLOCK_QUOTE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
BlockQuote
BORDER_STYLE_DASHED - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Dashed: The border is a series of short line segments.
BORDER_STYLE_DOTTED - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Dotted: The border is a series of dots.
BORDER_STYLE_DOUBLE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Double: The border is two solid lines.
BORDER_STYLE_GROOVE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Groove: The border looks as though it were carved into the canvas.
BORDER_STYLE_HIDDEN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Hidden: Same as PDLayoutAttributeObject.BORDER_STYLE_NONE, except in terms of border conflict resolution for table elements.
BORDER_STYLE_INSET - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Inset: The border makes the entire box look as though it were embedded in the canvas.
BORDER_STYLE_NONE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: None: No border.
BORDER_STYLE_OUTSET - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Outset: The border makes the entire box look as though it were coming out of the canvas (the opposite of PDLayoutAttributeObject.BORDER_STYLE_INSET.
BORDER_STYLE_RIDGE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Ridge: The border looks as though it were coming out of the canvas (the opposite of PDLayoutAttributeObject.BORDER_STYLE_GROOVE).
BORDER_STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
BorderStyle: Solid: The border is a single line segment.
BOUNDARY_ART_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
BOUNDARY_BLEED_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
BOUNDARY_CROP_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
BOUNDARY_MEDIA_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
BOUNDARY_TRIM_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
BOUNDS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BPC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
BS_ESCAPE - Static variable in class org.apache.pdfbox.cos.COSString
BS escape characters.
buildPDF(PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateCreator
this method builds pdf step by step, and finally it returns stream of visible signature
buildSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
start building of visible signature
ByteArrayPushBackInputStream - Class in org.apache.pdfbox.io
PushBackInputStream for byte arrays.
ByteArrayPushBackInputStream(byte[]) - Constructor for class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Constructor.
BYTERANGE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

C

C - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
C0 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
C1 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CA_NS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
calculateColorValues(List<COSBase>) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Returns the components of the color in the alternate colorspace for the given tint value.
calculateColorValues(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Returns the components of the color for the given index.
calculateColorValues(COSBase) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Returns the components of the color in the alternate colorspace for the given tint value.
CALGRAY - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CALRGB - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
canAssembleDocument() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can insert/rotate/delete pages.
canAssembleDocument() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will tell if the user can insert/rotate/delete pages.
canExtractContent() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can extract text and images from the PDF document.
canExtractContent() - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can fill in interactive form fields (including signature fields) even if canModifyAnnotations() returns false.
canFillInForm() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will tell if the user can fill in interactive forms.
canModify() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can modify contents of the document.
canModify() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will tell if the user can modify contents of the document.
canModifyAnnotations() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can add or modify text annotations and fill in interactive forms fields and, if canModify() returns true, create or modify interactive form fields (including signature fields).
canModifyAnnotations() - Method in class org.apache.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.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can print.
canPrint() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will tell if the user can print.
canPrintDegraded() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can print the document in a degraded format.
canPrintDegraded() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will tell if the user can print the document in a degraded format.
CAP_HEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CAPTION - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Caption
CATALOG - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CCITTFAX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CCITTFAX_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CCITTFaxConstants - Interface in org.apache.pdfbox.io.ccitt
Constants for CCITT Fax Filter.
CCITTFaxDecodeFilter - Class in org.apache.pdfbox.filter
This is a filter for the CCITTFax Decoder.
CCITTFaxDecodeFilter() - Constructor for class org.apache.pdfbox.filter.CCITTFaxDecodeFilter
Constructor.
CCITTFaxG31DDecodeInputStream - Class in org.apache.pdfbox.io.ccitt
This is a CCITT Group 3 1D decoder (ITU T.4).
CCITTFaxG31DDecodeInputStream(InputStream, int, int, boolean) - Constructor for class org.apache.pdfbox.io.ccitt.CCITTFaxG31DDecodeInputStream
Creates a new decoder.
CCITTFaxG31DDecodeInputStream(InputStream, int, boolean) - Constructor for class org.apache.pdfbox.io.ccitt.CCITTFaxG31DDecodeInputStream
Creates a new decoder.
CENTER_WINDOW - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
centerWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the center window preference.
CERT_PATH_CHECK_INVALID - Static variable in exception org.apache.pdfbox.exceptions.SignatureException
 
CF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CFM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CHAR_PROCS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CHAR_SET - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
charactersByArticle - Variable in class org.apache.pdfbox.util.PDFTextStripper
The charactersByArticle is used to extract text by article divisions.
charsetForName(String) - Method in class org.apache.pdfbox.encoding.PDFBoxCharsetProvider
charsets() - Method in class org.apache.pdfbox.encoding.PDFBoxCharsetProvider
check() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
Checks the radiobutton.
checkBufsiz(byte[], byte[]) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
check that buffer sizes matches width,height,bpp.
checkBufsiz(byte[], byte[]) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
check that buffer sizes matches width,height,bpp.
CHECKED_STATE_NEUTRAL - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
checked state: neutral
CHECKED_STATE_OFF - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
checked state: off
CHECKED_STATE_ON - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
checked state: on
CICI_SIGNIT - Static variable in class org.apache.pdfbox.cos.COSName
A signature filter value.
CID_FONT_TYPE0 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CID_FONT_TYPE2 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CID_TO_GID_MAP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CIDSYSTEMINFO - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CJKConverter - Class in org.apache.pdfbox.encoding.conversion
CJKConverter converts encodings defined in CJKEncodings.
CJKConverter(String) - Constructor for class org.apache.pdfbox.encoding.conversion.CJKConverter
Constructs a CJKConverter from a PDF encoding name.
clear() - Method in class org.apache.pdfbox.cos.COSArray
This will remove all of the objects in the collection.
clear() - Method in class org.apache.pdfbox.cos.COSDictionary
This will clear all items in the map.
clear(int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Clears a bit at the given offset.
clear() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Clear all bits in the array.
clear() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
clear() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Calling this will release all cached information.
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDType1AfmPfbFont
 
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
clear() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
clear() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
 
clear() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
 
clear() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Calling this will release all cached information.
clear() - Method in class org.apache.pdfbox.pdmodel.PDPage
Calling this will release all cached information.
clear() - Method in class org.apache.pdfbox.pdmodel.PDResources
Calling this will release all cached information.
CLEAR_TABLE - Static variable in class org.apache.pdfbox.filter.LZWFilter
The LZW clear table code.
clearBits(int, int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Clears a run of bits at the given offset.
clearResources() - Static method in class org.apache.pdfbox.cos.COSName
Not usually needed except if resources need to be reclaimed in a ong running process.
clearResources() - Method in class org.apache.pdfbox.pdfparser.BaseParser
Release all used resources.
clearResources() - Method in class org.apache.pdfbox.pdfparser.PDFParser
Release all used resources.
clearResources() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
Release all used resources.
clearResources() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Release all used resources.
clearResources() - Static method in class org.apache.pdfbox.pdmodel.font.PDFont
This will clear AFM resources that are stored statically.
clearWillEncryptWhenSaving() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.
Do not rely on this method anymore. It is the responsability of COSWriter to hold this state.
ClipEvenOddRule - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
ClipEvenOddRule() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.ClipEvenOddRule
 
ClipNonZeroRule - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
ClipNonZeroRule() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.ClipNonZeroRule
 
clipPath(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Clip path.
clipToRange(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Clip the given input values to the ranges.
clipToRange(float, float, float) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Clip the given input value to the given range.
clone() - Method in class org.apache.pdfbox.io.RandomAccessBuffer
 
clone() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
clone() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
clone() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
clone() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
clone() - Method in class org.apache.pdfbox.util.Matrix
Clones this object.
cloneForNewDocument(Object) - Method in class org.apache.pdfbox.util.PDFCloneUtility
Deep-clones the given object for inclusion into a different PDF document identified by the destination parameter.
cloneMerge(COSObjectable, COSObjectable) - Method in class org.apache.pdfbox.util.PDFCloneUtility
Merges two objects of the same type by deep-cloning its members.
close() - Method in class org.apache.pdfbox.cos.COSDocument
This will close all storage and delete the tmp files.
close() - Method in class org.apache.pdfbox.cos.COSStream
 
close(FDFDocument) - Method in class org.apache.pdfbox.ExportFDF
Close the document.
close(PDDocument) - Method in class org.apache.pdfbox.ExportFDF
Close the document.
close(FDFDocument) - Method in class org.apache.pdfbox.ExportXFDF
Close the document.
close(PDDocument) - Method in class org.apache.pdfbox.ExportXFDF
Close the document.
close(FDFDocument) - Method in class org.apache.pdfbox.ImportFDF
Close the document.
close(PDDocument) - Method in class org.apache.pdfbox.ImportFDF
Close the document.
close(FDFDocument) - Method in class org.apache.pdfbox.ImportXFDF
Close the document.
close(PDDocument) - Method in class org.apache.pdfbox.ImportXFDF
Close the document.
close() - Method in class org.apache.pdfbox.io.ASCII85InputStream
This will close the underlying stream and release any resources.
close() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will close the stream.
close() - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Release resources that are being held.
close() - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
 
close() - Method in class org.apache.pdfbox.io.RandomAccessFile
Release resources that are being held.
close() - Method in class org.apache.pdfbox.io.RandomAccessFileInputStream
close() - Method in interface org.apache.pdfbox.io.SequentialRead
Release resources that are being held.
close() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will close the underlying pdfSource object.
close() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will close the stream.
close() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Close the content stream.
close() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will close the underlying COSDocument object.
close() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Closes the visual signature COSDocument, if any.
close() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will close the underlying COSDocument object.
closeAndStroke() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Close and stroke the path.
CloseAndStrokePath - Class in org.apache.pdfbox.util.operator
Implementation of content stream operator for page drawer.
CloseAndStrokePath() - Constructor for class org.apache.pdfbox.util.operator.CloseAndStrokePath
 
CloseFillEvenOddAndStrokePath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
CloseFillEvenOddAndStrokePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.CloseFillEvenOddAndStrokePath
 
CloseFillNonZeroAndStrokePath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
CloseFillNonZeroAndStrokePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.CloseFillNonZeroAndStrokePath
 
closeNode() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Close this node.
ClosePath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
ClosePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.ClosePath
 
closeQuietly(InputStream) - Static method in class org.apache.pdfbox.io.IOUtils
Unconditionally close an InputStream.
closeQuietly(Reader) - Static method in class org.apache.pdfbox.io.IOUtils
Unconditionally close an Reader.
closeQuietly(Writer) - Static method in class org.apache.pdfbox.io.IOUtils
Unconditionally close a Writer.
closeQuietly(OutputStream) - Static method in class org.apache.pdfbox.io.IOUtils
Unconditionally close an OutputStream.
closeSubPath() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Close subpath.
closeTemplate(PDDocument) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Closes template
closeTemplate(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
CLR_F - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CLR_FF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
cmap - Variable in class org.apache.pdfbox.pdmodel.font.PDFont
This is only used if this is a font object and it has an encoding and it is a type0 font with a cmap.
cmapEncoding(int, int, boolean, CMap) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Encode the given value using the CMap of the font.
cmapObjects - Static variable in class org.apache.pdfbox.pdmodel.font.PDFont
 
CMapSubstitution - Class in org.apache.pdfbox.encoding.conversion
This class provides a mapping from char code to unicode mapping files used for CJK-encoding.
CODE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Code
codeToName - Variable in class org.apache.pdfbox.encoding.Encoding
This is a mapping from a character code to a character name.
COL_SPAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
COLORANTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
colorChanged(boolean) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Deprecated.
COLORS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
COLORSPACE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
colorSpace - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
ColorSpaceCalRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a CalRGB color space.
ColorSpaceCalRGB() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
Constructor.
ColorSpaceCalRGB(PDGamma, PDTristimulus, PDTristimulus, PDMatrix) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
Constructor.
ColorSpaceCMYK - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a CMYK color space.
ColorSpaceCMYK() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCMYK
Constructor.
ColorSpaceLab - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a CalRGB color space.
ColorSpaceLab() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceLab
Default Constructor.
ColorSpaceLab(PDTristimulus, PDTristimulus, PDRange, PDRange) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceLab
Constructor.
COLUMNS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
COMMENT - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The start to a PDF comment.
comment(CharSequence) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.Parser.AbstractSyntaxHandler
Called for a comment.
comment(CharSequence) - Method in interface org.apache.pdfbox.pdmodel.common.function.type4.Parser.SyntaxHandler
Called for a comment.
commonXObjectCreation(COSBase, boolean) - Static method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Create the correct xobject from the cos base.
compare(Object, Object) - Method in class org.apache.pdfbox.util.TextPositionComparator
compareTo(COSName) - Method in class org.apache.pdfbox.cos.COSName
compareTo(COSWriterXRefEntry) - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
compareTo(COSObjectKey) - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
CompositeImage - Class in org.apache.pdfbox.pdmodel.graphics.xobject
This class is responsible for combining a base image with an SMask-based transparency image to form a composite image.
CompositeImage(BufferedImage, BufferedImage) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.CompositeImage
Standard constructor.
COMPRESSION_GROUP3_1D - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
A constant for group 3 1D encoding (ITU T.4).
COMPRESSION_GROUP3_2D - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
A constant for group 3 2D encoding (ITU T.4).
COMPRESSION_GROUP4_2D - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
A constant for group 4 2D encoding (ITU T.6).
computeEncryptedKey(byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated.
This will compute the encrypted key.
computeEncryptedKey(byte[], byte[], int, byte[], int, int, boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Compute the encryption key.
computeOwnerPassword(byte[], byte[], int, int) - Method in class org.apache.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.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Compute the owner entry in the encryption dictionary.
computeUserPassword(byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated.
This will compute the user password hash.
computeUserPassword(byte[], byte[], int, byte[], int, int, boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
This will compute the user password hash.
Concatenate - Class in org.apache.pdfbox.util.operator
 
Concatenate() - Constructor for class org.apache.pdfbox.util.operator.Concatenate
 
concatenate2CTM(double, double, double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Cm operator.
concatenate2CTM(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Cm operator.
ConformingPDDocument - Class in org.apache.pdfbox.pdmodel
 
ConformingPDDocument() - Constructor for class org.apache.pdfbox.pdmodel.ConformingPDDocument
 
ConformingPDDocument(COSDocument) - Constructor for class org.apache.pdfbox.pdmodel.ConformingPDDocument
 
ConformingPDFParser - Class in org.apache.pdfbox.pdfparser
 
ConformingPDFParser(File) - Constructor for class org.apache.pdfbox.pdfparser.ConformingPDFParser
Constructor.
consumeWhitespace() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read all bytes until a non-whitespace character is found.
consumeWhitespaceBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read all bytes (backwards) until a non-whitespace character is found.
CONTACT_INFO - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
contains(Charset) - Method in class org.apache.pdfbox.encoding.SingleByteCharset
contains(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
contains(float, float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
Method to determine if the x/y point is inside this rectangle.
contains(TextPosition) - Method in class org.apache.pdfbox.util.TextPosition
Determine if this TextPosition logically contains another (i.e. they overlap and should be rendered on top of each other).
containsAll(Collection<?>) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
containsKey(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
 
containsKey(String) - Method in class org.apache.pdfbox.cos.COSDictionary
 
containsKey(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
containsValue(Object) - Method in class org.apache.pdfbox.cos.COSDictionary
 
containsValue(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
CONTENTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ContentStreamWriter - Class in org.apache.pdfbox.pdfwriter
A class that will take a list of tokens and write out a stream with them.
ContentStreamWriter(OutputStream) - Constructor for class org.apache.pdfbox.pdfwriter.ContentStreamWriter
This will create a new content stream writer.
context - Variable in class org.apache.pdfbox.util.operator.OperatorProcessor
The stream engine processing context.
convert(Map<?, ?>) - Static method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
This will take a map<java.lang.String,org.apache.pdfbox.pdmodel.COSObjectable> and convert it into a COSDictionary<COSName,COSBase>.
convertBasicTypesToMap(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
This will take a COS dictionary and convert it into COSDictionaryMap.
convertBytes(byte[], int, int, CMap) - Method in class org.apache.pdfbox.encoding.conversion.CJKConverter
Convert bytes to a string.
convertBytes(byte[], int, int, CMap) - Method in interface org.apache.pdfbox.encoding.conversion.EncodingConverter
Convert bytes to a string.
ConvertColorspace - Class in org.apache.pdfbox
This is the main program that simply parses the pdf document and replace change a PDF to use a specific colorspace.
convertCOSNameCOSArrayToList(COSArray) - Static method in class org.apache.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.apache.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.apache.pdfbox.pdmodel.common.PDNameTreeNode
Method to convert the COS value in the name tree to the PD Model object.
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Method to convert the COS value in the name tree to the PD Model object.
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
Method to convert the COS value in the name tree to the PD Model object.
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Method to convert the COS value in the name tree to the PD Model object.
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
Method to convert the COS value in the name tree to the PD Model object.
converterToCOSArray(List<?>) - Static method in class org.apache.pdfbox.pdmodel.common.COSArrayList
This will convert a list of COSObjectables to an array list of COSBase objects.
convertFloatCOSArrayToList(COSArray) - Static method in class org.apache.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.apache.pdfbox.pdmodel.common.COSArrayList
This will take an array of COSNumbers and return a COSArrayList of java.lang.Integer values.
convertString(String) - Method in class org.apache.pdfbox.encoding.conversion.CJKConverter
Convert a string.
convertString(String) - Method in interface org.apache.pdfbox.encoding.conversion.EncodingConverter
Convert a string.
convertStringListToCOSNameCOSArray(List<String>) - Static method in class org.apache.pdfbox.pdmodel.common.COSArrayList
This will take an list of string objects and return a COSArray of COSName objects.
convertStringListToCOSStringCOSArray(List<String>) - Static method in class org.apache.pdfbox.pdmodel.common.COSArrayList
This will take an list of string objects and return a COSArray of COSName objects.
convertToImage() - Method in class org.apache.pdfbox.pdmodel.PDPage
Convert this page to an output image with 8 bits per pixel and the double default screen resolution.
convertToImage(int, int) - Method in class org.apache.pdfbox.pdmodel.PDPage
Convert this page to an output image.
convertToRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
coordinates(float, float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
COORDS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
copy(InputStream, OutputStream) - Static method in class org.apache.pdfbox.io.IOUtils
Copies all the contents from the given input stream to the given output stream.
copy() - Method in class org.apache.pdfbox.util.Matrix
This will copy the text matrix data.
copyIntoGraphicsState(PDGraphicsState) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will implement the gs operator.
COSArray - Class in org.apache.pdfbox.cos
An array of PDFBase objects as part of the PDF document.
COSArray() - Constructor for class org.apache.pdfbox.cos.COSArray
Constructor.
COSArrayList<E> - Class in org.apache.pdfbox.pdmodel.common
This is an implementation of a List that will sync its contents to a COSArray.
COSArrayList() - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
Default constructor.
COSArrayList(List<E>, COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
Constructor.
COSArrayList(E, COSBase, COSDictionary, COSName) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
This is a really special constructor.
COSArrayList(E, COSBase, COSDictionary, String) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
COSBase - Class in org.apache.pdfbox.cos
The base object that all objects in the PDF document will extend.
COSBase() - Constructor for class org.apache.pdfbox.cos.COSBase
 
COSBoolean - Class in org.apache.pdfbox.cos
This class represents a boolean value in the PDF document.
COSDictionary - Class in org.apache.pdfbox.cos
This class represents a dictionary where name/value pairs reside.
COSDictionary() - Constructor for class org.apache.pdfbox.cos.COSDictionary
Constructor.
COSDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.cos.COSDictionary
Copy Constructor.
COSDictionaryLateBinding - Class in org.apache.pdfbox.cos
 
COSDictionaryLateBinding(ConformingPDFParser) - Constructor for class org.apache.pdfbox.cos.COSDictionaryLateBinding
 
COSDictionaryMap<K,V> - Class in org.apache.pdfbox.pdmodel.common
This is a Map that will automatically sync the contents to a COSDictionary.
COSDictionaryMap(Map<K, V>, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
Constructor for this map.
COSDocument - Class in org.apache.pdfbox.cos
This is the in-memory representation of the PDF document.
COSDocument(RandomAccess, boolean) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor that will use the given random access file for storage of the PDF streams.
COSDocument(File, boolean) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor that will use a temporary file in the given directory for storage of the PDF streams.
COSDocument() - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor.
COSDocument(File) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor that will create a create a scratch file in the following directory.
COSDocument(RandomAccess) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor that will use the following random access file for storage of the PDF streams.
COSFilterInputStream - Class in org.apache.pdfbox.pdfwriter
 
COSFilterInputStream(InputStream, int[]) - Constructor for class org.apache.pdfbox.pdfwriter.COSFilterInputStream
 
COSFilterInputStream(byte[], int[]) - Constructor for class org.apache.pdfbox.pdfwriter.COSFilterInputStream
 
COSFloat - Class in org.apache.pdfbox.cos
This class represents a floating point number in a PDF document.
COSFloat(float) - Constructor for class org.apache.pdfbox.cos.COSFloat
Constructor.
COSFloat(String) - Constructor for class org.apache.pdfbox.cos.COSFloat
Constructor.
COSHEXTable - Class in org.apache.pdfbox.persistence.util
helper type for faster mapping of bytes to their hex equivalent.
COSInteger - Class in org.apache.pdfbox.cos
This class represents an integer number in a PDF document.
COSInteger(long) - Constructor for class org.apache.pdfbox.cos.COSInteger
Deprecated.
use the static COSInteger.get(long) method instead
COSInteger(int) - Constructor for class org.apache.pdfbox.cos.COSInteger
Deprecated.
use the static COSInteger.get(long) method instead
COSInteger(String) - Constructor for class org.apache.pdfbox.cos.COSInteger
Deprecated.
use the static COSInteger.get(long) method instead
COSName - Class in org.apache.pdfbox.cos
This class represents a PDF named object.
COSNull - Class in org.apache.pdfbox.cos
This class represents a null PDF object.
COSNumber - Class in org.apache.pdfbox.cos
This class represents an abstract number in a PDF document.
COSNumber() - Constructor for class org.apache.pdfbox.cos.COSNumber
 
COSObject - Class in org.apache.pdfbox.cos
This class represents a PDF object.
COSObject(COSBase) - Constructor for class org.apache.pdfbox.cos.COSObject
Constructor.
COSObjectable - Interface in org.apache.pdfbox.pdmodel.common
This is an interface used to get/create the underlying COSObject.
COSObjectKey - Class in org.apache.pdfbox.persistence.util
Object representing the physical reference to an indirect pdf object.
COSObjectKey(COSObject) - Constructor for class org.apache.pdfbox.persistence.util.COSObjectKey
PDFObjectKey constructor comment.
COSObjectKey(long, long) - Constructor for class org.apache.pdfbox.persistence.util.COSObjectKey
PDFObjectKey constructor comment.
COSStandardOutputStream - Class in org.apache.pdfbox.pdfwriter
simple output stream with some minor features for generating "pretty" pdf files.
COSStandardOutputStream(OutputStream) - Constructor for class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
COSOutputStream constructor comment.
COSStream - Class in org.apache.pdfbox.cos
This class represents a stream object in a PDF document.
COSStream(RandomAccess) - Constructor for class org.apache.pdfbox.cos.COSStream
Constructor.
COSStream(COSDictionary, RandomAccess) - Constructor for class org.apache.pdfbox.cos.COSStream
Constructor.
COSStreamArray - Class in org.apache.pdfbox.pdmodel.common
This will take an array of streams and sequence them together.
COSStreamArray(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.COSStreamArray
Constructor.
COSString - Class in org.apache.pdfbox.cos
This represents a string object in a PDF document.
COSString() - Constructor for class org.apache.pdfbox.cos.COSString
Constructor.
COSString(boolean) - Constructor for class org.apache.pdfbox.cos.COSString
Deprecated.
Not needed anymore. Use COSString.COSString() instead. PDFBOX-1437
COSString(String) - Constructor for class org.apache.pdfbox.cos.COSString
Explicit constructor for ease of manual PDF construction.
COSString(byte[]) - Constructor for class org.apache.pdfbox.cos.COSString
Explicit constructor for ease of manual PDF construction.
COSUnread - Class in org.apache.pdfbox.cos
 
COSUnread() - Constructor for class org.apache.pdfbox.cos.COSUnread
 
COSUnread(long, long) - Constructor for class org.apache.pdfbox.cos.COSUnread
 
COSUnread(long, long, ConformingPDFParser) - Constructor for class org.apache.pdfbox.cos.COSUnread
 
COSVisitorException - Exception in org.apache.pdfbox.exceptions
An exception that represents something gone wrong when visiting a PDF object.
COSVisitorException(Exception) - Constructor for exception org.apache.pdfbox.exceptions.COSVisitorException
COSVisitorException constructor comment.
COSWriter - Class in org.apache.pdfbox.pdfwriter
this class acts on a in-memory representation of a pdf document.
COSWriter(OutputStream) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
COSWriter constructor comment.
COSWriter(OutputStream, InputStream) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
COSWriter constructor for incremental updates.
COSWriterXRefEntry - Class in org.apache.pdfbox.pdfwriter
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.apache.pdfbox.pdfwriter.COSWriterXRefEntry
COSWriterXRefEntry constructor comment.
COUNT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
COURIER - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
COURIER_BOLD - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
COURIER_BOLD_OBLIQUE - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
COURIER_OBLIQUE - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
CR_ESCAPE - Static variable in class org.apache.pdfbox.cos.COSString
CR escape characters.
create(COSBase) - Static method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Create the correct PD Model function based on the COS base function.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Creates an attribute object.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Creates a node in the structure tree.
create(COSName, COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Creates a marked-content sequence.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Create the correct FDFAnnotation.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
Create the correct PD Model pattern based on the COS base pattern.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
Create the correct PD Model shading based on the COS base shading.
create(COSBase) - Static method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
This will create a new destination depending on the type of COSBase that is passed in.
createAcroForm(PDDocument) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates Acro forms in the template
createAcroForm(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createAcroFormDictionary(PDAcroForm, PDSignatureField) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Create AcroForm Dictionary
createAcroFormDictionary(PDAcroForm, PDSignatureField) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createAction(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionFactory
This will create the correct type of action based on the type specified in the dictionary.
createAffineTransform(byte[]) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
In order to create Affine Transform, using parameters
createAffineTransform(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createAffineTransform() - Method in class org.apache.pdfbox.util.Matrix
Create an affine transform from this matrix's values.
createAnnotation(COSBase) - Static method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Create the correct annotation from the base COS object.
createAppearanceDictionary(PDXObjectForm, PDSignatureField) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates appearance dictionary
createAppearanceDictionary(PDXObjectForm, PDSignatureField) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Create a child node object.
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Create a child node object.
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
Create a child node object.
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Create a child node object.
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
Create a child node object.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Create a Java color model for this colorspace.
createColorModel(int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Create a Java color model for this colorspace including the given mask value.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Create a Java color model for this colorspace.
createColorModel(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Create a Java color model for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Create a Java colorspace for this colorspace.
createColorSpace(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(COSBase, Map<String, PDColorSpace>) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(COSBase, Map<String, PDColorSpace>, Map<String, PDPatternResources>) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(String) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(String, Map<String, PDColorSpace>) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space given the name.
createColorSpace(PDDocument, ColorSpace) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpaceFactory
This will create the correct color space from a java colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Create a Java colorspace for this colorspace.
createColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Create a Java colorspace for this colorspace.
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingPaint
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingPaint
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.Type1ShadingPaint
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.Type4ShadingPaint
 
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.Type5ShadingPaint
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.Type6ShadingPaint
createContext(ColorModel, Rectangle, Rectangle2D, AffineTransform, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.Type7ShadingPaint
createCOSStream() - Method in class org.apache.pdfbox.cos.COSDocument
Create a new COSStream using the underlying scratch file.
createCOSStream(COSDictionary) - Method in class org.apache.pdfbox.cos.COSDocument
Create a new COSStream using the underlying scratch file.
createDefaultFont() - Static method in class org.apache.pdfbox.pdmodel.font.PDFontFactory
Create a default font
createDimension() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
A convenience method to create a dimension object for AWT operations.
createField(PDAcroForm, COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.interactive.form.PDFieldFactory
This method creates a COSField subclass from the given field.
createFilteredStream() - Method in class org.apache.pdfbox.cos.COSStream
This will create a new stream for which filtered byte should be written to.
createFilteredStream(COSBase) - Method in class org.apache.pdfbox.cos.COSStream
This will create a new stream for which filtered byte should be written to.
createFilteredStream() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will create a new stream for which filtered byte should be written to.
createFilteredStream(COSBase) - Method in class org.apache.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.apache.pdfbox.pdmodel.font.PDFontFactory
Deprecated.
due to some side effects font caching is no longer supported, use PDFontFactory.createFont(COSDictionary) instead
createFont(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.font.PDFontFactory
This will create the correct font based on information in the dictionary.
createFormaterRectangle(byte[]) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
createFormaterRectangle(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createFromCOS(COSBase) - Static method in class org.apache.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.apache.pdfbox.cos.COSString
This will create a COS string from a string of hex characters.
createFromHexString(String, boolean) - Static method in class org.apache.pdfbox.cos.COSString
Creates a COS string from a string of hex characters, optionally ignoring malformed input.
createFS(COSBase) - Static method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
A file specfication can either be a COSString or a COSDictionary.
createHolderForm(PDResources, PDStream, PDRectangle) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates Form
createHolderForm(PDResources, PDStream, PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createHolderFormResources() - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates resources of form
createHolderFormResources() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createHolderFormStream(PDDocument) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
createHolderFormStream(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createImage(COSStream) - Method in class org.apache.pdfbox.pdmodel.font.Type3StreamParser
This will parse a type3 stream and create an image from it.
createImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will take the inlined image information and create a java.awt.Image from it.
createImage(Map) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will take the inlined image information and create a java.awt.Image from it.
createImageForm(PDResources, PDResources, PDStream, PDRectangle, AffineTransform, PDJpeg) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates Image form
createImageForm(PDResources, PDResources, PDStream, PDRectangle, AffineTransform, PDJpeg) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createImageFormResources() - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Create resource of image form
createImageFormResources() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createImageFormStream(PDDocument) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
createImageFormStream(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createInnerForm(PDResources, PDStream, PDRectangle) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
createInnerForm(PDResources, PDStream, PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createInnerFormResource() - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates InnerForm
createInnerFormResource() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createInnerFormStream(PDDocument) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
createInnerFormStream(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createInputStream() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get a stream that can be read from.
createInputStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream that can be read from.
createMaskedImage(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.CompositeImage
This method applies the specified transparency mask to a given image and returns a new BufferedImage whose alpha values are computed from the transparency mask (smask) image.
createNewDocument() - Method in class org.apache.pdfbox.util.Splitter
Create a new document to write the splitted contents to.
createNewDocumentIfNecessary() - Method in class org.apache.pdfbox.util.Splitter
Interface method, you can control where a document gets split by implementing this method.
createObject(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Creates an object for a kid of this structure node.
createOutputStream() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get a stream that can be written to.
createOutputStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream that can be written to.
createPage(PDVisibleSignDesigner) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates specified size page
createPage(PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createPDFFromText(Reader) - Method in class org.apache.pdfbox.TextToPDF
Create a PDF document with some text.
createPDFFromText(PDDocument, Reader) - Method in class org.apache.pdfbox.TextToPDF
Create a PDF document with some text.
createProcSetArray() - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI
createProcSetArray() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createRetranslatedRectangle() - Method in class org.apache.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.
createSignature(PDSignatureField, PDPage, String) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates PDSignature
createSignature(PDSignatureField, PDPage, String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createSignatureField(PDAcroForm) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates signature fields
createSignatureField(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createSignatureImage(PDDocument, InputStream) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates signature image
createSignatureImage(PDDocument, InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createSignatureRectangle(PDSignatureField, PDVisibleSignDesigner) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates SingatureRectangle
createSignatureRectangle(PDSignatureField, PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createStencilMaskedImage(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.CompositeImage
This method applies the specified stencil mask to a given image and returns a new BufferedImage whose alpha values are computed from the stencil mask (smask) image.
createStream(PDDocument) - Static method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
This will create a new PDStream object.
createTemplate(PDPage) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates template using page
createTemplate(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createTextStream(COSBase) - Static method in class org.apache.pdfbox.pdmodel.common.PDTextStream
This will create the text stream object.
createThumbnailXObject(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Create the correct thumbnail from the cos base.
createUnfilteredStream() - Method in class org.apache.pdfbox.cos.COSStream
This will create an output stream that can be written to.
createUnfilteredStream() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will create an output stream that can be written to.
createVisualSignature(PDDocument) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
just to create visible signature
createVisualSignature(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createWidgetDictionary(PDSignatureField, PDResources) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
adds Widget Dictionary
createWidgetDictionary(PDSignatureField, PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createXObject(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Create the correct xobject from the cos base.
CREATION_DATE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CREATOR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CRLF - Static variable in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
To be used when 2 byte sequence is enforced.
CROP_BOX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CRYPT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
CryptFilter - Class in org.apache.pdfbox.filter
 
CryptFilter() - Constructor for class org.apache.pdfbox.filter.CryptFilter
 
cryptFilterDictionary - Variable in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
COS crypt filter dictionary.
CryptographyException - Exception in org.apache.pdfbox.exceptions
An exception that indicates that something has gone wrong during a cryptography operation.
CryptographyException(String) - Constructor for exception org.apache.pdfbox.exceptions.CryptographyException
Constructor.
CryptographyException(Exception) - Constructor for exception org.apache.pdfbox.exceptions.CryptographyException
Constructor.
CS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
currentAccessPermission - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
The access permission granted to the current user for the document.
currentDocument - Variable in class org.apache.pdfbox.util.Splitter
The current PDF document that contains the splitted page.
CurveTo - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
CurveTo() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.CurveTo
 
CurveToReplicateFinalPoint - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
CurveToReplicateFinalPoint() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.CurveToReplicateFinalPoint
 
CurveToReplicateInitialPoint - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
CurveToReplicateInitialPoint() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.CurveToReplicateInitialPoint
 

D

D - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DATE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DateConverter - Class in org.apache.pdfbox.util
This class is used to convert dates to strings and back using the PDF date standard in section 3.8.2 of PDF Reference 1.7.
DCT_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DCT_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DCTFilter - Class in org.apache.pdfbox.filter
This is the used for the DCTDecode filter.
DCTFilter() - Constructor for class org.apache.pdfbox.filter.DCTFilter
 
DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.ASCII85Filter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.ASCIIHexFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.CCITTFaxDecodeFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.CryptFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.DCTFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in interface org.apache.pdfbox.filter.Filter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.FlateFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.IdentityFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.JBIG2Filter
Decode JBIG2 data using Java ImageIO library.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.JPXFilter
Decode JPEG and JPEG2000 data using Java ImageIO library.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.LZWFilter
This will decode some compressed data.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.RunLengthDecodeFilter
This will decode some compressed data.
decode(byte[], byte[]) - Method in class org.apache.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.apache.pdfbox.pdmodel.graphics.predictor.Optimum
decode a byte array full of image data using the filter that this object implements.
decode(byte[], byte[]) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
decode a byte array full of image data using the filter that this object implements.
DECODE_PARMS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
decodeLine(byte[], byte[], int, int, int, int) - Method in class org.apache.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.apache.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.apache.pdfbox.pdmodel.graphics.predictor.Optimum
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.apache.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.apache.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.apache.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.apache.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.
Decrypt - Class in org.apache.pdfbox
This will read a document from the filesystem, decrypt it and and then write the results to the filesystem.
decrypt(Object, long, long) - Method in class org.apache.pdfbox.encryption.DocumentEncryption
Deprecated.
This will dispatch to the correct method.
decrypt(COSBase, int, int) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Decrypts given object.
decrypt(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will decrypt a document.
decryptArray(COSArray, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will decrypt an array.
decryptDictionary(COSDictionary, long, long) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
 
decryptDocument(String) - Method in class org.apache.pdfbox.encryption.DocumentEncryption
Deprecated.
This will decrypt the document.
decryptDocument(PDDocument, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Decrypt the document.
decryptDocument(PDDocument, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Prepare the document for decryption.
decryptDocument(PDDocument, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Decrypt the document.
DecryptionMaterial - Class in org.apache.pdfbox.pdmodel.encryption
This class represents data required to decrypt PDF documents.
DecryptionMaterial() - Constructor for class org.apache.pdfbox.pdmodel.encryption.DecryptionMaterial
 
decryptMetadata - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
indicates if the Metadata have to be decrypted of not
decryptStream(COSStream, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will decrypt a stream.
decryptString(COSString, long, long) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Decrypts given COSString.
decryptString(COSString, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will decrypt a string.
DEF - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a string constant that will be used for comparisons.
DEFAULT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DEFAULT_COMPRESSION_QUALITY - Static variable in class org.apache.pdfbox.util.ImageIOUtil
Default compression quality: 1.0f.
DEFAULT_LENGTH - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default length for the encryption key.
DEFAULT_NAME - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default security handler.
DEFAULT_PERMISSIONS - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
The default set of permissions which is to allow all.
DEFAULT_REVISION - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
The default revision of one is not specified.
DEFAULT_SCREEN_RESOLUTION - Static variable in class org.apache.pdfbox.util.ImageIOUtil
Default screen resolution: 72dpi.
DEFAULT_TRAIL_BYTECOUNT - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
 
DEFAULT_VERSION - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default version, according to the PDF Reference.
deleteTempFile() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Remove the temporary file.
dereferenceObjectStreams() - Method in class org.apache.pdfbox.cos.COSDocument
This method will search the list of objects for types of ObjStm.
DESC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DESCENDANT_FONTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DESCENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DEST - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DEST_OUTPUT_PROFILE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DESTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
determineEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
determineEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Determines the encoding for the font.
determineEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Determines the encoding for the font.
determineEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
deviceBounds - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
DEVICECMYK - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DEVICEGRAY - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DEVICEN - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DEVICERGB - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DICT_CLOSE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The dictionary close token.
DICT_OPEN - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The dictionary open token.
DictionaryEncoding - Class in org.apache.pdfbox.encoding
This will perform the encoding from a dictionary.
DictionaryEncoding(COSDictionary) - Constructor for class org.apache.pdfbox.encoding.DictionaryEncoding
Constructor.
DIFFERENCES - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DIGEST_METHOD - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DIGEST_RIPEMD160 - Static variable in class org.apache.pdfbox.cos.COSName
Digest Method.
DIGEST_SHA1 - Static variable in class org.apache.pdfbox.cos.COSName
Digest Method.
DIGEST_SHA256 - Static variable in class org.apache.pdfbox.cos.COSName
Digest Method.
DIGEST_SHA384 - Static variable in class org.apache.pdfbox.cos.COSName
Digest Method.
DIGEST_SHA512 - Static variable in class org.apache.pdfbox.cos.COSName
Digest Method.
DIRECTION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DISPLAY_DOC_TITLE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
displayDocTitle() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the display doc title preference.
displayPage(PDPage) - Method in class org.apache.pdfbox.pdfviewer.PageWrapper
This will display the PDF page in this component.
dispose() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Remove all cached resources.
dispose() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
dispose() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
DIV - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Div
DL - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DOC_CHECKSUM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DOC_TIME_STAMP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
document - Variable in class org.apache.pdfbox.pdfparser.BaseParser
This is the document that will be parsed.
DOCUMENT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Document
document - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
The document whose security is handled by this security handler.
document - Variable in class org.apache.pdfbox.util.PDFTextStripper
The document to read.
DocumentEncryption - Class in org.apache.pdfbox.encryption
Deprecated.
use the new security API instead.
DocumentEncryption(PDDocument) - Constructor for class org.apache.pdfbox.encryption.DocumentEncryption
Deprecated.
Constructor.
DocumentEncryption(COSDocument) - Constructor for class org.apache.pdfbox.encryption.DocumentEncryption
Deprecated.
Constructor.
doIt(String, String) - Method in class org.apache.pdfbox.WriteDecodedDoc
doIt(String, String, String, boolean) - Method in class org.apache.pdfbox.WriteDecodedDoc
This will perform the document reading, decoding and writing.
DOMAIN - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
doNotScroll() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
doNotSpellCheck() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
DOS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
doubleValue() - Method in class org.apache.pdfbox.cos.COSFloat
The value of the double object that this one wraps.
doubleValue() - Method in class org.apache.pdfbox.cos.COSInteger
polymorphic access to value as float.
doubleValue() - Method in class org.apache.pdfbox.cos.COSNumber
This will get the double value of this number.
doWriteBody(COSDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the body of the document.
doWriteHeader(COSDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the header to the PDF document.
doWriteObject(COSBase) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write a COS object.
doWriteTrailer(COSDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the trailer to the PDF document.
doWriteXRef(COSDocument) - Method in class org.apache.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?
DP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
drawImage(Image, AffineTransform) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Draw the AWT image.
drawImage(PDXObjectImage, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw an image at the x,y coordinates, with the default size of the image.
drawLine(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw a line on the page using the current non stroking color and the current line width.
drawPage(Graphics, PDPage, Dimension) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
This will draw the page to the requested context.
drawPolygon(float[], float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw a polygon on the page using the current non stroking color.
drawString(String) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
This will draw a string at the current location on the screen.
drawString(String, Graphics, float, AffineTransform, float, float) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
drawString(String, int[], Graphics, float, AffineTransform, float, float) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will draw a string on a canvas using the font.
drawString(String, int[], Graphics, float, AffineTransform, float, float) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will draw a string on a canvas using the font.
drawString(String, int[], Graphics, float, AffineTransform, float, float) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
This will draw a string on a canvas using the font.
drawXObject(PDXObject, float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw an xobject(form or image) at the x,y coordinates and a certain width and height.
drawXObject(PDXObject, AffineTransform) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw an xobject(form or image) using the given AffineTransform to position the xobject.
DualCOSObjectable - Interface in org.apache.pdfbox.pdmodel.common
This is an interface to represent a PDModel object that holds two COS objects.
DUPLEX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DV - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
DW - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

E

E - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EARLY_CHANGE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EMBEDDED_FDFS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EMBEDDED_FILES - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ENCODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.ASCII85Filter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.ASCIIHexFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.CCITTFaxDecodeFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.CryptFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.DCTFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in interface org.apache.pdfbox.filter.Filter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.FlateFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.IdentityFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.JBIG2Filter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.JPXFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.LZWFilter
This will encode some data.
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.RunLengthDecodeFilter
This will encode some data.
encode(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
encode(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will perform the encoding of a character if needed.
encode(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
encode(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will perform the encoding of a character if needed.
encode(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
This will perform the encoding of a character if needed.
encode(byte[], byte[]) - Method in class org.apache.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.apache.pdfbox.pdmodel.graphics.predictor.Optimum
encode a byte array full of image data using the filter that this object implements.
encode(byte[], byte[]) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
encode a byte array full of image data using the filter that this object implements.
ENCODED_BYTE_ALIGN - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
encodeLine(byte[], byte[], int, int, int, int) - Method in class org.apache.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.apache.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.apache.pdfbox.pdmodel.graphics.predictor.Optimum
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.apache.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.apache.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.apache.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.apache.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.
encodeToCID(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
encodeToCID(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
encodeToCID(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Encoding - Class in org.apache.pdfbox.encoding
This is an interface to a text encoder.
Encoding() - Constructor for class org.apache.pdfbox.encoding.Encoding
 
ENCODING_90MS_RKSJ_H - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ENCODING_90MS_RKSJ_V - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ENCODING_ETEN_B5_H - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ENCODING_ETEN_B5_V - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EncodingConversionManager - Class in org.apache.pdfbox.encoding.conversion
EncodingConversionManager maintains relationship between PDF encoding name and respective EncodingConverter instance.
EncodingConverter - Interface in org.apache.pdfbox.encoding.conversion
EncodingConverter converts string or characters in one encoding, which is specified in PDF file, to another string with respective java charset.
EncodingManager - Class in org.apache.pdfbox.encoding
This class will handle getting the appropriate encodings.
EncodingManager() - Constructor for class org.apache.pdfbox.encoding.EncodingManager
 
ENCRYPT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Encrypt - Class in org.apache.pdfbox
This will read a document from the filesystem, encrypt it and and then write the results to the filesystem.
encrypt(String, String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will mark a document to be encrypted.
ENCRYPT_META_DATA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ENCRYPT_PADDING - Static variable in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated.
The encryption padding defined in the PDF 1.4 Spec algorithm 3.2.
ENCRYPT_PADDING - Static variable in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Standard padding for encryption.
encryptData(long, long, byte[], InputStream, OutputStream) - Method in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated.
This will encrypt a piece of data.
encryptData(long, long, InputStream, OutputStream) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Deprecated.
While this works fine for RC4 encryption, it will never decrypt AES data You should use encryptData(objectNumber, genNumber, data, output, decrypt) which can do everything. This function is just here for compatibility reasons and will be removed in the future.
encryptData(long, long, InputStream, OutputStream, boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Encrypt a set of data.
encryptionDictionary - Variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
COS encryption dictionary.
encryptionKey - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
The encryption key that will used to encrypt / decrypt.
encryptStream(COSStream, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will encrypt a stream, but not the dictionary as the dictionary is encrypted by visitFromString() in COSWriter and we don't want to encrypt it twice.
encryptString(COSString, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will encrypt a string.
END_OF_LINE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
endArticle() - Method in class org.apache.pdfbox.util.PDFText2HTML
Write out the article separator.
endArticle() - Method in class org.apache.pdfbox.util.PDFTextStripper
End an article.
endDocument(PDDocument) - Method in class org.apache.pdfbox.util.PDFText2HTML
This method is available for subclasses of this class.
endDocument(PDDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
This method is available for subclasses of this class.
endMarkedContentSequence() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
End a marked content sequence.
EndMarkedContentSequence - Class in org.apache.pdfbox.util.operator
EMC : Ends a marked-content sequence begun by BMC or BDC.
EndMarkedContentSequence() - Constructor for class org.apache.pdfbox.util.operator.EndMarkedContentSequence
 
endMarkedContentSequence() - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
 
ENDOBJ - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a byte array that will be used for comparisons.
ENDOBJ - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The end object token.
endPage - Variable in class org.apache.pdfbox.util.PageExtractor
 
endPage(PDPage) - Method in class org.apache.pdfbox.util.PDFHighlighter
End a page.
endPage(PDPage) - Method in class org.apache.pdfbox.util.PDFTextStripper
End a page.
endPath() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Set the clipping Path.
EndPath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
EndPath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.EndPath
 
ENDSTREAM - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a byte array that will be used for comparisons.
ENDSTREAM - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The close stream token.
endText() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
End some text operations.
EndText - Class in org.apache.pdfbox.util.operator
 
EndText() - Constructor for class org.apache.pdfbox.util.operator.EndText
 
ENTRUST_PPKEF - Static variable in class org.apache.pdfbox.cos.COSName
A signature filter value.
entrySet() - Method in class org.apache.pdfbox.cos.COSDictionary
Returns the name-value entries in this dictionary.
entrySet() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
EOD - Static variable in class org.apache.pdfbox.filter.LZWFilter
The LZW end of data code.
EOF - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The EOF constant.
EOF_MARKER - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
EOF-marker.
EOL - Static variable in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
standard line separator
EOL - Static variable in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
standard line separator.
EOL_CODE - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
The EOL code word.
equals(Object) - Method in class org.apache.pdfbox.cos.COSFloat
equals(Object) - Method in class org.apache.pdfbox.cos.COSInteger
equals(Object) - Method in class org.apache.pdfbox.cos.COSName
equals(Object) - Method in class org.apache.pdfbox.cos.COSString
equals(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
equals(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
equals(Object) - Method in class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
 
equals(Object) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
equals(Object) - Method in class org.apache.pdfbox.pdmodel.PDPage
equals(Object) - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
ErrorLogger - Class in org.apache.pdfbox.util
This class deals with some logging that is not handled by the log4j replacement.
ESCAPE - Static variable in class org.apache.pdfbox.cos.COSString
the escape character in strings.
eval(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Evaluates the function at the given input.
eval(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Evaluates the function at the given input.
eval(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Evaluates the function at the given input.
eval(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Evaluates the function at the given input.
eval(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Evaluates the function at the given input.
eval(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
Evaluates the function at the given input.
evalFunction(float) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
Convert the input value using the functions of the shading dictionary.
evalFunction(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
Convert the input values using the functions of the shading dictionary.
execute(ExecutionContext) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Executes the instruction sequence.
execute(ExecutionContext) - Method in interface org.apache.pdfbox.pdmodel.common.function.type4.Operator
Executes the operator.
ExecutionContext - Class in org.apache.pdfbox.pdmodel.common.function.type4
Makes up the execution context, holding the available operators and the execution stack.
ExecutionContext(Operators) - Constructor for class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
Creates a new execution context.
ExportFDF - Class in org.apache.pdfbox
This example will take a PDF document and fill the fields with data from the FDF fields.
ExportFDF() - Constructor for class org.apache.pdfbox.ExportFDF
Creates a new instance of ImportFDF.
exportFDF() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will export all FDF form data.
ExportXFDF - Class in org.apache.pdfbox
This example will take a PDF document and fill the fields with data from the FDF fields.
ExportXFDF() - Constructor for class org.apache.pdfbox.ExportXFDF
Creates a new instance of ImportFDF.
exportXMPMetadata() - Method in class org.apache.pdfbox.pdmodel.common.PDMetadata
Deprecated.
will return an InputStream in the future.
EXT_G_STATE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EXT_G_STATE - Static variable in class org.apache.pdfbox.Overlay
Deprecated.
use the COSName.EXT_G_STATE constant instead
EXTEND - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
EXTENDS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ExtensionFileFilter - Class in org.apache.pdfbox.util
A FileFilter that will only accept files of a certain extension.
ExtensionFileFilter(String[], String) - Constructor for class org.apache.pdfbox.util.ExtensionFileFilter
Constructor.
extract() - Method in class org.apache.pdfbox.util.PageExtractor
This will take a document and extract the desired pages into a new document.
ExtractImages - Class in org.apache.pdfbox
This will read a read pdf and extract images.
extractRegions(PDPage) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
Process the page to extract the region text.
extractScaling() - Method in class org.apache.pdfbox.util.Matrix
Create a new matrix with just the scaling operators.
ExtractText - Class in org.apache.pdfbox
This is the main program that simply parses the pdf document and transforms it into text.
extractTranslating() - Method in class org.apache.pdfbox.util.Matrix
Create a new matrix with just the translating operators.

F

F - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
F_DECODE_PARMS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
F_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FALSE - Static variable in class org.apache.pdfbox.cos.COSBoolean
The PDF false value.
FALSE_BYTES - Static variable in class org.apache.pdfbox.cos.COSBoolean
The false boolean token.
FastByteArrayOutputStream - Class in org.apache.pdfbox.io
An byte array output stream that allows direct access to the byte array.
FastByteArrayOutputStream(int) - Constructor for class org.apache.pdfbox.io.FastByteArrayOutputStream
Constructor.
FDFAnnotation - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF annotation that is part of the FDF document.
FDFAnnotation() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Default constructor.
FDFAnnotation(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Constructor.
FDFAnnotation(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Constructor.
FDFAnnotationCaret - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Caret FDF annotation.
FDFAnnotationCaret() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
Default constructor.
FDFAnnotationCaret(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
Constructor.
FDFAnnotationCaret(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
Constructor.
FDFAnnotationCircle - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Circle FDF annotation.
FDFAnnotationCircle() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
Default constructor.
FDFAnnotationCircle(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
Constructor.
FDFAnnotationCircle(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
Constructor.
FDFAnnotationFileAttachment - Class in org.apache.pdfbox.pdmodel.fdf
This represents a FileAttachment FDF annotation.
FDFAnnotationFileAttachment() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFileAttachment
Default constructor.
FDFAnnotationFileAttachment(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFileAttachment
Constructor.
FDFAnnotationFileAttachment(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFileAttachment
Constructor.
FDFAnnotationFreeText - Class in org.apache.pdfbox.pdmodel.fdf
This represents a FreeText FDF annotation.
FDFAnnotationFreeText() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Default constructor.
FDFAnnotationFreeText(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Constructor.
FDFAnnotationFreeText(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Constructor.
FDFAnnotationHighlight - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Highlight FDF annotation.
FDFAnnotationHighlight() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationHighlight
Default constructor.
FDFAnnotationHighlight(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationHighlight
Constructor.
FDFAnnotationHighlight(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationHighlight
Constructor.
FDFAnnotationInk - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Ink FDF annotation.
FDFAnnotationInk() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
Default constructor.
FDFAnnotationInk(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
Constructor.
FDFAnnotationInk(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
Constructor.
FDFAnnotationLine - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Line FDF annotation.
FDFAnnotationLine() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
Default constructor.
FDFAnnotationLine(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
Constructor.
FDFAnnotationLine(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
Constructor.
FDFAnnotationPolygon - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Polygon FDF annotation.
FDFAnnotationPolygon() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
Default constructor.
FDFAnnotationPolygon(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
Constructor.
FDFAnnotationPolygon(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
Constructor.
FDFAnnotationPolyline - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Polyline FDF annotation.
FDFAnnotationPolyline() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
Default constructor.
FDFAnnotationPolyline(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
Constructor.
FDFAnnotationPolyline(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
Constructor.
FDFAnnotationSound - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Sound FDF annotation.
FDFAnnotationSound() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSound
Default constructor.
FDFAnnotationSound(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSound
Constructor.
FDFAnnotationSound(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSound
Constructor.
FDFAnnotationSquare - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Square FDF annotation.
FDFAnnotationSquare() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
Default constructor.
FDFAnnotationSquare(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
Constructor.
FDFAnnotationSquare(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
Constructor.
FDFAnnotationSquiggly - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Squiggly FDF annotation.
FDFAnnotationSquiggly() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquiggly
Default constructor.
FDFAnnotationSquiggly(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquiggly
Constructor.
FDFAnnotationSquiggly(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquiggly
Constructor.
FDFAnnotationStamp - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Stamp FDF annotation.
FDFAnnotationStamp() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStamp
Default constructor.
FDFAnnotationStamp(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStamp
Constructor.
FDFAnnotationStamp(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStamp
Constructor.
FDFAnnotationStrikeOut - Class in org.apache.pdfbox.pdmodel.fdf
This represents a StrikeOut FDF annotation.
FDFAnnotationStrikeOut() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStrikeOut
Default constructor.
FDFAnnotationStrikeOut(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStrikeOut
Constructor.
FDFAnnotationStrikeOut(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStrikeOut
Constructor.
FDFAnnotationText - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Text FDF annotation.
FDFAnnotationText() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
Default constructor.
FDFAnnotationText(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
Constructor.
FDFAnnotationText(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
Constructor.
FDFAnnotationUnderline - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Underline FDF annotation.
FDFAnnotationUnderline() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationUnderline
Default constructor.
FDFAnnotationUnderline(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationUnderline
Constructor.
FDFAnnotationUnderline(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationUnderline
Constructor.
FDFCatalog - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF catalog that is part of the FDF document.
FDFCatalog() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
Default constructor.
FDFCatalog(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
Constructor.
FDFCatalog(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will create an FDF catalog from an XFDF XML document.
FDFDictionary - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF dictionary that is part of the FDF document.
FDFDictionary() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
Default constructor.
FDFDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
Constructor.
FDFDictionary(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will create an FDF dictionary from an XFDF XML document.
FDFDocument - Class in org.apache.pdfbox.pdmodel.fdf
This is the in-memory representation of the FDF document.
FDFDocument() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFDocument
Constructor, creates a new FDF document.
FDFDocument(COSDocument) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFDocument
Constructor that uses an existing document.
FDFDocument(Document) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will create an FDF document from an XFDF XML document.
FDFField - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF field that is part of the FDF document.
FDFField() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFField
Default constructor.
FDFField(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFField
Constructor.
FDFField(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFField
This will create an FDF field from an XFDF XML document.
FDFIconFit - Class in org.apache.pdfbox.pdmodel.fdf
This represents an Icon fit dictionary for an FDF field.
FDFIconFit() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
Default constructor.
FDFIconFit(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
Constructor.
FDFJavaScript - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF JavaScript dictionary that is part of the FDF document.
FDFJavaScript() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
Default constructor.
FDFJavaScript(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
Constructor.
FDFNamedPageReference - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF named page reference that is part of the FDF field.
FDFNamedPageReference() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
Default constructor.
FDFNamedPageReference(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
Constructor.
FDFOptionElement - Class in org.apache.pdfbox.pdmodel.fdf
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.apache.pdfbox.pdmodel.fdf.FDFOptionElement
Default constructor.
FDFOptionElement(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
Constructor.
FDFPage - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF page that is part of the FDF document.
FDFPage() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFPage
Default constructor.
FDFPage(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFPage
Constructor.
FDFPageInfo - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF page info that is part of the FDF page.
FDFPageInfo() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFPageInfo
Default constructor.
FDFPageInfo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFPageInfo
Constructor.
FDFTemplate - Class in org.apache.pdfbox.pdmodel.fdf
This represents an FDF template that is part of the FDF page.
FDFTemplate() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
Default constructor.
FDFTemplate(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
Constructor.
FF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FF_ESCAPE - Static variable in class org.apache.pdfbox.cos.COSString
FF escape characters.
FIELDS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Figure - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Figure
FILESPEC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
fill(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Fill the path.
fillBuffer() - Method in class org.apache.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.
FillEvenOddAndStrokePath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
FillEvenOddAndStrokePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.FillEvenOddAndStrokePath
 
FillEvenOddRule - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
FillEvenOddRule() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.FillEvenOddRule
 
FillNonZeroAndStrokePath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
FillNonZeroAndStrokePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.FillNonZeroAndStrokePath
 
FillNonZeroRule - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
FillNonZeroRule() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.FillNonZeroRule
 
FillOrderChangeInputStream - Class in org.apache.pdfbox.io.ccitt
This filtering input stream does a fill order change required for certain TIFF images.
FillOrderChangeInputStream(InputStream) - Constructor for class org.apache.pdfbox.io.ccitt.FillOrderChangeInputStream
Main constructor.
fillPath(int) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill the path.
fillPolygon(float[], float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw and fill a polygon on the page using the current non stroking color.
fillRect(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Draw a rectangle on the page using the current non stroking color.
FILTER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Filter - Interface in org.apache.pdfbox.filter
This is the interface that will be used to apply filters to a byte stream.
FILTER - Static variable in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
The filter name.
FILTER - Static variable in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Type of security handler.
FILTER_ADOBE_PPKLITE - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature filter value.
FILTER_CICI_SIGNIT - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature filter value.
FILTER_ENTRUST_PPKEF - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature filter value.
FILTER_NAME - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
The 'Filter' name for this security handler.
FILTER_VERISIGN_PPKVS - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature filter value.
FilterManager - Class in org.apache.pdfbox.filter
This will contain manage all the different types of filters that are available.
FilterManager() - Constructor for class org.apache.pdfbox.filter.FilterManager
Constructor.
finalize() - Method in class org.apache.pdfbox.cos.COSDocument
Warn the user in the finalizer if he didn't close the PDF document.
findCropBox() - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.interactive.form.PDField
Find the field type and optionally do a recursive upward search.
findKid(String[], int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will find one of the child elements.
findMediaBox() - Method in class org.apache.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.apache.pdfbox.pdmodel.PDPageNode
This will find the MediaBox for this page by looking up the hierarchy until it finds them.
findPageNumber() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Deprecated.
This method has inconsistent behavior (see returns), use PDPageDestination.retrieveDestPageNumber() instead.
findResources() - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.PDPageNode
This will find the rotation for this page by looking up the hierarchy until it finds them.
FIRST - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FIRST_CHAR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FIT_WINDOW - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
fitBoundingBox() - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the fit window preference.
fixY(double) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fix the y coordinate.
FL - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FLAG_ADD_REV_INFO - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_COMB - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_COMBO - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
A Ff flag.
FLAG_DIGEST_METHOD - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_DO_NOT_SCROLL - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_DO_NOT_SPELL_CHECK - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_EDIT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
A Ff flag.
FLAG_FILE_SELECT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_FILTER - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_HIDDEN - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_INVISIBLE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_LEGAL_ATTESTATION - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_LOCKED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_MULTILINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_NO_EXPORT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDField
A Ff flag.
FLAG_NO_ROTATE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_NO_VIEW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_NO_ZOOM - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_PASSWORD - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_PRINTED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_RADIOS_IN_UNISON - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
A Ff flag.
FLAG_READ_ONLY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_READ_ONLY - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDField
A Ff flag.
FLAG_REASON - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_REQUIRED - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDField
A Ff flag.
FLAG_RICH_TEXT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Ff flag.
FLAG_SUBFILTER - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_TOGGLE_NO_VIEW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
FLAG_V - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAGS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FLATE_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FLATE_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FlateFilter - Class in org.apache.pdfbox.filter
This is the used for the FlateDecode filter.
FlateFilter() - Constructor for class org.apache.pdfbox.filter.FlateFilter
 
floatValue() - Method in class org.apache.pdfbox.cos.COSFloat
The value of the float object that this one wraps.
floatValue() - Method in class org.apache.pdfbox.cos.COSInteger
polymorphic access to value as float.
floatValue() - Method in class org.apache.pdfbox.cos.COSNumber
This will get the float value of this number.
flush() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will flush the data to the stream.
FONT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
font - Variable in class org.apache.pdfbox.pdmodel.font.PDFont
The cos dictionary for this font.
FONT_BBOX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_DESC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_FAMILY - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_FILE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_FILE2 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_FILE3 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_MATRIX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_NAME - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_STRETCH - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FONT_WEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FontManager - Class in org.apache.pdfbox.pdmodel.font
This class is used as font manager.
fontMatrix - Variable in class org.apache.pdfbox.pdmodel.font.PDFont
The font matrix.
forceParsing - Variable in class org.apache.pdfbox.pdfparser.BaseParser
Flag to skip malformed or otherwise unparseable input where possible.
FORM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FORM - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Form
formaterRectangleParams(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
sets formatter PDRectangle;
formatTZoffset(long, String) - Static method in class org.apache.pdfbox.util.DateConverter
Formats a time zone offset as #hh^mm where # is + or -, hh is hours, ^ is a separator, and mm is minutes.
FORMTYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FORMULA - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Formula
FRACTIONAL_DISPLAY_DECIMAL - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constant for showing a fractional value as decimal to the precision specified by the D entry.
FRACTIONAL_DISPLAY_FRACTION - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constant for showing a fractional value as a fraction with denominator specified by the D entry.
FRACTIONAL_DISPLAY_ROUND - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constant for showing a fractional value without fractional part; round to the nearest whole unit.
FRACTIONAL_DISPLAY_TRUNCATE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constant for showing a fractional value without fractional part; truncate to achieve whole units.
FRM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
fromCIEXYZ(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
fromCIEXYZ(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCMYK
fromCIEXYZ(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceLab
fromRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
fromRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCMYK
fromRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceLab
FT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FUNCTION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FUNCTION_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
FUNCTIONS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

G

GAMMA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
GARBAGE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
Garbage bytes used to create the PDF header.
generateXMLHighlight(PDDocument, String, Writer) - Method in class org.apache.pdfbox.util.PDFHighlighter
Generate an XML highlight string based on the PDF.
generateXMLHighlight(PDDocument, String[], Writer) - Method in class org.apache.pdfbox.util.PDFHighlighter
Generate an XML highlight string based on the PDF.
get(int) - Method in class org.apache.pdfbox.cos.COSArray
This will get an object from the array.
get(long) - Static method in class org.apache.pdfbox.cos.COSInteger
Returns a COSInteger instance with the given value.
get(String) - Static method in class org.apache.pdfbox.cos.COSNumber
This factory method will get the appropriate number object.
get(int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
get(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
get(int) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get a stream (or the reference to a stream) from the array.
getAcroForm() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Acroform
getAcroForm() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get the acroform that this field is part of.
getAcroForm() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
This will get the documents acroform.
getAcroFormDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Dictionary of AcroForm.
getAcroFormFields() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets acroFormFields
getAction() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the action that is associated with this field.
getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
 
getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Get the action to be performed when this annotation is to be activated.
getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Get the action to be performed when this annotation is to be activated.
getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the action of this node.
getActions() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Get the additional actions for this field.
getActions() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Get the additional actions for this field.
getActions() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
 
getActions() - Method in class org.apache.pdfbox.pdmodel.PDPage
Get the page actions.
getActualText() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the actual text (ActualText).
getActualText() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the actual text (ActualText).
getAdditionalActions() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get a list of additional actions that will get executed based on events.
getAddMoreFormatting() - Method in class org.apache.pdfbox.util.PDFTextStripper
This will tell if the text stripper should add some more text formatting.
getAffineTransform() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets AffineTransform
getAffineTransformParams() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getAFM() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get an AFM object if one exists.
getAfter() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
This will get the javascript that is executed after the import.
getAfterColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Gets the colour for the after edge.
getAllKids(List) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will return all kids of this node as PDPage.
getAllPages() - Method in class org.apache.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.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the stroke alpha constants property.
getAlphaSourceFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the alpha source flag.
getAlternateCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the alternate caption.
getAlternateColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the alternate color space for this separation.
getAlternateColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the alternate color space for this separation.
getAlternateColorSpaces() - Method in class org.apache.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.
getAlternateDescription() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the alternate description (Alt).
getAlternateDescription() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the alternate description (Alt).
getAlternateFieldName() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Gets the alternate name of the field.
getAlternateIcon() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the alternate icon.
getAlternateName() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Gets the alternate name of the field (Desc).
getAngles() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the angles.
getAnnotationFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the flags for this field.
getAnnotationName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the name, a string intended to uniquely identify each annotation within a page.
getAnnotations() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of FDF Annotations.
getAnnotations() - Method in class org.apache.pdfbox.pdmodel.PDPage
This will return a list of the annotations for this page.
getAntiAlias() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
This will return a boolean flag indicating whether to antialias the shading pattern.
getAntiAlias() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will return the AntiAlias value.
getApp() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
A build data dictionary for the viewing application software module that was used to create the parent signature.
getAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the appearance dictionary associated with this annotation.
getAppearanceCharacteristics() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Returns the appearance characteristics dictionary.
getAppearanceDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the appearance dictionary that specifies the appearance of a pushbutton field.
getAppearanceDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets AppearanceDictionary That is /AP entry the appearance dictionary.
getAppearanceStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the name of the current appearance stream if any.
getAppearanceStreamReference() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get named page references..
getARange() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will get the valid range for the "a" component.
getAreas() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the areas.
getArrayOfString(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets an array of strings.
getArtBox() - Method in class org.apache.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.
getArticleEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
Returns the string which will be used at the end of an article.
getArticleStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
Returns the string which will be used at the beginning of an article.
getAscent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the ascent for the font.
getAscent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the ascent for the font.
getAscent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the ascent for the font.
getAsStream() - Method in class org.apache.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.apache.pdfbox.pdmodel.common.PDTextStream
This will get this value as a string.
getAttachmentName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
This is the name used to draw the type of attachment.
getAttributeNames() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
Gets the attribute names.
getAttributes() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the attributes together with their revision numbers (A).
getAttributes() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the attributes that are associated with the deviceN color space.
getAttributeValue(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
Gets the attribute value for a given name.
getAttributeValue(String, COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
Gets the attribute value for a given name.
getAuthor() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the author of the document.
getAutomaticStrokeAdjustment() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the automatic stroke adjustment flag.
getAverageCharTolerance() - Method in class org.apache.pdfbox.util.PDFTextStripper
Get the current character width-based tolerance value that is being used to estimate where spaces in text should be added.
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the average font width for all characters.
getAverageFontWidthFromAFMFile() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will attempt to get the average font width from an AFM file.
getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the average width for the font.
getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the average width for the font.
getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the average width for the font.
getAwtFont(String) - Static method in class org.apache.pdfbox.pdmodel.font.FontManager
Get the font for the given fontname.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0Font
Returns the AWT font that corresponds with this CIDFontType0 font.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
Looks up, creates, returns the AWT Font.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Looks up, creates, returns the AWT Font.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Looks up, creates, returns the AWT Font.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Looks up, creates, returns the AWT Font.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
Looks up, creates, returns the AWT Font.
getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
Looks up, creates, returns the AWT Font.
getB() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
This will get the b value of the tristimulus.
getBackground() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will return the background.
getBackground() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the background color.
getBackgroundColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the background colour (BackgroundColor).
getBase() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
Deprecated.
getBase() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
This will get the base URI to be used in resolving relative URI references.
getBaseColorSpace() - Method in class org.apache.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.apache.pdfbox.pdmodel.font.PDFont
The PostScript name of the font.
getBaselineShift() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the distance by which the element's baseline shall be shifted relative to that of its parent element (BaselineShift).
getBaseState() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Returns the base state for optional content groups.
getBBox() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Gets the artifact's bounding box (BBox).
getBBox() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the bounding box.
getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern's bounding box.
getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the shadings's bounding box.
getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the form XObject's bounding box.
getBBox() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will retrieve the rectangle specifying the location of the viewport.
getBefore() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
This will get the javascript that is executed before the import.
getBeforeColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Gets the colour for the before edge.
getBitCount() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Returns the number of bits maintained by this array.
getBitsPerComponent() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
The bits per component of this image.
getBitsPerComponent() - Method in class org.apache.pdfbox.util.ImageParameters
The bits per component of this image.
getBitsPerFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
The bits per flag of this shading.
getBitsPerSample() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Get the number of bits that the output value will take up.
getBl() - Method in class org.apache.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.apache.pdfbox.pdmodel.graphics.color.PDCalGray
This will return the BlackPoint tristimulus.
getBlackPoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will return the BlackPoint tristimulus.
getBlackPoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will return the BlackPoint tristimulus.
getBleedBox() - Method in class org.apache.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.
getBlockAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the alignment, in the block-progression direction, of content within the table cell (BlockAlign).
getBoolean(boolean) - Static method in class org.apache.pdfbox.cos.COSBoolean
This will get the boolean value.
getBoolean(Boolean) - Static method in class org.apache.pdfbox.cos.COSBoolean
This will get the boolean value.
getBoolean(String, boolean) - Method in class org.apache.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.apache.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.
getBoolean(COSName, COSName, boolean) - Method in class org.apache.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.
getBorderColors() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the border colour (BorderColor).
getBorderColour() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the border color.
getBorderEffect() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the border style (BorderStyle).
getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
getBorderThickness() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the border thickness (BorderThickness).
getBottom() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the bottom y coordinate.
getBottomStatusPanel() - Method in class org.apache.pdfbox.PDFReader
Get the bottom status panel.
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Get the bounding box for this appearance.
getBounds() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Returns all bounds values as COSArray.
getBpp() - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getBRange() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will get the valid range for the "b" component.
getByteArray() - Method in class org.apache.pdfbox.io.FastByteArrayOutputStream
This will get the underlying byte array.
getByteArray() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will copy the stream into a byte array.
getByteArray() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will copy the stream into a byte array.
getByteCount() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Returns the size of the byte buffer for this array.
getByteOffset() - Method in class org.apache.pdfbox.pdmodel.common.XrefEntry
 
getByteRange() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Read out the byterange from the file.
getBytes() - Method in class org.apache.pdfbox.cos.COSString
This will get the bytes of the string.
getBytes() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDXFA
Get the XFA content as byte array.
getBytes(String) - Static method in class org.apache.pdfbox.util.StringUtil
Converts a string to it ISO-8859-1 byte sequence It is an workaround for variable initialisations outside of functions.
getC() - Method in class org.apache.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.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will get an action to be performed when the page is closed.
getC0() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Returns the C0 values of the function, 0 if empty.
getC1() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Returns the C1 values of the function, 1 if empty.
getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the CapHeight for the font.
getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the CapHeight for the font.
getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the CapHeight for the font.
getCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve if the contents are shown as a caption or not.
getCaptionHorizontalOffset() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the horizontal offset of the caption.
getCaptionPositioning() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the caption positioning.
getCaptionVerticalOffset() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the vertical offset of the caption.
getCatalog() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the document catalog.
getCatalog() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will get the FDF Catalog.
getCertificate() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
Returns the certificate contained in the keystore.
getChangeXs() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the changes along the x-axis.
getChangeYs() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the changes along the y-axis.
getCharacter(int) - Method in class org.apache.pdfbox.encoding.Encoding
This will get the character from the code.
getCharacter(String) - Method in class org.apache.pdfbox.encoding.Encoding
This will get the character from the name.
getCharacter() - Method in class org.apache.pdfbox.util.TextPosition
Return the string of characters stored in this object.
getCharacterForName(String) - Static method in class org.apache.pdfbox.encoding.Encoding
This will take a name and get the character code for that name.
getCharactersByArticle() - Method in class org.apache.pdfbox.util.PDFTextStripper
Character strings are grouped by articles.
getCharacterSpacing() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the characterSpacing.
getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the character set for the font.
getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the character set for the font.
getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the character set for the font.
getCheckedState() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Gets the checked state.
getCheckSum() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the check sum of the embedded file.
getChild(Object, int) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Returns the child of parent at index index in the parent's child array.
getChildCount(Object) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Returns the number of children of parent.
getClassNames() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the class names together with their revision numbers (C).
getClearFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the ClrFf entry of the cos dictionary.
getClearWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the ClrF entry of the cos dictionary.
getCode(String) - Method in class org.apache.pdfbox.encoding.Encoding
This will get the character code for the name.
getCodeFromArray(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Used for multibyte encodings.
getCodePoints() - Method in class org.apache.pdfbox.util.TextPosition
Return the codepoints of the characters stored in this object.
getCodeToNameMap() - Method in class org.apache.pdfbox.encoding.Encoding
Returns an unmodifiable view of the Code2Name mapping.
getColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).
getColor(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a colour.
getColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the annotation color.
getColorantName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the separation name.
getColorantNames() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the colorant names.
getColorants() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
This will get a map of colorants.
getColorModel() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
getColorModel() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
getColorOrFourColors(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a single colour or four colours.
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will get the current colorspace.
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
This will return the Color Space.
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will get the color space or null if none exists.
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
This will get the color space.
getColorSpace() - Method in class org.apache.pdfbox.util.ImageParameters
This will get the color space or null if none exists.
getColorSpace(Map) - Method in class org.apache.pdfbox.util.ImageParameters
This will get the color space or null if none exists.
getColorSpaces() - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the map of colorspaces.
getColorSpaces() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getColorSpaceValue() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will get the color space values.
getColour() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the colour used in drawing various elements.
getColSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Gets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).
getColSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Gets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).
getColumnCount() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the number of columns in the content of the grouping element (ColumnCount).
getColumnGap() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the desired space between adjacent columns in the inline-progression direction (ColumnGap).
getColumnWidths() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the desired width of the columns, measured in default user space units in the inline-progression direction (ColumnWidths).
getConstantOpacity() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the constant opacity value used when rendering the annotation (excluing any popup).
getContactInfo() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Returns the contact info.
getContainedObjectNumbers(int) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Returns object numbers which are referenced as contained in object stream with specified object number.
getContents() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the contents of the marked content sequence.
getContents() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the "contents" of the field.
getContents(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Will return the embedded signature between the byterange gap.
getContents(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Will return the embedded signature between the byterange gap.
getContents() - Method in class org.apache.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.
getContext() - Method in class org.apache.pdfbox.util.operator.OperatorProcessor
Get the context for processing.
getConversionFactor() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the conversion factor.
getConverter(String) - Static method in class org.apache.pdfbox.encoding.conversion.EncodingConversionManager
Get converter from given encoding name.
getCoords() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
Returns the coordinate array used by several of the gradient types.
getCoords() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
Returns the coords values.
getCoords() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
This will get the Coords values for this shading.
getCoords() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
Returns the coords values.
getCoordSystemOrigin() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the origin of the coordinate system.
getCOSArray() - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
This will get the underlying array value.
getCOSArray() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will get the underlying array value.
getCOSArray() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the underlying array for this rectangle.
getCOSArray() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
Convert this standard java object to a COS object.
getCOSArray() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Convert this standard java object to a COS object.
getCOSArray() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Convert this standard java object to a COS object.
getCOSColorSpaceValue() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will get the color space values.
getCOSDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Get the line dash pattern as a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
Gets the COS dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Returns the underlying dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
 
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Returns the underlying dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
 
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
This will get the dictionary associated with this crypt filter dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the dictionary associated with this encryption dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPageInfo
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the dictionary for this object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
This will get the underlying cos dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will get the underlying dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the underlying dictionary that this class acts on.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will get the underlying dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Convert this standard java object to a COS object.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDPage
This will get the underlying dictionary that this class acts on.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the underlying dictionary.
getCOSObject() - Method in class org.apache.pdfbox.cos.COSBase
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.AFMEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.DictionaryEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.MacOSRomanEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.MacRomanEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.PdfDocEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.StandardEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.Type1Encoding
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.encoding.WinAnsiEncoding
Convert this standard java object to a COS object.
getCOSObject() - Method in interface org.apache.pdfbox.pdmodel.common.COSObjectable
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Returns the COSObject.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDTextStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPageInfo
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Returns the stream.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Interface method for COSObjectable.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
returns the dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
returns the dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
returns the dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDXFA
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDestinationDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDPage
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDResources
Convert this standard java object to a COS object.
getCOSStream() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Returns the stream.
getCount() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will get the count of descendent page objects.
getCreationDate() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the creation date of the embedded file.
getCreationDate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
The annotation create date.
getCreationDate() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the date and time the annotation was created.
getCreationDate() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the creation date of the document.
getCreator() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the creator of the document.
getCropBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the visible region of default user space.
getCropBox() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will get the CropBox at this page and not look up the hierarchy.
getCryptFilterDictionary(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Returns the crypt filter with the given name.
getCryptFilterMethod() - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
This will return the crypt filter method.
getCurrentAccessPermission() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Returns the access permissions that were computed during document decryption.
getCurrentAccessPermission() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Returns the access permissions granted when the document was decrypted.
getCurrentClippingPath() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the current clipping path.
getCurrentPage() - Method in class org.apache.pdfbox.util.PDFStreamEngine
Get the current page that is being processed.
getCurrentPageNo() - Method in class org.apache.pdfbox.util.PDFTextStripper
Get the current page number that is being processed.
getCurrentTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Returns the trailer last set by XrefTrailerResolver.setTrailer(COSDictionary).
getCurrentTransformationMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the CTM.
getCustomMetadataValue(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the value of a custom metadata information field for the document.
getCYX() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the CYX factor.
getD() - Method in class org.apache.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.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get the string specifying the default directory in standard DOS syntax.
getD() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will get the destination to jump to.
getDashPattern() - Method in class org.apache.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.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will retrieve the dash style used for drawing the border.
getData() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Returns the underlying byte buffer.
getDate(String) - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a date.
getDate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Modification date.
getDate() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The build date of the software module.
getDecimalSeparator() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the text to be used as the decimal point in displaying numerical values.
getDecode() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Returns the Decode Array of an XObjectImage.
getDecodedStreamLength() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Get the decoded stream length.
getDecodeForParameter(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Get the decode for the input parameter.
getDecodeParams() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Get the list of decode parameters.
getDecodeParams() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Deprecated.
getDecodeParms() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Get the list of decode parameters.
getDecryptionCertificate() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Getter of the property decryptionCertificate.
getDefaultAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
getDefaultAppearanceString() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will get the string of default appearance string.
getDefaultOverlayFile() - Method in class org.apache.pdfbox.util.Overlay
Returns the default overlay file.
getDefaultResources() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the default resources for the acro form.
getDefaultWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
This will get the default width.
getDenominator() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the precision or denominator of a fractional amount.
getDescendantFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Provides the descendant font.
getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the descent for the font.
getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the descent for the font.
getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the descent for the font.
getDescription() - Method in class org.apache.pdfbox.util.ExtensionFileFilter
getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
This will get the destination to jump to.
getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Get the destination to be displayed when the annotation is activated.
getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the page destination of this node.
getDestination(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDestinationDictionary
Returns the destination corresponding to the parameter.
getDestination() - Method in class org.apache.pdfbox.util.PDFCloneUtility
Returns the destination PDF document this cloner instance is set up for.
getDestinationFileName() - Method in class org.apache.pdfbox.util.PDFMergerUtility
Get the name of the destination file.
getDestinationStream() - Method in class org.apache.pdfbox.util.PDFMergerUtility
Get the destination OutputStream.
getDestOutputIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getDests() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
 
getDests() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Get the destination named tree node.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get the dictionary that is associated with this stream.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Returns the stream.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Convert this standard java object to a COS object.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Convert this standard java object to a COS object.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
Returns the corresponding dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
returns the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
returns the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
returns the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
returns the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
returns the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
returns the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Convert this standard java object to a COS dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Convert this standard java object to a COS dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
Convert this standard java object to a COS dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Convert this standard java object to a COS dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Convert this standard java object to a COS dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Convert this standard java object to a COS dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the dictionary that this form wraps.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get the dictionary associated with this field.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
This will return the corresponding dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will return the corresponding dictionary.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the underlying dictionary that this object wraps.
getDictionary() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will get the underlying dictionary that this class acts on.
getDictionary() - Method in class org.apache.pdfbox.util.ImageParameters
This will get the dictionary that stores the image parameters.
getDictionaryObject(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This will get an object from this dictionary.
getDictionaryObject(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
Deprecated.
use COSDictionary.getDictionaryObject(COSName, COSName) using COSName constants instead
getDictionaryObject(COSName, COSName) - Method in class org.apache.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.apache.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.apache.pdfbox.cos.COSDictionary
This will get an object from this dictionary.
getDictionaryObject(COSName) - Method in class org.apache.pdfbox.cos.COSDictionaryLateBinding
This will get an object from this dictionary.
getDictionaryObject(COSName) - Method in class org.apache.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.apache.pdfbox.pdmodel.common.COSStreamArray
This will get an object from this streams dictionary and dereference it if necessary.
getDifferences() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the incremental updates since the PDF was last opened.
getDigestMethod() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
An array of names indicating acceptable digest algorithms to use when signing.
getDir() - Method in class org.apache.pdfbox.util.TextPosition
Return the direction/orientation of the string in this object based on its text matrix.
getDirectory() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The dir to launch from.
getDistances() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the distances.
getDocument() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will get the document that was parsed.
getDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will get the document that was parsed.
getDocument() - Method in class org.apache.pdfbox.pdfparser.VisualSignatureParser
Returns the underlying COSDocument.
getDocument() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will get the low level document.
getDocument() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the document associated with this form.
getDocument() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDXFA
Get the XFA content as W3C document.
getDocument() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the low level document.
getDocument() - Method in class org.apache.pdfbox.util.LayerUtility
Returns the PDF document we work on.
getDocumentCatalog() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the document CATALOG.
getDocumentID() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the document ID.
getDocumentId() - Method in class org.apache.pdfbox.pdmodel.PDDocument
 
getDocumentInformation() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the document info dictionary.
getDocumentOutline() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the outline associated with this document or null if it does not exist.
getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
Returns the Domain array used by several of the gradient types.
getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
Returns the domain values.
getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
This will get the optional Domain values of a function based shading.
getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
This will get the optional Domain values for this shading.
getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
Returns the domain values.
getDomainForInput(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
This will get the range for a certain input parameter.
getDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getDP() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed after printing a document.
getDropThreshold() - Method in class org.apache.pdfbox.util.PDFTextStripper
the minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start.
getDS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed after saving a document.
getDuplex() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the Duplex preference.
getE() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the cursor enters the annotation's active area.
getElementIdentifier() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the element identifier (ID).
getEmbedded() - Method in exception org.apache.pdfbox.exceptions.CryptographyException
This will get the exception that caused this exception.
getEmbeddedDate(String, String) - Method in class org.apache.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.apache.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.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded file.
getEmbeddedFileDos() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded dos file.
getEmbeddedFileMac() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded Mac file.
getEmbeddedFiles() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Get the embedded files named tree node.
getEmbeddedFileUnicode() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded unicode file.
getEmbeddedFileUnix() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get the embedded Unix file.
getEmbeddedInt(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(String, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(String, String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(String, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedString(String, String) - Method in class org.apache.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.apache.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.apache.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.apache.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.
getEncode() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Returns all encode values as COSArray.
getEncodeForParameter(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Get the encode for the input parameter.
getEncoding(COSName) - Method in class org.apache.pdfbox.encoding.EncodingManager
This will get an encoding by name.
getEncoding() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
The encoding to be used for a FDF field.
getEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
cache the COSName.ENCODING object from the font's dictionary since it is called so often.
getEncryptionDictionary() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the encryption dictionary if the document is encrypted or null if the document is not encrypted.
getEncryptionDictionary(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionManager
Deprecated.
This will get the correct security handler for the encryption dictionary.
getEncryptionDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the encryption dictionary for this document.
getEncryptionKeyLength() - Method in class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
Get the length of the secrete key that will be used to encrypt document data.
getEndBookmark() - Method in class org.apache.pdfbox.util.PDFTextStripper
Get the bookmark where text extraction should end, inclusive.
getEndColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Gets the colour for the end edge.
getEndIndent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).
getEndPage() - Method in class org.apache.pdfbox.util.PageExtractor
Gets the last page number (inclusive) to be extracted.
getEndPage() - Method in class org.apache.pdfbox.util.PDFTextStripper
This will get the last page that will be extracted.
getEndPage() - Method in class org.apache.pdfbox.util.Splitter
This will return the end page.
getEndPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
getErrNo() - Method in exception org.apache.pdfbox.exceptions.SignatureException
A error number to fulfill this exception
getExecuteParam() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
A parameter to pass the executable.
getExpandedForm() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the expanded form (E).
getExpandedForm() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the expanded form (E).
getExpectedLength() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
This will get the length that the PDF document specified this stream should be.
getExtend() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
Returns the Extend array used by several of the gradient types.
getExtend() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
Returns the extend values.
getExtend() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
This will get the optional Extend values for this shading.
getExtend() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
Returns the extend values.
getExtendedGraphicsState() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
This will get the extended graphics state for this pattern.
getExtends() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
A reference to an object stream, of which the current object stream is considered an extension.
getExternalData() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will return the external data dictionary.
getF() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Get the F action.
getF() - Method in class org.apache.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.apache.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.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will get the FDF dictionary.
getFDFDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will get the FDF document that was parsed.
getField(String) - Method in class org.apache.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.apache.pdfbox.pdmodel.fdf.FDFField
This will get the Ff entry of the cos dictionary.
getFieldFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get the flags for this field.
getFields() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of FDF Fields.
getFields() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This will get a list of fields that are part of this template.
getFields() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will return all of the documents root fields.
getFieldType() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Get the FT entry of the field.
getFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the file name.
getFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
This will get the file name.
getFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
This will get the file name.
getFile() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get the file specification for this stream.
getFile() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get the file specification for this stream.
getFile() - Method in class org.apache.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.apache.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.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will get the file in which the destination is located.
getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Return the attached file.
getFileDecodeParams() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Get the list of decode parameters.
getFileDecodeParams() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Get the list of decode parameters.
getFileDescription() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the description.
getFileDos() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Dos file.
getFileFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get the list of filters that are associated with this stream.
getFileFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get the list of filters that are associated with this stream.
getFileInBytes(int[]) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
 
getFileMac() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Mac file.
getFilename() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Preferred method for getting the filename.
getFilename() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The file to launch.
getFilePointer() - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
getFileSpecification() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will get the file specification of this reference.
getFileUnicode() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the unicode file name.
getFileUnix() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Unix file.
getFilter(COSName) - Method in class org.apache.pdfbox.filter.FilterManager
This will get a filter by name.
getFilter(String) - Method in class org.apache.pdfbox.filter.FilterManager
This will get a filter by name.
getFilter() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Get the name of the filter.
getFilter() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
Get the name of the filter.
getFilter(int) - Static method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getFilter() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
A build data dictionary for the signature handler that was used to create the parent signature.
getFilter() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
If Filter is not null and the PDSeedValue.isFilterRequired() indicates this entry is a required constraint, then the signature handler specified by this entry shall be used when signing; otherwise, signing shall not take place.
getFilter() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Returns the filter.
getFilteredLength() - Method in class org.apache.pdfbox.cos.COSStream
This will get the length of the encoded stream.
getFilteredLengthWritten() - Method in class org.apache.pdfbox.cos.COSStream
This will get the length of the data written in the encoded stream.
getFilteredStream() - Method in class org.apache.pdfbox.cos.COSStream
This will get the stream with all of the filters applied.
getFilteredStream() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get the stream with all of the filters applied.
getFilterInputStream(int[]) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
 
getFilterManager() - Method in class org.apache.pdfbox.cos.COSBase
This will get the filter manager to use to filter streams.
getFilters() - Method in class org.apache.pdfbox.cos.COSStream
This will return the filters to apply to the byte stream.
getFilters() - Method in class org.apache.pdfbox.filter.FilterManager
This will get all of the filters that are available in the system.
getFilters() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will return the filters to apply to the byte stream the method will return
getFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get the list of filters that are associated with this stream.
getFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get the list of filters that are associated with this stream.
getFilters() - Method in class org.apache.pdfbox.util.ImageParameters
This will get the list of filters that are associated with this stream.
getFirstBead() - Method in class org.apache.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.apache.pdfbox.pdmodel.common.PDObjectStream
The byte offset (in the decoded stream) of the first compressed object.
getFirstChar() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
The code for the first char or -1 if there is none.
getFirstChild() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Return the first child or null if there is no child.
getFirstCOSObject() - Method in interface org.apache.pdfbox.pdmodel.common.DualCOSObjectable
Convert this standard java object to a COS object.
getFirstCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
Convert this standard java object to a COS object.
getFirstTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
 
getFlag(COSDictionary, String, int) - Static method in class org.apache.pdfbox.util.BitFlagHelper
Deprecated.
use BitFlagHelper.getFlag(COSDictionary, COSName, int) using COSName constants instead
getFlag(COSDictionary, COSName, int) - Static method in class org.apache.pdfbox.util.BitFlagHelper
Gets the boolean value from the flags at the given bit position.
getFlags() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the font flags.
getFlags() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the font flags.
getFlags() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the font flags.
getFlatness() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the flatness property.
getFlatnessTolerance() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the flatness tolerance.
getFloat(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float. -1 is returned if there is no value.
getFloat(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float. -1 is returned if there is no value.
getFloat(String, float) - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.graphics.PDFontSetting
This will get the font for this font setting.
getFont() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the font.
getFont() - Method in class org.apache.pdfbox.TextToPDF
 
getFont() - Method in class org.apache.pdfbox.util.TextPosition
This will get the font for the text being drawn.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the fonts bounding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the fonts bouding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the fonts bounding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the fonts bounding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
This will get the fonts bounding box.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the fonts bounding box.
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the font descriptor for this font.
getFontEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get or create the encoder.
getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A string representing the preferred font family.
getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
A string representing the preferred font family.
getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A string representing the preferred font family.
getFontFile() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A stream containing a Type 1 font program.
getFontFile2() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A stream containing a true type font program.
getFontFile3() - Method in class org.apache.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.apache.pdfbox.pdmodel.font.PDCIDFont
This will get the font height for a character.
getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the font height for a character.
getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the font height for a character.
getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
This will get the font height for a character.
getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the font height for a character.
getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the matrix that is used to transform glyph space to text space.
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the matrix that is used to transform glyph space to text space.
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
This will get the matrix that is used to transform glyph space to text space.
getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Get the font name.
getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
Get the font name.
getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Get the font name.
getFonts(Map<String, PDFont>) - Method in class org.apache.pdfbox.pdmodel.PDResources
Deprecated.
due to some side effects font caching is no longer supported, use PDResources.getFonts() instead
getFonts() - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the map of fonts.
getFonts() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getFontSetting() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the font setting of the graphics state.
getFontSize() - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
This will get the size of the font.
getFontSize() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the fontSize.
getFontSize() - Method in class org.apache.pdfbox.TextToPDF
 
getFontSize() - Method in class org.apache.pdfbox.util.TextPosition
This will get the font size that this object is suppose to be drawn at.
getFontSizeInPt() - Method in class org.apache.pdfbox.util.TextPosition
This will get the font size in pt.
getFontStretch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A string representing the preferred font stretch.
getFontStretch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
A string representing the preferred font stretch.
getFontStretch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
A string representing the preferred font stretch.
getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
The weight of the font.
getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
The weight of the font.
getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
The weight of the font.
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
This will get the font width for a character.
getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
Determines the width of the given character.
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the font width for a character.
getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Determines the width of the given character.
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the font width for a character.
getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
This will get the font width for a character.
getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Determines the width of the given character.
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the font width for a character.
getFontWidthFromAFMFile(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will attempt to get the font width from an AFM file.
getFormaterRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets formatter rectangle
getFormaterRectangleParams() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getFormats() - Static method in class org.apache.pdfbox.util.DateConverter
Get all know formats.
getFormattedValue() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Returns the string for the property value.
getFormType() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will get the form type, currently 1 is the only form type.
getFractionalDisplay() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the value for the manner to display a fractional value.
getFractionalSpaceToAllocate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This is guaranteed to never return null.
getFullyQualifiedName() - Method in class org.apache.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.
getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
Returns the function used by several of the gradient types.
getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
Returns the function.
getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will return the function used to convert the color values.
getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
Returns the function.
getFunctions() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Returns all functions values as COSArray.
getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Returns the function type.
getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Returns the function type.
getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Returns the function type.
getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Returns the function type.
getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
Returns the function type.
getG() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
This will get the g value of the tristimulus.
getGamma() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
This will get the gamma value.
getGamma() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will get the gamma value.
getGeneration() - Method in class org.apache.pdfbox.cos.COSUnread
 
getGeneration() - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
This will get the generation number.
getGenerationNumber() - Method in class org.apache.pdfbox.cos.COSObject
Getter for property generationNumber.
getGlyphOrientationVertical() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical).
getGraphics() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Get the graphics that we are currently drawing on.
getGraphicsStack() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getGraphicsState() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getGraphicsStates() - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the map of graphic states.
getGraphicsStates() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getGroup(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Returns the optional content group of the given name.
getGroupNames() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Lists all optional content group names.
getGuidelineColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the color to be used for the guidelines.
getGuidelineStyle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the style for the guideline.
getGuidelineWidth() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the width of the of the guideline in default user space units.
getHeaders() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Gets the headers (Headers).
getHeaders() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Gets the headers (Headers).
getHeaderString() - Method in class org.apache.pdfbox.cos.COSDocument
 
getHeight() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the height of this rectangle as calculated by upperRightY - lowerLeftY.
getHeight() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the height of the element's content rectangle in the block-progression direction (Height).
getHeight() - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getHeight() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Get the height of the image.
getHeight() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getHeight() - Method in class org.apache.pdfbox.util.ImageParameters
The height of this image.
getHeight() - Method in class org.apache.pdfbox.util.TextPosition
This will get the maximum height of all characters in this string.
getHeightDir() - Method in class org.apache.pdfbox.util.TextPosition
This will get the maximum height of all characters in this string.
getHexString() - Method in class org.apache.pdfbox.cos.COSString
This will take this string and create a hex representation of the bytes that make the string.
getHighlightingMode() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Returns the highlighting mode.
getHighlightMode() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Set the highlight mode for when the mouse is depressed.
getHighValue() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Get the highest value for the lookup.
getHolderForm() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Holder form.
getHolderFormResources() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Holder form resources
getHolderFormStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets HolderFormStream
getHorizontalScalingPercent() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the horizontalScaling.
getIconFit() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the icon fit that is associated with this field.
getID() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This is the FDF id.
getIDTree() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the ID tree.
getImageData() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
Get the bytes for the image.
getImageData() - Method in class org.apache.pdfbox.util.PDFOperator
This is the special case for the ID operator where there are just random bytes inlined the stream.
getImageForm() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Image form.
getImageFormName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets image form name
getImageFormResources() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets image form resources
getImageFormStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Image form stream
getImageMask() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Get the ImageMask flag.
getImageName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets visible signature image name
getImageParameters() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will get the image parameters.
getImageParameters() - Method in class org.apache.pdfbox.util.PDFOperator
This will get the image parameters, this is only valid for BI operators.
getImages() - Method in class org.apache.pdfbox.pdmodel.PDResources
Deprecated.
use PDResources.getXObjects() instead, as the images map isn't synchronized with the XObjects map.
getImageSizeInPercents() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
get image size in percents
getImageStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getIndentThreshold() - Method in class org.apache.pdfbox.util.PDFTextStripper
returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.
getIndex() - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
This will get the index of the array entry.
getIndexOfChild(Object, Object) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Returns the index of child in parent.
getIndividualWidths() - Method in class org.apache.pdfbox.util.TextPosition
Get the widths of each individual character.
getInfo() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getInlineAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign).
getInnerForm() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets inner form that is in this location: AcroForm/DR/XObject/{holder form name}/Resources/XObject/{inner name} By default inner form name starts with "n".
getInnerFormName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets name of inner form
getInnerFormResources() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets inner form Resource
getInnterFormStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Inner form Stream.
getInputFile() - Method in class org.apache.pdfbox.util.Overlay
Returns the input file.
getInputStreamAsString() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
A convenience method to get this stream as a string.
getInReplyTo() - Method in class org.apache.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.
getInstance() - Static method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
Get the singleton instance.
getInstructionSequence() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
Returns the instruction sequence that has been build from the syntactic elements.
getInt(int) - Method in class org.apache.pdfbox.cos.COSArray
Get the value of the array as an integer.
getInt(int, int) - Method in class org.apache.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.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an int. -1 is returned if there is no value.
getInt(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an int. -1 is returned if there is no value.
getInt(String[], int) - Method in class org.apache.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.apache.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.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getInt(COSName, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getInt(COSName, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getInteger(String, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets an integer.
getIntensity() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will retrieve the intensity of the applied effect.
getIntent() - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the italic angle for the font.
getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the italic angle for the font.
getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the italic angle for the font.
getItem(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This will do a lookup into the dictionary.
getItem(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This will do a lookup into the dictionary.
getItem(COSName) - Method in class org.apache.pdfbox.cos.COSObject
This will get the dictionary object in this object that has the name key.
getItem(COSName) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get an object from this streams dictionary.
getJavaColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
Returns the Java AWT color based on the current color space and value.
getJavaColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the Java AWT color space for this instance.
getJavaScript() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the java script entry.
getJavaScript() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Get the document level javascript entries.
getJpedImage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets the image of visible signature
getK() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the K entry.
getK() - Method in class org.apache.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.
getKArray() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the K array entry.
getKey() - Method in class org.apache.pdfbox.pdfviewer.MapEntry
Get the key for this entry.
getKey() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
This will get the Object key.
getKeyForValue(Object) - Method in class org.apache.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.apache.pdfbox.pdmodel.encryption.SecurityHandler
Getter of the property keyLength.
getKeywords() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the keywords of the document.
getKids() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Return the children of this node.
getKids() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Return the children of this node.
getKids() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Returns a list of objects for the kids (K).
getKids() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the list of kids.
getKids() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get all the kids of this field.
getKids() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
This will return a list of PDField objects that are part of this radio collection.
getKids() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will return all kids of this node, either PDPageNode or PDPage.
getKnockoutFlag() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the knockout.
getLabelPositionToValue() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return a value indicating the ordering of the label specified by U to the calculated unit value.
getLabelPrefixString() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the text to be concatenated to the left of the label specified by U.
getLabelsByPageIndices() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Returns a mapping with 0-based page indices as keys and corresponding page labels as values as an array.
getLabelSuffixString() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the text to be concatenated after the label specified by U.
getLanguage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the language (Lang).
getLanguage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the language (Lang).
getLanguage() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
The language for the document.
getLastChar() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
The code for the last char or -1 if there is none.
getLastChild() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Return the last child or null if there is no child.
getLastModified() - Method in class org.apache.pdfbox.pdmodel.PDPage
This will get the date that the content stream was last modified.
getLastSignatureDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will return the last signature.
getLastTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
 
getLeaderLineExtensionLength() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the length of the leader line extensions.
getLeaderLineLength() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the length of the leader line.
getLeaderLineOffsetLength() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the length of the leader line offset.
getLeading() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the leading for the font.
getLeading() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the leading for the font.
getLeading() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the leading for the font.
getLeading() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the leading.
getLeft() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Get the left x coordinate.
getLeft() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the left x coordinate.
getLeft() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the left x coordinate.
getLegalAttestation() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional, PDF 1.6) An array of text strings that specifying possible legal attestations.
getLength() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
The number of bytes written or expected in the stream.
getLength() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get the length of the filtered/compressed stream.
getLength() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get the length of the filtered/compressed stream.
getLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
This will return the Length entry of the crypt filter dictionary.
getLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will return the Length entry of the encryption dictionary.
getLength() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will return the length of the content stream.
getLength() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will return the length of the content stream.
getLengthWritten() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
Get the amount of data that was actually written to the stream, in theory this should be the same as the length specified but in some cases it doesn't match.
getLine() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).
getLinearInterpretation() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will get the linear interpretation array.
getLineCap() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line cap.
getLineCapStyle() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the line cap style.
getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the line dash pattern for this box style.
getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the dash pattern.
getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the current line dash pattern.
getLineHeight() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the element's preferred height in the block-progression direction (LineHeight).
getLineJoin() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line join.
getLineJoinStyle() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the line join style.
getLineLength() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will get the length of the line.
getLinePath() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Get the current line path to be drawn.
getLineSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
This will get the line separator.
getLineSloaps() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the sloaps of a line.
getLineWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the line width.
getLineWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line width.
getListItemPatterns() - Method in class org.apache.pdfbox.util.PDFTextStripper
returns a list of regular expression Patterns representing different common list item formats.
getListNumbering() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Gets the list numbering (ListNumbering).
getListNumbering() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
Gets the list numbering (ListNumbering).
getLocation() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Returns the location.
getLong(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long. -1 is returned if there is no value.
getLong(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long. -1 is returned if there is no value.
getLong(String[], long) - Method in class org.apache.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.apache.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.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getLookupData() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Get the lookup data table.
getLowerLeftX() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the lower left x coordinate.
getLowerLeftY() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the lower left y coordinate.
getLowerLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Get the lowest value for a key in the name map.
getLowerLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Get the lowest value for a key in the name map.
getMacCreator() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac Creator.
getMacResFork() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac ResFork.
getMacSubtype() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac subtype.
getMarkedContents() - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
 
getMarkInfo() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get info about doc's usage of tagged features.
getMask() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Returns the optional mask of a XObjectImage if there is one.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
This will get the optional Matrix of a Pattern.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will get the optional Matrix of a Pattern.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
This will get the optional Matrix of a function based shading.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will get the optional Matrix of an XObjectForm.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Gets the optional matrix for this appearance.
getMax() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will get the maximum value of the range.
getMaxLen() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextbox
Returns the maximum number of characters of the text field.
getMaxWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the max width for the font.
getMaxWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the max width for the font.
getMaxWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the max width for the font.
getMCID() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Gets the marked content identifier.
getMCID() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the marked-content identifier.
getMDP() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional; PDF 1.6) A dictionary containing a single entry whose key is P and whose value is an integer between 0 and 3.
getMeasure() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will retrieve the measure dictionary.
getMediaBox() - Method in class org.apache.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.apache.pdfbox.pdmodel.PDPageNode
This will get the MediaBox at this page and not look up the hierarchy.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will get the metadata stream for this object.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the metadata that is part of the document catalog.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.PDPage
Get the metadata that is part of the document catalog.
getMetadataKeys() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the keys of all metadata information fields for the document.
getMin() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will get the minimum value of the range.
getMinimumRevision() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.
getMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the missing width for the font.
getMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the missing width for the font.
getMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the missing width for the font.
getMiterLimit() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the miter limit.
getMiterLimit() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the miter limit.
getModDate() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mod date of the embedded file.
getModificationDate() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the modification date of the document.
getModifiedDate() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the date and time the annotation was modified.
getN() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Returns the exponent of the function.
getN() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
This will get the name of the action to be performed.
getName(int) - Method in class org.apache.pdfbox.cos.COSArray
Get the value of the array as a string.
getName(int, String) - Method in class org.apache.pdfbox.cos.COSArray
Get an entry in the array that is expected to be a COSName.
getName() - Method in class org.apache.pdfbox.cos.COSName
This will get the name of this COSName object.
getName(int) - Method in class org.apache.pdfbox.encoding.Encoding
This will take a character code and get the name from the code.
getName() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
The name of the named text stream.
getName() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Returns the property name.
getName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a name value.
getName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a name value.
getName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the annotation name.
getName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will get the name of the referenced page.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will return the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
Returns the name of the optional content group.
getName() - Method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState
Returns the PDF name for the state.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
This will return the name of the object.
getName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.
getName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will retrieve the name (and hence appearance, AP taking precedence) For this annotation.
getName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The name of the software module that was used to create the signature.
getName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Returns the name.
getName() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will retrieve the name of the viewport.
getNameAsString(String) - Method in class org.apache.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.apache.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.apache.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.apache.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.
getNamedDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
This will get the name of the destination.
getNamedJavaScripts() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
This will return a list of PDNamedTextStream objects.
getNameFromCharacter(char) - Method in class org.apache.pdfbox.encoding.Encoding
This will take a character code and get the name from the code.
getNameOrArrayOfName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a name value or array of name values.
getNames() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
This will return a map of names.
getNames() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
 
getNameToCodeMap() - Method in class org.apache.pdfbox.encoding.Encoding
Returns an unmodifiable view of the Name2Code mapping.
getNext() - Method in class org.apache.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.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the next bead.
getNextSibling() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Return the next sibling or null if there is no next sibling.
getNextUniqueKey(Map<String, ?>, String) - Static method in class org.apache.pdfbox.util.MapUtil
Generate a unique key for the map based on a prefix.
getNodeValue(Element) - Static method in class org.apache.pdfbox.util.XMLUtil
This will get the text value of an element.
getNonEFontNoWarn() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true.
getNonFullScreenPageMode() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the non full screen page mode preference.
getNonStrokeAlphaConstants() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the non-stroke alpha constants property.
getNonStrokeJavaComposite() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
 
getNonStrokingAlphaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the non stroking alpha constant.
getNonStrokingColor() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Returns the non-stroking color state.
getNonStrokingOverprintControl() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control for non stroking operations.
getNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getNormalCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the normal caption.
getNormalIcon() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the normal icon.
getNullEntry() - Static method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
This will return a null entry: 0000000000 65535 f
getNumber() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get the current object number.
getNumber(String, float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a number value.
getNumber(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a number value.
getNumber() - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
This will get the objects id.
getNumberOfComponents() - Method in class org.apache.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.apache.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.apache.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.apache.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.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will return the number of color components.
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
This will return the number of color components.
getNumberOfComponents() - Method in class org.apache.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.apache.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.apache.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.apache.pdfbox.pdmodel.common.function.PDFunction
This will get the number of input parameters that have a domain specified.
getNumberOfObjects() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
Get the number of compressed object.
getNumberOfOutputParameters() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
This will get the number of output parameters that have a range specified.
getNumberOfPages() - Method in class org.apache.pdfbox.pdmodel.PDDocument
getNumberOfPages() - Method in class org.apache.pdfbox.pdmodel.PDPageable
Returns the number of pages in the given PDF document.
getNumberOrArrayOfNumber(String, float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a number or an array of numbers.
getNumberOrName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a number or a name value.
getNumbers() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
This will return a map of numbers.
getO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will get an action to be performed when the page is opened.
getO() - Method in class org.apache.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.apache.pdfbox.cos.COSArray
This will get an object from the array.
getObject() - Method in class org.apache.pdfbox.cos.COSObject
This will get the object that this object encapsulates.
getObject(long, long) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
getObject(int) - Method in interface org.apache.pdfbox.pdfparser.PDFXRef
Returns the object referenced by the given object number.
getObject(int) - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Returns the object referenced by the given object number.
getObject() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
This will get the object.
getObject(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Returns the object at the specified position.
getObjectByType(String) - Method in class org.apache.pdfbox.cos.COSDocument
Deprecated.
getObjectByType(COSName) - Method in class org.apache.pdfbox.cos.COSDocument
This will get the first dictionary object by type.
getObjectFromPath(String) - Method in class org.apache.pdfbox.cos.COSDictionary
Nice method, gives you every object you want Arrays works properly too.
getObjectFromPool(COSObjectKey) - Method in class org.apache.pdfbox.cos.COSDocument
This will get an object from the pool.
getObjectFromPool(COSObjectKey) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
This will get an object from the pool.
getObjectFromPool(long, long) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
This will get an object from the pool.
getObjectKeys() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get all available object keys.
getObjectKeysFromPool() - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
This will get list of object keys from the pool.
getObjectNumber() - Method in class org.apache.pdfbox.cos.COSObject
Getter for property objectNumber.
getObjectNumber() - Method in class org.apache.pdfbox.cos.COSUnread
 
getObjects() - Method in class org.apache.pdfbox.cos.COSDocument
This will get a list of all available objects.
getObjects() - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
This will get the objects that were parsed from the stream.
getObjectsByType(String) - Method in class org.apache.pdfbox.cos.COSDocument
This will get all dictionary objects by type.
getObjectsByType(COSName) - Method in class org.apache.pdfbox.cos.COSDocument
This will get a dictionary object by type.
getOCProperties() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the optional content properties dictionary associated with this document.
getOffset() - Method in class org.apache.pdfbox.io.PushBackInputStream
Returns the current byte offset in the file.
getOffset() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
This will get the offset into the document.
getOffValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
This will get the value of the radio button.
getOnValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
This will get the value of the radio button.
getOpacity() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the opacity value.
getOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will retrieve the initial state of the annotation, open Or closed (default closed).
getOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will retrieve the initial state of the annotation, open Or closed (default closed).
getOpenAction() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the Document Open Action for this object.
getOpenCount() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Get the number of open nodes.
getOperation() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Get the operation to perform on the file.
getOperation() - Method in class org.apache.pdfbox.util.PDFOperator
This will get the operation that this operator represents.
getOperator(String) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.Operators
Returns the operator for the given operator name.
getOperator(String) - Static method in class org.apache.pdfbox.util.PDFOperator
This is used to create/cache operators in the system.
getOperators() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
Returns the operator set used by this execution context.
getOption() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will get the string of one of the available options.
getOptionalContentGroup(COSName) - Method in class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
Returns the optional content group belonging to the given resource name.
getOptionalContentGroups() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Returns the collection of all optional content groups.
getOptions() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will return a list of options for a choice field.
getOptions() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
This will get the option values "Opt" entry of the pdf button.
getOptions() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
This will get the option values "Opt".
getOrder() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Get the order of interpolation between samples.
getOriginalHeaderString() - Method in class org.apache.pdfbox.cos.COSDocument
Get the original headerString from the PDF file.
getOS() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Indicates the operating system.
getOutput() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get the output stream.
getOutput() - Method in class org.apache.pdfbox.util.PDFTextStripper
The output stream that is being written to.
getOutputCondition() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getOutputConditionIdentifier() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getOutputFile() - Method in class org.apache.pdfbox.util.Overlay
Returns the output file.
getOutputIntent() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the list of OutputIntents defined in the document.
getOverprintMode() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control mode.
getOverprintMode() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the overprint mode property.
getOwner() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Returns the owner of the attributes.
getOwnerAccessPermission() - Static method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
returns an access permission object for a document owner.
getOwnerKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the O entry in the standard encryption dictionary.
getOwnerKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will get the O entry in the standard encryption dictionary.
getOwnerPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Getter of the property ownerPassword.
getOwnerPasswordForEncryption() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.
Do not rely on this method anymore.
getOwnerUserProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Returns the user properties.
getP() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get a parameter string to be passed to the application designated by the F entry.
getP() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Return the P value.
getPadding() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the padding (Padding).
getPage(int) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Returns the page requested with all the objects loaded into it.
getPage() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Get the page that is currently being drawn.
getPage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Gets the page.
getPage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the page on which some or all of the content items designated by the K entry shall be rendered (Pg).
getPage() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
This will get the page number or null if it does not exist.
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the corresponding page of this annotation.
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Get the 1-based page number.
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Returns document page.
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
returns your page
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
This will get the page for this destination.
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Get the page that this bead is part of.
getPageCount() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.
Use the getNumberOfPages method instead!
getPageEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
Returns the string which will be used at the end of a page.
getPageFormat(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.
Use the PDPageable adapter class
getPageFormat(int) - Method in class org.apache.pdfbox.pdmodel.PDPageable
Returns the format of the page at the given index.
getPageHeight() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getPageIndicesByLabels() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Returns a mapping with computed page labels as keys and corresponding 0-based page indices as values.
getPageInfo() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
This will get the FDF page info object.
getPageLabelRange(int) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Returns the page label range starting at the given page, or null if no such range is defined.
getPageLabels() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Returns the page labels descriptor of the document.
getPageLayout() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the page layout, see the PAGE_LAYOUT_XXX constants.
getPageMap() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will return the Map containing the mapping from object-ids to pagenumbers.
getPageMode() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the page display mode, see the PAGE_MODE_XXX constants.
getPageNumber() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Returns the number of pages in a document.
getPageNumber() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
This will get the page number for this destination.
getPageRangeCount() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Returns the number of page label ranges.
getPages() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the list of FDF Pages.
getPages() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
This will get the root node for the pages.
getPageSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
getPageSize() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Get the size of the page that is currently being drawn.
getPageStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
Returns the string which will be used at the beginning of a page.
getPageWidth() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
Returns the Java AWT paint based on the current pattern.
getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will return the paint of the pattern.
getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
This will return the paint of the pattern.
getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will return the paint of the pattern.
getPaintType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will return the paint type.
getPanel() - Method in class org.apache.pdfbox.pdfviewer.PageWrapper
This will get the JPanel that can be displayed.
getParagraphEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
Returns the string which will be used at the end of a paragraph.
getParagraphStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
Returns the string which will be used at the beginning of a paragraph.
getParent() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Returns the parent node.
getParent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the parent in the structure hierarchy (P).
getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will retrieve the markup annotation which this popup relates to.
getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the parent of this object.
getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Get the parent of this object.
getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Get the parent field to this field, or null if none exists.
getParent() - Method in class org.apache.pdfbox.pdmodel.PDPage
This is the parent page node.
getParent() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This is the parent page node.
getParentTree() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the parent tree.
getParentTreeNextKey() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the next key in the parent tree.
getParser() - Method in class org.apache.pdfbox.cos.COSUnread
 
getParser() - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
 
getPartialFieldName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the "T" entry in the field dictionary.
getPartiallyFilteredStream(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will get a stream with some filters applied but not others.
getPartiallyFilteredStream(List<String>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream with some filters applied but not others.
getPartialName() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Returns the partial name of the field.
getPassword() - Method in class org.apache.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.apache.pdfbox.pdmodel.encryption.StandardDecryptionMaterial
Returns the password.
getPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will get the current pattern.
getPatterns() - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the map of patterns.
getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will return the pattern type.
getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
This will return the pattern type.
getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will return the pattern type.
getPC() - Method in class org.apache.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.apache.pdfbox.pdfparser.ConformingPDFParser
This will get the PD document that was parsed.
getPDDocument() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
This will get the PD document that was parsed.
getPDDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will get the PD document that was parsed.
getPdfFile() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Return the pdf file.
getPDFName(String) - Static method in class org.apache.pdfbox.cos.COSName
This will get a COSName object with that name.
getPdfStructure() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateCreator
that method returns object of PDFStructur
getPdSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets PDSignature
getPDStream() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Returns the underlying PDStream.
getPDStream() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Get the pd stream for this icc color space.
getPDStream() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Returns the stream.
getPdVisibleSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
this method gets visible signature configuration object
getPermission() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
Returns the access permission granted to the recipient.
getPermissionBytes() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
The returns an integer representing the access permissions.
getPermissionBytesForPublicKey() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This returns an integer representing the access permissions.
getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the permissions bit mask.
getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will get the permissions bit mask.
getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Getter of the property permissions.
getPhaseStart() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
This will get the line dash pattern phase.
getPI() - Method in class org.apache.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.
getPlacement() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the positioning of the element with respect to the enclosing reference area and other content (Placement).
getPO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the page containing the annotation is opened.
getPopup() - Method in class org.apache.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.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will get the current position in the stream.
getPosition() - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Returns offset of next byte to be returned by a read method.
getPosition() - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
Returns offset in file at which next byte would be read.
getPosition() - Method in class org.apache.pdfbox.io.RandomAccessFile
Returns offset of next byte to be returned by a read method.
getPosition() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
This will get the position in the RAF that the stream was written to.
getPosition() - Method in interface org.apache.pdfbox.io.RandomAccessRead
Returns offset of next byte to be returned by a read method.
getPredictor() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Deprecated.
getPreferedSignatureSize() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Get the preferred size of the signature.
getPreferredSize() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
gets our preferred size
getPrefix() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Returns the page label prefix for this page range.
getPreRelease() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.
getPreviousBead() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the previous bead.
getPreviousSibling() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Return the previous sibling or null if there is no sibling.
getPreviousURI() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the previous URI action, in case it's needed.
getPrintable(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
getPrintable(int) - Method in class org.apache.pdfbox.pdmodel.PDPageable
Returns a Printable for the page at the given index.
getPrintArea() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the PrintArea preference.
getPrintClip() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the PrintClip preference.
getPrinterJob() - Method in class org.apache.pdfbox.pdmodel.PDPageable
Returns the printer job for printing the given PDF document.
getPrintScaling() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the PrintScaling preference.
getPrivateKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
returns The private key that will be used to open the document protection.
getProcSet() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets ProcSet Array
getProducer() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the producer of the document.
getPropBuild() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
PDF signature build dictionary.
getProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the properties.
getProperties() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the dictionary mapping resource names to property list dictionaries for marked content.
getPropertyStringValue(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
Return the properties String value.
getPubSec() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
A build data dictionary for the PubSec software module that was used to create the parent signature.
getPV() - Method in class org.apache.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.
getQ() - Method in class org.apache.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.apache.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.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will retrieve the set of quadpoints which encompass the areas of this annotation.
getR() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
This will get the r value of the tristimulus.
getRangeForComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Returns the range for a certain component number.
getRangeForOutput(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
This will get the range for a certain output parameters.
getRangeValues() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
Returns all ranges for the output values as COSArray .
getRaster(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
getRaster(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
getReadingDirection() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the reading direction preference.
getReason() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Returns the reason.
getReasons() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
If the Reasons array is provided and PDSeedValue.isReasonRequired() indicates that Reasons is a required constraint, one of the reasons in the array shall be used for the signature dictionary; otherwise signing shall not take place.
getRecipientsIterator() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Returns an iterator to browse the list of recipients.
getRecipientsLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Returns the number of recipients contained in the Recipients field of the dictionary.
getRecipientsNumber() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Returns the number of recipients.
getRecipientStringAt(int) - Method in class org.apache.pdfbox.pdmodel.