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

A

A - Static variable in class org.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.
AbstractExample - Class in org.apache.pdfbox.examples
A simple class which has some methods used by all examples.
AbstractExample() - Constructor for class org.apache.pdfbox.examples.AbstractExample
 
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.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
"ActualText"
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(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
add(int, Object) - 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) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
addAll(int, Collection) - 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.
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.
addFilter(COSName, Filter) - Method in class org.apache.pdfbox.filter.FilterManager
This will add an available filter.
AddImageToPDF - Class in org.apache.pdfbox.examples.pdmodel
This is an example that creates a reads a document and adds an image to it..
AddImageToPDF() - Constructor for class org.apache.pdfbox.examples.pdmodel.AddImageToPDF
 
AddJavascript - Class in org.apache.pdfbox.examples.pdmodel
This is an example of how to set some javascript in the document.
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.
AddMessageToEachPage - Class in org.apache.pdfbox.examples.pdmodel
This is an example of how to add a message to every page in a pdf document.
AddMessageToEachPage() - Constructor for class org.apache.pdfbox.examples.pdmodel.AddMessageToEachPage
Constructor.
AddMetadataFromDocInfo - Class in org.apache.pdfbox.examples.pdmodel
This is an example on how to add metadata to a document.
addObject(T, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Adds an object with a specified revision number.
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.
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.
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.
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.
addXRefEntry(COSWriterXRefEntry) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
add an entry in the x ref table for later dump.
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
"Alt"
ALTERNATE - Static variable in class org.apache.pdfbox.cos.COSName
"Alt"
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.
Annotation - Class in org.apache.pdfbox.examples.pdmodel
This is an example on how to add annotations to pages of a PDF document.
ANNOTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
AP - Static variable in class org.apache.pdfbox.cos.COSName
"AP"
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.
appendDocument(PDDocument, PDDocument) - Method in class org.apache.pdfbox.util.PDFMergerUtility
append all pages from source to destination.
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.
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.
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
"Artifact"
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
"Attached"
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.
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.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
 

B

B - 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.
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(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.
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 - 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_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_POINT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
Boundary constant.
BOUNDARY_BLEED_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_CROP_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_MEDIA_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
BOUNDARY_TRIM_BOX - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Boundary constant.
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_ESCAPE - Static variable in class org.apache.pdfbox.cos.COSString
BS escape characters.
ByteArrayPushBackInputStream - Class in org.apache.pdfbox.io
PushBackInputStream for byte arrays.
ByteArrayPushBackInputStream(byte[]) - Constructor for class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Constructor.

C

C - Static variable in class org.apache.pdfbox.cos.COSName
"C"
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(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 forms.
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/modify text annotations, fill in interactive forms 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.
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.
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.
centerWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the center window preference.
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.
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
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.
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() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
clear() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
CLEAR_TABLE - Static variable in class org.apache.pdfbox.filter.LZWFilter
The LZW clear table code.
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() - 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(COSArray) - 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.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.
close() - Method in class org.apache.pdfbox.cos.COSDocument
This will close all storage and delete the tmp files.
close(InputStream) - Method in class org.apache.pdfbox.examples.AbstractExample
Close the stream.
close(OutputStream) - Method in class org.apache.pdfbox.examples.AbstractExample
Close the stream.
close(COSDocument) - Method in class org.apache.pdfbox.examples.AbstractExample
Close the document.
close(PDDocument) - Method in class org.apache.pdfbox.examples.AbstractExample
Close the document.
close(COSWriter) - Static method in class org.apache.pdfbox.examples.AbstractExample
Close the writer.
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.NBitOutputStream
This will close the stream.
close() - Method in interface org.apache.pdfbox.io.RandomAccess
Release resources that are being held.
close() - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Release resources that are being held.
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 class org.apache.pdfbox.pdfparser.PDFStreamParser
 
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.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
 
closeSubPath() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Close subpath.
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
Called when the color changed.
COLORSPACE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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.
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.
compare(Object, Object) - Method in class org.apache.pdfbox.util.TextPositionComparator
compareTo(COSName) - Method in class org.apache.pdfbox.cos.COSName
compareTo(Object) - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
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.
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) - 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) - 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.
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(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) - 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) - 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.
copy() - Method in class org.apache.pdfbox.util.Matrix
This will copy the text matrix data.
CopyDoc - Class in org.apache.pdfbox.examples.persistence
This is an example used to copy a documents contents from a source doc to destination doc via an in-memory document representation.
CopyDoc() - Constructor for class org.apache.pdfbox.examples.persistence.CopyDoc
Constructor.
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 - 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, COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
Constructor.
COSArrayList(Object, COSBase, COSDictionary, COSName) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
This is a really special constructor.
COSArrayList(Object, COSBase, COSDictionary, String) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
Deprecated. use the COSArrayList.COSArrayList(Object, COSBase, COSDictionary, COSName) method instead
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
Constructor.
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.
COSDictionaryMap - Class in org.apache.pdfbox.pdmodel.common
This is a Map that will automatically sync the contents to a COSDictionary.
COSDictionaryMap(Map, 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() - 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.
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(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.
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.
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(String) - Method in class org.apache.pdfbox.examples.pdmodel.CreateBlankPDF
This will create a blank PDF and write the contents to a file.
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(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.
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() - 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.
CreateBlankPDF - Class in org.apache.pdfbox.examples.pdmodel
This will create a blank PDF and write the contents to a file.
CreateBlankPDF() - Constructor for class org.apache.pdfbox.examples.pdmodel.CreateBlankPDF
 
CreateBookmarks - Class in org.apache.pdfbox.examples.pdmodel
This is an example on how to add bookmarks to a PDF document.
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) - 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) - 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) - 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.
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
This will create the correct font based on information in the dictionary.
createFont(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.font.PDFontFactory
This will create the correct font based on information in the dictionary.
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.
createFS(COSBase) - Static method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
A file specfication can either be a COSString or a COSDictionary.
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.
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.
CreateLandscapePDF - Class in org.apache.pdfbox.examples.pdmodel
This is an example of how to create a page with a landscape orientation.
CreateLandscapePDF() - Constructor for class org.apache.pdfbox.examples.pdmodel.CreateLandscapePDF
Constructor.
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.
createPDFFromImage(String, String, String) - Method in class org.apache.pdfbox.examples.pdmodel.AddImageToPDF
Add an image to an existing PDF document.
createPDFFromImage(String, String) - Method in class org.apache.pdfbox.examples.pdmodel.ImageToPDF
create the second sample document from the PDF file format specification.
createPDFFromText(Reader) - Method in class org.apache.pdfbox.TextToPDF
Create a PDF document with some text.
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.
createStream(PDDocument) - Static method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
This will create a new PDStream object.
createTextStream(COSBase) - Static method in class org.apache.pdfbox.pdmodel.common.PDTextStream
This will create the text stream object.
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.
createXObject(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Create the correct xobject from the cos base.
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
The Crypt filter.
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
"D"
DateConverter - Class in org.apache.pdfbox.util
This class is used to convert dates to strings and back using the PDF date standards.
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.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
"DecodeParms"
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(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will decrypt a document.
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
 
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.pdmodel.encryption.SecurityHandler
This will decrypt a string.
DEF - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a byte array that will be used for comparisons.
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_VERSION - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
The default version, according to the PDF Reference.
dereferenceObjectStreams() - Method in class org.apache.pdfbox.cos.COSDocument
This method will search the list of objects for types of ObjStm.
DESCENDANT_FONTS - 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.
DESTS - Static variable in class org.apache.pdfbox.cos.COSName
"Dests"
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.
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.
DIV - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Div
DL - Static variable in class org.apache.pdfbox.cos.COSName
"DL"
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, String) - Method in class org.apache.pdfbox.examples.pdmodel.AddMessageToEachPage
create the second sample document from the PDF file format specification.
doIt(String, String) - Method in class org.apache.pdfbox.examples.pdmodel.CreateLandscapePDF
creates a sample document with a landscape orientation and some text surrounded by a box.
doIt(String) - Method in class org.apache.pdfbox.examples.pdmodel.EmbeddedFiles
create the second sample document from the PDF file format specification.
doIt(String, String) - Method in class org.apache.pdfbox.examples.pdmodel.HelloWorld
create the second sample document from the PDF file format specification.
doIt(String, String, String) - Method in class org.apache.pdfbox.examples.pdmodel.HelloWorldTTF
create the second sample document from the PDF file format specification.
doIt(String, String, String) - Method in class org.apache.pdfbox.examples.pdmodel.HelloWorldType1AfmPfb
create the second sample document from the PDF file format specification.
doIt(String, String, String, String) - Method in class org.apache.pdfbox.examples.pdmodel.ReplaceString
Locate a string in a PDF and replace it with a new string.
doIt(String[]) - Method in class org.apache.pdfbox.examples.pdmodel.RubberStampWithImage
Add a rubber stamp with an jpg image to every page of the given document.
doIt(String) - Method in class org.apache.pdfbox.examples.pdmodel.ShowColorBoxes
create the second sample document from the PDF file format specification.
doIt(String, String) - Method in class org.apache.pdfbox.examples.pdmodel.UsingTextMatrix
creates a sample document with some text using a text matrix.
doIt(String, String) - Method in class org.apache.pdfbox.examples.persistence.CopyDoc
This will perform the document copy.
doIt(String, String) - Method in class org.apache.pdfbox.examples.persistence.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
 
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
"DP"
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.PDCIDFont
This will draw a string on a canvas using the font.
drawString(String, 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, 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, Graphics, float, AffineTransform, float, float) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
This will draw a string on a canvas using the font.
drawString(String, 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.
DualCOSObjectable - Interface in org.apache.pdfbox.pdmodel.common
This is an interface to represent a PDModel object that holds two COS objects.
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
"E"
EMBEDDED_FILES - Static variable in class org.apache.pdfbox.cos.COSName
"EmbeddedFiles"
EmbeddedFiles - Class in org.apache.pdfbox.examples.pdmodel
This is an example that creates a simple document and embeds a file into it..
EmbeddedFiles() - Constructor for class org.apache.pdfbox.examples.pdmodel.EmbeddedFiles
Constructor.
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.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.PDFont
This will perform the encoding of a character if needed.
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[], 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.
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.
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
"Encrypt"
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_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
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.
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 - 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(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 - 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
 
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.
EOL - Static variable in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
standard line separator on this platform.
EOL - Static variable in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
standard line separator on this platform.
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(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Evaluates the function at the given input.
eval(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Evaluates the function at the given input.
eval(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Evaluates the function at the given input.
eval(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
Evaluates the function at the given input.
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
Extract the XMP metadata and create and build an in memory object.
EXT_G_STATE - Static variable in class org.apache.pdfbox.cos.COSName
"ExtGState"
EXT_G_STATE - Static variable in class org.apache.pdfbox.Overlay
Deprecated. use the COSName.EXT_G_STATE constant instead
EXTENDS - Static variable in class org.apache.pdfbox.cos.COSName
"Extends"
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.
ExtractImages - Class in org.apache.pdfbox
This will read a read pdf and extract images.
ExtractMetadata - Class in org.apache.pdfbox.examples.pdmodel
This is an example on how to extract metadata from a PDF document.
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.
ExtractTextByArea - Class in org.apache.pdfbox.examples.util
This is an example on how to extract text from a specific area on the PDF document.
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
"F"
F_DECODE_PARMS - Static variable in class org.apache.pdfbox.cos.COSName
"FDecodeParms"
F_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
"FFilter"
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_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
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
 
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_NAME - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. The 'Filter' name for this security handler.
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.
finalize() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will flush the stream.
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
Returns the page number for this destination, regardless of whether this is a page number or a reference to a page.
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_CHAR - 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_COMB - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
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_FILE_SELECT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
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_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_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_TOGGLE_NO_VIEW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
An annotation flag.
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.
FontManager - Class in org.apache.pdfbox.pdmodel.font
This class is used as font manager.
FORM - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Form
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
fromRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
fromRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCMYK
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.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.
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.
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 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.
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.
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.
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.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.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.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. use PDURIDictionary.getBase() instead
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).
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.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.
getBitsInChunk() - Method in class org.apache.pdfbox.io.NBitInputStream
Getter for property bitsToRead.
getBitsInChunk() - Method in class org.apache.pdfbox.io.NBitOutputStream
Getter for property bitsToRead.
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.
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.
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.
getBytes() - Method in class org.apache.pdfbox.cos.COSString
This will get the bytes of the string.
getBytesFromFile(File) - Static method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
Returns the given file as byte array.
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) - Static 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.
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.
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.
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.xobject.PDXObjectImage
This will get the color space or null if none exists.
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).
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() - 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.
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
 
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.PDExtendedGraphicsState
This will get the underlying dictionary that this class acts on.
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.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.digitalsignature.PDSignature
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.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.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
 
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.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.PDLab
Convert this standard java object to a COS object.
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.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.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.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.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.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.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.
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.
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.
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
DecodeParms is an optional parameter for filters.
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.
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.
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.
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.
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.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
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.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.
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.PDFParser
This will get the document that was parsed.
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.PDDocument
This will get the low level document.
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.
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.
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.
getDS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed after saving a document.
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.
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
This will get or create the encoder.
getEncodingManager() - Static method in class org.apache.pdfbox.pdmodel.font.PDFont
 
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.PDFTextStripper
This will get the last page that will be extracted.
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.
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.
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 fields in the document.
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.
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.
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.interactive.action.type.PDWindowsLaunchParams
The file to launch.
getFileSpecification() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will get the file specification of this reference.
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(int) - Static method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
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.
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.
getFlag(COSDictionary, String, 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
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
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 bouding 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 bouding 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 bouding 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.PDCIDFont
Get the font descriptor associated with this CID font.
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the font descriptor for this font.
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDType1AfmPfbFont
This will get the font descriptor for this font.
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the font descriptor for this font.
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 width 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.
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.
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) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the map of fonts.
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(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the font width for a character.
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the font width for a character.
getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
This will get the font width for a 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.
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.
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.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
 
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.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.
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.
getImageMask() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Get the ImageMask flag.
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
This will get the map of images.
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.
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).
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.
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
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
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.
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(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.
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.
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.
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.
getLength() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
The number of bytes written to 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.
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.
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).
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
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
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.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will get the optional Matrix of an XObjectForm.
getMax() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will get the maximum value of the range.
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.
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.
getMessage() - Method in exception org.apache.pdfbox.exceptions.WrappedException
Gets the wrapped exception message.
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.
getMin() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will get the minimum value of the range.
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.
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.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.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) - 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.
getNonFullScreenPageMode() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the non full screen page mode preference.
getNonStrokingAlpaConstant() - 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.
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
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() - 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
This will get the first dictionary object by type.
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.
getObjectKeys() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get all available object keys.
getObjectNumber() - Method in class org.apache.pdfbox.cos.COSObject
Getter for property objectNumber.
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.
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) - Static method in class org.apache.pdfbox.util.PDFOperator
This is used to create/cache operators in the system.
getOption() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will get the string of one of the available options.
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.
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.
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.
getPadding() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the padding (Padding).
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.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!
getPageFormat(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
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.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
This will get the page separator.
getPageSize() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Get the size of the page that is currently being drawn.
getPanel() - Method in class org.apache.pdfbox.pdfviewer.PageWrapper
This will get the JPanel that can be displayed.
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.
getParentTreeNextKey() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the next key in the parent tree.
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) - 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.
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.PDFParser
This will get the PD document that was parsed.
getPDFName(String) - Static method in class org.apache.pdfbox.cos.COSName
This will get a COSName object with that name.
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.
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.RandomAccessFileOutputStream
This will get the position in the RAF that the stream was written to.
getPredictor() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
A code that selects the predictor algorithm.
getPrefix() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Returns the page label prefix for this page range.
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
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.
getPrivateKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
returns The private key that will be used to open the document protection.
getProducer() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the producer of the document.
getProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the properties.
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
This will get 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 .
getReadingDirection() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the reading direction preference.
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.encryption.PDEncryptionDictionary
returns the COSString contained in the Recipients field at position i.
getRectangle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
The rectangle associated with this annotation.
getRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
The annotation rectangle, defining the location of the annotation on the page in default user space units.
getRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
The rectangle on the page that this bead is part of.
getRectDifference() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will get the rectangle difference rectangle.
getReferencedObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Gets a higher-level object for the referenced object.
getRegions() - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
Get the list of regions that have been setup.
getRenderingIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the rendering intent.
getRenderingIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the rendering intent.
getRenderingMode() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the renderingMode.
getReplyType() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
getResources() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will get the resources at this page and not look up the hierarchy.
getResources() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will get the resources for this appearance stream.
getResources() - Method in class org.apache.pdfbox.pdmodel.PDPage
This will get the resources at this page and not look up the hierarchy.
getResources() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will get the resources at this page node and not look up the hierarchy.
getResources() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getRevision() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will return the R entry of the encryption dictionary.
getRevision() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will return the R entry of the encryption dictionary.
getRevisionNumber() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the revision number (R).
getRevisionNumber(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Returns the revision number at the specified position.
getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
Returns an image of the CCITT Fax, or null if TIFFs are not supported.
getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
Returns an image of the JPeg, or null if JPegs are not supported.
getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Returns a BufferedImage of the COSStream set in the constructor or null if the COSStream could not be encoded.
getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Returns an java.awt.Image, that can be used for display etc.
getRichContents() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the rich text stream which is displayed in the popup window.
getRichText() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the rich text that is associated with this field.
getRight() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the right x coordinate.
getRise() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the rise.
getRole() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Gets the role.
getRoleMap() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Returns the role map.
getRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getRolloverCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the rollover caption.
getRolloverIcon() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the rollover icon.
getRoot() - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Returns the root of the tree.
getRotation() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will retrieve the rotation of the annotation widget.
getRotation() - Method in class org.apache.pdfbox.pdmodel.PDPage
A value representing the rotation.
getRotation() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
A value representing the rotation.
getRowSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Gets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).
getRowSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Gets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).
getRubyAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the justification of the lines within a ruby assembly (RubyAlign).
getRubyPosition() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition).
getS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will get the type of action that the actions dictionary describes.
getS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will get the type of action that the actions dictionary describes.
getSamples() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Get all sample values of this function.
getScaleInstance(float, float) - Static method in class org.apache.pdfbox.util.Matrix
Convenience method to create a scaled instance.
getScaleOption() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will get the scale option.
getScaleRatio() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the scale ration.
getScaleType() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will get the scale type.
getScope() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Gets the scope (Scope).
getScope() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Gets the scope (Scope).
getScratchFile() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the scratch file for this document.
getScratchFile() - Method in class org.apache.pdfbox.cos.COSStream
This will get the scratch file associated with this stream.
getScratchFile() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get the scratch file associated with this stream.
getSecondCOSObject() - Method in interface org.apache.pdfbox.pdmodel.common.DualCOSObjectable
Convert this standard java object to a COS object.
getSecondCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
Convert this standard java object to a COS object.
getSecurityHandler(ProtectionPolicy) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
Get the security handler for the protection policy.
getSecurityHandler(String) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
Retrieve the appropriate SecurityHandler for a the given filter name.
getSecurityHandler() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Get the security handler that is used for document encryption.
getSetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the SetFf entry of the cos dictionary.
getSetWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the SetF entry of the cos dictionary.
getShadingName() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
This will return the name of this particular shading dictionary
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
This will return the ShadingType -- an integer between 1 and 7 that specifies the gradient type.
getSignature() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will get the signature or null if there is none.
getSize() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the size of the embedded file.
getSize() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
The "Size" entry, which is the number of samples in each input dimension of the sample table.
getSMaskImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Returns a PDXObjectImage of the SMask image, if there is one.
getSmoothness() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the smoothness property.
getSmoothnessTolerance() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the smothness tolerance.
getSpaceAfter() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).
getSpaceBefore() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).
getSpacingTolerance() - Method in class org.apache.pdfbox.util.PDFTextStripper
Get the current space width-based tolerance value that is being used to estimate where spaces in text should be added.
getSplitAtPage() - Method in class org.apache.pdfbox.util.Splitter
This will return how many pages each split document will contain.
getStandard14Names() - Static method in class org.apache.pdfbox.pdmodel.font.PDType1Font
This will get the names of the standard 14 fonts.
getStandardEncoding() - Method in class org.apache.pdfbox.encoding.EncodingManager
This will get the standard encoding.
getStandardFont() - Static method in class org.apache.pdfbox.pdmodel.font.FontManager
Get the standard font from the environment, usually Arial or Times New Roman.
getStandardFont(String) - Static method in class org.apache.pdfbox.pdmodel.font.PDType1Font
A convenience method to get one of the standard 14 font from name.
getStandardOutput() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get the standard output stream.
getStandardStructureType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the standard structure type, the actual structure type is mapped to in the role map.
getStart() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Returns the start value for page numbering in this page range.
getStartBookmark() - Method in class org.apache.pdfbox.util.PDFTextStripper
Get the bookmark where text extraction should start, inclusive.
getStartColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Gets the colour for the start edge.
getStartIndent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).
getStartPage() - Method in class org.apache.pdfbox.util.PDFTextStripper
This is the page that the text extraction will start on.
getStartPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
getStartxref() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get the current start xref.
getState() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will retrieve the annotation state.
getStateModel() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will retrieve the annotation state model.
getStatus() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the status string to be displayed as the result of an action.
getStatusLabel() - Method in class org.apache.pdfbox.pdfviewer.ReaderBottomPanel
This method initializes status label.
getStdCryptFilterDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Returns the standard crypt filter.
getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the stemH for the font.
getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the stemH for the font.
getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the stemH for the font.
getStemV() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the stemV for the font.
getStemV() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the stemV for the font.
getStemV() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the stemV for the font.
getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Get the cos stream associated with this object.
getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
This will get the stream.
getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Get the cos stream associated with this object.
getStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will return the underlying stream.
getStreamCount() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get the number of streams in the array.
getStreamFilterName() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Returns the name of the filter which is used for de/encrypting streams.
getStreamTokens() - Method in class org.apache.pdfbox.cos.COSStream
This will get all the tokens in the stream.
getStreamTokens() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get all the tokens in the stream.
getString(int) - Method in class org.apache.pdfbox.cos.COSArray
Get the value of the array as a string.
getString(int, String) - Method in class org.apache.pdfbox.cos.COSArray
Get an entry in the array that is expected to be a COSName.
getString(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.
getString(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.
getString(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.
getString(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.
getString() - Method in class org.apache.pdfbox.cos.COSString
This will get the string that this object wraps.
getString(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a string attribute value.
getStringFilterName() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Returns the name of the filter which is used for de/encrypting strings.
getStringWidth(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the width of this string for this font.
getStringWidth(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
This will get the width of this string for this font.
getStroke() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
This will return the current stroke.
getStrokingAlpaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the stroking alpha constant.
getStrokingColor() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Returns the stroking color state.
getStrokingOverprintControl() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control.
getStructureElement() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the structure element of this node.
getStructureTreeRoot() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the document's structure tree root.
getStructureType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the structure type (S).
getStyle() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Returns the numbering style for this page range.
getStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will retrieve the border effect, see the STYLE_* constants for valid values.
getStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will retrieve the border style, see the STYLE_* constants for valid values.
getSubFilter() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Get the name of the subfilter.
getSubject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the description of the annotation.
getSubject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will retrieve the short description of the subject of the annotation.
getSubject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the subject of the document.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the subtype(mimetype) for the embedded file.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Gets the subtype (Subtype).
getSubType() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the subtype of font, Type1, Type3, ...
getSubType() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
This will get the type of action that the actions dictionary describes.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the subtype of the annotation.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
returns the subtype of the external data dictionary.
getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
returns the subtype of the measure dictionary.
getSuffix() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
This will get the suffix for this image type, jpg/png.
getSummary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Gets the summary of the table’s purpose and structure.
getSummary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Gets the summary of the table’s purpose and structure.
getTag() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the tag.
getTarget() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the target frame in the browser to open this document.
getTBorderStyle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the style of the border drawn on each edge of a table cell (TBorderStyle).
getTemplateReference() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This is the template reference.
getTemplates() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
This will get a list of FDFTemplage objects that describe the named pages that serve as templates.
getTerminator() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will get the terminating character.
getText(PDDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will return the text of a document.
getText(COSDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
Deprecated.  
getTextAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign).
getTextColor() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the text color of this node.
getTextDecorationColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the colour to be used for drawing text decorations (TextDecorationColor).
getTextDecorationThickness() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).
getTextDecorationType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the type of text decoration (TextDecorationType).
getTextForRegion(String) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
Get the text for the region, this should be called after extractRegions().
getTextIndent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent).
getTextKnockoutFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the text knockout flag.
getTextLineMatrix() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getTextMatrix() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getTextPos() - Method in class org.apache.pdfbox.util.TextPosition
Return the Matrix textPos stored in this object.
getTextState() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will get the graphics text state.
getThousandsSeparator() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the text to be used between orders of thousands in display of numerical values.
getThread() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the thread that this bead is part of.
getThreadBeads() - Method in class org.apache.pdfbox.pdmodel.PDPage
This will get a list of PDThreadBead objects, which are article threads in the document.
getThreadInfo() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Get info about the thread, or null if there is nothing.
getThreads() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the list threads for this pdf document.
getTintTransform() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will get the tint transform function.
getTintTransform() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will get the tint transform function.
getTitle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Returns the title (T).
getTitle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the annotation title.
getTitle() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Get the title of this node.
getTitle() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the title of the document.
getTitle() - Method in class org.apache.pdfbox.util.PDFText2HTML
This method will attempt to guess the title of the document using either the document properties or the first lines of text.
getTitlePopup() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Retrieve the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
getTokenIterator() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will get an iterator which can be used to parse the stream one token after the other.
getTokens() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will get the tokens that were parsed from the stream.
getTop() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Get the top y coordinate.
getTop() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Get the top y coordinate.
getTop() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the top y coordinate.
getTotalCharCnt() - Method in class org.apache.pdfbox.util.PDFStreamEngine
Get the total number of characters in the doc (including ones that could not be mapped).
getToUnicode() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the ToUnicode stream.
getTPadding() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the offset to account for the separation between the table cell’s content rectangle and the surrounding border (TPadding).
getTrailer() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the document trailer.
getTranslatingInstance(float, float) - Static method in class org.apache.pdfbox.util.Matrix
Convenience method to create a translating instance.
getTrapped() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the trapped value for the document.
getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeCellRenderer
getTrimBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
A rectangle, expressed in default user space units, defining the intended dimensions of the finished page after trimming.
getType() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
Get the type of this object, should always return "ObjStm".
getType() - Method in class org.apache.pdfbox.pdmodel.common.PDTypedDictionaryWrapper
Gets the type.
getType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Returns the type.
getType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Gets the type (Type).
getType() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will always return "Font" for fonts.
getType() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
This will get the type of PDF object that the actions dictionary describes.
getType() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
returns the type of the external data dictionary.
getType() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
This will return the type of the measure dictionary.
getType() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the type of the number format dictionary.
getType() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
Returns the type of the viewport dictionary.
getU() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the mouse button is released inside the annotation's active area.
getUnfilteredStream() - Method in class org.apache.pdfbox.cos.COSStream
This will get the logical content stream with none of the filters.
getUnfilteredStream() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
This will get the logical content stream with none of the filters.
getUnits() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the label for the units.
getUpperLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Get the highest value for a key in the name map.
getUpperLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Get the highest value for a key in the name map.
getUpperRightX() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the upper right x coordinate.
getUpperRightY() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the upper right y coordinate.
getURI() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will get the uniform resource identifier to resolve, encoded in 7-bit ASCII.
getURI() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Document level information in the URI.
getUserKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will get the U entry in the standard encryption dictionary.
getUserKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated. This will get the U entry in the standard encryption dictionary.
getUserPassword(byte[], byte[], int, long) - Method in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated. This will get the user password from the owner password and the documents o value.
getUserPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Getter of the property userPassword.
getUserPassword(byte[], byte[], int, long) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Get the user password based on the owner password.
getUserPasswordForEncryption() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated. Do not rely on this method anymore.
getV() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will get a JavaScript action to be performed when the field's value is changed.
getValidCharCnt() - Method in class org.apache.pdfbox.util.PDFStreamEngine
Get the total number of valid characters in the doc that could be decoded in processEncodedText().
getValue() - Method in class org.apache.pdfbox.cos.COSBoolean
This will get the value that this object wraps.
getValue() - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
This will get the value for this entry.
getValue() - Method in class org.apache.pdfbox.pdfviewer.MapEntry
This will get the value for this entry.
getValue(int, int) - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
This will get a matrix value at some point.
getValue(String) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
The name to retrieve.
getValue(Integer) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Returns the value corresponding to an index in the number tree.
getValue() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Returns the property value.
getValue() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the value for the field.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
getValue gets the fields value to as a string.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
getValue gets the fields value to as a string.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
getValue gets the fields value to as a string.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
getValue gets the fields value to as a string.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
 
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDUnknownField
getValue gets the fields value to as a string.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
getValue gets the fields value to as a string.
getValue(int, int) - Method in class org.apache.pdfbox.util.Matrix
This will get a matrix value at some point.
getValueAsObject() - Method in class org.apache.pdfbox.cos.COSBoolean
This will get the value that this object wraps.
getValues() - Method in class org.apache.pdfbox.cos.COSDictionary
This will get all of the values for the dictionary.
getValues() - Method in class org.apache.pdfbox.util.Matrix
Return a single dimension array of all values in the matrix.
getValuesAsDouble() - Method in class org.apache.pdfbox.util.Matrix
Return a single dimension array of all values in the matrix.
getVersion() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the version of this PDF document.
getVersion() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will return the V entry of the encryption dictionary.
getVersion() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will get the version that was specified in the catalog dictionary.
getVersion() - Static method in class org.apache.pdfbox.Version
Get the version of PDFBox or unknown if it is not known.
getViewArea() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the ViewArea preference.
getViewClip() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the ViewClip preference.
getViewerPreferences() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the viewer preferences associated with this document or null if they do not exist.
getWC() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before closing a document.
getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
This will return the whitepoint tristimulus.
getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will return the whitepoint tristimulus.
getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will return the whitepoint tristimulus.
getWidget() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get the single associated widget that is part of this field.
getWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the F entry of the cos dictionary.
getWidth() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will get the width of this rectangle as calculated by upperRightX - lowerLeftX.
getWidth() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the width of the element’s content rectangle in the inline-progression direction (Width).
getWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
getWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Get the width of the image.
getWidth() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will retrieve the border width in points, 0 = no border.
getWidth() - Method in class org.apache.pdfbox.util.ImageParameters
The width of this image.
getWidth() - Method in class org.apache.pdfbox.util.TextPosition
This will get the width of the string when page rotation adjusted coordinates are used.
getWidthDirAdj() - Method in class org.apache.pdfbox.util.TextPosition
This will get the width of the string when text direction adjusted coordinates are used.
getWidthOfSpace() - Method in class org.apache.pdfbox.util.TextPosition
This will get the width of a space character.
getWidths() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
The widths of the characters.
getWinLaunchParams() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will get a dictionary containing Windows-specific launch parameters.
getWordSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
This will get the word separator.
getWordSpacing() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Get the value of the wordSpacing.
getWordSpacing() - Method in class org.apache.pdfbox.util.TextPosition
This will get the current word spacing.
getWP() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before printing a document.
getWritingMode() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the writing mode (WritingMode).
getWS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before saving a document.
getX() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
This will get the x value of the tristimulus.
getX() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will get an action to be performed when the cursor exits the annotation's active area.
getX() - Method in class org.apache.pdfbox.util.TextPosition
This will get the page rotation adjusted x position of the character.
getX509() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
Returns the X509 certificate of the recipient.
getXDirAdj() - Method in class org.apache.pdfbox.util.TextPosition
This will get the text direction adjusted x position of the character.
getXFA() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.
getXHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the x height for the font.
getXHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will get the x height for the font.
getXHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will get the x height for the font.
getXObjects() - Method in class org.apache.pdfbox.pdmodel.PDResources
This will get the map of PDXObjects that are in the resource dictionary.
getXObjects() - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
getXPosition() - Method in class org.apache.pdfbox.util.Matrix
Get the x position in the matrix.
getXRefEntries() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get the xref entries.
getXrefTable() - Method in class org.apache.pdfbox.cos.COSDocument
Returns the xrefTable which is a mapping of ObjectKeys to byte offsets in the file.
getXScale() - Method in class org.apache.pdfbox.util.Matrix
Get the xscaling factor of this matrix.
getXScale() - Method in class org.apache.pdfbox.util.TextPosition
 
getY() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
This will get the y value of the tristimulus.
getY() - Method in class org.apache.pdfbox.util.TextPosition
This will get the y position of the text, adjusted so that 0,0 is upper left and it is adjusted based on the page rotation.
getYDirAdj() - Method in class org.apache.pdfbox.util.TextPosition
This will get the y position of the text, adjusted so that 0,0 is upper left and it is adjusted based on the text direction.
getYPosition() - Method in class org.apache.pdfbox.util.Matrix
Get the y position.
getYScale() - Method in class org.apache.pdfbox.util.Matrix
Get the y scaling factor of this matrix.
getYScale() - Method in class org.apache.pdfbox.util.TextPosition
 
getZ() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
This will get the z value of the tristimulus.
getZoom() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the zoom value.
GLYPH_ORIENTATION_VERTICAL_180_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 180°
GLYPH_ORIENTATION_VERTICAL_270_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 270°
GLYPH_ORIENTATION_VERTICAL_360_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 360°
GLYPH_ORIENTATION_VERTICAL_90_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 90°
GLYPH_ORIENTATION_VERTICAL_AUTO - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: Auto
GLYPH_ORIENTATION_VERTICAL_MINUS_180_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: -180°
GLYPH_ORIENTATION_VERTICAL_MINUS_90_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: -90°
GLYPH_ORIENTATION_VERTICAL_ZERO_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 0°
GoToSecondBookmarkOnOpen - Class in org.apache.pdfbox.examples.pdmodel
This is an example on how to an action to go to the second page when the PDF is opened.
GRestore - Class in org.apache.pdfbox.util.operator
 
GRestore() - Constructor for class org.apache.pdfbox.util.operator.GRestore
 
growToSize(int) - Method in class org.apache.pdfbox.cos.COSArray
This will add null values until the size of the array is at least as large as the parameter.
growToSize(int, COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will add the object until the size of the array is at least as large as the parameter.
GSave - Class in org.apache.pdfbox.util.operator
 
GSave() - Constructor for class org.apache.pdfbox.util.operator.GSave
 
GUIDELINE_STYLE_DASHED - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Style for guideline.
GUIDELINE_STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Style for guideline.

H

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

I

ICCBASED - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ICOSVisitor - Interface in org.apache.pdfbox.cos
An interface for visiting a PDF document at the type (COS) level.
ICU4JImpl - Class in org.apache.pdfbox.util
This class is an implementation the the ICU4J class.
ICU4JImpl() - Constructor for class org.apache.pdfbox.util.ICU4JImpl
Constructor.
ID - Static variable in class org.apache.pdfbox.cos.COSName
"ID"
ID_TREE - Static variable in class org.apache.pdfbox.cos.COSName
"IDTree"
IDENTITY - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
IDENTITY_H - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
IdentityFilter - Class in org.apache.pdfbox.filter
The IdentityFilter filter just passes the data through without any modifications.
IdentityFilter() - Constructor for class org.apache.pdfbox.filter.IdentityFilter
 
IMAGE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
IMAGE_MASK - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ImageParameters - Class in org.apache.pdfbox.util
This contains all of the image parameters for in inlined image.
ImageParameters() - Constructor for class org.apache.pdfbox.util.ImageParameters
Constructor.
ImageParameters(COSDictionary) - Constructor for class org.apache.pdfbox.util.ImageParameters
Constructor.
ImageToPDF - Class in org.apache.pdfbox.examples.pdmodel
This is an example that creates a simple document.
ImageToPDF() - Constructor for class org.apache.pdfbox.examples.pdmodel.ImageToPDF
 
ImportFDF - Class in org.apache.pdfbox
This example will take a PDF document and fill the fields with data from the FDF fields.
ImportFDF() - Constructor for class org.apache.pdfbox.ImportFDF
Creates a new instance of ImportFDF.
importFDF(PDDocument, FDFDocument) - Method in class org.apache.pdfbox.ImportFDF
This will takes the values from the fdf document and import them into the PDF document.
importFDF(PDDocument, FDFDocument) - Method in class org.apache.pdfbox.ImportXFDF
This will takes the values from the fdf document and import them into the PDF document.
importFDF(FDFDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This method will import an entire FDF document into the PDF document that this acroform is part of.
importFDF(FDFField) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will import a fdf field from a fdf document.
importPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will import and copy the contents from another location.
ImportXFDF - Class in org.apache.pdfbox
This example will take a PDF document and fill the fields with data from the XFDF fields.
ImportXFDF() - Constructor for class org.apache.pdfbox.ImportXFDF
Creates a new instance of ImportFDF.
importXMPMetadata(XMPMetadata) - Method in class org.apache.pdfbox.pdmodel.common.PDMetadata
Import an XMP stream into the PDF document.
incrementRevisionNumber() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Increments th revision number
INDEX - Static variable in class org.apache.pdfbox.cos.COSName
"Index"
INDEX - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Index
INDEXED - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
indexOf(COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will return the index of the entry or -1 if it is not found.
indexOf(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
indexOfObject(COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will return the index of the entry or -1 if it is not found.
INFO - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
initForEncryption() - Method in class org.apache.pdfbox.encryption.DocumentEncryption
Deprecated. This will encrypt the given document, given the owner password and user password.
INLINE_ALIGN_CENTER - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
InlineAlign: Center: Each child centered within the table cell.
INLINE_ALIGN_END - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
InlineAlign: End: End edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.
INLINE_ALIGN_START - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
InlineAlign: Start: Start edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.
insertBefore(COSInteger, Object) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Inserts a marked-content identifier kid before a reference kid.
insertBefore(PDMarkedContentReference, Object) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Inserts a marked-content reference kid before a reference kid.
insertBefore(PDObjectReference, Object) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Inserts an object reference kid before a reference kid.
insertBefore(PDStructureElement, Object) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Inserts a structure element kid before a reference kid.
insertBefore(COSBase, Object) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Inserts an COS base kid before a reference kid.
insertObjectableBefore(COSObjectable, Object) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Inserts an objectable kid before a reference kid.
insertSiblingAfter(PDOutlineItem) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Insert a sibling after this node.
inspectFontEncoding(String) - Method in class org.apache.pdfbox.util.PDFStreamEngine
A method provided as an event interface to allow a subclass to perform some specific functionality on the string encoded by a glyph.
inspectFontEncoding(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Reverse characters of a compound Arabic glyph.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
The single instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
This is the single instance of this class.
interpolate(float, float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
For a given value of x, interpolate calculates the y value on the line defined by the two points (xRangeMin , xRangeMax ) and (yRangeMin , yRangeMax ).
intValue() - Method in class org.apache.pdfbox.cos.COSFloat
This will get the integer value of this object.
intValue() - Method in class org.apache.pdfbox.cos.COSInteger
Polymorphic access to value as int This will get the integer value of this object.
intValue() - Method in class org.apache.pdfbox.cos.COSNumber
This will get the integer value of this number.
InvalidPasswordException - Exception in org.apache.pdfbox.exceptions
An exception that indicates an invalid password was supplied.
InvalidPasswordException(String) - Constructor for exception org.apache.pdfbox.exceptions.InvalidPasswordException
Constructor.
Invoke - Class in org.apache.pdfbox.util.operator
Invoke named XObject.
Invoke() - Constructor for class org.apache.pdfbox.util.operator.Invoke
 
Invoke - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
Invoke() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.Invoke
 
isAllCap() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isAllSecurityToBeRemoved() - Method in class org.apache.pdfbox.pdmodel.PDDocument
 
isAlphaSource() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the alpha source property.
isBold() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
A flag telling if the text should be bold.
isBottomAttached() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Is the artifact attached to the bottom edge?
isCachingFields() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will tell if this acro form is caching the fields.
isChecked() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
This will tell if this radio button is currently checked or not.
isClosing() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next character is a closing brace( close of PDF array ).
isClosing(int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next character is a closing brace( close of PDF array ).
isDashPatternEmpty() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Checks if the dashPattern is empty or all values equals 0.
isDiacritic() - Method in class org.apache.pdfbox.util.TextPosition
 
isEmpty() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
isEmpty() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
isEmpty() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Detects whether there are no properties in the attribute object.
isEncrypted() - Method in class org.apache.pdfbox.cos.COSDocument
This will tell if this is an encrypted document.
isEncrypted() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will tell if this document is encrypted or not.
isEndOfName(char) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Determine if a character terminates a PDF name.
isEOF() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
A simple test to see if we are at the end of the stream.
isEOF() - Method in class org.apache.pdfbox.io.PushBackInputStream
A simple test to see if we are at the end of the stream.
isEOL() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte to be read is an end of line byte.
isEOL(int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte to be read is an end of line byte.
isFD() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the value indication if the denominator of the fractional value is reduced/truncated .
isFileSelect() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
isFixedPitch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isForceBold() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isFree() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
Gets the xref 'free' attribute.
isHidden() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Shall the property be hidden?
isHidden() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the hidden flag.
isHidden() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the hidden flag.
isInvisible() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the invisible flag.
isInvisible() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the invisible flag.
isItalic() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isItalic() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
A flag telling if the text should be italic.
isLeaf(Object) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Returns true if node is a leaf.
isLeftAttached() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Is the artifact attached to the left edge?
isLocked() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the locked flag.
isLocked() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the locked flag.
isMarked() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Tells if this is a tagged PDF.
isMultiline() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
isNewDocNecessary() - Method in class org.apache.pdfbox.util.Splitter
Check if it is necessary to create a new document.
isNodeOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Node is open if the open count is greater than zero.
isNoExport() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
 
isNonSymbolic() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isNoRotate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the noRotate flag.
isNoRotate() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the noRotate flag.
isNoView() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the noView flag.
isNoView() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the noView flag.
isNoZoom() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the noZoom flag.
isNoZoom() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the noZoom flag.
isOnNewLine() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will tell if we are on a newling.
isOverprint() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the overprint property.
isOwnerPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated. This will tell if this is the owner password or not.
isOwnerPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check for owner password.
isOwnerPassword(String, byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check for owner password.
isOwnerPassword(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.  
isOwnerPermission() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the access permission corresponds to owner access permission (no restriction).
isPassword() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
isPrinted() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the printed flag.
isPrinted() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the printed flag.
isRadiosInUnison() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
 
isReadOnly() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the object has been set as read only.
isReadOnly() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the readOnly flag.
isReadOnly() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the readOnly flag.
isReadonly() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
 
isRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
 
isRichText() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
isRightAttached() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Is the artifact attached to the right edge?
isScript() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSerif() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSmallCap() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSpecified(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Is the attribute with the given name specified in this attribute object?
isStrokeAdjustment() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the stroke adjustment parameter.
isSuspect() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Tells if this PDF contain 'suspect' tags.
isSymbolic() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isToggleNoView() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the toggleNoView flag.
isToggleNoView() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the toggleNoView flag.
isTopAttached() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
Is the artifact attached to the top edge?
isUserPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.encryption.PDFEncryption
Deprecated. This will tell if this is a valid user password.
isUserPassword(byte[], byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check if a plaintext password is the user password.
isUserPassword(String, byte[], byte[], int, byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check if a plaintext password is the user password.
isUserPassword(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.  
isVolatile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get if the file is volatile.
isWhitespace() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte is whitespace or not.
isWhitespace(int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte is whitespace or not.
IT_LINE_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for annotation intent of Arrow.
IT_LINE_DIMENSION - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for annotation intent of a dimension line.
iterator() - Method in class org.apache.pdfbox.cos.COSArray
Get access to the list.
iterator() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList

J

JAVA_SCRIPT - Static variable in class org.apache.pdfbox.cos.COSName
"JavaScript"
JPX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

K

K - Static variable in class org.apache.pdfbox.cos.COSName
"K"
keyLength - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
The length of the secret key used to encrypt the document.
keyList() - Method in class org.apache.pdfbox.cos.COSDictionary
Deprecated. Use the COSDictionary.entrySet() method instead.
keySet() - Method in class org.apache.pdfbox.cos.COSDictionary
Returns the names of the entries in this dictionary.
keySet() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
KIDS - Static variable in class org.apache.pdfbox.cos.COSName
"Kids"

L

L - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
L
L_BODY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
LBody
LAB - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LABEL_PREFIX_TO_VALUE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constant indicating that the label specified by U is a postfix to the value.
LABEL_SUFFIX_TO_VALUE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constant indicating that the label specified by U is a suffix to the value.
LANG - Static variable in class org.apache.pdfbox.cos.COSName
"Lang"
LAST_CHAR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
lastIndexOf(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
LBL - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Lbl
LC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LE_BUTT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a butt line ending.
LE_CIRCLE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a circle line ending.
LE_CLOSED_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a closed arrow line ending.
LE_DIAMOND - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a diamond line ending.
LE_NONE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for no line ending.
LE_OPEN_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a open arrow line ending.
LE_R_CLOSED_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a revered closed arrow line ending.
LE_R_OPEN_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a reversed open arrow line ending.
LE_SLASH - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a slash line ending.
LE_SQUARE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constant for a square line ending.
leftPixel(byte[], int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the left pixel from the buffer.
LENGTH - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
length() - Method in interface org.apache.pdfbox.io.RandomAccess
The total number of bytes that are available.
length() - Method in class org.apache.pdfbox.io.RandomAccessBuffer
The total number of bytes that are available.
length() - Method in class org.apache.pdfbox.io.RandomAccessFile
The total number of bytes that are available.
LENGTH1 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LF - Static variable in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
Line feed character.
LF_ESCAPE - Static variable in class org.apache.pdfbox.cos.COSString
LF escape characters.
LI - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
LI
LIMITS - Static variable in class org.apache.pdfbox.cos.COSName
"Limits"
LINE_HEIGHT_AUTO - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
LineHeight: Auto: Adjustment for the value of BaselineShift shall not be made.
LINE_HEIGHT_NORMAL - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
LineHeight: NormalAdjust the line height to include any nonzero value specified for BaselineShift.
lineSeparator - Variable in class org.apache.pdfbox.util.PDFTextStripper
The platforms lineseparator.
lineTo(float, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Add a move to the given coordinate.
LineTo - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
LineTo() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.LineTo
 
LINK - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Link
LIST_NUMBERING - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
 
LIST_NUMBERING_CIRCLE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: Circle: Open circular bullet
LIST_NUMBERING_DECIMAL - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: Decimal: Decimal arabic numerals (1–9, 10–99, …)
LIST_NUMBERING_DISC - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: Disc: Solid circular bullet
LIST_NUMBERING_LOWER_ALPHA - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: LowerAlpha: Lowercase letters (a, b, c, …)
LIST_NUMBERING_LOWER_ROMAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: LowerRoman: Lowercase roman numerals (i, ii, iii, iv, …)
LIST_NUMBERING_NONE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: None: No autonumbering; Lbl elements (if present) contain arbitrary text not subject to any numbering scheme
LIST_NUMBERING_SQUARE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: Square: Solid square bullet
LIST_NUMBERING_UPPER_ALPHA - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: UpperAlpha: Uppercase letters (A, B, C, …)
LIST_NUMBERING_UPPER_ROMAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
ListNumbering: UpperRoman: Uppercase roman numerals (I, II, III, IV, …)
listIterator() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
listIterator(int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
LJ - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
load(String) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
load(File) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
load(InputStream) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from an input stream.
load(URL) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a url.
load(URL, boolean) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a url.
load(URL, RandomAccess) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a url.
load(String) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(String, boolean) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(String, RandomAccess) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(File) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(File, RandomAccess) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from a file.
load(InputStream) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from an input stream.
load(InputStream, boolean) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from an input stream.
load(InputStream, RandomAccess) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from an input stream.
load(InputStream, RandomAccess, boolean) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
This will load a document from an input stream.
loadProperties(String, boolean) - Static method in class org.apache.pdfbox.util.ResourceLoader
This will attempt to load the resource given the resource name.
loadProperties(String, Properties) - Static method in class org.apache.pdfbox.util.ResourceLoader
This will attempt to load the resource given the resource name.
loadResource(String) - Static method in class org.apache.pdfbox.util.ResourceLoader
This will attempt to load the resource given the resource name.
loadTTF(PDDocument, String) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
This will load a TTF font from a font file.
loadTTF(PDDocument, File) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
This will load a TTF to be embedded into a document.
loadTTF(PDDocument, InputStream) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
This will load a TTF to be embedded into a document.
loadXFDF(String) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
loadXFDF(File) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from a file.
loadXFDF(InputStream) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will load a document from an input stream.
localRead(byte[], int, int) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Read a number of bytes.
log(String) - Static method in class org.apache.pdfbox.util.ErrorLogger
Log an error message.
log(String, Throwable) - Static method in class org.apache.pdfbox.util.ErrorLogger
Log an error message.
longValue() - Method in class org.apache.pdfbox.cos.COSFloat
This will get the integer value of this object.
longValue() - Method in class org.apache.pdfbox.cos.COSInteger
Polymorphic access to value as int This will get the integer value of this object.
longValue() - Method in class org.apache.pdfbox.cos.COSNumber
This will get the long value of this number.
lookupColor(int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
This will perform a lookup into the color lookup table.
LW - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LZW_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LZW_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LZWFilter - Class in org.apache.pdfbox.filter
This is the used for the LZWDecode filter.
LZWFilter() - Constructor for class org.apache.pdfbox.filter.LZWFilter
 

M

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

N

N - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
NAME - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
The name of this color space.
NAME - Static variable in class org.apache.pdfbox.pdmodel.graphics.PDShading
The name of this object.
NAME_APPROVED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_AS_IS - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_COMMENT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_CONFIDENTIAL - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_DEPARTMENTAL - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_DRAFT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_ESCAPE - Static variable in class org.apache.pdfbox.cos.COSName
The escape character for a name.
NAME_EXPERIMENTAL - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_EXPIRED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_FINAL - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_FOR_COMMENT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_FOR_PUBLIC_RELEASE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_HELP - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_INSERT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_KEY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_NEW_PARAGRAPH - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_NOT_APPROVED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_NOT_FOR_PUBLIC_RELEASE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_NOTE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_PARAGRAPH - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a text annotation.
NAME_PREFIX - Static variable in class org.apache.pdfbox.cos.COSName
The prefix to a PDF name.
NAME_SOLD - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_TOP_SECRET - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAMES - Static variable in class org.apache.pdfbox.cos.COSName
"Names"
nameToCode - Variable in class org.apache.pdfbox.encoding.Encoding
This is a mapping from a character name to a character code.
NBitInputStream - Class in org.apache.pdfbox.io
This is an n-bit input stream.
NBitInputStream(InputStream) - Constructor for class org.apache.pdfbox.io.NBitInputStream
Constructor.
NBitOutputStream - Class in org.apache.pdfbox.io
This is an n-bit output stream.
NBitOutputStream(OutputStream) - Constructor for class org.apache.pdfbox.io.NBitOutputStream
Constructor.
NextLine - Class in org.apache.pdfbox.util.operator
 
NextLine() - Constructor for class org.apache.pdfbox.util.operator.NextLine
 
node - Variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
The dictionary for this node.
NON_FULL_SCREEN_PAGE_MODE_USE_NONE - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Neither document outline nor thumbnail images visible".
NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Optional content group panel visible".
NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Document outline visible".
NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
From PDF Reference: "Thumbnail images visible".
NON_STRUCT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
NonStruct
None - Class in org.apache.pdfbox.pdmodel.graphics.predictor
The none algorithm.
None() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.None
 
normalizeDiac(String) - Method in class org.apache.pdfbox.util.ICU4JImpl
Decomposes Diacritic characters to their combining forms.
normalizeDiac(String) - Method in class org.apache.pdfbox.util.TextNormalize
Normalize the diacritic, for example, convert non-combining diacritic characters to their combining counterparts.
normalizePres(String) - Method in class org.apache.pdfbox.util.ICU4JImpl
Normalize presentation forms of characters to the separate parts.
normalizePres(String) - Method in class org.apache.pdfbox.util.TextNormalize
Normalize the presentation forms of characters in the string.
NOTE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Note
notifyChanged() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Notifies the attribute object change listeners about a change in this attribute object.
NULL - Static variable in class org.apache.pdfbox.cos.COSNull
The one null object in the system.
NULL_BYTES - Static variable in class org.apache.pdfbox.cos.COSNull
The null token.
NUMS - Static variable in class org.apache.pdfbox.cos.COSName
"Nums"

O

O - Static variable in class org.apache.pdfbox.cos.COSName
"O"
OBJ - Static variable in class org.apache.pdfbox.cos.COSName
"Obj"
OBJ - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The starting object token.
ONE - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number one.
ONE - Static variable in class org.apache.pdfbox.cos.COSNumber
Deprecated. Use the COSInteger.ONE constant instead
OP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OP_NS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OPEN_ACTION - Static variable in class org.apache.pdfbox.cos.COSName
"OpenAction"
openNode() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
This will set this node to be open when it is shown in the viewer.
openProtection(DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Tries to decrypt the document in memory using the provided decryption material.
OPERATION_OPEN - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The open operation for the launch.
OPERATION_PRINT - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The print operation for the lanuch.
OperatorProcessor - Class in org.apache.pdfbox.util.operator
 
OperatorProcessor() - Constructor for class org.apache.pdfbox.util.operator.OperatorProcessor
Constructor.
OPM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Optimum - Class in org.apache.pdfbox.pdmodel.graphics.predictor
In an Uptimum encoded image, each line takes up width*bpp+1 bytes.
Optimum() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
 
ORDERING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
org.apache.pdfbox - package org.apache.pdfbox
This package holds executable classes that interact with the PDFBox application.
org.apache.pdfbox.cos - package org.apache.pdfbox.cos
These are the low level objects that make up a PDF document.
org.apache.pdfbox.encoding - package org.apache.pdfbox.encoding
This package contains the implementations for all of the encodings that are used in PDF documents.
org.apache.pdfbox.encoding.conversion - package org.apache.pdfbox.encoding.conversion
This package contains the implementations for conversions of encodings and CMaps that are used in PDF documents.
org.apache.pdfbox.encryption - package org.apache.pdfbox.encryption
These classes deal with encryption algorithms that are used in the PDF Document.
org.apache.pdfbox.examples - package org.apache.pdfbox.examples
The packages in this package will show how to use the PDFBox API.
org.apache.pdfbox.examples.fdf - package org.apache.pdfbox.examples.fdf
These are examples that use the FDF features of a PDF document.
org.apache.pdfbox.examples.pdmodel - package org.apache.pdfbox.examples.pdmodel
These examples show how to use the classes in the PDModel package.
org.apache.pdfbox.examples.persistence - package org.apache.pdfbox.examples.persistence
These examples will show how to use the persistence features of the PDFBox.
org.apache.pdfbox.examples.signature - package org.apache.pdfbox.examples.signature
These examples will show how to gain access to the PDF signature.
org.apache.pdfbox.examples.util - package org.apache.pdfbox.examples.util
The packages in this package will show how to use the PDFBox util API.
org.apache.pdfbox.exceptions - package org.apache.pdfbox.exceptions
This package is a place holder for exceptions that are used in the PDFBox project.
org.apache.pdfbox.filter - package org.apache.pdfbox.filter
This package will hold the PDFBox implementations of the filters that are used in PDF documents.
org.apache.pdfbox.io - package org.apache.pdfbox.io
This package contains IO streams.
org.apache.pdfbox.pdfparser - package org.apache.pdfbox.pdfparser
The pdfparser package contains classes to parse PDF documents and objects within the document.
org.apache.pdfbox.pdfviewer - package org.apache.pdfbox.pdfviewer
The pdfviewer package contains classes to graphically display information about a PDF document.
org.apache.pdfbox.pdfwriter - package org.apache.pdfbox.pdfwriter
This is the persistence layer used to write the PDFBox documents to a stream.
org.apache.pdfbox.pdmodel - package org.apache.pdfbox.pdmodel
The PDModel package represents a high level API for creating and manipulating PDF documents.
org.apache.pdfbox.pdmodel.common - package org.apache.pdfbox.pdmodel.common
High level PD classes that are used throughout several packages are placed in the PDModel common package.
org.apache.pdfbox.pdmodel.common.filespecification - package org.apache.pdfbox.pdmodel.common.filespecification
The file specification package defines classes that are used for the PDF File Specification logic.
org.apache.pdfbox.pdmodel.common.function - package org.apache.pdfbox.pdmodel.common.function
This package contains functions that are available in the PDF specification.
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure - package org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
The logical structure package provides a mechanism for incorporating structural information about a document's content into a PDF file.
org.apache.pdfbox.pdmodel.documentinterchange.markedcontent - package org.apache.pdfbox.pdmodel.documentinterchange.markedcontent
The marked content package provides a mechanism for modeling marked-content sequences.
org.apache.pdfbox.pdmodel.documentinterchange.prepress - package org.apache.pdfbox.pdmodel.documentinterchange.prepress
This package contains classes for prepress support in PDFBox.
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf - package org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
The tagged PDF package provides a mechanism for incorporating "tags" (standard structure types and attributes) into a PDF file.
org.apache.pdfbox.pdmodel.edit - package org.apache.pdfbox.pdmodel.edit
The PDModel edit package will be used to store classes for creating page content.
org.apache.pdfbox.pdmodel.encryption - package org.apache.pdfbox.pdmodel.encryption
The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
org.apache.pdfbox.pdmodel.fdf - package org.apache.pdfbox.pdmodel.fdf
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
org.apache.pdfbox.pdmodel.font - package org.apache.pdfbox.pdmodel.font
Classes to deal with font functionality in a PDF Document.
org.apache.pdfbox.pdmodel.graphics - package org.apache.pdfbox.pdmodel.graphics
The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
org.apache.pdfbox.pdmodel.graphics.color - package org.apache.pdfbox.pdmodel.graphics.color
This package deals with colors that are stored in a PDF document.
org.apache.pdfbox.pdmodel.graphics.predictor - package org.apache.pdfbox.pdmodel.graphics.predictor
The predictor package contains code for different PNG predictor algorithms that are present in PDF documents.
org.apache.pdfbox.pdmodel.graphics.xobject - package org.apache.pdfbox.pdmodel.graphics.xobject
This package deals with images that are stored in a PDF document.
org.apache.pdfbox.pdmodel.interactive.action - package org.apache.pdfbox.pdmodel.interactive.action
This package represents actions that can be performed in a PDF document.
org.apache.pdfbox.pdmodel.interactive.action.type - package org.apache.pdfbox.pdmodel.interactive.action.type
This package contains all of the available PDF action types.
org.apache.pdfbox.pdmodel.interactive.annotation - package org.apache.pdfbox.pdmodel.interactive.annotation
The annotation package contains classes that work with PDF annotation elements.
org.apache.pdfbox.pdmodel.interactive.digitalsignature - package org.apache.pdfbox.pdmodel.interactive.digitalsignature
The digitial signature library will manage signatures that are stored in the PDF document.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination - package org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
The destination package allows destinations into a pdf document to be specified.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline - package org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
The outline package allows for a PDF outline(bookmarks) to be created.
org.apache.pdfbox.pdmodel.interactive.form - package org.apache.pdfbox.pdmodel.interactive.form
The interactive package contains classes that deal with interactive annotations such as textfields and buttons.
org.apache.pdfbox.pdmodel.interactive.measurement - package org.apache.pdfbox.pdmodel.interactive.measurement
The measurement package contains classes that work with elements specifying measure properties.
org.apache.pdfbox.pdmodel.interactive.pagenavigation - package org.apache.pdfbox.pdmodel.interactive.pagenavigation
A package to allow provide access to PDF page navigation functionality.
org.apache.pdfbox.pdmodel.interactive.viewerpreferences - package org.apache.pdfbox.pdmodel.interactive.viewerpreferences
A package to allow access to document viewing preferences.
org.apache.pdfbox.pdmodel.text - package org.apache.pdfbox.pdmodel.text
The PDModel text package deals with text states, operations, and parameters within the PDF document.
org.apache.pdfbox.persistence.util - package org.apache.pdfbox.persistence.util
These are utilities used by the persistence layer.
org.apache.pdfbox.util - package org.apache.pdfbox.util
This package contains utility classes that are used by the PDFBox project.
org.apache.pdfbox.util.operator - package org.apache.pdfbox.util.operator
This package contains implementations of all of the PDF operators.
org.apache.pdfbox.util.operator.pagedrawer - package org.apache.pdfbox.util.operator.pagedrawer
This package contains implementations of all of the PDF operators.
OutlineNotLocalException - Exception in org.apache.pdfbox.exceptions
This exception will be thrown when a local destination(page within the same PDF) is required but the bookmark(PDOutlineItem) refers to an external destination or an action that does not point to a page.
OutlineNotLocalException(String) - Constructor for exception org.apache.pdfbox.exceptions.OutlineNotLocalException
Constructor.
OUTLINES - Static variable in class org.apache.pdfbox.cos.COSName
"Outlines"
output - Variable in class org.apache.pdfbox.util.PDFTextStripper
The stream to write the output to.
outputEncoding - Variable in class org.apache.pdfbox.util.PDFMarkedContentExtractor
encoding that text will be written in (or null).
outputEncoding - Variable in class org.apache.pdfbox.util.PDFTextStripper
encoding that text will be written in (or null).
Overlay - Class in org.apache.pdfbox
Overlay on document with another one.
Overlay() - Constructor for class org.apache.pdfbox.Overlay
 
overlay(PDDocument, PDDocument) - Method in class org.apache.pdfbox.Overlay
This will overlay two documents onto each other.
OWNER_CSS_1_00 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: CSS-1.00
OWNER_CSS_2_00 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: CSS-2.00
OWNER_HTML_3_20 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: HTML-3.2
OWNER_HTML_4_01 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: HTML-4.01
OWNER_LAYOUT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
standard attribute owner: Layout
OWNER_LIST - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
standard attribute owner: List
OWNER_OEB_1_00 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: OEB-1.00
OWNER_PRINT_FIELD - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
standard attribute owner: PrintField
OWNER_RTF_1_05 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: RTF-1.05
OWNER_TABLE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
standard attribute owner: Table
OWNER_USER_PROPERTIES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Attribute owner for user properties
OWNER_XML_1_00 - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
standard attribute owner: XML-1.00

P

P - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
P - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
P
Paeth - Class in org.apache.pdfbox.pdmodel.graphics.predictor
From http://www.w3.org/TR/PNG-Filters.html: The Paeth filter computes a simple linear function of the three neighboring pixels (left, above, upper left), then chooses as predictor the neighboring pixel closest to the computed value.
Paeth() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Paeth
 
paethPredictor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Paeth
The paeth predictor function.
PAGE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
page - Variable in class org.apache.pdfbox.pdfviewer.PageDrawer
 
PAGE_LABELS - Static variable in class org.apache.pdfbox.cos.COSName
"PageLabels"
PAGE_LAYOUT - Static variable in class org.apache.pdfbox.cos.COSName
"PageLayout"
PAGE_LAYOUT_ONE_COLUMN - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Display the pages in one column.
PAGE_LAYOUT_SINGLE_PAGE - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Display one page at a time.
PAGE_LAYOUT_TWO_COLUMN_LEFT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Display the pages in two columns, with odd numbered pagse on the left.
PAGE_LAYOUT_TWO_COLUMN_RIGHT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Display the pages in two columns, with odd numbered pagse on the right.
PAGE_LAYOUT_TWO_PAGE_LEFT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Display the pages two at a time, with odd-numbered pages on the left.
PAGE_LAYOUT_TWO_PAGE_RIGHT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Display the pages two at a time, with odd-numbered pages on the right.
PAGE_MODE - Static variable in class org.apache.pdfbox.cos.COSName
"PageMode"
PAGE_MODE_FULL_SCREEN - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Full screen mode with no menu bar, window controls.
PAGE_MODE_USE_ATTACHMENTS - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Attachments panel is visible.
PAGE_MODE_USE_NONE - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Page mode where neither the outline nor the thumbnails are displayed.
PAGE_MODE_USE_OPTIONAL_CONTENT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Optional content group panel is visible when opened.
PAGE_MODE_USE_OUTLINES - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Show bookmarks when pdf is opened.
PAGE_MODE_USE_THUMBS - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Show thumbnails when pdf is opened.
PAGE_SIZE_A0 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A0 Paper.
PAGE_SIZE_A1 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A1 Paper.
PAGE_SIZE_A2 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A2 Paper.
PAGE_SIZE_A3 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A3 Paper.
PAGE_SIZE_A4 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A4 Paper.
PAGE_SIZE_A5 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A5 Paper.
PAGE_SIZE_A6 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of A6 Paper.
PAGE_SIZE_LETTER - Static variable in class org.apache.pdfbox.pdmodel.PDPage
A page size of LETTER or 8.5x11.
PageDrawer - Class in org.apache.pdfbox.pdfviewer
This will paint a page in a PDF document to a graphics context.
PageDrawer() - Constructor for class org.apache.pdfbox.pdfviewer.PageDrawer
Default constructor, loads properties from file.
pageNumber - Variable in class org.apache.pdfbox.util.Splitter
The current page number that we are processing, zero based.
PAGES - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
pageSize - Variable in class org.apache.pdfbox.pdfviewer.PageDrawer
 
PageWrapper - Class in org.apache.pdfbox.pdfviewer
A class to handle some prettyness around a single PDF page.
PageWrapper(PDFReader) - Constructor for class org.apache.pdfbox.pdfviewer.PageWrapper
Constructor.
paint(Graphics) - Method in class org.apache.pdfbox.pdfviewer.PDFPagePanel
params - Variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
The params dictionary.
PARENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PARENT_TREE_NEXT_KEY - Static variable in class org.apache.pdfbox.cos.COSName
"ParentTreeNextKey"
parse() - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
This will parse the tokens in the stream.
parse() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will parse the stream and populate the COSDocument object.
parse() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will parse the tokens in the stream.
parse() - Method in class org.apache.pdfbox.pdfparser.PDFXrefStreamParser
Parses through the unfiltered stream and populates the xrefTable HashMap.
parse(InputStream) - Static method in class org.apache.pdfbox.util.XMLUtil
This will parse an XML stream and create a DOM document.
parseBoolean() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a boolean object from the stream.
parseCOSArray() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF array object.
parseCOSDictionary() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF dictionary.
parseCOSName() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF name from the stream.
parseCOSStream(COSDictionary, RandomAccess) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read a COSStream from the input stream.
parseCOSString() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF string.
parseDirObject() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a directory object from the stream.
parseXrefStreams() - Method in class org.apache.pdfbox.cos.COSDocument
This method will search the list of objects for types of XRef and uses the parsed data to populate the trailer information as well as the xref Map.
PART - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Part
PATTERN - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PDAcroForm - Class in org.apache.pdfbox.pdmodel.interactive.form
This class represents the acroform of a PDF document.
PDAcroForm(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Constructor.
PDAcroForm(PDDocument, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Constructor.
PDAction - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents an action that can be executed in a PDF document.
PDAction() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
Default constructor.
PDAction(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
Constructor.
PDActionFactory - Class in org.apache.pdfbox.pdmodel.interactive.action
This class will take a dictionary and determine which type of action to create.
PDActionGoTo - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents a go-to action that can be executed in a PDF document.
PDActionGoTo() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
Default constructor.
PDActionGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
Constructor.
PDActionJavaScript - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents a JavaScript action.
PDActionJavaScript() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
Constructor #1.
PDActionJavaScript(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
Constructor.
PDActionJavaScript(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
Constructor #2.
PDActionLaunch - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents a launch action that can be executed in a PDF document.
PDActionLaunch() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
Default constructor.
PDActionLaunch(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
Constructor.
PDActionRemoteGoTo - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents a remote go-to action that can be executed in a PDF document.
PDActionRemoteGoTo() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Default constructor.
PDActionRemoteGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
Constructor.
PDActionURI - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents a URI action that can be executed in a PDF document.
PDActionURI() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
Default constructor.
PDActionURI(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
Constructor.
PDAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a dictionary of actions that occur due to events.
PDAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Default constructor.
PDAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Constructor.
PDAnnotation - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents a PDF annotation.
PDAnnotation() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Constructor.
PDAnnotation(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Constructor.
PDAnnotationAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
This class represents an annotation's dictionary of actions that occur due to events.
PDAnnotationAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Default constructor.
PDAnnotationAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
Constructor.
PDAnnotationFileAttachment - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a file attachement.
PDAnnotationFileAttachment() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Constructor.
PDAnnotationFileAttachment(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationLine - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a line annotation.
PDAnnotationLine() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Constructor.
PDAnnotationLine(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationLink - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a link annotation.
PDAnnotationLink() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Constructor.
PDAnnotationLink(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationMarkup - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents the additonal fields of a Markup type Annotation.
PDAnnotationMarkup() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constructor.
PDAnnotationMarkup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constructor.
PDAnnotationPopup - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a popup annotation.
PDAnnotationPopup() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
Constructor.
PDAnnotationPopup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
Creates a popup annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationRubberStamp - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a rubber stamp annotation.
PDAnnotationRubberStamp() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constructor.
PDAnnotationRubberStamp(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Creates a Rubber Stamp annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationSquareCircle - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represe